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 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 17 | #include <linux/types.h> |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 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> |
Alexandre Bounine | 3bdbb62 | 2013-07-03 15:08:58 -0700 | [diff] [blame] | 23 | #include <linux/mod_devicetable.h> |
Alexandre Bounine | e42d98e | 2012-05-31 16:26:38 -0700 | [diff] [blame] | 24 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| 25 | #include <linux/dmaengine.h> |
| 26 | #endif |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 27 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 28 | #define RIO_NO_HOPCOUNT -1 |
Alexandre Bounine | c70555b | 2007-02-10 01:46:47 -0800 | [diff] [blame] | 29 | #define RIO_INVALID_DESTID 0xffff |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 30 | |
Alexandre Bounine | 569fccb | 2011-03-23 16:43:05 -0700 | [diff] [blame] | 31 | #define RIO_MAX_MPORTS 8 |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 32 | #define RIO_MAX_MPORT_RESOURCES 16 |
| 33 | #define RIO_MAX_DEV_RESOURCES 16 |
Alexandre Bounine | ed43f44 | 2012-10-04 17:15:51 -0700 | [diff] [blame] | 34 | #define RIO_MAX_MPORT_NAME 40 |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 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 | |
Zhang Wei | e042323 | 2008-04-18 13:33:42 -0700 | [diff] [blame] | 45 | #define RIO_MAX_ROUTE_ENTRIES(size) (size ? (1 << 16) : (1 << 8)) |
| 46 | #define RIO_ANY_DESTID(size) (size ? 0xffff : 0xff) |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 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 |
Chad Reese | fdb8d56 | 2012-10-10 15:54:05 -0700 | [diff] [blame] | 67 | * 2 RapidIO outbound mailboxes |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 68 | */ |
| 69 | #define RIO_DOORBELL_RESOURCE 0 |
| 70 | #define RIO_INB_MBOX_RESOURCE 1 |
| 71 | #define RIO_OUTB_MBOX_RESOURCE 2 |
| 72 | |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 73 | #define RIO_PW_MSG_SIZE 64 |
| 74 | |
Alexandre Bounine | e653692 | 2011-01-12 17:00:40 -0800 | [diff] [blame] | 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 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 85 | extern struct bus_type rio_bus_type; |
Alexandre Bounine | 2aaf308 | 2014-04-07 15:38:56 -0700 | [diff] [blame] | 86 | extern struct class rio_mport_class; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 87 | |
| 88 | struct rio_mport; |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 89 | struct rio_dev; |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 90 | union rio_pw_msg; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 91 | |
| 92 | /** |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 93 | * struct rio_switch - RIO switch info |
| 94 | * @node: Node in global list of switches |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 95 | * @route_table: Copy of switch routing table |
| 96 | * @port_ok: Status of each port (one bit per port) - OK=1 or UNINIT=0 |
Alexandre Bounine | 2ec3ba6 | 2013-07-03 15:08:50 -0700 | [diff] [blame] | 97 | * @ops: pointer to switch-specific operations |
| 98 | * @lock: lock to serialize operations updates |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 99 | * @nextdev: Array of per-port pointers to the next attached device |
| 100 | */ |
| 101 | struct rio_switch { |
| 102 | struct list_head node; |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 103 | u8 *route_table; |
| 104 | u32 port_ok; |
Alexandre Bounine | 2ec3ba6 | 2013-07-03 15:08:50 -0700 | [diff] [blame] | 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; |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 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); |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 138 | }; |
| 139 | |
| 140 | /** |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 141 | * struct rio_dev - RIO device info |
| 142 | * @global_list: Node in list of all RIO devices |
| 143 | * @net_list: Node in list of RIO devices in a network |
| 144 | * @net: Network this device is a part of |
Alexandre Bounine | 2ec3ba6 | 2013-07-03 15:08:50 -0700 | [diff] [blame] | 145 | * @do_enum: Enumeration flag |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 146 | * @did: Device ID |
| 147 | * @vid: Vendor ID |
| 148 | * @device_rev: Device revision |
| 149 | * @asm_did: Assembly device ID |
| 150 | * @asm_vid: Assembly vendor ID |
| 151 | * @asm_rev: Assembly revision |
| 152 | * @efptr: Extended feature pointer |
| 153 | * @pef: Processing element features |
| 154 | * @swpinfo: Switch port info |
| 155 | * @src_ops: Source operation capabilities |
| 156 | * @dst_ops: Destination operation capabilities |
Randy Dunlap | 97ef6f7 | 2010-05-28 15:08:08 -0700 | [diff] [blame] | 157 | * @comp_tag: RIO component tag |
| 158 | * @phys_efptr: RIO device extended features pointer |
| 159 | * @em_efptr: RIO Error Management features pointer |
Matt Porter | fa78cc5 | 2005-11-07 01:00:18 -0800 | [diff] [blame] | 160 | * @dma_mask: Mask of bits of RIO address this device implements |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 161 | * @driver: Driver claiming this device |
| 162 | * @dev: Device model device |
| 163 | * @riores: RIO resources this device owns |
Randy Dunlap | 97ef6f7 | 2010-05-28 15:08:08 -0700 | [diff] [blame] | 164 | * @pwcback: port-write callback function for this device |
Alexandre Bounine | a93192a | 2011-01-12 17:00:38 -0800 | [diff] [blame] | 165 | * @destid: Network destination ID (or associated destid for switch) |
| 166 | * @hopcount: Hopcount to this device |
Alexandre Bounine | 68fe4df | 2010-10-27 15:34:29 -0700 | [diff] [blame] | 167 | * @prev: Previous RIO device connected to the current one |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 168 | * @rswitch: struct rio_switch (if valid for this device) |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 169 | */ |
| 170 | struct rio_dev { |
| 171 | struct list_head global_list; /* node in list of all RIO devices */ |
| 172 | struct list_head net_list; /* node in per net list */ |
| 173 | struct rio_net *net; /* RIO net this device resides in */ |
Alexandre Bounine | 2ec3ba6 | 2013-07-03 15:08:50 -0700 | [diff] [blame] | 174 | bool do_enum; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 175 | u16 did; |
| 176 | u16 vid; |
| 177 | u32 device_rev; |
| 178 | u16 asm_did; |
| 179 | u16 asm_vid; |
| 180 | u16 asm_rev; |
| 181 | u16 efptr; |
| 182 | u32 pef; |
Alexandre Bounine | ae05cbd | 2010-10-27 15:34:29 -0700 | [diff] [blame] | 183 | u32 swpinfo; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 184 | u32 src_ops; |
| 185 | u32 dst_ops; |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 186 | u32 comp_tag; |
| 187 | u32 phys_efptr; |
| 188 | u32 em_efptr; |
Matt Porter | fa78cc5 | 2005-11-07 01:00:18 -0800 | [diff] [blame] | 189 | u64 dma_mask; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 190 | struct rio_driver *driver; /* RIO driver claiming this device */ |
| 191 | struct device dev; /* LDM device structure */ |
| 192 | struct resource riores[RIO_MAX_DEV_RESOURCES]; |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 193 | int (*pwcback) (struct rio_dev *rdev, union rio_pw_msg *msg, int step); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 194 | u16 destid; |
Alexandre Bounine | a93192a | 2011-01-12 17:00:38 -0800 | [diff] [blame] | 195 | u8 hopcount; |
Alexandre Bounine | 68fe4df | 2010-10-27 15:34:29 -0700 | [diff] [blame] | 196 | struct rio_dev *prev; |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 197 | struct rio_switch rswitch[0]; /* RIO switch info */ |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 198 | }; |
| 199 | |
| 200 | #define rio_dev_g(n) list_entry(n, struct rio_dev, global_list) |
| 201 | #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list) |
| 202 | #define to_rio_dev(n) container_of(n, struct rio_dev, dev) |
Alexandre Bounine | ded0578 | 2011-01-12 17:00:39 -0800 | [diff] [blame] | 203 | #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0]) |
Alexandre Bounine | 2aaf308 | 2014-04-07 15:38:56 -0700 | [diff] [blame] | 204 | #define to_rio_mport(n) container_of(n, struct rio_mport, dev) |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 205 | |
| 206 | /** |
| 207 | * struct rio_msg - RIO message event |
| 208 | * @res: Mailbox resource |
| 209 | * @mcback: Message event callback |
| 210 | */ |
| 211 | struct rio_msg { |
| 212 | struct resource *res; |
Matt Porter | 6978bbc | 2005-11-07 01:00:20 -0800 | [diff] [blame] | 213 | void (*mcback) (struct rio_mport * mport, void *dev_id, int mbox, int slot); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 214 | }; |
| 215 | |
| 216 | /** |
| 217 | * struct rio_dbell - RIO doorbell event |
| 218 | * @node: Node in list of doorbell events |
| 219 | * @res: Doorbell resource |
| 220 | * @dinb: Doorbell event callback |
Matt Porter | 6978bbc | 2005-11-07 01:00:20 -0800 | [diff] [blame] | 221 | * @dev_id: Device specific pointer to pass on event |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 222 | */ |
| 223 | struct rio_dbell { |
| 224 | struct list_head node; |
| 225 | struct resource *res; |
Matt Porter | 6978bbc | 2005-11-07 01:00:20 -0800 | [diff] [blame] | 226 | void (*dinb) (struct rio_mport *mport, void *dev_id, u16 src, u16 dst, u16 info); |
| 227 | void *dev_id; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 228 | }; |
| 229 | |
Zhang Wei | 61b2691 | 2008-04-18 13:33:44 -0700 | [diff] [blame] | 230 | enum rio_phy_type { |
| 231 | RIO_PHY_PARALLEL, |
| 232 | RIO_PHY_SERIAL, |
| 233 | }; |
| 234 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 235 | /** |
| 236 | * struct rio_mport - RIO master port info |
| 237 | * @dbells: List of doorbell events |
| 238 | * @node: Node in global list of master ports |
| 239 | * @nnode: Node in network list of master ports |
| 240 | * @iores: I/O mem resource that this master port interface owns |
| 241 | * @riores: RIO resources that this master port interfaces owns |
| 242 | * @inb_msg: RIO inbound message event descriptors |
| 243 | * @outb_msg: RIO outbound message event descriptors |
| 244 | * @host_deviceid: Host device ID associated with this master port |
| 245 | * @ops: configuration space functions |
| 246 | * @id: Port ID, unique among all ports |
| 247 | * @index: Port index, unique among all port interfaces of the same type |
Randy Dunlap | 9941d94 | 2008-04-30 16:45:58 -0700 | [diff] [blame] | 248 | * @sys_size: RapidIO common transport system size |
| 249 | * @phy_type: RapidIO phy type |
Alexandre Bounine | af84ca3 | 2010-10-27 15:34:34 -0700 | [diff] [blame] | 250 | * @phys_efptr: RIO port extended features pointer |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 251 | * @name: Port name string |
Alexandre Bounine | 2aaf308 | 2014-04-07 15:38:56 -0700 | [diff] [blame] | 252 | * @dev: device structure associated with an mport |
Zhang Wei | ad1e938 | 2008-04-18 13:33:41 -0700 | [diff] [blame] | 253 | * @priv: Master port private data |
Alexandre Bounine | fe50c92 | 2012-10-04 17:15:52 -0700 | [diff] [blame] | 254 | * @dma: DMA device associated with mport |
Alexandre Bounine | a11650e | 2013-05-24 15:55:05 -0700 | [diff] [blame] | 255 | * @nscan: RapidIO network enumeration/discovery operations |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 256 | */ |
| 257 | struct rio_mport { |
| 258 | struct list_head dbells; /* list of doorbell events */ |
| 259 | struct list_head node; /* node in global list of ports */ |
| 260 | struct list_head nnode; /* node in net list of ports */ |
| 261 | struct resource iores; |
| 262 | struct resource riores[RIO_MAX_MPORT_RESOURCES]; |
| 263 | struct rio_msg inb_msg[RIO_MAX_MBOX]; |
| 264 | struct rio_msg outb_msg[RIO_MAX_MBOX]; |
| 265 | int host_deviceid; /* Host device ID */ |
Alexandre Bounine | f8f0626 | 2011-03-23 16:43:02 -0700 | [diff] [blame] | 266 | struct rio_ops *ops; /* low-level architecture-dependent routines */ |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 267 | unsigned char id; /* port ID, unique among all ports */ |
| 268 | unsigned char index; /* port index, unique among all port |
| 269 | interfaces of the same type */ |
Zhang Wei | e042323 | 2008-04-18 13:33:42 -0700 | [diff] [blame] | 270 | unsigned int sys_size; /* RapidIO common transport system size. |
| 271 | * 0 - Small size. 256 devices. |
| 272 | * 1 - Large size, 65536 devices. |
| 273 | */ |
Zhang Wei | 61b2691 | 2008-04-18 13:33:44 -0700 | [diff] [blame] | 274 | enum rio_phy_type phy_type; /* RapidIO phy type */ |
Alexandre Bounine | af84ca3 | 2010-10-27 15:34:34 -0700 | [diff] [blame] | 275 | u32 phys_efptr; |
Alexandre Bounine | ed43f44 | 2012-10-04 17:15:51 -0700 | [diff] [blame] | 276 | unsigned char name[RIO_MAX_MPORT_NAME]; |
Alexandre Bounine | 2aaf308 | 2014-04-07 15:38:56 -0700 | [diff] [blame] | 277 | struct device dev; |
Zhang Wei | ad1e938 | 2008-04-18 13:33:41 -0700 | [diff] [blame] | 278 | void *priv; /* Master port private data */ |
Alexandre Bounine | e42d98e | 2012-05-31 16:26:38 -0700 | [diff] [blame] | 279 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| 280 | struct dma_device dma; |
| 281 | #endif |
Alexandre Bounine | a11650e | 2013-05-24 15:55:05 -0700 | [diff] [blame] | 282 | struct rio_scan *nscan; |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 283 | }; |
| 284 | |
Alexandre Bounine | bc8fcfe | 2013-05-24 15:55:06 -0700 | [diff] [blame] | 285 | /* |
| 286 | * Enumeration/discovery control flags |
| 287 | */ |
| 288 | #define RIO_SCAN_ENUM_NO_WAIT 0x00000001 /* Do not wait for enum completed */ |
| 289 | |
Alexandre Bounine | de74e00 | 2012-10-04 17:16:13 -0700 | [diff] [blame] | 290 | struct rio_id_table { |
| 291 | u16 start; /* logical minimal id */ |
Alexandre Bounine | de74e00 | 2012-10-04 17:16:13 -0700 | [diff] [blame] | 292 | u32 max; /* max number of IDs in table */ |
| 293 | spinlock_t lock; |
| 294 | unsigned long *table; |
| 295 | }; |
| 296 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 297 | /** |
| 298 | * struct rio_net - RIO network info |
| 299 | * @node: Node in global list of RIO networks |
| 300 | * @devices: List of devices in this network |
Masanari Iida | 7667928 | 2015-05-08 00:02:27 +0900 | [diff] [blame] | 301 | * @switches: List of switches in this network |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 302 | * @mports: List of master ports accessing this network |
| 303 | * @hport: Default port for accessing this network |
| 304 | * @id: RIO network ID |
Randy Dunlap | 2ca3cb5 | 2012-11-16 14:14:56 -0800 | [diff] [blame] | 305 | * @destid_table: destID allocation table |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 306 | */ |
| 307 | struct rio_net { |
| 308 | struct list_head node; /* node in list of networks */ |
| 309 | struct list_head devices; /* list of devices in this net */ |
Alexandre Bounine | a7071ef | 2012-10-04 17:16:05 -0700 | [diff] [blame] | 310 | struct list_head switches; /* list of switches in this net */ |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 311 | struct list_head mports; /* list of ports accessing net */ |
| 312 | struct rio_mport *hport; /* primary port for accessing net */ |
| 313 | unsigned char id; /* RIO network ID */ |
Alexandre Bounine | de74e00 | 2012-10-04 17:16:13 -0700 | [diff] [blame] | 314 | struct rio_id_table destid_table; /* destID allocation table */ |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 315 | }; |
| 316 | |
Alexandre Bounine | 8b189fd | 2016-03-22 14:26:00 -0700 | [diff] [blame] | 317 | enum rio_link_speed { |
| 318 | RIO_LINK_DOWN = 0, /* SRIO Link not initialized */ |
| 319 | RIO_LINK_125 = 1, /* 1.25 GBaud */ |
| 320 | RIO_LINK_250 = 2, /* 2.5 GBaud */ |
| 321 | RIO_LINK_312 = 3, /* 3.125 GBaud */ |
| 322 | RIO_LINK_500 = 4, /* 5.0 GBaud */ |
| 323 | RIO_LINK_625 = 5 /* 6.25 GBaud */ |
| 324 | }; |
| 325 | |
| 326 | enum rio_link_width { |
| 327 | RIO_LINK_1X = 0, |
| 328 | RIO_LINK_1XR = 1, |
| 329 | RIO_LINK_2X = 3, |
| 330 | RIO_LINK_4X = 2, |
| 331 | RIO_LINK_8X = 4, |
| 332 | RIO_LINK_16X = 5 |
| 333 | }; |
| 334 | |
| 335 | enum rio_mport_flags { |
| 336 | RIO_MPORT_DMA = (1 << 0), /* supports DMA data transfers */ |
| 337 | RIO_MPORT_DMA_SG = (1 << 1), /* DMA supports HW SG mode */ |
| 338 | RIO_MPORT_IBSG = (1 << 2), /* inbound mapping supports SG */ |
| 339 | }; |
| 340 | |
| 341 | /** |
| 342 | * struct rio_mport_attr - RIO mport device attributes |
| 343 | * @flags: mport device capability flags |
| 344 | * @link_speed: SRIO link speed value (as defined by RapidIO specification) |
| 345 | * @link_width: SRIO link width value (as defined by RapidIO specification) |
| 346 | * @dma_max_sge: number of SG list entries that can be handled by DMA channel(s) |
| 347 | * @dma_max_size: max number of bytes in single DMA transfer (SG entry) |
| 348 | * @dma_align: alignment shift for DMA operations (as for other DMA operations) |
| 349 | */ |
| 350 | struct rio_mport_attr { |
| 351 | int flags; |
| 352 | int link_speed; |
| 353 | int link_width; |
| 354 | |
| 355 | /* DMA capability info: valid only if RIO_MPORT_DMA flag is set */ |
| 356 | int dma_max_sge; |
| 357 | int dma_max_size; |
| 358 | int dma_align; |
| 359 | }; |
| 360 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 361 | /* Low-level architecture-dependent routines */ |
| 362 | |
| 363 | /** |
| 364 | * struct rio_ops - Low-level RIO configuration space operations |
| 365 | * @lcread: Callback to perform local (master port) read of config space. |
| 366 | * @lcwrite: Callback to perform local (master port) write of config space. |
| 367 | * @cread: Callback to perform network read of config space. |
| 368 | * @cwrite: Callback to perform network write of config space. |
| 369 | * @dsend: Callback to send a doorbell message. |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 370 | * @pwenable: Callback to enable/disable port-write message handling. |
Alexandre Bounine | f8f0626 | 2011-03-23 16:43:02 -0700 | [diff] [blame] | 371 | * @open_outb_mbox: Callback to initialize outbound mailbox. |
| 372 | * @close_outb_mbox: Callback to shut down outbound mailbox. |
| 373 | * @open_inb_mbox: Callback to initialize inbound mailbox. |
| 374 | * @close_inb_mbox: Callback to shut down inbound mailbox. |
| 375 | * @add_outb_message: Callback to add a message to an outbound mailbox queue. |
| 376 | * @add_inb_buffer: Callback to add a buffer to an inbound mailbox queue. |
| 377 | * @get_inb_message: Callback to get a message from an inbound mailbox queue. |
Alexandre Bounine | da1589f | 2012-10-04 17:15:57 -0700 | [diff] [blame] | 378 | * @map_inb: Callback to map RapidIO address region into local memory space. |
| 379 | * @unmap_inb: Callback to unmap RapidIO address region mapped with map_inb(). |
Alexandre Bounine | 8b189fd | 2016-03-22 14:26:00 -0700 | [diff] [blame] | 380 | * @query_mport: Callback to query mport device attributes. |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 381 | */ |
| 382 | struct rio_ops { |
Zhang Wei | ad1e938 | 2008-04-18 13:33:41 -0700 | [diff] [blame] | 383 | int (*lcread) (struct rio_mport *mport, int index, u32 offset, int len, |
| 384 | u32 *data); |
| 385 | int (*lcwrite) (struct rio_mport *mport, int index, u32 offset, int len, |
| 386 | u32 data); |
| 387 | int (*cread) (struct rio_mport *mport, int index, u16 destid, |
| 388 | u8 hopcount, u32 offset, int len, u32 *data); |
| 389 | int (*cwrite) (struct rio_mport *mport, int index, u16 destid, |
| 390 | u8 hopcount, u32 offset, int len, u32 data); |
| 391 | int (*dsend) (struct rio_mport *mport, int index, u16 destid, u16 data); |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 392 | int (*pwenable) (struct rio_mport *mport, int enable); |
Alexandre Bounine | f8f0626 | 2011-03-23 16:43:02 -0700 | [diff] [blame] | 393 | int (*open_outb_mbox)(struct rio_mport *mport, void *dev_id, |
| 394 | int mbox, int entries); |
| 395 | void (*close_outb_mbox)(struct rio_mport *mport, int mbox); |
| 396 | int (*open_inb_mbox)(struct rio_mport *mport, void *dev_id, |
| 397 | int mbox, int entries); |
| 398 | void (*close_inb_mbox)(struct rio_mport *mport, int mbox); |
| 399 | int (*add_outb_message)(struct rio_mport *mport, struct rio_dev *rdev, |
| 400 | int mbox, void *buffer, size_t len); |
| 401 | int (*add_inb_buffer)(struct rio_mport *mport, int mbox, void *buf); |
| 402 | void *(*get_inb_message)(struct rio_mport *mport, int mbox); |
Alexandre Bounine | da1589f | 2012-10-04 17:15:57 -0700 | [diff] [blame] | 403 | int (*map_inb)(struct rio_mport *mport, dma_addr_t lstart, |
| 404 | u64 rstart, u32 size, u32 flags); |
| 405 | void (*unmap_inb)(struct rio_mport *mport, dma_addr_t lstart); |
Alexandre Bounine | 8b189fd | 2016-03-22 14:26:00 -0700 | [diff] [blame] | 406 | int (*query_mport)(struct rio_mport *mport, |
| 407 | struct rio_mport_attr *attr); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 408 | }; |
| 409 | |
| 410 | #define RIO_RESOURCE_MEM 0x00000100 |
| 411 | #define RIO_RESOURCE_DOORBELL 0x00000200 |
| 412 | #define RIO_RESOURCE_MAILBOX 0x00000400 |
| 413 | |
| 414 | #define RIO_RESOURCE_CACHEABLE 0x00010000 |
| 415 | #define RIO_RESOURCE_PCI 0x00020000 |
| 416 | |
| 417 | #define RIO_RESOURCE_BUSY 0x80000000 |
| 418 | |
| 419 | /** |
| 420 | * struct rio_driver - RIO driver info |
| 421 | * @node: Node in list of drivers |
| 422 | * @name: RIO driver name |
| 423 | * @id_table: RIO device ids to be associated with this driver |
| 424 | * @probe: RIO device inserted |
| 425 | * @remove: RIO device removed |
Alexandre Bounine | 83dc2cbc | 2016-03-22 14:26:05 -0700 | [diff] [blame^] | 426 | * @shutdown: shutdown notification callback |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 427 | * @suspend: RIO device suspended |
| 428 | * @resume: RIO device awakened |
| 429 | * @enable_wake: RIO device enable wake event |
| 430 | * @driver: LDM driver struct |
| 431 | * |
| 432 | * Provides info on a RIO device driver for insertion/removal and |
| 433 | * power management purposes. |
| 434 | */ |
| 435 | struct rio_driver { |
| 436 | struct list_head node; |
| 437 | char *name; |
| 438 | const struct rio_device_id *id_table; |
| 439 | int (*probe) (struct rio_dev * dev, const struct rio_device_id * id); |
| 440 | void (*remove) (struct rio_dev * dev); |
Alexandre Bounine | 83dc2cbc | 2016-03-22 14:26:05 -0700 | [diff] [blame^] | 441 | void (*shutdown)(struct rio_dev *dev); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 442 | int (*suspend) (struct rio_dev * dev, u32 state); |
| 443 | int (*resume) (struct rio_dev * dev); |
| 444 | int (*enable_wake) (struct rio_dev * dev, u32 state, int enable); |
| 445 | struct device_driver driver; |
| 446 | }; |
| 447 | |
| 448 | #define to_rio_driver(drv) container_of(drv,struct rio_driver, driver) |
| 449 | |
Alexandre Bounine | e5cabeb | 2010-05-26 14:43:59 -0700 | [diff] [blame] | 450 | union rio_pw_msg { |
| 451 | struct { |
| 452 | u32 comptag; /* Component Tag CSR */ |
| 453 | u32 errdetect; /* Port N Error Detect CSR */ |
| 454 | u32 is_port; /* Implementation specific + PortID */ |
| 455 | u32 ltlerrdet; /* LTL Error Detect CSR */ |
| 456 | u32 padding[12]; |
| 457 | } em; |
| 458 | u32 raw[RIO_PW_MSG_SIZE/sizeof(u32)]; |
| 459 | }; |
| 460 | |
Alexandre Bounine | e42d98e | 2012-05-31 16:26:38 -0700 | [diff] [blame] | 461 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| 462 | |
Alexandre Bounine | fe50c92 | 2012-10-04 17:15:52 -0700 | [diff] [blame] | 463 | /* |
Alexandre Bounine | e42d98e | 2012-05-31 16:26:38 -0700 | [diff] [blame] | 464 | * enum rio_write_type - RIO write transaction types used in DMA transfers |
| 465 | * |
| 466 | * Note: RapidIO specification defines write (NWRITE) and |
| 467 | * write-with-response (NWRITE_R) data transfer operations. |
| 468 | * Existing DMA controllers that service RapidIO may use one of these operations |
| 469 | * for entire data transfer or their combination with only the last data packet |
| 470 | * requires response. |
| 471 | */ |
| 472 | enum rio_write_type { |
| 473 | RDW_DEFAULT, /* default method used by DMA driver */ |
| 474 | RDW_ALL_NWRITE, /* all packets use NWRITE */ |
| 475 | RDW_ALL_NWRITE_R, /* all packets use NWRITE_R */ |
| 476 | RDW_LAST_NWRITE_R, /* last packet uses NWRITE_R, others - NWRITE */ |
| 477 | }; |
| 478 | |
| 479 | struct rio_dma_ext { |
| 480 | u16 destid; |
| 481 | u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ |
| 482 | u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ |
| 483 | enum rio_write_type wr_type; /* preferred RIO write operation type */ |
| 484 | }; |
| 485 | |
| 486 | struct rio_dma_data { |
| 487 | /* Local data (as scatterlist) */ |
| 488 | struct scatterlist *sg; /* I/O scatter list */ |
| 489 | unsigned int sg_len; /* size of scatter list */ |
| 490 | /* Remote device address (flat buffer) */ |
| 491 | u64 rio_addr; /* low 64-bits of 66-bit RapidIO address */ |
| 492 | u8 rio_addr_u; /* upper 2-bits of 66-bit RapidIO address */ |
| 493 | enum rio_write_type wr_type; /* preferred RIO write operation type */ |
| 494 | }; |
| 495 | |
| 496 | static inline struct rio_mport *dma_to_mport(struct dma_device *ddev) |
| 497 | { |
| 498 | return container_of(ddev, struct rio_mport, dma); |
| 499 | } |
| 500 | #endif /* CONFIG_RAPIDIO_DMA_ENGINE */ |
| 501 | |
Alexandre Bounine | a11650e | 2013-05-24 15:55:05 -0700 | [diff] [blame] | 502 | /** |
| 503 | * struct rio_scan - RIO enumeration and discovery operations |
Alexandre Bounine | 9edbc30b | 2013-07-03 15:08:53 -0700 | [diff] [blame] | 504 | * @owner: The module owner of this structure |
Alexandre Bounine | a11650e | 2013-05-24 15:55:05 -0700 | [diff] [blame] | 505 | * @enumerate: Callback to perform RapidIO fabric enumeration. |
| 506 | * @discover: Callback to perform RapidIO fabric discovery. |
| 507 | */ |
| 508 | struct rio_scan { |
Alexandre Bounine | 9edbc30b | 2013-07-03 15:08:53 -0700 | [diff] [blame] | 509 | struct module *owner; |
Alexandre Bounine | bc8fcfe | 2013-05-24 15:55:06 -0700 | [diff] [blame] | 510 | int (*enumerate)(struct rio_mport *mport, u32 flags); |
| 511 | int (*discover)(struct rio_mport *mport, u32 flags); |
Alexandre Bounine | a11650e | 2013-05-24 15:55:05 -0700 | [diff] [blame] | 512 | }; |
| 513 | |
Alexandre Bounine | 9edbc30b | 2013-07-03 15:08:53 -0700 | [diff] [blame] | 514 | /** |
| 515 | * struct rio_scan_node - list node to register RapidIO enumeration and |
| 516 | * discovery methods with RapidIO core. |
| 517 | * @mport_id: ID of an mport (net) serviced by this enumerator |
| 518 | * @node: node in global list of registered enumerators |
| 519 | * @ops: RIO enumeration and discovery operations |
| 520 | */ |
| 521 | struct rio_scan_node { |
| 522 | int mport_id; |
| 523 | struct list_head node; |
| 524 | struct rio_scan *ops; |
| 525 | }; |
| 526 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 527 | /* Architecture and hardware-specific functions */ |
Alexandre Bounine | 59f9996 | 2011-04-14 15:22:14 -0700 | [diff] [blame] | 528 | extern int rio_register_mport(struct rio_mport *); |
Matt Porter | 6978bbc | 2005-11-07 01:00:20 -0800 | [diff] [blame] | 529 | extern int rio_open_inb_mbox(struct rio_mport *, void *, int, int); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 530 | extern void rio_close_inb_mbox(struct rio_mport *, int); |
Matt Porter | 6978bbc | 2005-11-07 01:00:20 -0800 | [diff] [blame] | 531 | extern int rio_open_outb_mbox(struct rio_mport *, void *, int, int); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 532 | extern void rio_close_outb_mbox(struct rio_mport *, int); |
Alexandre Bounine | 8b189fd | 2016-03-22 14:26:00 -0700 | [diff] [blame] | 533 | extern int rio_query_mport(struct rio_mport *port, |
| 534 | struct rio_mport_attr *mport_attr); |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 535 | |
Matt Porter | 70a50eb | 2005-11-07 01:00:16 -0800 | [diff] [blame] | 536 | #endif /* LINUX_RIO_H */ |