2 * RapidIO interconnect services
3 * (RapidIO Interconnect Specification, http://www.rapidio.org)
5 * Copyright 2005 MontaVista Software, Inc.
6 * Matt Porter <mporter@kernel.crashing.org>
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.
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>
28 #define RIO_NO_HOPCOUNT -1
29 #define RIO_INVALID_DESTID 0xffff
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
36 #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's
37 global routing table if it
38 has multiple (or per port)
41 #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table
42 entry is invalid (no route
43 exists for the device ID) */
45 #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
46 #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
48 #define RIO_MAX_MBOX 4
49 #define RIO_MAX_MSG_SIZE 0x1000
52 * Error values that may be returned by RIO functions.
54 #define RIO_SUCCESSFUL 0x00
55 #define RIO_BAD_SIZE 0x81
58 * For RIO devices, the region numbers are assigned this way:
60 * 0 RapidIO outbound doorbells
61 * 1-15 RapidIO memory regions
63 * For RIO master ports, the region number are assigned this way:
65 * 0 RapidIO inbound doorbells
66 * 1 RapidIO inbound mailboxes
67 * 2 RapidIO outbound mailboxes
69 #define RIO_DOORBELL_RESOURCE 0
70 #define RIO_INB_MBOX_RESOURCE 1
71 #define RIO_OUTB_MBOX_RESOURCE 2
73 #define RIO_PW_MSG_SIZE 64
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.
82 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
83 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
85 extern struct bus_type rio_bus_type;
86 extern struct class rio_mport_class;
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
102 struct list_head node;
105 struct rio_switch_ops *ops;
107 struct rio_dev *nextdev[0];
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
121 * Defines the operations that are necessary to initialize/control
122 * a particular RIO switch device.
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,
132 int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
134 int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount,
136 int (*em_init) (struct rio_dev *dev);
137 int (*em_handle) (struct rio_dev *dev, u8 swport);
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
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)
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 */
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);
196 struct rio_dev *prev;
197 struct rio_switch rswitch[0]; /* RIO switch info */
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)
207 * struct rio_msg - RIO message event
208 * @res: Mailbox resource
209 * @mcback: Message event callback
212 struct resource *res;
213 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot);
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
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);
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
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.
274 enum rio_phy_type phy_type; /* RapidIO phy type */
276 unsigned char name[RIO_MAX_MPORT_NAME];
278 void *priv; /* Master port private data */
279 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
280 struct dma_device dma;
282 struct rio_scan *nscan;
286 * Enumeration/discovery control flags
288 #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */
290 struct rio_id_table {
291 u16 start; /* logical minimal id */
292 u32 max; /* max number of IDs in table */
294 unsigned long *table;
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
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 */
317 enum rio_link_speed {
318 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */
319 RIO_LINK_125 = 1, /* 1.25 GBaud */
320 RIO_LINK_250 = 2, /* 2.5 GBaud */
321 RIO_LINK_312 = 3, /* 3.125 GBaud */
322 RIO_LINK_500 = 4, /* 5.0 GBaud */
323 RIO_LINK_625 = 5 /* 6.25 GBaud */
326 enum rio_link_width {
335 enum rio_mport_flags {
336 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */
337 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */
338 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */
342 * struct rio_mport_attr - RIO mport device attributes
343 * @flags: mport device capability flags
344 * @link_speed: SRIO link speed value (as defined by RapidIO specification)
345 * @link_width: SRIO link width value (as defined by RapidIO specification)
346 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s)
347 * @dma_max_size: max number of bytes in single DMA transfer (SG entry)
348 * @dma_align: alignment shift for DMA operations (as for other DMA operations)
350 struct rio_mport_attr {
355 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */
361 /* Low-level architecture-dependent routines */
364 * struct rio_ops - Low-level RIO configuration space operations
365 * @lcread: Callback to perform local (master port) read of config space.
366 * @lcwrite: Callback to perform local (master port) write of config space.
367 * @cread: Callback to perform network read of config space.
368 * @cwrite: Callback to perform network write of config space.
369 * @dsend: Callback to send a doorbell message.
370 * @pwenable: Callback to enable/disable port-write message handling.
371 * @open_outb_mbox: Callback to initialize outbound mailbox.
372 * @close_outb_mbox: Callback to shut down outbound mailbox.
373 * @open_inb_mbox: Callback to initialize inbound mailbox.
374 * @close_inb_mbox: Callback to shut down inbound mailbox.
375 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
376 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
377 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
378 * @map_inb: Callback to map RapidIO address region into local memory space.
379 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
380 * @query_mport: Callback to query mport device attributes.
383 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len,
385 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len,
387 int (*cread) (struct rio_mport *mport, int index, u16 destid,
388 u8 hopcount, u32 offset, int len, u32 *data);
389 int (*cwrite) (struct rio_mport *mport, int index, u16 destid,
390 u8 hopcount, u32 offset, int len, u32 data);
391 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data);
392 int (*pwenable) (struct rio_mport *mport, int enable);
393 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id,
394 int mbox, int entries);
395 void (*close_outb_mbox)(struct rio_mport *mport, int mbox);
396 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id,
397 int mbox, int entries);
398 void (*close_inb_mbox)(struct rio_mport *mport, int mbox);
399 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev,
400 int mbox, void *buffer, size_t len);
401 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf);
402 void *(*get_inb_message)(struct rio_mport *mport, int mbox);
403 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart,
404 u64 rstart, u32 size, u32 flags);
405 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart);
406 int (*query_mport)(struct rio_mport *mport,
407 struct rio_mport_attr *attr);
410 #define RIO_RESOURCE_MEM 0x00000100
411 #define RIO_RESOURCE_DOORBELL 0x00000200
412 #define RIO_RESOURCE_MAILBOX 0x00000400
414 #define RIO_RESOURCE_CACHEABLE 0x00010000
415 #define RIO_RESOURCE_PCI 0x00020000
417 #define RIO_RESOURCE_BUSY 0x80000000
420 * struct rio_driver - RIO driver info
421 * @node: Node in list of drivers
422 * @name: RIO driver name
423 * @id_table: RIO device ids to be associated with this driver
424 * @probe: RIO device inserted
425 * @remove: RIO device removed
426 * @suspend: RIO device suspended
427 * @resume: RIO device awakened
428 * @enable_wake: RIO device enable wake event
429 * @driver: LDM driver struct
431 * Provides info on a RIO device driver for insertion/removal and
432 * power management purposes.
435 struct list_head node;
437 const struct rio_device_id *id_table;
438 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id);
439 void (*remove) (struct rio_dev * dev);
440 int (*suspend) (struct rio_dev * dev, u32 state);
441 int (*resume) (struct rio_dev * dev);
442 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable);
443 struct device_driver driver;
446 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
450 u32 comptag; /* Component Tag CSR */
451 u32 errdetect; /* Port N Error Detect CSR */
452 u32 is_port; /* Implementation specific + PortID */
453 u32 ltlerrdet; /* LTL Error Detect CSR */
456 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)];
459 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
462 * enum rio_write_type - RIO write transaction types used in DMA transfers
464 * Note: RapidIO specification defines write (NWRITE) and
465 * write-with-response (NWRITE_R) data transfer operations.
466 * Existing DMA controllers that service RapidIO may use one of these operations
467 * for entire data transfer or their combination with only the last data packet
470 enum rio_write_type {
471 RDW_DEFAULT, /* default method used by DMA driver */
472 RDW_ALL_NWRITE, /* all packets use NWRITE */
473 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */
474 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */
479 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
480 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
481 enum rio_write_type wr_type; /* preferred RIO write operation type */
484 struct rio_dma_data {
485 /* Local data (as scatterlist) */
486 struct scatterlist *sg; /* I/O scatter list */
487 unsigned int sg_len; /* size of scatter list */
488 /* Remote device address (flat buffer) */
489 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */
490 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */
491 enum rio_write_type wr_type; /* preferred RIO write operation type */
494 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev)
496 return container_of(ddev, struct rio_mport, dma);
498 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
501 * struct rio_scan - RIO enumeration and discovery operations
502 * @owner: The module owner of this structure
503 * @enumerate: Callback to perform RapidIO fabric enumeration.
504 * @discover: Callback to perform RapidIO fabric discovery.
507 struct module *owner;
508 int (*enumerate)(struct rio_mport *mport, u32 flags);
509 int (*discover)(struct rio_mport *mport, u32 flags);
513 * struct rio_scan_node - list node to register RapidIO enumeration and
514 * discovery methods with RapidIO core.
515 * @mport_id: ID of an mport (net) serviced by this enumerator
516 * @node: node in global list of registered enumerators
517 * @ops: RIO enumeration and discovery operations
519 struct rio_scan_node {
521 struct list_head node;
522 struct rio_scan *ops;
525 /* Architecture and hardware-specific functions */
526 extern int rio_register_mport(struct rio_mport *);
527 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int);
528 extern void rio_close_inb_mbox(struct rio_mport *, int);
529 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int);
530 extern void rio_close_outb_mbox(struct rio_mport *, int);
531 extern int rio_query_mport(struct rio_mport *port,
532 struct rio_mport_attr *mport_attr);
534 #endif /* LINUX_RIO_H */