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