Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 1 | /* |
| 2 | * Industry-pack bus. |
| 3 | * |
| 4 | * (C) 2011 Samuel Iglesias Gonsalvez <siglesia@cern.ch>, CERN |
| 5 | * (C) 2012 Samuel Iglesias Gonsalvez <siglesias@igalia.com>, Igalia |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify it |
| 8 | * under the terms of the GNU General Public License as published by the Free |
Samuel Iglesias Gonsalvez | 416289b | 2012-05-11 10:17:13 +0200 | [diff] [blame] | 9 | * Software Foundation; version 2 of the License. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 10 | */ |
| 11 | |
Jens Taprogge | 849e0ad | 2012-09-04 17:01:13 +0200 | [diff] [blame] | 12 | #include <linux/mod_devicetable.h> |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 13 | #include <linux/device.h> |
Jens Taprogge | faa75c4 | 2012-09-12 14:55:38 +0200 | [diff] [blame] | 14 | #include <linux/interrupt.h> |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 15 | |
Jens Taprogge | 187e478 | 2012-09-04 17:01:14 +0200 | [diff] [blame] | 16 | #include "ipack_ids.h" |
| 17 | |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 18 | #define IPACK_IDPROM_OFFSET_I 0x01 |
| 19 | #define IPACK_IDPROM_OFFSET_P 0x03 |
| 20 | #define IPACK_IDPROM_OFFSET_A 0x05 |
| 21 | #define IPACK_IDPROM_OFFSET_C 0x07 |
| 22 | #define IPACK_IDPROM_OFFSET_MANUFACTURER_ID 0x09 |
| 23 | #define IPACK_IDPROM_OFFSET_MODEL 0x0B |
| 24 | #define IPACK_IDPROM_OFFSET_REVISION 0x0D |
| 25 | #define IPACK_IDPROM_OFFSET_RESERVED 0x0F |
| 26 | #define IPACK_IDPROM_OFFSET_DRIVER_ID_L 0x11 |
| 27 | #define IPACK_IDPROM_OFFSET_DRIVER_ID_H 0x13 |
| 28 | #define IPACK_IDPROM_OFFSET_NUM_BYTES 0x15 |
| 29 | #define IPACK_IDPROM_OFFSET_CRC 0x17 |
| 30 | |
| 31 | struct ipack_bus_ops; |
| 32 | struct ipack_driver; |
| 33 | |
| 34 | enum ipack_space { |
| 35 | IPACK_IO_SPACE = 0, |
Jens Taprogge | 84a08fa | 2012-09-27 12:37:29 +0200 | [diff] [blame] | 36 | IPACK_ID_SPACE, |
| 37 | IPACK_MEM_SPACE, |
Jens Taprogge | e4af949 | 2012-09-13 12:32:19 +0200 | [diff] [blame] | 38 | IPACK_INT_SPACE, |
Jens Taprogge | 84a08fa | 2012-09-27 12:37:29 +0200 | [diff] [blame] | 39 | /* Dummy for counting the number of entries. Must remain the last |
| 40 | * entry */ |
| 41 | IPACK_SPACE_COUNT, |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 42 | }; |
| 43 | |
| 44 | /** |
| 45 | * struct ipack_addr_space - Virtual address space mapped for a specified type. |
| 46 | * |
| 47 | * @address: virtual address |
| 48 | * @size: size of the mapped space |
| 49 | */ |
| 50 | struct ipack_addr_space { |
Samuel Iglesias Gonsalvez | 5a81b4a | 2012-05-14 12:41:25 +0200 | [diff] [blame] | 51 | void __iomem *address; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 52 | unsigned int size; |
| 53 | }; |
| 54 | |
| 55 | /** |
Jens Taprogge | bb29ab8 | 2012-09-27 12:37:28 +0200 | [diff] [blame] | 56 | */ |
| 57 | struct ipack_region { |
| 58 | phys_addr_t start; |
| 59 | size_t size; |
| 60 | }; |
| 61 | |
| 62 | /** |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 63 | * struct ipack_device |
| 64 | * |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 65 | * @slot: Slot where the device is plugged in the carrier board |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 66 | * @bus: ipack_bus_device where the device is plugged to. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 67 | * @id_space: Virtual address to ID space. |
| 68 | * @io_space: Virtual address to IO space. |
| 69 | * @mem_space: Virtual address to MEM space. |
| 70 | * @dev: device in kernel representation. |
| 71 | * |
| 72 | * Warning: Direct access to mapped memory is possible but the endianness |
| 73 | * is not the same with PCI carrier or VME carrier. The endianness is managed |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 74 | * by the carrier board throught bus->ops. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 75 | */ |
| 76 | struct ipack_device { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 77 | unsigned int slot; |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 78 | struct ipack_bus_device *bus; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 79 | struct ipack_addr_space id_space; |
| 80 | struct ipack_addr_space io_space; |
Jens Taprogge | e4af949 | 2012-09-13 12:32:19 +0200 | [diff] [blame] | 81 | struct ipack_addr_space int_space; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 82 | struct ipack_addr_space mem_space; |
| 83 | struct device dev; |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 84 | void (*release) (struct ipack_device *dev); |
Jens Taprogge | a19ad7d | 2012-09-27 12:37:31 +0200 | [diff] [blame^] | 85 | struct ipack_region region[IPACK_SPACE_COUNT]; |
Jens Taprogge | e8ed327 | 2012-09-04 17:01:15 +0200 | [diff] [blame] | 86 | u8 *id; |
Jens Taprogge | 187e478 | 2012-09-04 17:01:14 +0200 | [diff] [blame] | 87 | size_t id_avail; |
Jens Taprogge | e8ed327 | 2012-09-04 17:01:15 +0200 | [diff] [blame] | 88 | u32 id_vendor; |
| 89 | u32 id_device; |
Jens Taprogge | 187e478 | 2012-09-04 17:01:14 +0200 | [diff] [blame] | 90 | u8 id_format; |
Jens Taprogge | a92caeb | 2012-09-11 13:35:03 +0200 | [diff] [blame] | 91 | unsigned int id_crc_correct:1; |
Jens Taprogge | 0b0f3a1 | 2012-09-11 13:34:57 +0200 | [diff] [blame] | 92 | unsigned int speed_8mhz:1; |
| 93 | unsigned int speed_32mhz:1; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 94 | }; |
| 95 | |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 96 | /** |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 97 | * struct ipack_driver_ops -- callbacks to mezzanine driver for installing/removing one device |
| 98 | * |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 99 | * @probe: Probe function |
| 100 | * @remove: tell the driver that the carrier board wants to remove one device |
| 101 | */ |
| 102 | |
| 103 | struct ipack_driver_ops { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 104 | int (*probe) (struct ipack_device *dev); |
| 105 | void (*remove) (struct ipack_device *dev); |
| 106 | }; |
| 107 | |
| 108 | /** |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 109 | * struct ipack_driver -- Specific data to each ipack board driver |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 110 | * |
| 111 | * @driver: Device driver kernel representation |
| 112 | * @ops: Mezzanine driver operations specific for the ipack bus. |
| 113 | */ |
| 114 | struct ipack_driver { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 115 | struct device_driver driver; |
Jens Taprogge | 849e0ad | 2012-09-04 17:01:13 +0200 | [diff] [blame] | 116 | const struct ipack_device_id *id_table; |
Jens Taprogge | e801113 | 2012-09-04 17:01:17 +0200 | [diff] [blame] | 117 | const struct ipack_driver_ops *ops; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 118 | }; |
| 119 | |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 120 | /** |
| 121 | * struct ipack_bus_ops - available operations on a bridge module |
| 122 | * |
| 123 | * @map_space: map IP address space |
| 124 | * @unmap_space: unmap IP address space |
| 125 | * @request_irq: request IRQ |
| 126 | * @free_irq: free IRQ |
Jens Taprogge | 7b6ab33 | 2012-09-11 13:34:55 +0200 | [diff] [blame] | 127 | * @get_clockrate: Returns the clockrate the carrier is currently |
| 128 | * communicating with the device at. |
| 129 | * @set_clockrate: Sets the clock-rate for carrier / module communication. |
| 130 | * Should return -EINVAL if the requested speed is not supported. |
| 131 | * @get_error: Returns the error state for the slot the device is attached |
| 132 | * to. |
| 133 | * @get_timeout: Returns 1 if the communication with the device has |
| 134 | * previously timed out. |
| 135 | * @reset_timeout: Resets the state returned by get_timeout. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 136 | */ |
| 137 | struct ipack_bus_ops { |
Jens Taprogge | bb29ab8 | 2012-09-27 12:37:28 +0200 | [diff] [blame] | 138 | int (*map_space) (struct ipack_device *dev, ssize_t memory_size, int space); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 139 | int (*unmap_space) (struct ipack_device *dev, int space); |
Jens Taprogge | c6e2dfa | 2012-09-13 12:32:21 +0200 | [diff] [blame] | 140 | int (*request_irq) (struct ipack_device *dev, |
Jens Taprogge | faa75c4 | 2012-09-12 14:55:38 +0200 | [diff] [blame] | 141 | irqreturn_t (*handler)(void *), void *arg); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 142 | int (*free_irq) (struct ipack_device *dev); |
Jens Taprogge | 7b6ab33 | 2012-09-11 13:34:55 +0200 | [diff] [blame] | 143 | int (*get_clockrate) (struct ipack_device *dev); |
| 144 | int (*set_clockrate) (struct ipack_device *dev, int mherz); |
| 145 | int (*get_error) (struct ipack_device *dev); |
| 146 | int (*get_timeout) (struct ipack_device *dev); |
| 147 | int (*reset_timeout) (struct ipack_device *dev); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | /** |
| 151 | * struct ipack_bus_device |
| 152 | * |
| 153 | * @dev: pointer to carrier device |
| 154 | * @slots: number of slots available |
| 155 | * @bus_nr: ipack bus number |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 156 | * @ops: bus operations for the mezzanine drivers |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 157 | */ |
| 158 | struct ipack_bus_device { |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 159 | struct device *parent; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 160 | int slots; |
| 161 | int bus_nr; |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 162 | const struct ipack_bus_ops *ops; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 163 | }; |
| 164 | |
| 165 | /** |
| 166 | * ipack_bus_register -- register a new ipack bus |
| 167 | * |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 168 | * @parent: pointer to the parent device, if any. |
| 169 | * @slots: number of slots available in the bus device. |
| 170 | * @ops: bus operations for the mezzanine drivers. |
| 171 | * |
| 172 | * The carrier board device should call this function to register itself as |
| 173 | * available bus device in ipack. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 174 | */ |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 175 | struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots, |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 176 | const struct ipack_bus_ops *ops); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 177 | |
| 178 | /** |
| 179 | * ipack_bus_unregister -- unregister an ipack bus |
| 180 | */ |
| 181 | int ipack_bus_unregister(struct ipack_bus_device *bus); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 182 | |
| 183 | /** |
| 184 | * ipack_driver_register -- Register a new driver |
| 185 | * |
| 186 | * Called by a ipack driver to register itself as a driver |
| 187 | * that can manage ipack devices. |
| 188 | */ |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 189 | int ipack_driver_register(struct ipack_driver *edrv, struct module *owner, |
| 190 | const char *name); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 191 | void ipack_driver_unregister(struct ipack_driver *edrv); |
| 192 | |
| 193 | /** |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 194 | * ipack_device_register -- register an IPack device with the kernel |
| 195 | * @dev: the new device to register. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 196 | * |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 197 | * Register a new IPack device ("module" in IndustryPack jargon). The call |
| 198 | * is done by the carrier driver. The carrier should populate the fields |
Jens Taprogge | a19ad7d | 2012-09-27 12:37:31 +0200 | [diff] [blame^] | 199 | * bus and slot as well as the region array of @dev prior to calling this |
| 200 | * function. The rest of the fields will be allocated and populated |
| 201 | * during registration. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 202 | * |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 203 | * Return zero on success or error code on failure. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 204 | */ |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 205 | int ipack_device_register(struct ipack_device *dev); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 206 | void ipack_device_unregister(struct ipack_device *dev); |
Jens Taprogge | 849e0ad | 2012-09-04 17:01:13 +0200 | [diff] [blame] | 207 | |
| 208 | /** |
| 209 | * DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table |
| 210 | * @_table: device table name |
| 211 | * |
| 212 | * This macro is used to create a struct ipack_device_id array (a device table) |
| 213 | * in a generic manner. |
| 214 | */ |
| 215 | #define DEFINE_IPACK_DEVICE_TABLE(_table) \ |
| 216 | const struct ipack_device_id _table[] __devinitconst |
| 217 | |
| 218 | /** |
| 219 | * IPACK_DEVICE - macro used to describe a specific IndustryPack device |
| 220 | * @_format: the format version (currently either 1 or 2, 8 bit value) |
| 221 | * @vend: the 8 or 24 bit IndustryPack Vendor ID |
| 222 | * @dev: the 8 or 16 bit IndustryPack Device ID |
| 223 | * |
| 224 | * This macro is used to create a struct ipack_device_id that matches a specific |
| 225 | * device. |
| 226 | */ |
| 227 | #define IPACK_DEVICE(_format, vend, dev) \ |
| 228 | .format = (_format), \ |
| 229 | .vendor = (vend), \ |
| 230 | .device = (dev) |