dio.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /* header file for DIO boards for the HP300 architecture.
  3. * Maybe this should handle DIO-II later?
  4. * The general structure of this is vaguely based on how
  5. * the Amiga port handles Zorro boards.
  6. * Copyright (C) Peter Maydell 05/1998 <pmaydell@chiark.greenend.org.uk>
  7. * Converted to driver model Jochen Friedrich <jochen@scram.de>
  8. *
  9. * The board IDs are from the NetBSD kernel, which for once provided
  10. * helpful comments...
  11. *
  12. * This goes with drivers/dio/dio.c
  13. */
  14. #ifndef _LINUX_DIO_H
  15. #define _LINUX_DIO_H
  16. /* The DIO boards in a system are distinguished by 'select codes' which
  17. * range from 0-63 (DIO) and 132-255 (DIO-II).
  18. * The DIO board with select code sc is located at physical address
  19. * 0x600000 + sc * 0x10000
  20. * So DIO cards cover [0x600000-0x800000); the areas [0x200000-0x400000) and
  21. * [0x800000-0x1000000) are for additional space required by things
  22. * like framebuffers. [0x400000-0x600000) is for miscellaneous internal I/O.
  23. * On Linux, this is currently all mapped into the virtual address space
  24. * at 0xf0000000 on bootup.
  25. * DIO-II boards are at 0x1000000 + (sc - 132) * 0x400000
  26. * which is address range [0x1000000-0x20000000) -- too big to map completely,
  27. * so currently we just don't handle DIO-II boards. It wouldn't be hard to
  28. * do with ioremap() though.
  29. */
  30. #include <linux/device.h>
  31. #ifdef __KERNEL__
  32. #include <asm/hp300hw.h>
  33. typedef __u16 dio_id;
  34. /*
  35. * DIO devices
  36. */
  37. struct dio_dev {
  38. struct dio_bus *bus;
  39. dio_id id;
  40. int scode;
  41. struct dio_driver *driver; /* which driver has allocated this device */
  42. struct device dev; /* Generic device interface */
  43. u8 ipl;
  44. char name[64];
  45. struct resource resource;
  46. };
  47. #define to_dio_dev(n) container_of(n, struct dio_dev, dev)
  48. /*
  49. * DIO bus
  50. */
  51. struct dio_bus {
  52. struct list_head devices; /* list of devices on this bus */
  53. unsigned int num_resources; /* number of resources */
  54. struct resource resources[2]; /* address space routed to this bus */
  55. struct device dev;
  56. char name[10];
  57. };
  58. extern struct dio_bus dio_bus; /* Single DIO bus */
  59. extern struct bus_type dio_bus_type;
  60. /*
  61. * DIO device IDs
  62. */
  63. struct dio_device_id {
  64. dio_id id; /* Device ID or DIO_WILDCARD */
  65. unsigned long driver_data; /* Data private to the driver */
  66. };
  67. /*
  68. * DIO device drivers
  69. */
  70. struct dio_driver {
  71. struct list_head node;
  72. char *name;
  73. const struct dio_device_id *id_table; /* NULL if wants all devices */
  74. int (*probe)(struct dio_dev *z, const struct dio_device_id *id);
  75. /* New device inserted */
  76. void (*remove)(struct dio_dev *z); /* Device removed (NULL if not a hot-plug capable driver) */
  77. struct device_driver driver;
  78. };
  79. #define to_dio_driver(drv) container_of(drv, struct dio_driver, driver)
  80. /* DIO/DIO-II boards all have the following 8bit registers.
  81. * These are offsets from the base of the device.
  82. */
  83. #define DIO_IDOFF 0x01 /* primary device ID */
  84. #define DIO_IPLOFF 0x03 /* interrupt priority level */
  85. #define DIO_SECIDOFF 0x15 /* secondary device ID */
  86. #define DIOII_SIZEOFF 0x101 /* device size, DIO-II only */
  87. #define DIO_VIRADDRBASE 0xf0000000UL /* vir addr where IOspace is mapped */
  88. #define DIO_BASE 0x600000 /* start of DIO space */
  89. #define DIO_END 0x1000000 /* end of DIO space */
  90. #define DIO_DEVSIZE 0x10000 /* size of a DIO device */
  91. #define DIOII_BASE 0x01000000 /* start of DIO-II space */
  92. #define DIOII_END 0x20000000 /* end of DIO-II space */
  93. #define DIOII_DEVSIZE 0x00400000 /* size of a DIO-II device */
  94. /* Highest valid select code. If we add DIO-II support this should become
  95. * 256 for everything except HP320, which only has DIO.
  96. */
  97. #define DIO_SCMAX (hp300_model == HP_320 ? 32 : 256)
  98. #define DIOII_SCBASE 132 /* lowest DIO-II select code */
  99. #define DIO_SCINHOLE(scode) (((scode) >= 32) && ((scode) < DIOII_SCBASE))
  100. #define DIO_ISDIOII(scode) ((scode) >= 132 && (scode) < 256)
  101. /* macros to read device IDs, given base address */
  102. #define DIO_ID(baseaddr) in_8((baseaddr) + DIO_IDOFF)
  103. #define DIO_SECID(baseaddr) in_8((baseaddr) + DIO_SECIDOFF)
  104. /* extract the interrupt level */
  105. #define DIO_IPL(baseaddr) (((in_8((baseaddr) + DIO_IPLOFF) >> 4) & 0x03) + 3)
  106. /* find the size of a DIO-II board's address space.
  107. * DIO boards are all fixed length.
  108. */
  109. #define DIOII_SIZE(baseaddr) ((in_8((baseaddr) + DIOII_SIZEOFF) + 1) * 0x100000)
  110. /* general purpose macro for both DIO and DIO-II */
  111. #define DIO_SIZE(scode, base) (DIO_ISDIOII((scode)) ? DIOII_SIZE((base)) : DIO_DEVSIZE)
  112. /* The hardware has primary and secondary IDs; we encode these in a single
  113. * int as PRIMARY ID & (SECONDARY ID << 8).
  114. * In practice this is only important for framebuffers,
  115. * and everybody else just sets ID fields equal to the DIO_ID_FOO value.
  116. */
  117. #define DIO_ENCODE_ID(pr,sec) ((((int)sec & 0xff) << 8) | ((int)pr & 0xff))
  118. /* macro to determine whether a given primary ID requires a secondary ID byte */
  119. #define DIO_NEEDSSECID(id) ((id) == DIO_ID_FBUFFER)
  120. #define DIO_WILDCARD 0xff
  121. /* Now a whole slew of macros giving device IDs and descriptive strings: */
  122. #define DIO_ID_DCA0 0x02 /* 98644A serial */
  123. #define DIO_DESC_DCA0 "98644A DCA0 serial"
  124. #define DIO_ID_DCA0REM 0x82 /* 98644A serial */
  125. #define DIO_DESC_DCA0REM "98644A DCA0REM serial"
  126. #define DIO_ID_DCA1 0x42 /* 98644A serial */
  127. #define DIO_DESC_DCA1 "98644A DCA1 serial"
  128. #define DIO_ID_DCA1REM 0xc2 /* 98644A serial */
  129. #define DIO_DESC_DCA1REM "98644A DCA1REM serial"
  130. #define DIO_ID_DCM 0x05 /* 98642A serial MUX */
  131. #define DIO_DESC_DCM "98642A DCM serial MUX"
  132. #define DIO_ID_DCMREM 0x85 /* 98642A serial MUX */
  133. #define DIO_DESC_DCMREM "98642A DCMREM serial MUX"
  134. #define DIO_ID_LAN 0x15 /* 98643A LAN */
  135. #define DIO_DESC_LAN "98643A LANCE ethernet"
  136. #define DIO_ID_FHPIB 0x08 /* 98625A/98625B fast HP-IB */
  137. #define DIO_DESC_FHPIB "98625A/98625B fast HPIB"
  138. #define DIO_ID_NHPIB 0x01 /* 98624A HP-IB (normal ie slow) */
  139. #define DIO_DESC_NHPIB "98624A HPIB"
  140. #define DIO_ID_SCSI0 0x07 /* 98265A SCSI */
  141. #define DIO_DESC_SCSI0 "98265A SCSI0"
  142. #define DIO_ID_SCSI1 0x27 /* ditto */
  143. #define DIO_DESC_SCSI1 "98265A SCSI1"
  144. #define DIO_ID_SCSI2 0x47 /* ditto */
  145. #define DIO_DESC_SCSI2 "98265A SCSI2"
  146. #define DIO_ID_SCSI3 0x67 /* ditto */
  147. #define DIO_DESC_SCSI3 "98265A SCSI3"
  148. #define DIO_ID_FBUFFER 0x39 /* framebuffer: flavour is distinguished by secondary ID */
  149. #define DIO_DESC_FBUFFER "bitmapped display"
  150. /* the NetBSD kernel source is a bit unsure as to what these next IDs actually do :-> */
  151. #define DIO_ID_MISC0 0x03 /* 98622A */
  152. #define DIO_DESC_MISC0 "98622A"
  153. #define DIO_ID_MISC1 0x04 /* 98623A */
  154. #define DIO_DESC_MISC1 "98623A"
  155. #define DIO_ID_PARALLEL 0x06 /* internal parallel */
  156. #define DIO_DESC_PARALLEL "internal parallel"
  157. #define DIO_ID_MISC2 0x09 /* 98287A keyboard */
  158. #define DIO_DESC_MISC2 "98287A keyboard"
  159. #define DIO_ID_MISC3 0x0a /* HP98635A FP accelerator */
  160. #define DIO_DESC_MISC3 "HP98635A FP accelerator"
  161. #define DIO_ID_MISC4 0x0b /* timer */
  162. #define DIO_DESC_MISC4 "timer"
  163. #define DIO_ID_MISC5 0x12 /* 98640A */
  164. #define DIO_DESC_MISC5 "98640A"
  165. #define DIO_ID_MISC6 0x16 /* 98659A */
  166. #define DIO_DESC_MISC6 "98659A"
  167. #define DIO_ID_MISC7 0x19 /* 237 display */
  168. #define DIO_DESC_MISC7 "237 display"
  169. #define DIO_ID_MISC8 0x1a /* quad-wide card */
  170. #define DIO_DESC_MISC8 "quad-wide card"
  171. #define DIO_ID_MISC9 0x1b /* 98253A */
  172. #define DIO_DESC_MISC9 "98253A"
  173. #define DIO_ID_MISC10 0x1c /* 98627A */
  174. #define DIO_DESC_MISC10 "98253A"
  175. #define DIO_ID_MISC11 0x1d /* 98633A */
  176. #define DIO_DESC_MISC11 "98633A"
  177. #define DIO_ID_MISC12 0x1e /* 98259A */
  178. #define DIO_DESC_MISC12 "98259A"
  179. #define DIO_ID_MISC13 0x1f /* 8741 */
  180. #define DIO_DESC_MISC13 "8741"
  181. #define DIO_ID_VME 0x31 /* 98577A VME adapter */
  182. #define DIO_DESC_VME "98577A VME adapter"
  183. #define DIO_ID_DCL 0x34 /* 98628A serial */
  184. #define DIO_DESC_DCL "98628A DCL serial"
  185. #define DIO_ID_DCLREM 0xb4 /* 98628A serial */
  186. #define DIO_DESC_DCLREM "98628A DCLREM serial"
  187. /* These are the secondary IDs for the framebuffers */
  188. #define DIO_ID2_GATORBOX 0x01 /* 98700/98710 "gatorbox" */
  189. #define DIO_DESC2_GATORBOX "98700/98710 \"gatorbox\" display"
  190. #define DIO_ID2_TOPCAT 0x02 /* 98544/98545/98547 "topcat" */
  191. #define DIO_DESC2_TOPCAT "98544/98545/98547 \"topcat\" display"
  192. #define DIO_ID2_RENAISSANCE 0x04 /* 98720/98721 "renaissance" */
  193. #define DIO_DESC2_RENAISSANCE "98720/98721 \"renaissance\" display"
  194. #define DIO_ID2_LRCATSEYE 0x05 /* lowres "catseye" */
  195. #define DIO_DESC2_LRCATSEYE "low-res catseye display"
  196. #define DIO_ID2_HRCCATSEYE 0x06 /* highres colour "catseye" */
  197. #define DIO_DESC2_HRCCATSEYE "high-res color catseye display"
  198. #define DIO_ID2_HRMCATSEYE 0x07 /* highres mono "catseye" */
  199. #define DIO_DESC2_HRMCATSEYE "high-res mono catseye display"
  200. #define DIO_ID2_DAVINCI 0x08 /* 98730/98731 "davinci" */
  201. #define DIO_DESC2_DAVINCI "98730/98731 \"davinci\" display"
  202. #define DIO_ID2_XXXCATSEYE 0x09 /* "catseye" */
  203. #define DIO_DESC2_XXXCATSEYE "catseye display"
  204. #define DIO_ID2_HYPERION 0x0e /* A1096A "hyperion" */
  205. #define DIO_DESC2_HYPERION "A1096A \"hyperion\" display"
  206. #define DIO_ID2_XGENESIS 0x0b /* "x-genesis"; no NetBSD support */
  207. #define DIO_DESC2_XGENESIS "\"x-genesis\" display"
  208. #define DIO_ID2_TIGER 0x0c /* "tiger"; no NetBSD support */
  209. #define DIO_DESC2_TIGER "\"tiger\" display"
  210. #define DIO_ID2_YGENESIS 0x0d /* "y-genesis"; no NetBSD support */
  211. #define DIO_DESC2_YGENESIS "\"y-genesis\" display"
  212. /* if you add new IDs then you should tell dio.c about them so it can
  213. * identify them...
  214. */
  215. extern int dio_find(int deviceid);
  216. extern unsigned long dio_scodetophysaddr(int scode);
  217. extern int dio_create_sysfs_dev_files(struct dio_dev *);
  218. /* New-style probing */
  219. extern int dio_register_driver(struct dio_driver *);
  220. extern void dio_unregister_driver(struct dio_driver *);
  221. #define dio_resource_start(d) ((d)->resource.start)
  222. #define dio_resource_end(d) ((d)->resource.end)
  223. #define dio_resource_len(d) (resource_size(&(d)->resource))
  224. #define dio_resource_flags(d) ((d)->resource.flags)
  225. #define dio_request_device(d, name) \
  226. request_mem_region(dio_resource_start(d), dio_resource_len(d), name)
  227. #define dio_release_device(d) \
  228. release_mem_region(dio_resource_start(d), dio_resource_len(d))
  229. /* Similar to the helpers above, these manipulate per-dio_dev
  230. * driver-specific data. They are really just a wrapper around
  231. * the generic device structure functions of these calls.
  232. */
  233. static inline void *dio_get_drvdata (struct dio_dev *d)
  234. {
  235. return dev_get_drvdata(&d->dev);
  236. }
  237. static inline void dio_set_drvdata (struct dio_dev *d, void *data)
  238. {
  239. dev_set_drvdata(&d->dev, data);
  240. }
  241. #endif /* __KERNEL__ */
  242. #endif /* ndef _LINUX_DIO_H */