Blame view
include/linux/rio.h
13.7 KB
70a50ebd9 [PATCH] RapidIO s... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
/* * RapidIO interconnect services * (RapidIO Interconnect Specification, http://www.rapidio.org) * * Copyright 2005 MontaVista Software, Inc. * Matt Porter <mporter@kernel.crashing.org> * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the * Free Software Foundation; either version 2 of the License, or (at your * option) any later version. */ #ifndef LINUX_RIO_H #define LINUX_RIO_H |
70a50ebd9 [PATCH] RapidIO s... |
16 |
#include <linux/types.h> |
70a50ebd9 [PATCH] RapidIO s... |
17 18 19 20 21 |
#include <linux/ioport.h> #include <linux/list.h> #include <linux/errno.h> #include <linux/device.h> #include <linux/rio_regs.h> |
70a50ebd9 [PATCH] RapidIO s... |
22 |
#define RIO_NO_HOPCOUNT -1 |
c70555b05 [PATCH] rapidio: ... |
23 |
#define RIO_INVALID_DESTID 0xffff |
70a50ebd9 [PATCH] RapidIO s... |
24 |
|
569fccb6b rapidio: modify m... |
25 |
#define RIO_MAX_MPORTS 8 |
70a50ebd9 [PATCH] RapidIO s... |
26 27 28 29 30 31 32 33 34 35 36 |
#define RIO_MAX_MPORT_RESOURCES 16 #define RIO_MAX_DEV_RESOURCES 16 #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's global routing table if it has multiple (or per port) tables */ #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table entry is invalid (no route exists for the device ID) */ |
e04232360 [RAPIDIO] Auto-pr... |
37 38 |
#define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8)) #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff) |
70a50ebd9 [PATCH] RapidIO s... |
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
#define RIO_MAX_MBOX 4 #define RIO_MAX_MSG_SIZE 0x1000 /* * Error values that may be returned by RIO functions. */ #define RIO_SUCCESSFUL 0x00 #define RIO_BAD_SIZE 0x81 /* * For RIO devices, the region numbers are assigned this way: * * 0 RapidIO outbound doorbells * 1-15 RapidIO memory regions * * For RIO master ports, the region number are assigned this way: * * 0 RapidIO inbound doorbells * 1 RapidIO inbound mailboxes * 1 RapidIO outbound mailboxes */ #define RIO_DOORBELL_RESOURCE 0 #define RIO_INB_MBOX_RESOURCE 1 #define RIO_OUTB_MBOX_RESOURCE 2 |
e5cabeb3d rapidio: add Port... |
64 |
#define RIO_PW_MSG_SIZE 64 |
e6536927e rapidio: add defi... |
65 66 67 68 69 70 71 72 73 |
/* * A component tag value (stored in the component tag CSR) is used as device's * unique identifier assigned during enumeration. Besides being used for * identifying switches (which do not have device ID register), it also is used * by error management notification and therefore has to be assigned * to endpoints as well. */ #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */ #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */ |
70a50ebd9 [PATCH] RapidIO s... |
74 |
extern struct bus_type rio_bus_type; |
2c70f022e rapidio: fix Rapi... |
75 |
extern struct device rio_bus; |
70a50ebd9 [PATCH] RapidIO s... |
76 77 78 |
extern struct list_head rio_devices; /* list of all devices */ struct rio_mport; |
ded057827 rapidio: integrat... |
79 |
struct rio_dev; |
e5cabeb3d rapidio: add Port... |
80 |
union rio_pw_msg; |
70a50ebd9 [PATCH] RapidIO s... |
81 82 |
/** |
ded057827 rapidio: integrat... |
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
* struct rio_switch - RIO switch info * @node: Node in global list of switches * @switchid: Switch ID that is unique across a network * @route_table: Copy of switch routing table * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0 * @add_entry: Callback for switch-specific route add function * @get_entry: Callback for switch-specific route get function * @clr_table: Callback for switch-specific clear route table function * @set_domain: Callback for switch-specific domain setting function * @get_domain: Callback for switch-specific domain get function * @em_init: Callback for switch-specific error management init function * @em_handle: Callback for switch-specific error management handler function * @sw_sysfs: Callback that initializes switch-specific sysfs attributes * @nextdev: Array of per-port pointers to the next attached device */ struct rio_switch { struct list_head node; u16 switchid; u8 *route_table; u32 port_ok; int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount, u16 table, u16 route_destid, u8 route_port); int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount, u16 table, u16 route_destid, u8 *route_port); int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount, u16 table); int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, u8 sw_domain); int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, u8 *sw_domain); int (*em_init) (struct rio_dev *dev); int (*em_handle) (struct rio_dev *dev, u8 swport); int (*sw_sysfs) (struct rio_dev *dev, int create); struct rio_dev *nextdev[0]; }; /** |
70a50ebd9 [PATCH] RapidIO s... |
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
* struct rio_dev - RIO device info * @global_list: Node in list of all RIO devices * @net_list: Node in list of RIO devices in a network * @net: Network this device is a part of * @did: Device ID * @vid: Vendor ID * @device_rev: Device revision * @asm_did: Assembly device ID * @asm_vid: Assembly vendor ID * @asm_rev: Assembly revision * @efptr: Extended feature pointer * @pef: Processing element features * @swpinfo: Switch port info * @src_ops: Source operation capabilities * @dst_ops: Destination operation capabilities |
97ef6f744 rapidio: fix new ... |
135 136 137 |
* @comp_tag: RIO component tag * @phys_efptr: RIO device extended features pointer * @em_efptr: RIO Error Management features pointer |
fa78cc517 [PATCH] rapidio: ... |
138 |
* @dma_mask: Mask of bits of RIO address this device implements |
70a50ebd9 [PATCH] RapidIO s... |
139 140 141 |
* @driver: Driver claiming this device * @dev: Device model device * @riores: RIO resources this device owns |
97ef6f744 rapidio: fix new ... |
142 |
* @pwcback: port-write callback function for this device |
a93192a5d rapidio: use comm... |
143 144 |
* @destid: Network destination ID (or associated destid for switch) * @hopcount: Hopcount to this device |
68fe4df5d rapidio: add rela... |
145 |
* @prev: Previous RIO device connected to the current one |
ded057827 rapidio: integrat... |
146 |
* @rswitch: struct rio_switch (if valid for this device) |
70a50ebd9 [PATCH] RapidIO s... |
147 148 149 150 151 152 153 154 155 156 157 158 159 |
*/ struct rio_dev { struct list_head global_list; /* node in list of all RIO devices */ struct list_head net_list; /* node in per net list */ struct rio_net *net; /* RIO net this device resides in */ u16 did; u16 vid; u32 device_rev; u16 asm_did; u16 asm_vid; u16 asm_rev; u16 efptr; u32 pef; |
ae05cbd5a rapidio: use stor... |
160 |
u32 swpinfo; |
70a50ebd9 [PATCH] RapidIO s... |
161 162 |
u32 src_ops; u32 dst_ops; |
e5cabeb3d rapidio: add Port... |
163 164 165 |
u32 comp_tag; u32 phys_efptr; u32 em_efptr; |
fa78cc517 [PATCH] rapidio: ... |
166 |
u64 dma_mask; |
70a50ebd9 [PATCH] RapidIO s... |
167 168 169 |
struct rio_driver *driver; /* RIO driver claiming this device */ struct device dev; /* LDM device structure */ struct resource riores[RIO_MAX_DEV_RESOURCES]; |
e5cabeb3d rapidio: add Port... |
170 |
int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step); |
70a50ebd9 [PATCH] RapidIO s... |
171 |
u16 destid; |
a93192a5d rapidio: use comm... |
172 |
u8 hopcount; |
68fe4df5d rapidio: add rela... |
173 |
struct rio_dev *prev; |
ded057827 rapidio: integrat... |
174 |
struct rio_switch rswitch[0]; /* RIO switch info */ |
70a50ebd9 [PATCH] RapidIO s... |
175 176 177 178 179 |
}; #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list) #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list) #define to_rio_dev(n) container_of(n, struct rio_dev, dev) |
ded057827 rapidio: integrat... |
180 |
#define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0]) |
70a50ebd9 [PATCH] RapidIO s... |
181 182 183 184 185 186 187 188 |
/** * struct rio_msg - RIO message event * @res: Mailbox resource * @mcback: Message event callback */ struct rio_msg { struct resource *res; |
6978bbc09 [PATCH] rapidio: ... |
189 |
void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); |
70a50ebd9 [PATCH] RapidIO s... |
190 191 192 193 194 195 196 |
}; /** * struct rio_dbell - RIO doorbell event * @node: Node in list of doorbell events * @res: Doorbell resource * @dinb: Doorbell event callback |
6978bbc09 [PATCH] rapidio: ... |
197 |
* @dev_id: Device specific pointer to pass on event |
70a50ebd9 [PATCH] RapidIO s... |
198 199 200 201 |
*/ struct rio_dbell { struct list_head node; struct resource *res; |
6978bbc09 [PATCH] rapidio: ... |
202 203 |
void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); void *dev_id; |
70a50ebd9 [PATCH] RapidIO s... |
204 |
}; |
61b269179 [RAPIDIO] Add ser... |
205 206 207 208 |
enum rio_phy_type { RIO_PHY_PARALLEL, RIO_PHY_SERIAL, }; |
70a50ebd9 [PATCH] RapidIO s... |
209 210 211 212 213 214 215 216 217 218 219 220 221 |
/** * struct rio_mport - RIO master port info * @dbells: List of doorbell events * @node: Node in global list of master ports * @nnode: Node in network list of master ports * @iores: I/O mem resource that this master port interface owns * @riores: RIO resources that this master port interfaces owns * @inb_msg: RIO inbound message event descriptors * @outb_msg: RIO outbound message event descriptors * @host_deviceid: Host device ID associated with this master port * @ops: configuration space functions * @id: Port ID, unique among all ports * @index: Port index, unique among all port interfaces of the same type |
9941d945f [RAPIDIO] fix cur... |
222 223 |
* @sys_size: RapidIO common transport system size * @phy_type: RapidIO phy type |
af84ca38a rapidio: add hand... |
224 |
* @phys_efptr: RIO port extended features pointer |
70a50ebd9 [PATCH] RapidIO s... |
225 |
* @name: Port name string |
ad1e9380b [RAPIDIO] Add Rap... |
226 |
* @priv: Master port private data |
70a50ebd9 [PATCH] RapidIO s... |
227 228 229 230 231 232 233 234 235 236 |
*/ struct rio_mport { struct list_head dbells; /* list of doorbell events */ struct list_head node; /* node in global list of ports */ struct list_head nnode; /* node in net list of ports */ struct resource iores; struct resource riores[RIO_MAX_MPORT_RESOURCES]; struct rio_msg inb_msg[RIO_MAX_MBOX]; struct rio_msg outb_msg[RIO_MAX_MBOX]; int host_deviceid; /* Host device ID */ |
f8f062698 rapidio: add arch... |
237 |
struct rio_ops *ops; /* low-level architecture-dependent routines */ |
70a50ebd9 [PATCH] RapidIO s... |
238 239 240 |
unsigned char id; /* port ID, unique among all ports */ unsigned char index; /* port index, unique among all port interfaces of the same type */ |
e04232360 [RAPIDIO] Auto-pr... |
241 242 243 244 |
unsigned int sys_size; /* RapidIO common transport system size. * 0 - Small size. 256 devices. * 1 - Large size, 65536 devices. */ |
61b269179 [RAPIDIO] Add ser... |
245 |
enum rio_phy_type phy_type; /* RapidIO phy type */ |
af84ca38a rapidio: add hand... |
246 |
u32 phys_efptr; |
70a50ebd9 [PATCH] RapidIO s... |
247 |
unsigned char name[40]; |
ad1e9380b [RAPIDIO] Add Rap... |
248 |
void *priv; /* Master port private data */ |
70a50ebd9 [PATCH] RapidIO s... |
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
}; /** * struct rio_net - RIO network info * @node: Node in global list of RIO networks * @devices: List of devices in this network * @mports: List of master ports accessing this network * @hport: Default port for accessing this network * @id: RIO network ID */ struct rio_net { struct list_head node; /* node in list of networks */ struct list_head devices; /* list of devices in this net */ struct list_head mports; /* list of ports accessing net */ struct rio_mport *hport; /* primary port for accessing net */ unsigned char id; /* RIO network ID */ }; |
ac38d7232 rapidio: modify s... |
266 267 268 |
/* Definitions used by switch sysfs initialization callback */ #define RIO_SW_SYSFS_CREATE 1 /* Create switch attributes */ #define RIO_SW_SYSFS_REMOVE 0 /* Remove switch attributes */ |
70a50ebd9 [PATCH] RapidIO s... |
269 270 271 272 273 274 275 276 277 |
/* Low-level architecture-dependent routines */ /** * struct rio_ops - Low-level RIO configuration space operations * @lcread: Callback to perform local (master port) read of config space. * @lcwrite: Callback to perform local (master port) write of config space. * @cread: Callback to perform network read of config space. * @cwrite: Callback to perform network write of config space. * @dsend: Callback to send a doorbell message. |
e5cabeb3d rapidio: add Port... |
278 |
* @pwenable: Callback to enable/disable port-write message handling. |
f8f062698 rapidio: add arch... |
279 280 281 282 283 284 285 |
* @open_outb_mbox: Callback to initialize outbound mailbox. * @close_outb_mbox: Callback to shut down outbound mailbox. * @open_inb_mbox: Callback to initialize inbound mailbox. * @close_inb_mbox: Callback to shut down inbound mailbox. * @add_outb_message: Callback to add a message to an outbound mailbox queue. * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue. * @get_inb_message: Callback to get a message from an inbound mailbox queue. |
70a50ebd9 [PATCH] RapidIO s... |
286 287 |
*/ struct rio_ops { |
ad1e9380b [RAPIDIO] Add Rap... |
288 289 290 291 292 293 294 295 296 |
int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len, u32 *data); int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len, u32 data); int (*cread) (struct rio_mport *mport, int index, u16 destid, u8 hopcount, u32 offset, int len, u32 *data); int (*cwrite) (struct rio_mport *mport, int index, u16 destid, u8 hopcount, u32 offset, int len, u32 data); int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data); |
e5cabeb3d rapidio: add Port... |
297 |
int (*pwenable) (struct rio_mport *mport, int enable); |
f8f062698 rapidio: add arch... |
298 299 300 301 302 303 304 305 306 307 |
int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id, int mbox, int entries); void (*close_outb_mbox)(struct rio_mport *mport, int mbox); int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id, int mbox, int entries); void (*close_inb_mbox)(struct rio_mport *mport, int mbox); int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev, int mbox, void *buffer, size_t len); int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf); void *(*get_inb_message)(struct rio_mport *mport, int mbox); |
70a50ebd9 [PATCH] RapidIO s... |
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
}; #define RIO_RESOURCE_MEM 0x00000100 #define RIO_RESOURCE_DOORBELL 0x00000200 #define RIO_RESOURCE_MAILBOX 0x00000400 #define RIO_RESOURCE_CACHEABLE 0x00010000 #define RIO_RESOURCE_PCI 0x00020000 #define RIO_RESOURCE_BUSY 0x80000000 /** * struct rio_driver - RIO driver info * @node: Node in list of drivers * @name: RIO driver name * @id_table: RIO device ids to be associated with this driver * @probe: RIO device inserted * @remove: RIO device removed * @suspend: RIO device suspended * @resume: RIO device awakened * @enable_wake: RIO device enable wake event * @driver: LDM driver struct * * Provides info on a RIO device driver for insertion/removal and * power management purposes. */ struct rio_driver { struct list_head node; char *name; const struct rio_device_id *id_table; int (*probe) (struct rio_dev * dev, const struct rio_device_id * id); void (*remove) (struct rio_dev * dev); int (*suspend) (struct rio_dev * dev, u32 state); int (*resume) (struct rio_dev * dev); int (*enable_wake) (struct rio_dev * dev, u32 state, int enable); struct device_driver driver; }; #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) /** * struct rio_device_id - RIO device identifier * @did: RIO device ID * @vid: RIO vendor ID * @asm_did: RIO assembly device ID * @asm_vid: RIO assembly vendor ID * * Identifies a RIO device based on both the device/vendor IDs and * the assembly device/vendor IDs. */ struct rio_device_id { u16 did, vid; u16 asm_did, asm_vid; }; /** |
058f88d67 rapidio: modify i... |
364 |
* struct rio_switch_ops - Per-switch operations |
70a50ebd9 [PATCH] RapidIO s... |
365 366 |
* @vid: RIO vendor ID * @did: RIO device ID |
058f88d67 rapidio: modify i... |
367 |
* @init_hook: Callback that performs switch device initialization |
70a50ebd9 [PATCH] RapidIO s... |
368 |
* |
058f88d67 rapidio: modify i... |
369 370 |
* Defines the operations that are necessary to initialize/control * a particular RIO switch device. |
70a50ebd9 [PATCH] RapidIO s... |
371 |
*/ |
058f88d67 rapidio: modify i... |
372 |
struct rio_switch_ops { |
70a50ebd9 [PATCH] RapidIO s... |
373 |
u16 vid, did; |
058f88d67 rapidio: modify i... |
374 |
int (*init_hook) (struct rio_dev *rdev, int do_enum); |
e5cabeb3d rapidio: add Port... |
375 376 377 378 379 380 381 382 383 384 385 386 |
}; union rio_pw_msg { struct { u32 comptag; /* Component Tag CSR */ u32 errdetect; /* Port N Error Detect CSR */ u32 is_port; /* Implementation specific + PortID */ u32 ltlerrdet; /* LTL Error Detect CSR */ u32 padding[12]; } em; u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)]; }; |
70a50ebd9 [PATCH] RapidIO s... |
387 |
/* Architecture and hardware-specific functions */ |
59f999655 RapidIO/mpc85xx: ... |
388 |
extern int rio_register_mport(struct rio_mport *); |
6978bbc09 [PATCH] rapidio: ... |
389 |
extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd9 [PATCH] RapidIO s... |
390 |
extern void rio_close_inb_mbox(struct rio_mport *, int); |
6978bbc09 [PATCH] rapidio: ... |
391 |
extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); |
70a50ebd9 [PATCH] RapidIO s... |
392 |
extern void rio_close_outb_mbox(struct rio_mport *, int); |
70a50ebd9 [PATCH] RapidIO s... |
393 |
#endif /* LINUX_RIO_H */ |