~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/rio.h

Version: ~ [ linux-5.15-rc7 ] ~ [ linux-5.14.14 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.75 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.155 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.213 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.252 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.287 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.289 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  * RapidIO interconnect services
  3  * (RapidIO Interconnect Specification, http://www.rapidio.org)
  4  *
  5  * Copyright 2005 MontaVista Software, Inc.
  6  * Matt Porter <mporter@kernel.crashing.org>
  7  *
  8  * This program is free software; you can redistribute  it and/or modify it
  9  * under  the terms of  the GNU General  Public License as published by the
 10  * Free Software Foundation;  either version 2 of the  License, or (at your
 11  * option) any later version.
 12  */
 13 
 14 #ifndef LINUX_RIO_H
 15 #define LINUX_RIO_H
 16 
 17 #include <linux/types.h>
 18 #include <linux/ioport.h>
 19 #include <linux/list.h>
 20 #include <linux/errno.h>
 21 #include <linux/device.h>
 22 #include <linux/rio_regs.h>
 23 #include <linux/mod_devicetable.h>
 24 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
 25 #include <linux/dmaengine.h>
 26 #endif
 27 
 28 #define RIO_NO_HOPCOUNT         -1
 29 #define RIO_INVALID_DESTID      0xffff
 30 
 31 #define RIO_MAX_MPORTS          8
 32 #define RIO_MAX_MPORT_RESOURCES 16
 33 #define RIO_MAX_DEV_RESOURCES   16
 34 #define RIO_MAX_MPORT_NAME      40
 35 
 36 #define RIO_GLOBAL_TABLE        0xff    /* Indicates access of a switch's
 37                                            global routing table if it
 38                                            has multiple (or per port)
 39                                            tables */
 40 
 41 #define RIO_INVALID_ROUTE       0xff    /* Indicates that a route table
 42                                            entry is invalid (no route
 43                                            exists for the device ID) */
 44 
 45 #define RIO_MAX_ROUTE_ENTRIES(size)     (size ? (1 << 16) : (1 << 8))
 46 #define RIO_ANY_DESTID(size)            (size ? 0xffff : 0xff)
 47 
 48 #define RIO_MAX_MBOX            4
 49 #define RIO_MAX_MSG_SIZE        0x1000
 50 
 51 /*
 52  * Error values that may be returned by RIO functions.
 53  */
 54 #define RIO_SUCCESSFUL                  0x00
 55 #define RIO_BAD_SIZE                    0x81
 56 
 57 /*
 58  * For RIO devices, the region numbers are assigned this way:
 59  *
 60  *      0       RapidIO outbound doorbells
 61  *      1-15    RapidIO memory regions
 62  *
 63  * For RIO master ports, the region number are assigned this way:
 64  *
 65  *      0       RapidIO inbound doorbells
 66  *      1       RapidIO inbound mailboxes
 67  *      2       RapidIO outbound mailboxes
 68  */
 69 #define RIO_DOORBELL_RESOURCE   0
 70 #define RIO_INB_MBOX_RESOURCE   1
 71 #define RIO_OUTB_MBOX_RESOURCE  2
 72 
 73 #define RIO_PW_MSG_SIZE         64
 74 
 75 /*
 76  * A component tag value (stored in the component tag CSR) is used as device's
 77  * unique identifier assigned during enumeration. Besides being used for
 78  * identifying switches (which do not have device ID register), it also is used
 79  * by error management notification and therefore has to be assigned
 80  * to endpoints as well.
 81  */
 82 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
 83 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
 84 
 85 extern struct bus_type rio_bus_type;
 86 extern struct class rio_mport_class;
 87 
 88 struct rio_mport;
 89 struct rio_dev;
 90 union rio_pw_msg;
 91 
 92 /**
 93  * struct rio_switch - RIO switch info
 94  * @node: Node in global list of switches
 95  * @route_table: Copy of switch routing table
 96  * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
 97  * @ops: pointer to switch-specific operations
 98  * @lock: lock to serialize operations updates
 99  * @nextdev: Array of per-port pointers to the next attached device
100  */
101 struct rio_switch {
102         struct list_head node;
103         u8 *route_table;
104         u32 port_ok;
105         struct rio_switch_ops *ops;
106         spinlock_t lock;
107         struct rio_dev *nextdev[0];
108 };
109 
110 /**
111  * struct rio_switch_ops - Per-switch operations
112  * @owner: The module owner of this structure
113  * @add_entry: Callback for switch-specific route add function
114  * @get_entry: Callback for switch-specific route get function
115  * @clr_table: Callback for switch-specific clear route table function
116  * @set_domain: Callback for switch-specific domain setting function
117  * @get_domain: Callback for switch-specific domain get function
118  * @em_init: Callback for switch-specific error management init function
119  * @em_handle: Callback for switch-specific error management handler function
120  *
121  * Defines the operations that are necessary to initialize/control
122  * a particular RIO switch device.
123  */
124 struct rio_switch_ops {
125         struct module *owner;
126         int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
127                           u16 table, u16 route_destid, u8 route_port);
128         int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount,
129                           u16 table, u16 route_destid, u8 *route_port);
130         int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount,
131                           u16 table);
132         int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
133                            u8 sw_domain);
134         int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
135                            u8 *sw_domain);
136         int (*em_init) (struct rio_dev *dev);
137         int (*em_handle) (struct rio_dev *dev, u8 swport);
138 };
139 
140 /**
141  * struct rio_dev - RIO device info
142  * @global_list: Node in list of all RIO devices
143  * @net_list: Node in list of RIO devices in a network
144  * @net: Network this device is a part of
145  * @do_enum: Enumeration flag
146  * @did: Device ID
147  * @vid: Vendor ID
148  * @device_rev: Device revision
149  * @asm_did: Assembly device ID
150  * @asm_vid: Assembly vendor ID
151  * @asm_rev: Assembly revision
152  * @efptr: Extended feature pointer
153  * @pef: Processing element features
154  * @swpinfo: Switch port info
155  * @src_ops: Source operation capabilities
156  * @dst_ops: Destination operation capabilities
157  * @comp_tag: RIO component tag
158  * @phys_efptr: RIO device extended features pointer
159  * @em_efptr: RIO Error Management features pointer
160  * @dma_mask: Mask of bits of RIO address this device implements
161  * @driver: Driver claiming this device
162  * @dev: Device model device
163  * @riores: RIO resources this device owns
164  * @pwcback: port-write callback function for this device
165  * @destid: Network destination ID (or associated destid for switch)
166  * @hopcount: Hopcount to this device
167  * @prev: Previous RIO device connected to the current one
168  * @rswitch: struct rio_switch (if valid for this device)
169  */
170 struct rio_dev {
171         struct list_head global_list;   /* node in list of all RIO devices */
172         struct list_head net_list;      /* node in per net list */
173         struct rio_net *net;    /* RIO net this device resides in */
174         bool do_enum;
175         u16 did;
176         u16 vid;
177         u32 device_rev;
178         u16 asm_did;
179         u16 asm_vid;
180         u16 asm_rev;
181         u16 efptr;
182         u32 pef;
183         u32 swpinfo;
184         u32 src_ops;
185         u32 dst_ops;
186         u32 comp_tag;
187         u32 phys_efptr;
188         u32 em_efptr;
189         u64 dma_mask;
190         struct rio_driver *driver;      /* RIO driver claiming this device */
191         struct device dev;      /* LDM device structure */
192         struct resource riores[RIO_MAX_DEV_RESOURCES];
193         int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step);
194         u16 destid;
195         u8 hopcount;
196         struct rio_dev *prev;
197         struct rio_switch rswitch[0];   /* RIO switch info */
198 };
199 
200 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
201 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
202 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
203 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
204 #define to_rio_mport(n) container_of(n, struct rio_mport, dev)
205 
206 /**
207  * struct rio_msg - RIO message event
208  * @res: Mailbox resource
209  * @mcback: Message event callback
210  */
211 struct rio_msg {
212         struct resource *res;
213         void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
214 };
215 
216 /**
217  * struct rio_dbell - RIO doorbell event
218  * @node: Node in list of doorbell events
219  * @res: Doorbell resource
220  * @dinb: Doorbell event callback
221  * @dev_id: Device specific pointer to pass on event
222  */
223 struct rio_dbell {
224         struct list_head node;
225         struct resource *res;
226         void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info);
227         void *dev_id;
228 };
229 
230 enum rio_phy_type {
231         RIO_PHY_PARALLEL,
232         RIO_PHY_SERIAL,
233 };
234 
235 /**
236  * struct rio_mport - RIO master port info
237  * @dbells: List of doorbell events
238  * @node: Node in global list of master ports
239  * @nnode: Node in network list of master ports
240  * @iores: I/O mem resource that this master port interface owns
241  * @riores: RIO resources that this master port interfaces owns
242  * @inb_msg: RIO inbound message event descriptors
243  * @outb_msg: RIO outbound message event descriptors
244  * @host_deviceid: Host device ID associated with this master port
245  * @ops: configuration space functions
246  * @id: Port ID, unique among all ports
247  * @index: Port index, unique among all port interfaces of the same type
248  * @sys_size: RapidIO common transport system size
249  * @phy_type: RapidIO phy type
250  * @phys_efptr: RIO port extended features pointer
251  * @name: Port name string
252  * @dev: device structure associated with an mport
253  * @priv: Master port private data
254  * @dma: DMA device associated with mport
255  * @nscan: RapidIO network enumeration/discovery operations
256  */
257 struct rio_mport {
258         struct list_head dbells;        /* list of doorbell events */
259         struct list_head node;  /* node in global list of ports */
260         struct list_head nnode; /* node in net list of ports */
261         struct resource iores;
262         struct resource riores[RIO_MAX_MPORT_RESOURCES];
263         struct rio_msg inb_msg[RIO_MAX_MBOX];
264         struct rio_msg outb_msg[RIO_MAX_MBOX];
265         int host_deviceid;      /* Host device ID */
266         struct rio_ops *ops;    /* low-level architecture-dependent routines */
267         unsigned char id;       /* port ID, unique among all ports */
268         unsigned char index;    /* port index, unique among all port
269                                    interfaces of the same type */
270         unsigned int sys_size;  /* RapidIO common transport system size.
271                                  * 0 - Small size. 256 devices.
272                                  * 1 - Large size, 65536 devices.
273                                  */
274         enum rio_phy_type phy_type;     /* RapidIO phy type */
275         u32 phys_efptr;
276         unsigned char name[RIO_MAX_MPORT_NAME];
277         struct device dev;
278         void *priv;             /* Master port private data */
279 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
280         struct dma_device       dma;
281 #endif
282         struct rio_scan *nscan;
283 };
284 
285 /*
286  * Enumeration/discovery control flags
287  */
288 #define RIO_SCAN_ENUM_NO_WAIT   0x00000001 /* Do not wait for enum completed */
289 
290 struct rio_id_table {
291         u16 start;      /* logical minimal id */
292         u32 max;        /* max number of IDs in table */
293         spinlock_t lock;
294         unsigned long *table;
295 };
296 
297 /**
298  * struct rio_net - RIO network info
299  * @node: Node in global list of RIO networks
300  * @devices: List of devices in this network
301  * @switches: List of switches in this network
302  * @mports: List of master ports accessing this network
303  * @hport: Default port for accessing this network
304  * @id: RIO network ID
305  * @destid_table: destID allocation table
306  */
307 struct rio_net {
308         struct list_head node;  /* node in list of networks */
309         struct list_head devices;       /* list of devices in this net */
310         struct list_head switches;      /* list of switches in this net */
311         struct list_head mports;        /* list of ports accessing net */
312         struct rio_mport *hport;        /* primary port for accessing net */
313         unsigned char id;       /* RIO network ID */
314         struct rio_id_table destid_table;  /* destID allocation table */
315 };
316 
317 /* Low-level architecture-dependent routines */
318 
319 /**
320  * struct rio_ops - Low-level RIO configuration space operations
321  * @lcread: Callback to perform local (master port) read of config space.
322  * @lcwrite: Callback to perform local (master port) write of config space.
323  * @cread: Callback to perform network read of config space.
324  * @cwrite: Callback to perform network write of config space.
325  * @dsend: Callback to send a doorbell message.
326  * @pwenable: Callback to enable/disable port-write message handling.
327  * @open_outb_mbox: Callback to initialize outbound mailbox.
328  * @close_outb_mbox: Callback to shut down outbound mailbox.
329  * @open_inb_mbox: Callback to initialize inbound mailbox.
330  * @close_inb_mbox: Callback to shut down inbound mailbox.
331  * @add_outb_message: Callback to add a message to an outbound mailbox queue.
332  * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
333  * @get_inb_message: Callback to get a message from an inbound mailbox queue.
334  * @map_inb: Callback to map RapidIO address region into local memory space.
335  * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
336  */
337 struct rio_ops {
338         int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
339                         u32 *data);
340         int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
341                         u32 data);
342         int (*cread) (struct rio_mport *mport, int index, u16 destid,
343                         u8 hopcount, u32 offset, int len, u32 *data);
344         int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
345                         u8 hopcount, u32 offset, int len, u32 data);
346         int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
347         int (*pwenable) (struct rio_mport *mport, int enable);
348         int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
349                               int mbox, int entries);
350         void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
351         int  (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
352                              int mbox, int entries);
353         void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
354         int  (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
355                                  int mbox, void *buffer, size_t len);
356         int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
357         void *(*get_inb_message)(struct rio_mport *mport, int mbox);
358         int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
359                         u64 rstart, u32 size, u32 flags);
360         void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
361 };
362 
363 #define RIO_RESOURCE_MEM        0x00000100
364 #define RIO_RESOURCE_DOORBELL   0x00000200
365 #define RIO_RESOURCE_MAILBOX    0x00000400
366 
367 #define RIO_RESOURCE_CACHEABLE  0x00010000
368 #define RIO_RESOURCE_PCI        0x00020000
369 
370 #define RIO_RESOURCE_BUSY       0x80000000
371 
372 /**
373  * struct rio_driver - RIO driver info
374  * @node: Node in list of drivers
375  * @name: RIO driver name
376  * @id_table: RIO device ids to be associated with this driver
377  * @probe: RIO device inserted
378  * @remove: RIO device removed
379  * @suspend: RIO device suspended
380  * @resume: RIO device awakened
381  * @enable_wake: RIO device enable wake event
382  * @driver: LDM driver struct
383  *
384  * Provides info on a RIO device driver for insertion/removal and
385  * power management purposes.
386  */
387 struct rio_driver {
388         struct list_head node;
389         char *name;
390         const struct rio_device_id *id_table;
391         int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
392         void (*remove) (struct rio_dev * dev);
393         int (*suspend) (struct rio_dev * dev, u32 state);
394         int (*resume) (struct rio_dev * dev);
395         int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
396         struct device_driver driver;
397 };
398 
399 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
400 
401 union rio_pw_msg {
402         struct {
403                 u32 comptag;    /* Component Tag CSR */
404                 u32 errdetect;  /* Port N Error Detect CSR */
405                 u32 is_port;    /* Implementation specific + PortID */
406                 u32 ltlerrdet;  /* LTL Error Detect CSR */
407                 u32 padding[12];
408         } em;
409         u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
410 };
411 
412 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
413 
414 /*
415  * enum rio_write_type - RIO write transaction types used in DMA transfers
416  *
417  * Note: RapidIO specification defines write (NWRITE) and
418  * write-with-response (NWRITE_R) data transfer operations.
419  * Existing DMA controllers that service RapidIO may use one of these operations
420  * for entire data transfer or their combination with only the last data packet
421  * requires response.
422  */
423 enum rio_write_type {
424         RDW_DEFAULT,            /* default method used by DMA driver */
425         RDW_ALL_NWRITE,         /* all packets use NWRITE */
426         RDW_ALL_NWRITE_R,       /* all packets use NWRITE_R */
427         RDW_LAST_NWRITE_R,      /* last packet uses NWRITE_R, others - NWRITE */
428 };
429 
430 struct rio_dma_ext {
431         u16 destid;
432         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
433         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
434         enum rio_write_type wr_type; /* preferred RIO write operation type */
435 };
436 
437 struct rio_dma_data {
438         /* Local data (as scatterlist) */
439         struct scatterlist      *sg;    /* I/O scatter list */
440         unsigned int            sg_len; /* size of scatter list */
441         /* Remote device address (flat buffer) */
442         u64 rio_addr;   /* low 64-bits of 66-bit RapidIO address */
443         u8  rio_addr_u;  /* upper 2-bits of 66-bit RapidIO address */
444         enum rio_write_type wr_type; /* preferred RIO write operation type */
445 };
446 
447 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
448 {
449         return container_of(ddev, struct rio_mport, dma);
450 }
451 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
452 
453 /**
454  * struct rio_scan - RIO enumeration and discovery operations
455  * @owner: The module owner of this structure
456  * @enumerate: Callback to perform RapidIO fabric enumeration.
457  * @discover: Callback to perform RapidIO fabric discovery.
458  */
459 struct rio_scan {
460         struct module *owner;
461         int (*enumerate)(struct rio_mport *mport, u32 flags);
462         int (*discover)(struct rio_mport *mport, u32 flags);
463 };
464 
465 /**
466  * struct rio_scan_node - list node to register RapidIO enumeration and
467  * discovery methods with RapidIO core.
468  * @mport_id: ID of an mport (net) serviced by this enumerator
469  * @node: node in global list of registered enumerators
470  * @ops: RIO enumeration and discovery operations
471  */
472 struct rio_scan_node {
473         int mport_id;
474         struct list_head node;
475         struct rio_scan *ops;
476 };
477 
478 /* Architecture and hardware-specific functions */
479 extern int rio_register_mport(struct rio_mport *);
480 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
481 extern void rio_close_inb_mbox(struct rio_mport *, int);
482 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
483 extern void rio_close_outb_mbox(struct rio_mport *, int);
484 
485 #endif                          /* LINUX_RIO_H */
486 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp