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