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