Commit | Line | Data |
---|---|---|
70a50ebd MP |
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 | ||
70a50ebd | 17 | #include <linux/types.h> |
70a50ebd MP |
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> | |
e42d98eb AB |
23 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
24 | #include <linux/dmaengine.h> | |
25 | #endif | |
70a50ebd | 26 | |
70a50ebd | 27 | #define RIO_NO_HOPCOUNT -1 |
c70555b0 | 28 | #define RIO_INVALID_DESTID 0xffff |
70a50ebd | 29 | |
569fccb6 | 30 | #define RIO_MAX_MPORTS 8 |
70a50ebd MP |
31 | #define RIO_MAX_MPORT_RESOURCES 16 |
32 | #define RIO_MAX_DEV_RESOURCES 16 | |
ed43f44f | 33 | #define RIO_MAX_MPORT_NAME 40 |
70a50ebd MP |
34 | |
35 | #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's | |
36 | global routing table if it | |
37 | has multiple (or per port) | |
38 | tables */ | |
39 | ||
40 | #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table | |
41 | entry is invalid (no route | |
42 | exists for the device ID) */ | |
43 | ||
e0423236 ZW |
44 | #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8)) |
45 | #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff) | |
70a50ebd MP |
46 | |
47 | #define RIO_MAX_MBOX 4 | |
48 | #define RIO_MAX_MSG_SIZE 0x1000 | |
49 | ||
50 | /* | |
51 | * Error values that may be returned by RIO functions. | |
52 | */ | |
53 | #define RIO_SUCCESSFUL 0x00 | |
54 | #define RIO_BAD_SIZE 0x81 | |
55 | ||
56 | /* | |
57 | * For RIO devices, the region numbers are assigned this way: | |
58 | * | |
59 | * 0 RapidIO outbound doorbells | |
60 | * 1-15 RapidIO memory regions | |
61 | * | |
62 | * For RIO master ports, the region number are assigned this way: | |
63 | * | |
64 | * 0 RapidIO inbound doorbells | |
65 | * 1 RapidIO inbound mailboxes | |
66 | * 1 RapidIO outbound mailboxes | |
67 | */ | |
68 | #define RIO_DOORBELL_RESOURCE 0 | |
69 | #define RIO_INB_MBOX_RESOURCE 1 | |
70 | #define RIO_OUTB_MBOX_RESOURCE 2 | |
71 | ||
e5cabeb3 AB |
72 | #define RIO_PW_MSG_SIZE 64 |
73 | ||
e6536927 AB |
74 | /* |
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. | |
80 | */ | |
81 | #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */ | |
82 | #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */ | |
83 | ||
70a50ebd | 84 | extern struct bus_type rio_bus_type; |
2c70f022 | 85 | extern struct device rio_bus; |
70a50ebd MP |
86 | extern struct list_head rio_devices; /* list of all devices */ |
87 | ||
88 | struct rio_mport; | |
ded05782 | 89 | struct rio_dev; |
e5cabeb3 | 90 | union rio_pw_msg; |
70a50ebd | 91 | |
ded05782 AB |
92 | /** |
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 | |
107 | */ | |
108 | struct rio_switch { | |
109 | struct list_head node; | |
110 | u16 switchid; | |
111 | u8 *route_table; | |
112 | u32 port_ok; | |
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, | |
118 | u16 table); | |
119 | int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, | |
120 | u8 sw_domain); | |
121 | int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, | |
122 | u8 *sw_domain); | |
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]; | |
127 | }; | |
128 | ||
70a50ebd MP |
129 | /** |
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 | |
134 | * @did: Device ID | |
135 | * @vid: Vendor ID | |
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 | |
97ef6f74 RD |
145 | * @comp_tag: RIO component tag |
146 | * @phys_efptr: RIO device extended features pointer | |
147 | * @em_efptr: RIO Error Management features pointer | |
fa78cc51 | 148 | * @dma_mask: Mask of bits of RIO address this device implements |
70a50ebd MP |
149 | * @driver: Driver claiming this device |
150 | * @dev: Device model device | |
151 | * @riores: RIO resources this device owns | |
97ef6f74 | 152 | * @pwcback: port-write callback function for this device |
a93192a5 AB |
153 | * @destid: Network destination ID (or associated destid for switch) |
154 | * @hopcount: Hopcount to this device | |
68fe4df5 | 155 | * @prev: Previous RIO device connected to the current one |
ded05782 | 156 | * @rswitch: struct rio_switch (if valid for this device) |
70a50ebd MP |
157 | */ |
158 | struct rio_dev { | |
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 */ | |
162 | u16 did; | |
163 | u16 vid; | |
164 | u32 device_rev; | |
165 | u16 asm_did; | |
166 | u16 asm_vid; | |
167 | u16 asm_rev; | |
168 | u16 efptr; | |
169 | u32 pef; | |
ae05cbd5 | 170 | u32 swpinfo; |
70a50ebd MP |
171 | u32 src_ops; |
172 | u32 dst_ops; | |
e5cabeb3 AB |
173 | u32 comp_tag; |
174 | u32 phys_efptr; | |
175 | u32 em_efptr; | |
fa78cc51 | 176 | u64 dma_mask; |
70a50ebd MP |
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]; | |
e5cabeb3 | 180 | int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step); |
70a50ebd | 181 | u16 destid; |
a93192a5 | 182 | u8 hopcount; |
68fe4df5 | 183 | struct rio_dev *prev; |
ded05782 | 184 | struct rio_switch rswitch[0]; /* RIO switch info */ |
70a50ebd MP |
185 | }; |
186 | ||
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) | |
ded05782 | 190 | #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0]) |
70a50ebd MP |
191 | |
192 | /** | |
193 | * struct rio_msg - RIO message event | |
194 | * @res: Mailbox resource | |
195 | * @mcback: Message event callback | |
196 | */ | |
197 | struct rio_msg { | |
198 | struct resource *res; | |
6978bbc0 | 199 | void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); |
70a50ebd MP |
200 | }; |
201 | ||
202 | /** | |
203 | * struct rio_dbell - RIO doorbell event | |
204 | * @node: Node in list of doorbell events | |
205 | * @res: Doorbell resource | |
206 | * @dinb: Doorbell event callback | |
6978bbc0 | 207 | * @dev_id: Device specific pointer to pass on event |
70a50ebd MP |
208 | */ |
209 | struct rio_dbell { | |
210 | struct list_head node; | |
211 | struct resource *res; | |
6978bbc0 MP |
212 | void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); |
213 | void *dev_id; | |
70a50ebd MP |
214 | }; |
215 | ||
61b26917 ZW |
216 | enum rio_phy_type { |
217 | RIO_PHY_PARALLEL, | |
218 | RIO_PHY_SERIAL, | |
219 | }; | |
220 | ||
70a50ebd MP |
221 | /** |
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 | |
9941d945 RD |
234 | * @sys_size: RapidIO common transport system size |
235 | * @phy_type: RapidIO phy type | |
af84ca38 | 236 | * @phys_efptr: RIO port extended features pointer |
70a50ebd | 237 | * @name: Port name string |
ad1e9380 | 238 | * @priv: Master port private data |
70a50ebd MP |
239 | */ |
240 | struct rio_mport { | |
241 | struct list_head dbells; /* list of doorbell events */ | |
242 | struct list_head node; /* node in global list of ports */ | |
243 | struct list_head nnode; /* node in net list of ports */ | |
244 | struct resource iores; | |
245 | struct resource riores[RIO_MAX_MPORT_RESOURCES]; | |
246 | struct rio_msg inb_msg[RIO_MAX_MBOX]; | |
247 | struct rio_msg outb_msg[RIO_MAX_MBOX]; | |
248 | int host_deviceid; /* Host device ID */ | |
f8f06269 | 249 | struct rio_ops *ops; /* low-level architecture-dependent routines */ |
70a50ebd MP |
250 | unsigned char id; /* port ID, unique among all ports */ |
251 | unsigned char index; /* port index, unique among all port | |
252 | interfaces of the same type */ | |
e0423236 ZW |
253 | unsigned int sys_size; /* RapidIO common transport system size. |
254 | * 0 - Small size. 256 devices. | |
255 | * 1 - Large size, 65536 devices. | |
256 | */ | |
61b26917 | 257 | enum rio_phy_type phy_type; /* RapidIO phy type */ |
af84ca38 | 258 | u32 phys_efptr; |
ed43f44f | 259 | unsigned char name[RIO_MAX_MPORT_NAME]; |
ad1e9380 | 260 | void *priv; /* Master port private data */ |
e42d98eb AB |
261 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
262 | struct dma_device dma; | |
263 | #endif | |
70a50ebd MP |
264 | }; |
265 | ||
266 | /** | |
267 | * struct rio_net - RIO network info | |
268 | * @node: Node in global list of RIO networks | |
269 | * @devices: List of devices in this network | |
270 | * @mports: List of master ports accessing this network | |
271 | * @hport: Default port for accessing this network | |
272 | * @id: RIO network ID | |
273 | */ | |
274 | struct rio_net { | |
275 | struct list_head node; /* node in list of networks */ | |
276 | struct list_head devices; /* list of devices in this net */ | |
277 | struct list_head mports; /* list of ports accessing net */ | |
278 | struct rio_mport *hport; /* primary port for accessing net */ | |
279 | unsigned char id; /* RIO network ID */ | |
280 | }; | |
281 | ||
ac38d723 AB |
282 | /* Definitions used by switch sysfs initialization callback */ |
283 | #define RIO_SW_SYSFS_CREATE 1 /* Create switch attributes */ | |
284 | #define RIO_SW_SYSFS_REMOVE 0 /* Remove switch attributes */ | |
285 | ||
70a50ebd MP |
286 | /* Low-level architecture-dependent routines */ |
287 | ||
288 | /** | |
289 | * struct rio_ops - Low-level RIO configuration space operations | |
290 | * @lcread: Callback to perform local (master port) read of config space. | |
291 | * @lcwrite: Callback to perform local (master port) write of config space. | |
292 | * @cread: Callback to perform network read of config space. | |
293 | * @cwrite: Callback to perform network write of config space. | |
294 | * @dsend: Callback to send a doorbell message. | |
e5cabeb3 | 295 | * @pwenable: Callback to enable/disable port-write message handling. |
f8f06269 AB |
296 | * @open_outb_mbox: Callback to initialize outbound mailbox. |
297 | * @close_outb_mbox: Callback to shut down outbound mailbox. | |
298 | * @open_inb_mbox: Callback to initialize inbound mailbox. | |
299 | * @close_inb_mbox: Callback to shut down inbound mailbox. | |
300 | * @add_outb_message: Callback to add a message to an outbound mailbox queue. | |
301 | * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue. | |
302 | * @get_inb_message: Callback to get a message from an inbound mailbox queue. | |
70a50ebd MP |
303 | */ |
304 | struct rio_ops { | |
ad1e9380 ZW |
305 | int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len, |
306 | u32 *data); | |
307 | int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len, | |
308 | u32 data); | |
309 | int (*cread) (struct rio_mport *mport, int index, u16 destid, | |
310 | u8 hopcount, u32 offset, int len, u32 *data); | |
311 | int (*cwrite) (struct rio_mport *mport, int index, u16 destid, | |
312 | u8 hopcount, u32 offset, int len, u32 data); | |
313 | int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data); | |
e5cabeb3 | 314 | int (*pwenable) (struct rio_mport *mport, int enable); |
f8f06269 AB |
315 | int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id, |
316 | int mbox, int entries); | |
317 | void (*close_outb_mbox)(struct rio_mport *mport, int mbox); | |
318 | int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id, | |
319 | int mbox, int entries); | |
320 | void (*close_inb_mbox)(struct rio_mport *mport, int mbox); | |
321 | int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev, | |
322 | int mbox, void *buffer, size_t len); | |
323 | int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf); | |
324 | void *(*get_inb_message)(struct rio_mport *mport, int mbox); | |
70a50ebd MP |
325 | }; |
326 | ||
327 | #define RIO_RESOURCE_MEM 0x00000100 | |
328 | #define RIO_RESOURCE_DOORBELL 0x00000200 | |
329 | #define RIO_RESOURCE_MAILBOX 0x00000400 | |
330 | ||
331 | #define RIO_RESOURCE_CACHEABLE 0x00010000 | |
332 | #define RIO_RESOURCE_PCI 0x00020000 | |
333 | ||
334 | #define RIO_RESOURCE_BUSY 0x80000000 | |
335 | ||
336 | /** | |
337 | * struct rio_driver - RIO driver info | |
338 | * @node: Node in list of drivers | |
339 | * @name: RIO driver name | |
340 | * @id_table: RIO device ids to be associated with this driver | |
341 | * @probe: RIO device inserted | |
342 | * @remove: RIO device removed | |
343 | * @suspend: RIO device suspended | |
344 | * @resume: RIO device awakened | |
345 | * @enable_wake: RIO device enable wake event | |
346 | * @driver: LDM driver struct | |
347 | * | |
348 | * Provides info on a RIO device driver for insertion/removal and | |
349 | * power management purposes. | |
350 | */ | |
351 | struct rio_driver { | |
352 | struct list_head node; | |
353 | char *name; | |
354 | const struct rio_device_id *id_table; | |
355 | int (*probe) (struct rio_dev * dev, const struct rio_device_id * id); | |
356 | void (*remove) (struct rio_dev * dev); | |
357 | int (*suspend) (struct rio_dev * dev, u32 state); | |
358 | int (*resume) (struct rio_dev * dev); | |
359 | int (*enable_wake) (struct rio_dev * dev, u32 state, int enable); | |
360 | struct device_driver driver; | |
361 | }; | |
362 | ||
363 | #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) | |
364 | ||
365 | /** | |
366 | * struct rio_device_id - RIO device identifier | |
367 | * @did: RIO device ID | |
368 | * @vid: RIO vendor ID | |
369 | * @asm_did: RIO assembly device ID | |
370 | * @asm_vid: RIO assembly vendor ID | |
371 | * | |
372 | * Identifies a RIO device based on both the device/vendor IDs and | |
373 | * the assembly device/vendor IDs. | |
374 | */ | |
375 | struct rio_device_id { | |
376 | u16 did, vid; | |
377 | u16 asm_did, asm_vid; | |
378 | }; | |
379 | ||
380 | /** | |
058f88d6 | 381 | * struct rio_switch_ops - Per-switch operations |
70a50ebd MP |
382 | * @vid: RIO vendor ID |
383 | * @did: RIO device ID | |
058f88d6 | 384 | * @init_hook: Callback that performs switch device initialization |
70a50ebd | 385 | * |
058f88d6 AB |
386 | * Defines the operations that are necessary to initialize/control |
387 | * a particular RIO switch device. | |
70a50ebd | 388 | */ |
058f88d6 | 389 | struct rio_switch_ops { |
70a50ebd | 390 | u16 vid, did; |
058f88d6 | 391 | int (*init_hook) (struct rio_dev *rdev, int do_enum); |
e5cabeb3 AB |
392 | }; |
393 | ||
394 | union rio_pw_msg { | |
395 | struct { | |
396 | u32 comptag; /* Component Tag CSR */ | |
397 | u32 errdetect; /* Port N Error Detect CSR */ | |
398 | u32 is_port; /* Implementation specific + PortID */ | |
399 | u32 ltlerrdet; /* LTL Error Detect CSR */ | |
400 | u32 padding[12]; | |
401 | } em; | |
402 | u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)]; | |
403 | }; | |
404 | ||
e42d98eb AB |
405 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
406 | ||
407 | /** | |
408 | * enum rio_write_type - RIO write transaction types used in DMA transfers | |
409 | * | |
410 | * Note: RapidIO specification defines write (NWRITE) and | |
411 | * write-with-response (NWRITE_R) data transfer operations. | |
412 | * Existing DMA controllers that service RapidIO may use one of these operations | |
413 | * for entire data transfer or their combination with only the last data packet | |
414 | * requires response. | |
415 | */ | |
416 | enum rio_write_type { | |
417 | RDW_DEFAULT, /* default method used by DMA driver */ | |
418 | RDW_ALL_NWRITE, /* all packets use NWRITE */ | |
419 | RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */ | |
420 | RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */ | |
421 | }; | |
422 | ||
423 | struct rio_dma_ext { | |
424 | u16 destid; | |
425 | u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ | |
426 | u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ | |
427 | enum rio_write_type wr_type; /* preferred RIO write operation type */ | |
428 | }; | |
429 | ||
430 | struct rio_dma_data { | |
431 | /* Local data (as scatterlist) */ | |
432 | struct scatterlist *sg; /* I/O scatter list */ | |
433 | unsigned int sg_len; /* size of scatter list */ | |
434 | /* Remote device address (flat buffer) */ | |
435 | u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ | |
436 | u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ | |
437 | enum rio_write_type wr_type; /* preferred RIO write operation type */ | |
438 | }; | |
439 | ||
440 | static inline struct rio_mport *dma_to_mport(struct dma_device *ddev) | |
441 | { | |
442 | return container_of(ddev, struct rio_mport, dma); | |
443 | } | |
444 | #endif /* CONFIG_RAPIDIO_DMA_ENGINE */ | |
445 | ||
70a50ebd | 446 | /* Architecture and hardware-specific functions */ |
59f99965 | 447 | extern int rio_register_mport(struct rio_mport *); |
6978bbc0 | 448 | extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd | 449 | extern void rio_close_inb_mbox(struct rio_mport *, int); |
6978bbc0 | 450 | extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd MP |
451 | extern void rio_close_outb_mbox(struct rio_mport *, int); |
452 | ||
70a50ebd | 453 | #endif /* LINUX_RIO_H */ |