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