ipack.h 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Industry-pack bus.
  4. *
  5. * Copyright (C) 2011-2012 CERN (www.cern.ch)
  6. * Author: Samuel Iglesias Gonsalvez <[email protected]>
  7. */
  8. #include <linux/mod_devicetable.h>
  9. #include <linux/device.h>
  10. #include <linux/interrupt.h>
  11. #define IPACK_IDPROM_OFFSET_I 0x01
  12. #define IPACK_IDPROM_OFFSET_P 0x03
  13. #define IPACK_IDPROM_OFFSET_A 0x05
  14. #define IPACK_IDPROM_OFFSET_C 0x07
  15. #define IPACK_IDPROM_OFFSET_MANUFACTURER_ID 0x09
  16. #define IPACK_IDPROM_OFFSET_MODEL 0x0B
  17. #define IPACK_IDPROM_OFFSET_REVISION 0x0D
  18. #define IPACK_IDPROM_OFFSET_RESERVED 0x0F
  19. #define IPACK_IDPROM_OFFSET_DRIVER_ID_L 0x11
  20. #define IPACK_IDPROM_OFFSET_DRIVER_ID_H 0x13
  21. #define IPACK_IDPROM_OFFSET_NUM_BYTES 0x15
  22. #define IPACK_IDPROM_OFFSET_CRC 0x17
  23. /*
  24. * IndustryPack Fromat, Vendor and Device IDs.
  25. */
  26. /* ID section format versions */
  27. #define IPACK_ID_VERSION_INVALID 0x00
  28. #define IPACK_ID_VERSION_1 0x01
  29. #define IPACK_ID_VERSION_2 0x02
  30. /* Vendors and devices. Sort key: vendor first, device next. */
  31. #define IPACK1_VENDOR_ID_RESERVED1 0x00
  32. #define IPACK1_VENDOR_ID_RESERVED2 0xFF
  33. #define IPACK1_VENDOR_ID_UNREGISTRED01 0x01
  34. #define IPACK1_VENDOR_ID_UNREGISTRED02 0x02
  35. #define IPACK1_VENDOR_ID_UNREGISTRED03 0x03
  36. #define IPACK1_VENDOR_ID_UNREGISTRED04 0x04
  37. #define IPACK1_VENDOR_ID_UNREGISTRED05 0x05
  38. #define IPACK1_VENDOR_ID_UNREGISTRED06 0x06
  39. #define IPACK1_VENDOR_ID_UNREGISTRED07 0x07
  40. #define IPACK1_VENDOR_ID_UNREGISTRED08 0x08
  41. #define IPACK1_VENDOR_ID_UNREGISTRED09 0x09
  42. #define IPACK1_VENDOR_ID_UNREGISTRED10 0x0A
  43. #define IPACK1_VENDOR_ID_UNREGISTRED11 0x0B
  44. #define IPACK1_VENDOR_ID_UNREGISTRED12 0x0C
  45. #define IPACK1_VENDOR_ID_UNREGISTRED13 0x0D
  46. #define IPACK1_VENDOR_ID_UNREGISTRED14 0x0E
  47. #define IPACK1_VENDOR_ID_UNREGISTRED15 0x0F
  48. #define IPACK1_VENDOR_ID_SBS 0xF0
  49. #define IPACK1_DEVICE_ID_SBS_OCTAL_232 0x22
  50. #define IPACK1_DEVICE_ID_SBS_OCTAL_422 0x2A
  51. #define IPACK1_DEVICE_ID_SBS_OCTAL_485 0x48
  52. struct ipack_bus_ops;
  53. struct ipack_driver;
  54. enum ipack_space {
  55. IPACK_IO_SPACE = 0,
  56. IPACK_ID_SPACE,
  57. IPACK_INT_SPACE,
  58. IPACK_MEM8_SPACE,
  59. IPACK_MEM16_SPACE,
  60. /* Dummy for counting the number of entries. Must remain the last
  61. * entry */
  62. IPACK_SPACE_COUNT,
  63. };
  64. /**
  65. */
  66. struct ipack_region {
  67. phys_addr_t start;
  68. size_t size;
  69. };
  70. /**
  71. * struct ipack_device
  72. *
  73. * @slot: Slot where the device is plugged in the carrier board
  74. * @bus: ipack_bus_device where the device is plugged to.
  75. * @id_space: Virtual address to ID space.
  76. * @io_space: Virtual address to IO space.
  77. * @mem_space: Virtual address to MEM space.
  78. * @dev: device in kernel representation.
  79. *
  80. * Warning: Direct access to mapped memory is possible but the endianness
  81. * is not the same with PCI carrier or VME carrier. The endianness is managed
  82. * by the carrier board throught bus->ops.
  83. */
  84. struct ipack_device {
  85. unsigned int slot;
  86. struct ipack_bus_device *bus;
  87. struct device dev;
  88. void (*release) (struct ipack_device *dev);
  89. struct ipack_region region[IPACK_SPACE_COUNT];
  90. u8 *id;
  91. size_t id_avail;
  92. u32 id_vendor;
  93. u32 id_device;
  94. u8 id_format;
  95. unsigned int id_crc_correct:1;
  96. unsigned int speed_8mhz:1;
  97. unsigned int speed_32mhz:1;
  98. };
  99. /**
  100. * struct ipack_driver_ops -- Callbacks to IPack device driver
  101. *
  102. * @probe: Probe function
  103. * @remove: Prepare imminent removal of the device. Services provided by the
  104. * device should be revoked.
  105. */
  106. struct ipack_driver_ops {
  107. int (*probe) (struct ipack_device *dev);
  108. void (*remove) (struct ipack_device *dev);
  109. };
  110. /**
  111. * struct ipack_driver -- Specific data to each ipack device driver
  112. *
  113. * @driver: Device driver kernel representation
  114. * @ops: Callbacks provided by the IPack device driver
  115. */
  116. struct ipack_driver {
  117. struct device_driver driver;
  118. const struct ipack_device_id *id_table;
  119. const struct ipack_driver_ops *ops;
  120. };
  121. /**
  122. * struct ipack_bus_ops - available operations on a bridge module
  123. *
  124. * @map_space: map IP address space
  125. * @unmap_space: unmap IP address space
  126. * @request_irq: request IRQ
  127. * @free_irq: free IRQ
  128. * @get_clockrate: Returns the clockrate the carrier is currently
  129. * communicating with the device at.
  130. * @set_clockrate: Sets the clock-rate for carrier / module communication.
  131. * Should return -EINVAL if the requested speed is not supported.
  132. * @get_error: Returns the error state for the slot the device is attached
  133. * to.
  134. * @get_timeout: Returns 1 if the communication with the device has
  135. * previously timed out.
  136. * @reset_timeout: Resets the state returned by get_timeout.
  137. */
  138. struct ipack_bus_ops {
  139. int (*request_irq) (struct ipack_device *dev,
  140. irqreturn_t (*handler)(void *), void *arg);
  141. int (*free_irq) (struct ipack_device *dev);
  142. int (*get_clockrate) (struct ipack_device *dev);
  143. int (*set_clockrate) (struct ipack_device *dev, int mherz);
  144. int (*get_error) (struct ipack_device *dev);
  145. int (*get_timeout) (struct ipack_device *dev);
  146. int (*reset_timeout) (struct ipack_device *dev);
  147. };
  148. /**
  149. * struct ipack_bus_device
  150. *
  151. * @dev: pointer to carrier device
  152. * @slots: number of slots available
  153. * @bus_nr: ipack bus number
  154. * @ops: bus operations for the mezzanine drivers
  155. */
  156. struct ipack_bus_device {
  157. struct module *owner;
  158. struct device *parent;
  159. int slots;
  160. int bus_nr;
  161. const struct ipack_bus_ops *ops;
  162. };
  163. /**
  164. * ipack_bus_register -- register a new ipack bus
  165. *
  166. * @parent: pointer to the parent device, if any.
  167. * @slots: number of slots available in the bus device.
  168. * @ops: bus operations for the mezzanine drivers.
  169. *
  170. * The carrier board device should call this function to register itself as
  171. * available bus device in ipack.
  172. */
  173. struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots,
  174. const struct ipack_bus_ops *ops,
  175. struct module *owner);
  176. /**
  177. * ipack_bus_unregister -- unregister an ipack bus
  178. */
  179. int ipack_bus_unregister(struct ipack_bus_device *bus);
  180. /**
  181. * ipack_driver_register -- Register a new ipack device driver
  182. *
  183. * Called by a ipack driver to register itself as a driver
  184. * that can manage ipack devices.
  185. */
  186. int ipack_driver_register(struct ipack_driver *edrv, struct module *owner,
  187. const char *name);
  188. void ipack_driver_unregister(struct ipack_driver *edrv);
  189. /**
  190. * ipack_device_init -- initialize an IPack device
  191. * @dev: the new device to initialize.
  192. *
  193. * Initialize a new IPack device ("module" in IndustryPack jargon). The call
  194. * is done by the carrier driver. The carrier should populate the fields
  195. * bus and slot as well as the region array of @dev prior to calling this
  196. * function. The rest of the fields will be allocated and populated
  197. * during initalization.
  198. *
  199. * Return zero on success or error code on failure.
  200. *
  201. * NOTE: _Never_ directly free @dev after calling this function, even
  202. * if it returned an error! Always use ipack_put_device() to give up the
  203. * reference initialized in this function instead.
  204. */
  205. int ipack_device_init(struct ipack_device *dev);
  206. /**
  207. * ipack_device_add -- Add an IPack device
  208. * @dev: the new device to add.
  209. *
  210. * Add a new IPack device. The call is done by the carrier driver
  211. * after calling ipack_device_init().
  212. *
  213. * Return zero on success or error code on failure.
  214. *
  215. * NOTE: _Never_ directly free @dev after calling this function, even
  216. * if it returned an error! Always use ipack_put_device() to give up the
  217. * reference initialized in this function instead.
  218. */
  219. int ipack_device_add(struct ipack_device *dev);
  220. void ipack_device_del(struct ipack_device *dev);
  221. void ipack_get_device(struct ipack_device *dev);
  222. void ipack_put_device(struct ipack_device *dev);
  223. /**
  224. * DEFINE_IPACK_DEVICE_TABLE - macro used to describe a IndustryPack table
  225. * @_table: device table name
  226. *
  227. * This macro is used to create a struct ipack_device_id array (a device table)
  228. * in a generic manner.
  229. */
  230. #define DEFINE_IPACK_DEVICE_TABLE(_table) \
  231. const struct ipack_device_id _table[]
  232. /**
  233. * IPACK_DEVICE - macro used to describe a specific IndustryPack device
  234. * @_format: the format version (currently either 1 or 2, 8 bit value)
  235. * @vend: the 8 or 24 bit IndustryPack Vendor ID
  236. * @dev: the 8 or 16 bit IndustryPack Device ID
  237. *
  238. * This macro is used to create a struct ipack_device_id that matches a specific
  239. * device.
  240. */
  241. #define IPACK_DEVICE(_format, vend, dev) \
  242. .format = (_format), \
  243. .vendor = (vend), \
  244. .device = (dev)
  245. /**
  246. * ipack_get_carrier - it increase the carrier ref. counter of
  247. * the carrier module
  248. * @dev: mezzanine device which wants to get the carrier
  249. */
  250. static inline int ipack_get_carrier(struct ipack_device *dev)
  251. {
  252. return try_module_get(dev->bus->owner);
  253. }
  254. /**
  255. * ipack_get_carrier - it decrease the carrier ref. counter of
  256. * the carrier module
  257. * @dev: mezzanine device which wants to get the carrier
  258. */
  259. static inline void ipack_put_carrier(struct ipack_device *dev)
  260. {
  261. module_put(dev->bus->owner);
  262. }