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 #include <linux/mod_devicetable.h> 24 #ifdef CONFIG_RAPIDIO_DMA_ENGINE 25 #include <linux/dmaengine.h> 26 #endif 27 28 #define RIO_NO_HOPCOUNT -1 29 #define RIO_INVALID_DESTID 0xffff 30 31 #define RIO_MAX_MPORTS 8 32 #define RIO_MAX_MPORT_RESOURCES 16 33 #define RIO_MAX_DEV_RESOURCES 16 34 #define RIO_MAX_MPORT_NAME 40 35 36 #define RIO_GLOBAL_TABLE 0xff /* Indicates access of a switch's 37 global routing table if it 38 has multiple (or per port) 39 tables */ 40 41 #define RIO_INVALID_ROUTE 0xff /* Indicates that a route table 42 entry is invalid (no route 43 exists for the device ID) */ 44 45 #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8)) 46 #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff) 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 * 2 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 #define RIO_PW_MSG_SIZE 64 74 75 /* 76 * A component tag value (stored in the component tag CSR) is used as device's 77 * unique identifier assigned during enumeration. Besides being used for 78 * identifying switches (which do not have device ID register), it also is used 79 * by error management notification and therefore has to be assigned 80 * to endpoints as well. 81 */ 82 #define RIO_CTAG_RESRVD 0xfffe0000 /* Reserved */ 83 #define RIO_CTAG_UDEVID 0x0001ffff /* Unique device identifier */ 84 85 extern struct bus_type rio_bus_type; 86 extern struct class rio_mport_class; 87 88 struct rio_mport; 89 struct rio_dev; 90 union rio_pw_msg; 91 92 /** 93 * struct rio_switch - RIO switch info 94 * @node: Node in global list of switches 95 * @route_table: Copy of switch routing table 96 * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0 97 * @ops: pointer to switch-specific operations 98 * @lock: lock to serialize operations updates 99 * @nextdev: Array of per-port pointers to the next attached device 100 */ 101 struct rio_switch { 102 struct list_head node; 103 u8 *route_table; 104 u32 port_ok; 105 struct rio_switch_ops *ops; 106 spinlock_t lock; 107 struct rio_dev *nextdev[0]; 108 }; 109 110 /** 111 * struct rio_switch_ops - Per-switch operations 112 * @owner: The module owner of this structure 113 * @add_entry: Callback for switch-specific route add function 114 * @get_entry: Callback for switch-specific route get function 115 * @clr_table: Callback for switch-specific clear route table function 116 * @set_domain: Callback for switch-specific domain setting function 117 * @get_domain: Callback for switch-specific domain get function 118 * @em_init: Callback for switch-specific error management init function 119 * @em_handle: Callback for switch-specific error management handler function 120 * 121 * Defines the operations that are necessary to initialize/control 122 * a particular RIO switch device. 123 */ 124 struct rio_switch_ops { 125 struct module *owner; 126 int (*add_entry) (struct rio_mport *mport, u16 destid, u8 hopcount, 127 u16 table, u16 route_destid, u8 route_port); 128 int (*get_entry) (struct rio_mport *mport, u16 destid, u8 hopcount, 129 u16 table, u16 route_destid, u8 *route_port); 130 int (*clr_table) (struct rio_mport *mport, u16 destid, u8 hopcount, 131 u16 table); 132 int (*set_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, 133 u8 sw_domain); 134 int (*get_domain) (struct rio_mport *mport, u16 destid, u8 hopcount, 135 u8 *sw_domain); 136 int (*em_init) (struct rio_dev *dev); 137 int (*em_handle) (struct rio_dev *dev, u8 swport); 138 }; 139 140 enum rio_device_state { 141 RIO_DEVICE_INITIALIZING, 142 RIO_DEVICE_RUNNING, 143 RIO_DEVICE_GONE, 144 RIO_DEVICE_SHUTDOWN, 145 }; 146 147 /** 148 * struct rio_dev - RIO device info 149 * @global_list: Node in list of all RIO devices 150 * @net_list: Node in list of RIO devices in a network 151 * @net: Network this device is a part of 152 * @do_enum: Enumeration flag 153 * @did: Device ID 154 * @vid: Vendor ID 155 * @device_rev: Device revision 156 * @asm_did: Assembly device ID 157 * @asm_vid: Assembly vendor ID 158 * @asm_rev: Assembly revision 159 * @efptr: Extended feature pointer 160 * @pef: Processing element features 161 * @swpinfo: Switch port info 162 * @src_ops: Source operation capabilities 163 * @dst_ops: Destination operation capabilities 164 * @comp_tag: RIO component tag 165 * @phys_efptr: RIO device extended features pointer 166 * @em_efptr: RIO Error Management features pointer 167 * @dma_mask: Mask of bits of RIO address this device implements 168 * @driver: Driver claiming this device 169 * @dev: Device model device 170 * @riores: RIO resources this device owns 171 * @pwcback: port-write callback function for this device 172 * @destid: Network destination ID (or associated destid for switch) 173 * @hopcount: Hopcount to this device 174 * @prev: Previous RIO device connected to the current one 175 * @state: device state 176 * @rswitch: struct rio_switch (if valid for this device) 177 */ 178 struct rio_dev { 179 struct list_head global_list; /* node in list of all RIO devices */ 180 struct list_head net_list; /* node in per net list */ 181 struct rio_net *net; /* RIO net this device resides in */ 182 bool do_enum; 183 u16 did; 184 u16 vid; 185 u32 device_rev; 186 u16 asm_did; 187 u16 asm_vid; 188 u16 asm_rev; 189 u16 efptr; 190 u32 pef; 191 u32 swpinfo; 192 u32 src_ops; 193 u32 dst_ops; 194 u32 comp_tag; 195 u32 phys_efptr; 196 u32 em_efptr; 197 u64 dma_mask; 198 struct rio_driver *driver; /* RIO driver claiming this device */ 199 struct device dev; /* LDM device structure */ 200 struct resource riores[RIO_MAX_DEV_RESOURCES]; 201 int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step); 202 u16 destid; 203 u8 hopcount; 204 struct rio_dev *prev; 205 atomic_t state; 206 struct rio_switch rswitch[0]; /* RIO switch info */ 207 }; 208 209 #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list) 210 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list) 211 #define to_rio_dev(n) container_of(n, struct rio_dev, dev) 212 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0]) 213 #define to_rio_mport(n) container_of(n, struct rio_mport, dev) 214 #define to_rio_net(n) container_of(n, struct rio_net, dev) 215 216 /** 217 * struct rio_msg - RIO message event 218 * @res: Mailbox resource 219 * @mcback: Message event callback 220 */ 221 struct rio_msg { 222 struct resource *res; 223 void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); 224 }; 225 226 /** 227 * struct rio_dbell - RIO doorbell event 228 * @node: Node in list of doorbell events 229 * @res: Doorbell resource 230 * @dinb: Doorbell event callback 231 * @dev_id: Device specific pointer to pass on event 232 */ 233 struct rio_dbell { 234 struct list_head node; 235 struct resource *res; 236 void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); 237 void *dev_id; 238 }; 239 240 enum rio_phy_type { 241 RIO_PHY_PARALLEL, 242 RIO_PHY_SERIAL, 243 }; 244 245 /** 246 * struct rio_mport - RIO master port info 247 * @dbells: List of doorbell events 248 * @node: Node in global list of master ports 249 * @nnode: Node in network list of master ports 250 * @net: RIO net this mport is attached to 251 * @lock: lock to synchronize lists manipulations 252 * @iores: I/O mem resource that this master port interface owns 253 * @riores: RIO resources that this master port interfaces owns 254 * @inb_msg: RIO inbound message event descriptors 255 * @outb_msg: RIO outbound message event descriptors 256 * @host_deviceid: Host device ID associated with this master port 257 * @ops: configuration space functions 258 * @id: Port ID, unique among all ports 259 * @index: Port index, unique among all port interfaces of the same type 260 * @sys_size: RapidIO common transport system size 261 * @phy_type: RapidIO phy type 262 * @phys_efptr: RIO port extended features pointer 263 * @name: Port name string 264 * @dev: device structure associated with an mport 265 * @priv: Master port private data 266 * @dma: DMA device associated with mport 267 * @nscan: RapidIO network enumeration/discovery operations 268 * @state: mport device state 269 * @pwe_refcnt: port-write enable ref counter to track enable/disable requests 270 */ 271 struct rio_mport { 272 struct list_head dbells; /* list of doorbell events */ 273 struct list_head node; /* node in global list of ports */ 274 struct list_head nnode; /* node in net list of ports */ 275 struct rio_net *net; /* RIO net this mport is attached to */ 276 struct mutex lock; 277 struct resource iores; 278 struct resource riores[RIO_MAX_MPORT_RESOURCES]; 279 struct rio_msg inb_msg[RIO_MAX_MBOX]; 280 struct rio_msg outb_msg[RIO_MAX_MBOX]; 281 int host_deviceid; /* Host device ID */ 282 struct rio_ops *ops; /* low-level architecture-dependent routines */ 283 unsigned char id; /* port ID, unique among all ports */ 284 unsigned char index; /* port index, unique among all port 285 interfaces of the same type */ 286 unsigned int sys_size; /* RapidIO common transport system size. 287 * 0 - Small size. 256 devices. 288 * 1 - Large size, 65536 devices. 289 */ 290 enum rio_phy_type phy_type; /* RapidIO phy type */ 291 u32 phys_efptr; 292 unsigned char name[RIO_MAX_MPORT_NAME]; 293 struct device dev; 294 void *priv; /* Master port private data */ 295 #ifdef CONFIG_RAPIDIO_DMA_ENGINE 296 struct dma_device dma; 297 #endif 298 struct rio_scan *nscan; 299 atomic_t state; 300 unsigned int pwe_refcnt; 301 }; 302 303 static inline int rio_mport_is_running(struct rio_mport *mport) 304 { 305 return atomic_read(&mport->state) == RIO_DEVICE_RUNNING; 306 } 307 308 /* 309 * Enumeration/discovery control flags 310 */ 311 #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */ 312 313 /** 314 * struct rio_net - RIO network info 315 * @node: Node in global list of RIO networks 316 * @devices: List of devices in this network 317 * @switches: List of switches in this network 318 * @mports: List of master ports accessing this network 319 * @hport: Default port for accessing this network 320 * @id: RIO network ID 321 * @dev: Device object 322 * @enum_data: private data specific to a network enumerator 323 * @release: enumerator-specific release callback 324 */ 325 struct rio_net { 326 struct list_head node; /* node in list of networks */ 327 struct list_head devices; /* list of devices in this net */ 328 struct list_head switches; /* list of switches in this net */ 329 struct list_head mports; /* list of ports accessing net */ 330 struct rio_mport *hport; /* primary port for accessing net */ 331 unsigned char id; /* RIO network ID */ 332 struct device dev; 333 void *enum_data; /* private data for enumerator of the network */ 334 void (*release)(struct rio_net *net); 335 }; 336 337 enum rio_link_speed { 338 RIO_LINK_DOWN = 0, /* SRIO Link not initialized */ 339 RIO_LINK_125 = 1, /* 1.25 GBaud */ 340 RIO_LINK_250 = 2, /* 2.5 GBaud */ 341 RIO_LINK_312 = 3, /* 3.125 GBaud */ 342 RIO_LINK_500 = 4, /* 5.0 GBaud */ 343 RIO_LINK_625 = 5 /* 6.25 GBaud */ 344 }; 345 346 enum rio_link_width { 347 RIO_LINK_1X = 0, 348 RIO_LINK_1XR = 1, 349 RIO_LINK_2X = 3, 350 RIO_LINK_4X = 2, 351 RIO_LINK_8X = 4, 352 RIO_LINK_16X = 5 353 }; 354 355 enum rio_mport_flags { 356 RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */ 357 RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */ 358 RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */ 359 }; 360 361 /** 362 * struct rio_mport_attr - RIO mport device attributes 363 * @flags: mport device capability flags 364 * @link_speed: SRIO link speed value (as defined by RapidIO specification) 365 * @link_width: SRIO link width value (as defined by RapidIO specification) 366 * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s) 367 * @dma_max_size: max number of bytes in single DMA transfer (SG entry) 368 * @dma_align: alignment shift for DMA operations (as for other DMA operations) 369 */ 370 struct rio_mport_attr { 371 int flags; 372 int link_speed; 373 int link_width; 374 375 /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */ 376 int dma_max_sge; 377 int dma_max_size; 378 int dma_align; 379 }; 380 381 /* Low-level architecture-dependent routines */ 382 383 /** 384 * struct rio_ops - Low-level RIO configuration space operations 385 * @lcread: Callback to perform local (master port) read of config space. 386 * @lcwrite: Callback to perform local (master port) write of config space. 387 * @cread: Callback to perform network read of config space. 388 * @cwrite: Callback to perform network write of config space. 389 * @dsend: Callback to send a doorbell message. 390 * @pwenable: Callback to enable/disable port-write message handling. 391 * @open_outb_mbox: Callback to initialize outbound mailbox. 392 * @close_outb_mbox: Callback to shut down outbound mailbox. 393 * @open_inb_mbox: Callback to initialize inbound mailbox. 394 * @close_inb_mbox: Callback to shut down inbound mailbox. 395 * @add_outb_message: Callback to add a message to an outbound mailbox queue. 396 * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue. 397 * @get_inb_message: Callback to get a message from an inbound mailbox queue. 398 * @map_inb: Callback to map RapidIO address region into local memory space. 399 * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb(). 400 * @query_mport: Callback to query mport device attributes. 401 */ 402 struct rio_ops { 403 int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len, 404 u32 *data); 405 int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len, 406 u32 data); 407 int (*cread) (struct rio_mport *mport, int index, u16 destid, 408 u8 hopcount, u32 offset, int len, u32 *data); 409 int (*cwrite) (struct rio_mport *mport, int index, u16 destid, 410 u8 hopcount, u32 offset, int len, u32 data); 411 int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data); 412 int (*pwenable) (struct rio_mport *mport, int enable); 413 int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id, 414 int mbox, int entries); 415 void (*close_outb_mbox)(struct rio_mport *mport, int mbox); 416 int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id, 417 int mbox, int entries); 418 void (*close_inb_mbox)(struct rio_mport *mport, int mbox); 419 int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev, 420 int mbox, void *buffer, size_t len); 421 int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf); 422 void *(*get_inb_message)(struct rio_mport *mport, int mbox); 423 int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart, 424 u64 rstart, u32 size, u32 flags); 425 void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart); 426 int (*query_mport)(struct rio_mport *mport, 427 struct rio_mport_attr *attr); 428 }; 429 430 #define RIO_RESOURCE_MEM 0x00000100 431 #define RIO_RESOURCE_DOORBELL 0x00000200 432 #define RIO_RESOURCE_MAILBOX 0x00000400 433 434 #define RIO_RESOURCE_CACHEABLE 0x00010000 435 #define RIO_RESOURCE_PCI 0x00020000 436 437 #define RIO_RESOURCE_BUSY 0x80000000 438 439 /** 440 * struct rio_driver - RIO driver info 441 * @node: Node in list of drivers 442 * @name: RIO driver name 443 * @id_table: RIO device ids to be associated with this driver 444 * @probe: RIO device inserted 445 * @remove: RIO device removed 446 * @shutdown: shutdown notification callback 447 * @suspend: RIO device suspended 448 * @resume: RIO device awakened 449 * @enable_wake: RIO device enable wake event 450 * @driver: LDM driver struct 451 * 452 * Provides info on a RIO device driver for insertion/removal and 453 * power management purposes. 454 */ 455 struct rio_driver { 456 struct list_head node; 457 char *name; 458 const struct rio_device_id *id_table; 459 int (*probe) (struct rio_dev * dev, const struct rio_device_id * id); 460 void (*remove) (struct rio_dev * dev); 461 void (*shutdown)(struct rio_dev *dev); 462 int (*suspend) (struct rio_dev * dev, u32 state); 463 int (*resume) (struct rio_dev * dev); 464 int (*enable_wake) (struct rio_dev * dev, u32 state, int enable); 465 struct device_driver driver; 466 }; 467 468 #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) 469 470 union rio_pw_msg { 471 struct { 472 u32 comptag; /* Component Tag CSR */ 473 u32 errdetect; /* Port N Error Detect CSR */ 474 u32 is_port; /* Implementation specific + PortID */ 475 u32 ltlerrdet; /* LTL Error Detect CSR */ 476 u32 padding[12]; 477 } em; 478 u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)]; 479 }; 480 481 #ifdef CONFIG_RAPIDIO_DMA_ENGINE 482 483 /* 484 * enum rio_write_type - RIO write transaction types used in DMA transfers 485 * 486 * Note: RapidIO specification defines write (NWRITE) and 487 * write-with-response (NWRITE_R) data transfer operations. 488 * Existing DMA controllers that service RapidIO may use one of these operations 489 * for entire data transfer or their combination with only the last data packet 490 * requires response. 491 */ 492 enum rio_write_type { 493 RDW_DEFAULT, /* default method used by DMA driver */ 494 RDW_ALL_NWRITE, /* all packets use NWRITE */ 495 RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */ 496 RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */ 497 }; 498 499 struct rio_dma_ext { 500 u16 destid; 501 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ 502 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ 503 enum rio_write_type wr_type; /* preferred RIO write operation type */ 504 }; 505 506 struct rio_dma_data { 507 /* Local data (as scatterlist) */ 508 struct scatterlist *sg; /* I/O scatter list */ 509 unsigned int sg_len; /* size of scatter list */ 510 /* Remote device address (flat buffer) */ 511 u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ 512 u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ 513 enum rio_write_type wr_type; /* preferred RIO write operation type */ 514 }; 515 516 static inline struct rio_mport *dma_to_mport(struct dma_device *ddev) 517 { 518 return container_of(ddev, struct rio_mport, dma); 519 } 520 #endif /* CONFIG_RAPIDIO_DMA_ENGINE */ 521 522 /** 523 * struct rio_scan - RIO enumeration and discovery operations 524 * @owner: The module owner of this structure 525 * @enumerate: Callback to perform RapidIO fabric enumeration. 526 * @discover: Callback to perform RapidIO fabric discovery. 527 */ 528 struct rio_scan { 529 struct module *owner; 530 int (*enumerate)(struct rio_mport *mport, u32 flags); 531 int (*discover)(struct rio_mport *mport, u32 flags); 532 }; 533 534 /** 535 * struct rio_scan_node - list node to register RapidIO enumeration and 536 * discovery methods with RapidIO core. 537 * @mport_id: ID of an mport (net) serviced by this enumerator 538 * @node: node in global list of registered enumerators 539 * @ops: RIO enumeration and discovery operations 540 */ 541 struct rio_scan_node { 542 int mport_id; 543 struct list_head node; 544 struct rio_scan *ops; 545 }; 546 547 /* Architecture and hardware-specific functions */ 548 extern int rio_mport_initialize(struct rio_mport *); 549 extern int rio_register_mport(struct rio_mport *); 550 extern int rio_unregister_mport(struct rio_mport *); 551 extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); 552 extern void rio_close_inb_mbox(struct rio_mport *, int); 553 extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); 554 extern void rio_close_outb_mbox(struct rio_mport *, int); 555 extern int rio_query_mport(struct rio_mport *port, 556 struct rio_mport_attr *mport_attr); 557 558 #endif /* LINUX_RIO_H */ 559