]>
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 <[email protected]> | |
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 | #ifdef __KERNEL__ | |
18 | ||
19 | #include <linux/types.h> | |
70a50ebd MP |
20 | #include <linux/ioport.h> |
21 | #include <linux/list.h> | |
22 | #include <linux/errno.h> | |
23 | #include <linux/device.h> | |
24 | #include <linux/rio_regs.h> | |
25 | ||
26 | #define RIO_ANY_DESTID 0xff | |
27 | #define RIO_NO_HOPCOUNT -1 | |
c70555b0 | 28 | #define RIO_INVALID_DESTID 0xffff |
70a50ebd MP |
29 | |
30 | #define RIO_MAX_MPORT_RESOURCES 16 | |
31 | #define RIO_MAX_DEV_RESOURCES 16 | |
32 | ||
33 | #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's | |
34 | global routing table if it | |
35 | has multiple (or per port) | |
36 | tables */ | |
37 | ||
38 | #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table | |
39 | entry is invalid (no route | |
40 | exists for the device ID) */ | |
41 | ||
42 | #ifdef CONFIG_RAPIDIO_8_BIT_TRANSPORT | |
43 | #define RIO_MAX_ROUTE_ENTRIES (1 << 8) | |
44 | #else | |
45 | #define RIO_MAX_ROUTE_ENTRIES (1 << 16) | |
46 | #endif | |
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 | * 1 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 | extern struct bus_type rio_bus_type; | |
74 | extern struct list_head rio_devices; /* list of all devices */ | |
75 | ||
76 | struct rio_mport; | |
77 | ||
78 | /** | |
79 | * struct rio_dev - RIO device info | |
80 | * @global_list: Node in list of all RIO devices | |
81 | * @net_list: Node in list of RIO devices in a network | |
82 | * @net: Network this device is a part of | |
83 | * @did: Device ID | |
84 | * @vid: Vendor ID | |
85 | * @device_rev: Device revision | |
86 | * @asm_did: Assembly device ID | |
87 | * @asm_vid: Assembly vendor ID | |
88 | * @asm_rev: Assembly revision | |
89 | * @efptr: Extended feature pointer | |
90 | * @pef: Processing element features | |
91 | * @swpinfo: Switch port info | |
92 | * @src_ops: Source operation capabilities | |
93 | * @dst_ops: Destination operation capabilities | |
fa78cc51 | 94 | * @dma_mask: Mask of bits of RIO address this device implements |
70a50ebd MP |
95 | * @rswitch: Pointer to &struct rio_switch if valid for this device |
96 | * @driver: Driver claiming this device | |
97 | * @dev: Device model device | |
98 | * @riores: RIO resources this device owns | |
99 | * @destid: Network destination ID | |
100 | */ | |
101 | struct rio_dev { | |
102 | struct list_head global_list; /* node in list of all RIO devices */ | |
103 | struct list_head net_list; /* node in per net list */ | |
104 | struct rio_net *net; /* RIO net this device resides in */ | |
105 | u16 did; | |
106 | u16 vid; | |
107 | u32 device_rev; | |
108 | u16 asm_did; | |
109 | u16 asm_vid; | |
110 | u16 asm_rev; | |
111 | u16 efptr; | |
112 | u32 pef; | |
113 | u32 swpinfo; /* Only used for switches */ | |
114 | u32 src_ops; | |
115 | u32 dst_ops; | |
fa78cc51 | 116 | u64 dma_mask; |
70a50ebd MP |
117 | struct rio_switch *rswitch; /* RIO switch info */ |
118 | struct rio_driver *driver; /* RIO driver claiming this device */ | |
119 | struct device dev; /* LDM device structure */ | |
120 | struct resource riores[RIO_MAX_DEV_RESOURCES]; | |
121 | u16 destid; | |
122 | }; | |
123 | ||
124 | #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list) | |
125 | #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list) | |
126 | #define to_rio_dev(n) container_of(n, struct rio_dev, dev) | |
127 | ||
128 | /** | |
129 | * struct rio_msg - RIO message event | |
130 | * @res: Mailbox resource | |
131 | * @mcback: Message event callback | |
132 | */ | |
133 | struct rio_msg { | |
134 | struct resource *res; | |
6978bbc0 | 135 | void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); |
70a50ebd MP |
136 | }; |
137 | ||
138 | /** | |
139 | * struct rio_dbell - RIO doorbell event | |
140 | * @node: Node in list of doorbell events | |
141 | * @res: Doorbell resource | |
142 | * @dinb: Doorbell event callback | |
6978bbc0 | 143 | * @dev_id: Device specific pointer to pass on event |
70a50ebd MP |
144 | */ |
145 | struct rio_dbell { | |
146 | struct list_head node; | |
147 | struct resource *res; | |
6978bbc0 MP |
148 | void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); |
149 | void *dev_id; | |
70a50ebd MP |
150 | }; |
151 | ||
152 | /** | |
153 | * struct rio_mport - RIO master port info | |
154 | * @dbells: List of doorbell events | |
155 | * @node: Node in global list of master ports | |
156 | * @nnode: Node in network list of master ports | |
157 | * @iores: I/O mem resource that this master port interface owns | |
158 | * @riores: RIO resources that this master port interfaces owns | |
159 | * @inb_msg: RIO inbound message event descriptors | |
160 | * @outb_msg: RIO outbound message event descriptors | |
161 | * @host_deviceid: Host device ID associated with this master port | |
162 | * @ops: configuration space functions | |
163 | * @id: Port ID, unique among all ports | |
164 | * @index: Port index, unique among all port interfaces of the same type | |
165 | * @name: Port name string | |
166 | */ | |
167 | struct rio_mport { | |
168 | struct list_head dbells; /* list of doorbell events */ | |
169 | struct list_head node; /* node in global list of ports */ | |
170 | struct list_head nnode; /* node in net list of ports */ | |
171 | struct resource iores; | |
172 | struct resource riores[RIO_MAX_MPORT_RESOURCES]; | |
173 | struct rio_msg inb_msg[RIO_MAX_MBOX]; | |
174 | struct rio_msg outb_msg[RIO_MAX_MBOX]; | |
175 | int host_deviceid; /* Host device ID */ | |
176 | struct rio_ops *ops; /* maintenance transaction functions */ | |
177 | unsigned char id; /* port ID, unique among all ports */ | |
178 | unsigned char index; /* port index, unique among all port | |
179 | interfaces of the same type */ | |
180 | unsigned char name[40]; | |
181 | }; | |
182 | ||
183 | /** | |
184 | * struct rio_net - RIO network info | |
185 | * @node: Node in global list of RIO networks | |
186 | * @devices: List of devices in this network | |
187 | * @mports: List of master ports accessing this network | |
188 | * @hport: Default port for accessing this network | |
189 | * @id: RIO network ID | |
190 | */ | |
191 | struct rio_net { | |
192 | struct list_head node; /* node in list of networks */ | |
193 | struct list_head devices; /* list of devices in this net */ | |
194 | struct list_head mports; /* list of ports accessing net */ | |
195 | struct rio_mport *hport; /* primary port for accessing net */ | |
196 | unsigned char id; /* RIO network ID */ | |
197 | }; | |
198 | ||
199 | /** | |
200 | * struct rio_switch - RIO switch info | |
201 | * @node: Node in global list of switches | |
202 | * @switchid: Switch ID that is unique across a network | |
203 | * @hopcount: Hopcount to this switch | |
204 | * @destid: Associated destid in the path | |
205 | * @route_table: Copy of switch routing table | |
206 | * @add_entry: Callback for switch-specific route add function | |
207 | * @get_entry: Callback for switch-specific route get function | |
208 | */ | |
209 | struct rio_switch { | |
210 | struct list_head node; | |
211 | u16 switchid; | |
212 | u16 hopcount; | |
213 | u16 destid; | |
214 | u8 route_table[RIO_MAX_ROUTE_ENTRIES]; | |
215 | int (*add_entry) (struct rio_mport * mport, u16 destid, u8 hopcount, | |
216 | u16 table, u16 route_destid, u8 route_port); | |
217 | int (*get_entry) (struct rio_mport * mport, u16 destid, u8 hopcount, | |
218 | u16 table, u16 route_destid, u8 * route_port); | |
219 | }; | |
220 | ||
221 | /* Low-level architecture-dependent routines */ | |
222 | ||
223 | /** | |
224 | * struct rio_ops - Low-level RIO configuration space operations | |
225 | * @lcread: Callback to perform local (master port) read of config space. | |
226 | * @lcwrite: Callback to perform local (master port) write of config space. | |
227 | * @cread: Callback to perform network read of config space. | |
228 | * @cwrite: Callback to perform network write of config space. | |
229 | * @dsend: Callback to send a doorbell message. | |
230 | */ | |
231 | struct rio_ops { | |
232 | int (*lcread) (int index, u32 offset, int len, u32 * data); | |
233 | int (*lcwrite) (int index, u32 offset, int len, u32 data); | |
234 | int (*cread) (int index, u16 destid, u8 hopcount, u32 offset, int len, | |
235 | u32 * data); | |
236 | int (*cwrite) (int index, u16 destid, u8 hopcount, u32 offset, int len, | |
237 | u32 data); | |
238 | int (*dsend) (int index, u16 destid, u16 data); | |
239 | }; | |
240 | ||
241 | #define RIO_RESOURCE_MEM 0x00000100 | |
242 | #define RIO_RESOURCE_DOORBELL 0x00000200 | |
243 | #define RIO_RESOURCE_MAILBOX 0x00000400 | |
244 | ||
245 | #define RIO_RESOURCE_CACHEABLE 0x00010000 | |
246 | #define RIO_RESOURCE_PCI 0x00020000 | |
247 | ||
248 | #define RIO_RESOURCE_BUSY 0x80000000 | |
249 | ||
250 | /** | |
251 | * struct rio_driver - RIO driver info | |
252 | * @node: Node in list of drivers | |
253 | * @name: RIO driver name | |
254 | * @id_table: RIO device ids to be associated with this driver | |
255 | * @probe: RIO device inserted | |
256 | * @remove: RIO device removed | |
257 | * @suspend: RIO device suspended | |
258 | * @resume: RIO device awakened | |
259 | * @enable_wake: RIO device enable wake event | |
260 | * @driver: LDM driver struct | |
261 | * | |
262 | * Provides info on a RIO device driver for insertion/removal and | |
263 | * power management purposes. | |
264 | */ | |
265 | struct rio_driver { | |
266 | struct list_head node; | |
267 | char *name; | |
268 | const struct rio_device_id *id_table; | |
269 | int (*probe) (struct rio_dev * dev, const struct rio_device_id * id); | |
270 | void (*remove) (struct rio_dev * dev); | |
271 | int (*suspend) (struct rio_dev * dev, u32 state); | |
272 | int (*resume) (struct rio_dev * dev); | |
273 | int (*enable_wake) (struct rio_dev * dev, u32 state, int enable); | |
274 | struct device_driver driver; | |
275 | }; | |
276 | ||
277 | #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) | |
278 | ||
279 | /** | |
280 | * struct rio_device_id - RIO device identifier | |
281 | * @did: RIO device ID | |
282 | * @vid: RIO vendor ID | |
283 | * @asm_did: RIO assembly device ID | |
284 | * @asm_vid: RIO assembly vendor ID | |
285 | * | |
286 | * Identifies a RIO device based on both the device/vendor IDs and | |
287 | * the assembly device/vendor IDs. | |
288 | */ | |
289 | struct rio_device_id { | |
290 | u16 did, vid; | |
291 | u16 asm_did, asm_vid; | |
292 | }; | |
293 | ||
294 | /** | |
295 | * struct rio_route_ops - Per-switch route operations | |
296 | * @vid: RIO vendor ID | |
297 | * @did: RIO device ID | |
298 | * @add_hook: Callback that adds a route entry | |
299 | * @get_hook: Callback that gets a route entry | |
300 | * | |
301 | * Defines the operations that are necessary to manipulate the route | |
302 | * tables for a particular RIO switch device. | |
303 | */ | |
304 | struct rio_route_ops { | |
305 | u16 vid, did; | |
306 | int (*add_hook) (struct rio_mport * mport, u16 destid, u8 hopcount, | |
307 | u16 table, u16 route_destid, u8 route_port); | |
308 | int (*get_hook) (struct rio_mport * mport, u16 destid, u8 hopcount, | |
309 | u16 table, u16 route_destid, u8 * route_port); | |
310 | }; | |
311 | ||
312 | /* Architecture and hardware-specific functions */ | |
313 | extern int rio_init_mports(void); | |
314 | extern void rio_register_mport(struct rio_mport *); | |
315 | extern int rio_hw_add_outb_message(struct rio_mport *, struct rio_dev *, int, | |
316 | void *, size_t); | |
317 | extern int rio_hw_add_inb_buffer(struct rio_mport *, int, void *); | |
318 | extern void *rio_hw_get_inb_message(struct rio_mport *, int); | |
6978bbc0 | 319 | extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd | 320 | extern void rio_close_inb_mbox(struct rio_mport *, int); |
6978bbc0 | 321 | extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd MP |
322 | extern void rio_close_outb_mbox(struct rio_mport *, int); |
323 | ||
324 | #endif /* __KERNEL__ */ | |
325 | #endif /* LINUX_RIO_H */ |