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 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
24 #include <linux/dmaengine.h>
27 #define RIO_NO_HOPCOUNT -1
28 #define RIO_INVALID_DESTID 0xffff
30 #define RIO_MAX_MPORTS 8
31 #define RIO_MAX_MPORT_RESOURCES 16
32 #define RIO_MAX_DEV_RESOURCES 16
33 #define RIO_MAX_MPORT_NAME 40
35 #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's
36 global routing table if it
37 has multiple (or per port)
40 #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table
41 entry is invalid (no route
42 exists for the device ID) */
44 #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8))
45 #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff)
47 #define RIO_MAX_MBOX 4
48 #define RIO_MAX_MSG_SIZE 0x1000
51 * Error values that may be returned by RIO functions.
53 #define RIO_SUCCESSFUL 0x00
54 #define RIO_BAD_SIZE 0x81
57 * For RIO devices, the region numbers are assigned this way:
59 * 0 RapidIO outbound doorbells
60 * 1-15 RapidIO memory regions
62 * For RIO master ports, the region number are assigned this way:
64 * 0 RapidIO inbound doorbells
65 * 1 RapidIO inbound mailboxes
66 * 2 RapidIO outbound mailboxes
68 #define RIO_DOORBELL_RESOURCE 0
69 #define RIO_INB_MBOX_RESOURCE 1
70 #define RIO_OUTB_MBOX_RESOURCE 2
72 #define RIO_PW_MSG_SIZE 64
75 * A component tag value (stored in the component tag CSR) is used as device's
76 * unique identifier assigned during enumeration. Besides being used for
77 * identifying switches (which do not have device ID register), it also is used
78 * by error management notification and therefore has to be assigned
79 * to endpoints as well.
81 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */
82 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */
84 extern struct bus_type rio_bus_type
;
85 extern struct device rio_bus
;
86 extern struct list_head rio_devices
; /* list of all devices */
93 * struct rio_switch - RIO switch info
94 * @node: Node in global list of switches
95 * @switchid: Switch ID that is unique across a network
96 * @route_table: Copy of switch routing table
97 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0
98 * @add_entry: Callback for switch-specific route add function
99 * @get_entry: Callback for switch-specific route get function
100 * @clr_table: Callback for switch-specific clear route table function
101 * @set_domain: Callback for switch-specific domain setting function
102 * @get_domain: Callback for switch-specific domain get function
103 * @em_init: Callback for switch-specific error management init function
104 * @em_handle: Callback for switch-specific error management handler function
105 * @sw_sysfs: Callback that initializes switch-specific sysfs attributes
106 * @nextdev: Array of per-port pointers to the next attached device
109 struct list_head node
;
113 int (*add_entry
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
114 u16 table
, u16 route_destid
, u8 route_port
);
115 int (*get_entry
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
116 u16 table
, u16 route_destid
, u8
*route_port
);
117 int (*clr_table
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
119 int (*set_domain
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
121 int (*get_domain
) (struct rio_mport
*mport
, u16 destid
, u8 hopcount
,
123 int (*em_init
) (struct rio_dev
*dev
);
124 int (*em_handle
) (struct rio_dev
*dev
, u8 swport
);
125 int (*sw_sysfs
) (struct rio_dev
*dev
, int create
);
126 struct rio_dev
*nextdev
[0];
130 * struct rio_dev - RIO device info
131 * @global_list: Node in list of all RIO devices
132 * @net_list: Node in list of RIO devices in a network
133 * @net: Network this device is a part of
136 * @device_rev: Device revision
137 * @asm_did: Assembly device ID
138 * @asm_vid: Assembly vendor ID
139 * @asm_rev: Assembly revision
140 * @efptr: Extended feature pointer
141 * @pef: Processing element features
142 * @swpinfo: Switch port info
143 * @src_ops: Source operation capabilities
144 * @dst_ops: Destination operation capabilities
145 * @comp_tag: RIO component tag
146 * @phys_efptr: RIO device extended features pointer
147 * @em_efptr: RIO Error Management features pointer
148 * @dma_mask: Mask of bits of RIO address this device implements
149 * @driver: Driver claiming this device
150 * @dev: Device model device
151 * @riores: RIO resources this device owns
152 * @pwcback: port-write callback function for this device
153 * @destid: Network destination ID (or associated destid for switch)
154 * @hopcount: Hopcount to this device
155 * @prev: Previous RIO device connected to the current one
156 * @rswitch: struct rio_switch (if valid for this device)
159 struct list_head global_list
; /* node in list of all RIO devices */
160 struct list_head net_list
; /* node in per net list */
161 struct rio_net
*net
; /* RIO net this device resides in */
177 struct rio_driver
*driver
; /* RIO driver claiming this device */
178 struct device dev
; /* LDM device structure */
179 struct resource riores
[RIO_MAX_DEV_RESOURCES
];
180 int (*pwcback
) (struct rio_dev
*rdev
, union rio_pw_msg
*msg
, int step
);
183 struct rio_dev
*prev
;
184 struct rio_switch rswitch
[0]; /* RIO switch info */
187 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list)
188 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
189 #define to_rio_dev(n) container_of(n, struct rio_dev, dev)
190 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
193 * struct rio_msg - RIO message event
194 * @res: Mailbox resource
195 * @mcback: Message event callback
198 struct resource
*res
;
199 void (*mcback
) (struct rio_mport
* mport
, void *dev_id
, int mbox
, int slot
);
203 * struct rio_dbell - RIO doorbell event
204 * @node: Node in list of doorbell events
205 * @res: Doorbell resource
206 * @dinb: Doorbell event callback
207 * @dev_id: Device specific pointer to pass on event
210 struct list_head node
;
211 struct resource
*res
;
212 void (*dinb
) (struct rio_mport
*mport
, void *dev_id
, u16 src
, u16 dst
, u16 info
);
222 * struct rio_mport - RIO master port info
223 * @dbells: List of doorbell events
224 * @node: Node in global list of master ports
225 * @nnode: Node in network list of master ports
226 * @iores: I/O mem resource that this master port interface owns
227 * @riores: RIO resources that this master port interfaces owns
228 * @inb_msg: RIO inbound message event descriptors
229 * @outb_msg: RIO outbound message event descriptors
230 * @host_deviceid: Host device ID associated with this master port
231 * @ops: configuration space functions
232 * @id: Port ID, unique among all ports
233 * @index: Port index, unique among all port interfaces of the same type
234 * @sys_size: RapidIO common transport system size
235 * @phy_type: RapidIO phy type
236 * @phys_efptr: RIO port extended features pointer
237 * @name: Port name string
238 * @priv: Master port private data
239 * @dma: DMA device associated with mport
242 struct list_head dbells
; /* list of doorbell events */
243 struct list_head node
; /* node in global list of ports */
244 struct list_head nnode
; /* node in net list of ports */
245 struct resource iores
;
246 struct resource riores
[RIO_MAX_MPORT_RESOURCES
];
247 struct rio_msg inb_msg
[RIO_MAX_MBOX
];
248 struct rio_msg outb_msg
[RIO_MAX_MBOX
];
249 int host_deviceid
; /* Host device ID */
250 struct rio_ops
*ops
; /* low-level architecture-dependent routines */
251 unsigned char id
; /* port ID, unique among all ports */
252 unsigned char index
; /* port index, unique among all port
253 interfaces of the same type */
254 unsigned int sys_size
; /* RapidIO common transport system size.
255 * 0 - Small size. 256 devices.
256 * 1 - Large size, 65536 devices.
258 enum rio_phy_type phy_type
; /* RapidIO phy type */
260 unsigned char name
[RIO_MAX_MPORT_NAME
];
261 void *priv
; /* Master port private data */
262 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
263 struct dma_device dma
;
267 struct rio_id_table
{
268 u16 start
; /* logical minimal id */
269 u32 max
; /* max number of IDs in table */
271 unsigned long *table
;
275 * struct rio_net - RIO network info
276 * @node: Node in global list of RIO networks
277 * @devices: List of devices in this network
278 * @switches: List of switches in this netowrk
279 * @mports: List of master ports accessing this network
280 * @hport: Default port for accessing this network
281 * @id: RIO network ID
282 * @destid_table: destID allocation table
285 struct list_head node
; /* node in list of networks */
286 struct list_head devices
; /* list of devices in this net */
287 struct list_head switches
; /* list of switches in this net */
288 struct list_head mports
; /* list of ports accessing net */
289 struct rio_mport
*hport
; /* primary port for accessing net */
290 unsigned char id
; /* RIO network ID */
291 struct rio_id_table destid_table
; /* destID allocation table */
294 /* Definitions used by switch sysfs initialization callback */
295 #define RIO_SW_SYSFS_CREATE 1 /* Create switch attributes */
296 #define RIO_SW_SYSFS_REMOVE 0 /* Remove switch attributes */
298 /* Low-level architecture-dependent routines */
301 * struct rio_ops - Low-level RIO configuration space operations
302 * @lcread: Callback to perform local (master port) read of config space.
303 * @lcwrite: Callback to perform local (master port) write of config space.
304 * @cread: Callback to perform network read of config space.
305 * @cwrite: Callback to perform network write of config space.
306 * @dsend: Callback to send a doorbell message.
307 * @pwenable: Callback to enable/disable port-write message handling.
308 * @open_outb_mbox: Callback to initialize outbound mailbox.
309 * @close_outb_mbox: Callback to shut down outbound mailbox.
310 * @open_inb_mbox: Callback to initialize inbound mailbox.
311 * @close_inb_mbox: Callback to shut down inbound mailbox.
312 * @add_outb_message: Callback to add a message to an outbound mailbox queue.
313 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue.
314 * @get_inb_message: Callback to get a message from an inbound mailbox queue.
315 * @map_inb: Callback to map RapidIO address region into local memory space.
316 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb().
319 int (*lcread
) (struct rio_mport
*mport
, int index
, u32 offset
, int len
,
321 int (*lcwrite
) (struct rio_mport
*mport
, int index
, u32 offset
, int len
,
323 int (*cread
) (struct rio_mport
*mport
, int index
, u16 destid
,
324 u8 hopcount
, u32 offset
, int len
, u32
*data
);
325 int (*cwrite
) (struct rio_mport
*mport
, int index
, u16 destid
,
326 u8 hopcount
, u32 offset
, int len
, u32 data
);
327 int (*dsend
) (struct rio_mport
*mport
, int index
, u16 destid
, u16 data
);
328 int (*pwenable
) (struct rio_mport
*mport
, int enable
);
329 int (*open_outb_mbox
)(struct rio_mport
*mport
, void *dev_id
,
330 int mbox
, int entries
);
331 void (*close_outb_mbox
)(struct rio_mport
*mport
, int mbox
);
332 int (*open_inb_mbox
)(struct rio_mport
*mport
, void *dev_id
,
333 int mbox
, int entries
);
334 void (*close_inb_mbox
)(struct rio_mport
*mport
, int mbox
);
335 int (*add_outb_message
)(struct rio_mport
*mport
, struct rio_dev
*rdev
,
336 int mbox
, void *buffer
, size_t len
);
337 int (*add_inb_buffer
)(struct rio_mport
*mport
, int mbox
, void *buf
);
338 void *(*get_inb_message
)(struct rio_mport
*mport
, int mbox
);
339 int (*map_inb
)(struct rio_mport
*mport
, dma_addr_t lstart
,
340 u64 rstart
, u32 size
, u32 flags
);
341 void (*unmap_inb
)(struct rio_mport
*mport
, dma_addr_t lstart
);
344 #define RIO_RESOURCE_MEM 0x00000100
345 #define RIO_RESOURCE_DOORBELL 0x00000200
346 #define RIO_RESOURCE_MAILBOX 0x00000400
348 #define RIO_RESOURCE_CACHEABLE 0x00010000
349 #define RIO_RESOURCE_PCI 0x00020000
351 #define RIO_RESOURCE_BUSY 0x80000000
354 * struct rio_driver - RIO driver info
355 * @node: Node in list of drivers
356 * @name: RIO driver name
357 * @id_table: RIO device ids to be associated with this driver
358 * @probe: RIO device inserted
359 * @remove: RIO device removed
360 * @suspend: RIO device suspended
361 * @resume: RIO device awakened
362 * @enable_wake: RIO device enable wake event
363 * @driver: LDM driver struct
365 * Provides info on a RIO device driver for insertion/removal and
366 * power management purposes.
369 struct list_head node
;
371 const struct rio_device_id
*id_table
;
372 int (*probe
) (struct rio_dev
* dev
, const struct rio_device_id
* id
);
373 void (*remove
) (struct rio_dev
* dev
);
374 int (*suspend
) (struct rio_dev
* dev
, u32 state
);
375 int (*resume
) (struct rio_dev
* dev
);
376 int (*enable_wake
) (struct rio_dev
* dev
, u32 state
, int enable
);
377 struct device_driver driver
;
380 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver)
383 * struct rio_device_id - RIO device identifier
384 * @did: RIO device ID
385 * @vid: RIO vendor ID
386 * @asm_did: RIO assembly device ID
387 * @asm_vid: RIO assembly vendor ID
389 * Identifies a RIO device based on both the device/vendor IDs and
390 * the assembly device/vendor IDs.
392 struct rio_device_id
{
394 u16 asm_did
, asm_vid
;
398 * struct rio_switch_ops - Per-switch operations
399 * @vid: RIO vendor ID
400 * @did: RIO device ID
401 * @init_hook: Callback that performs switch device initialization
403 * Defines the operations that are necessary to initialize/control
404 * a particular RIO switch device.
406 struct rio_switch_ops
{
408 int (*init_hook
) (struct rio_dev
*rdev
, int do_enum
);
413 u32 comptag
; /* Component Tag CSR */
414 u32 errdetect
; /* Port N Error Detect CSR */
415 u32 is_port
; /* Implementation specific + PortID */
416 u32 ltlerrdet
; /* LTL Error Detect CSR */
419 u32 raw
[RIO_PW_MSG_SIZE
/sizeof(u32
)];
422 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
425 * enum rio_write_type - RIO write transaction types used in DMA transfers
427 * Note: RapidIO specification defines write (NWRITE) and
428 * write-with-response (NWRITE_R) data transfer operations.
429 * Existing DMA controllers that service RapidIO may use one of these operations
430 * for entire data transfer or their combination with only the last data packet
433 enum rio_write_type
{
434 RDW_DEFAULT
, /* default method used by DMA driver */
435 RDW_ALL_NWRITE
, /* all packets use NWRITE */
436 RDW_ALL_NWRITE_R
, /* all packets use NWRITE_R */
437 RDW_LAST_NWRITE_R
, /* last packet uses NWRITE_R, others - NWRITE */
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 */
447 struct rio_dma_data
{
448 /* Local data (as scatterlist) */
449 struct scatterlist
*sg
; /* I/O scatter list */
450 unsigned int sg_len
; /* size of scatter list */
451 /* Remote device address (flat buffer) */
452 u64 rio_addr
; /* low 64-bits of 66-bit RapidIO address */
453 u8 rio_addr_u
; /* upper 2-bits of 66-bit RapidIO address */
454 enum rio_write_type wr_type
; /* preferred RIO write operation type */
457 static inline struct rio_mport
*dma_to_mport(struct dma_device
*ddev
)
459 return container_of(ddev
, struct rio_mport
, dma
);
461 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */
463 /* Architecture and hardware-specific functions */
464 extern int rio_register_mport(struct rio_mport
*);
465 extern int rio_open_inb_mbox(struct rio_mport
*, void *, int, int);
466 extern void rio_close_inb_mbox(struct rio_mport
*, int);
467 extern int rio_open_outb_mbox(struct rio_mport
*, void *, int, int);
468 extern void rio_close_outb_mbox(struct rio_mport
*, int);
470 #endif /* LINUX_RIO_H */