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, |
Jens Taprogge | e4af949 | 2012-09-13 12:32:19 +0200 | [diff] [blame] | 37 | IPACK_INT_SPACE, |
Jens Taprogge | fe4a3ed | 2012-09-27 12:37:36 +0200 | [diff] [blame] | 38 | IPACK_MEM8_SPACE, |
Jens Taprogge | 48a9735 | 2012-09-27 12:37:37 +0200 | [diff] [blame] | 39 | IPACK_MEM16_SPACE, |
Jens Taprogge | 84a08fa | 2012-09-27 12:37:29 +0200 | [diff] [blame] | 40 | /* Dummy for counting the number of entries. Must remain the last |
| 41 | * entry */ |
| 42 | IPACK_SPACE_COUNT, |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 43 | }; |
| 44 | |
| 45 | /** |
Jens Taprogge | bb29ab8 | 2012-09-27 12:37:28 +0200 | [diff] [blame] | 46 | */ |
| 47 | struct ipack_region { |
| 48 | phys_addr_t start; |
| 49 | size_t size; |
| 50 | }; |
| 51 | |
| 52 | /** |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 53 | * struct ipack_device |
| 54 | * |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 55 | * @slot: Slot where the device is plugged in the carrier board |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 56 | * @bus: ipack_bus_device where the device is plugged to. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 57 | * @id_space: Virtual address to ID space. |
| 58 | * @io_space: Virtual address to IO space. |
| 59 | * @mem_space: Virtual address to MEM space. |
| 60 | * @dev: device in kernel representation. |
| 61 | * |
| 62 | * Warning: Direct access to mapped memory is possible but the endianness |
| 63 | * 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] | 64 | * by the carrier board throught bus->ops. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 65 | */ |
| 66 | struct ipack_device { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 67 | unsigned int slot; |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 68 | struct ipack_bus_device *bus; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 69 | struct device dev; |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 70 | void (*release) (struct ipack_device *dev); |
Jens Taprogge | a19ad7d | 2012-09-27 12:37:31 +0200 | [diff] [blame] | 71 | struct ipack_region region[IPACK_SPACE_COUNT]; |
Jens Taprogge | e8ed327 | 2012-09-04 17:01:15 +0200 | [diff] [blame] | 72 | u8 *id; |
Jens Taprogge | 187e478 | 2012-09-04 17:01:14 +0200 | [diff] [blame] | 73 | size_t id_avail; |
Jens Taprogge | e8ed327 | 2012-09-04 17:01:15 +0200 | [diff] [blame] | 74 | u32 id_vendor; |
| 75 | u32 id_device; |
Jens Taprogge | 187e478 | 2012-09-04 17:01:14 +0200 | [diff] [blame] | 76 | u8 id_format; |
Jens Taprogge | a92caeb | 2012-09-11 13:35:03 +0200 | [diff] [blame] | 77 | unsigned int id_crc_correct:1; |
Jens Taprogge | 0b0f3a1 | 2012-09-11 13:34:57 +0200 | [diff] [blame] | 78 | unsigned int speed_8mhz:1; |
| 79 | unsigned int speed_32mhz:1; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 80 | }; |
| 81 | |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 82 | /** |
Jens Taprogge | 26c295c | 2012-09-27 12:37:40 +0200 | [diff] [blame^] | 83 | * struct ipack_driver_ops -- Callbacks to IPack device driver |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 84 | * |
Jens Taprogge | 26c295c | 2012-09-27 12:37:40 +0200 | [diff] [blame^] | 85 | * @probe: Probe function |
| 86 | * @remove: Prepare imminent removal of the device. Services provided by the |
| 87 | * device should be revoked. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 88 | */ |
| 89 | |
| 90 | struct ipack_driver_ops { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 91 | int (*probe) (struct ipack_device *dev); |
| 92 | void (*remove) (struct ipack_device *dev); |
| 93 | }; |
| 94 | |
| 95 | /** |
Jens Taprogge | 26c295c | 2012-09-27 12:37:40 +0200 | [diff] [blame^] | 96 | * struct ipack_driver -- Specific data to each ipack device driver |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 97 | * |
Jens Taprogge | 26c295c | 2012-09-27 12:37:40 +0200 | [diff] [blame^] | 98 | * @driver: Device driver kernel representation |
| 99 | * @ops: Callbacks provided by the IPack device driver |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 100 | */ |
| 101 | struct ipack_driver { |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 102 | struct device_driver driver; |
Jens Taprogge | 849e0ad | 2012-09-04 17:01:13 +0200 | [diff] [blame] | 103 | const struct ipack_device_id *id_table; |
Jens Taprogge | e801113 | 2012-09-04 17:01:17 +0200 | [diff] [blame] | 104 | const struct ipack_driver_ops *ops; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 105 | }; |
| 106 | |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 107 | /** |
| 108 | * struct ipack_bus_ops - available operations on a bridge module |
| 109 | * |
| 110 | * @map_space: map IP address space |
| 111 | * @unmap_space: unmap IP address space |
| 112 | * @request_irq: request IRQ |
| 113 | * @free_irq: free IRQ |
Jens Taprogge | 7b6ab33 | 2012-09-11 13:34:55 +0200 | [diff] [blame] | 114 | * @get_clockrate: Returns the clockrate the carrier is currently |
| 115 | * communicating with the device at. |
| 116 | * @set_clockrate: Sets the clock-rate for carrier / module communication. |
| 117 | * Should return -EINVAL if the requested speed is not supported. |
| 118 | * @get_error: Returns the error state for the slot the device is attached |
| 119 | * to. |
| 120 | * @get_timeout: Returns 1 if the communication with the device has |
| 121 | * previously timed out. |
| 122 | * @reset_timeout: Resets the state returned by get_timeout. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 123 | */ |
| 124 | struct ipack_bus_ops { |
Jens Taprogge | c6e2dfa | 2012-09-13 12:32:21 +0200 | [diff] [blame] | 125 | int (*request_irq) (struct ipack_device *dev, |
Jens Taprogge | faa75c4 | 2012-09-12 14:55:38 +0200 | [diff] [blame] | 126 | irqreturn_t (*handler)(void *), void *arg); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 127 | int (*free_irq) (struct ipack_device *dev); |
Jens Taprogge | 7b6ab33 | 2012-09-11 13:34:55 +0200 | [diff] [blame] | 128 | int (*get_clockrate) (struct ipack_device *dev); |
| 129 | int (*set_clockrate) (struct ipack_device *dev, int mherz); |
| 130 | int (*get_error) (struct ipack_device *dev); |
| 131 | int (*get_timeout) (struct ipack_device *dev); |
| 132 | int (*reset_timeout) (struct ipack_device *dev); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 133 | }; |
| 134 | |
| 135 | /** |
| 136 | * struct ipack_bus_device |
| 137 | * |
| 138 | * @dev: pointer to carrier device |
| 139 | * @slots: number of slots available |
| 140 | * @bus_nr: ipack bus number |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 141 | * @ops: bus operations for the mezzanine drivers |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 142 | */ |
| 143 | struct ipack_bus_device { |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 144 | struct device *parent; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 145 | int slots; |
| 146 | int bus_nr; |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 147 | const struct ipack_bus_ops *ops; |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 148 | }; |
| 149 | |
| 150 | /** |
| 151 | * ipack_bus_register -- register a new ipack bus |
| 152 | * |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 153 | * @parent: pointer to the parent device, if any. |
| 154 | * @slots: number of slots available in the bus device. |
| 155 | * @ops: bus operations for the mezzanine drivers. |
| 156 | * |
| 157 | * The carrier board device should call this function to register itself as |
| 158 | * available bus device in ipack. |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 159 | */ |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 160 | struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots, |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 161 | const struct ipack_bus_ops *ops); |
Samuel Iglesias Gonsalvez | d346587 | 2012-05-09 15:27:19 +0200 | [diff] [blame] | 162 | |
| 163 | /** |
| 164 | * ipack_bus_unregister -- unregister an ipack bus |
| 165 | */ |
| 166 | int ipack_bus_unregister(struct ipack_bus_device *bus); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 167 | |
| 168 | /** |
Jens Taprogge | 26c295c | 2012-09-27 12:37:40 +0200 | [diff] [blame^] | 169 | * ipack_driver_register -- Register a new ipack device driver |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 170 | * |
| 171 | * Called by a ipack driver to register itself as a driver |
| 172 | * that can manage ipack devices. |
| 173 | */ |
Stephen Hemminger | 9869a93 | 2012-09-10 11:14:01 -0700 | [diff] [blame] | 174 | int ipack_driver_register(struct ipack_driver *edrv, struct module *owner, |
| 175 | const char *name); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 176 | void ipack_driver_unregister(struct ipack_driver *edrv); |
| 177 | |
| 178 | /** |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 179 | * ipack_device_register -- register an IPack device with the kernel |
| 180 | * @dev: the new device to register. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 181 | * |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 182 | * Register a new IPack device ("module" in IndustryPack jargon). The call |
| 183 | * is done by the carrier driver. The carrier should populate the fields |
Jens Taprogge | a19ad7d | 2012-09-27 12:37:31 +0200 | [diff] [blame] | 184 | * bus and slot as well as the region array of @dev prior to calling this |
| 185 | * function. The rest of the fields will be allocated and populated |
| 186 | * during registration. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 187 | * |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 188 | * Return zero on success or error code on failure. |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 189 | */ |
Jens Taprogge | 1e91795 | 2012-09-27 12:37:26 +0200 | [diff] [blame] | 190 | int ipack_device_register(struct ipack_device *dev); |
Samuel Iglesias Gonsalvez | ec44033 | 2012-05-18 11:10:05 +0200 | [diff] [blame] | 191 | void ipack_device_unregister(struct ipack_device *dev); |
Jens Taprogge | 849e0ad | 2012-09-04 17:01:13 +0200 | [diff] [blame] | 192 | |
| 193 | /** |
| 194 | * DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table |
| 195 | * @_table: device table name |
| 196 | * |
| 197 | * This macro is used to create a struct ipack_device_id array (a device table) |
| 198 | * in a generic manner. |
| 199 | */ |
| 200 | #define DEFINE_IPACK_DEVICE_TABLE(_table) \ |
| 201 | const struct ipack_device_id _table[] __devinitconst |
| 202 | |
| 203 | /** |
| 204 | * IPACK_DEVICE - macro used to describe a specific IndustryPack device |
| 205 | * @_format: the format version (currently either 1 or 2, 8 bit value) |
| 206 | * @vend: the 8 or 24 bit IndustryPack Vendor ID |
| 207 | * @dev: the 8 or 16 bit IndustryPack Device ID |
| 208 | * |
| 209 | * This macro is used to create a struct ipack_device_id that matches a specific |
| 210 | * device. |
| 211 | */ |
| 212 | #define IPACK_DEVICE(_format, vend, dev) \ |
| 213 | .format = (_format), \ |
| 214 | .vendor = (vend), \ |
| 215 | .device = (dev) |