You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

isapnp.h 7.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. /**************************************************************************
  2. *
  3. * isapnp.h -- Etherboot isapnp support for the 3Com 3c515
  4. * Written 2002-2003 by Timothy Legge <tlegge@rogers.com>
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software
  18. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19. *
  20. * Portions of this code:
  21. * Copyright (C) 2001 P.J.H.Fox (fox@roestock.demon.co.uk)
  22. *
  23. *
  24. *
  25. * REVISION HISTORY:
  26. * ================
  27. * Version 0.1 April 26, 2002 TJL
  28. * Version 0.2 01/08/2003 TJL Renamed from 3c515_isapnp.h
  29. *
  30. *
  31. * Generalised into an ISAPnP bus that can be used by more than just
  32. * the 3c515 by Michael Brown <mbrown@fensystems.co.uk>
  33. *
  34. ***************************************************************************/
  35. #ifndef ISAPNP_H
  36. #define ISAPNP_H
  37. #include <stdint.h>
  38. #include <gpxe/isa_ids.h>
  39. #include <gpxe/device.h>
  40. #include <gpxe/tables.h>
  41. /*
  42. * ISAPnP constants
  43. *
  44. */
  45. /* Port addresses */
  46. #define ISAPNP_ADDRESS 0x279
  47. #define ISAPNP_WRITE_DATA 0xa79
  48. #define ISAPNP_READ_PORT_MIN 0x213 /* ISAPnP spec says 0x203, but
  49. * Linux ISAPnP starts at
  50. * 0x213 with no explanatory
  51. * comment. 0x203 probably
  52. * clashes with something. */
  53. #define ISAPNP_READ_PORT_MAX 0x3ff
  54. #define ISAPNP_READ_PORT_STEP 0x10 /* Can be any multiple of 4
  55. * according to the spec, but
  56. * since ISA I/O addresses are
  57. * allocated in blocks of 16,
  58. * it makes no sense to use
  59. * any value less than 16.
  60. */
  61. /* Registers */
  62. #define ISAPNP_READPORT 0x00
  63. #define ISAPNP_SERIALISOLATION 0x01
  64. #define ISAPNP_CONFIGCONTROL 0x02
  65. #define ISAPNP_WAKE 0x03
  66. #define ISAPNP_RESOURCEDATA 0x04
  67. #define ISAPNP_STATUS 0x05
  68. #define ISAPNP_CARDSELECTNUMBER 0x06
  69. #define ISAPNP_LOGICALDEVICENUMBER 0x07
  70. #define ISAPNP_ACTIVATE 0x30
  71. #define ISAPNP_IORANGECHECK 0x31
  72. #define ISAPNP_IOBASE(n) ( 0x60 + ( (n) * 2 ) )
  73. #define ISAPNP_IRQNO(n) ( 0x70 + ( (n) * 2 ) )
  74. #define ISAPNP_IRQTYPE(n) ( 0x71 + ( (n) * 2 ) )
  75. /* Bits in the CONFIGCONTROL register */
  76. #define ISAPNP_CONFIG_RESET ( 1 << 0 )
  77. #define ISAPNP_CONFIG_WAIT_FOR_KEY ( 1 << 1 )
  78. #define ISAPNP_CONFIG_RESET_CSN ( 1 << 2 )
  79. #define ISAPNP_CONFIG_RESET_DRV ( ISAPNP_CONFIG_RESET | \
  80. ISAPNP_CONFIG_WAIT_FOR_KEY | \
  81. ISAPNP_CONFIG_RESET_CSN )
  82. /* The LFSR used for the initiation key and for checksumming */
  83. #define ISAPNP_LFSR_SEED 0x6a
  84. /* Small tags */
  85. #define ISAPNP_IS_SMALL_TAG(tag) ( ! ( (tag) & 0x80 ) )
  86. #define ISAPNP_SMALL_TAG_NAME(tag) ( ( (tag) >> 3 ) & 0xf )
  87. #define ISAPNP_SMALL_TAG_LEN(tag) ( ( (tag) & 0x7 ) )
  88. #define ISAPNP_TAG_PNPVERNO 0x01
  89. #define ISAPNP_TAG_LOGDEVID 0x02
  90. #define ISAPNP_TAG_COMPATDEVID 0x03
  91. #define ISAPNP_TAG_IRQ 0x04
  92. #define ISAPNP_TAG_DMA 0x05
  93. #define ISAPNP_TAG_STARTDEP 0x06
  94. #define ISAPNP_TAG_ENDDEP 0x07
  95. #define ISAPNP_TAG_IOPORT 0x08
  96. #define ISAPNP_TAG_FIXEDIO 0x09
  97. #define ISAPNP_TAG_RSVDSHORTA 0x0A
  98. #define ISAPNP_TAG_RSVDSHORTB 0x0B
  99. #define ISAPNP_TAG_RSVDSHORTC 0x0C
  100. #define ISAPNP_TAG_RSVDSHORTD 0x0D
  101. #define ISAPNP_TAG_VENDORSHORT 0x0E
  102. #define ISAPNP_TAG_END 0x0F
  103. /* Large tags */
  104. #define ISAPNP_IS_LARGE_TAG(tag) ( ( (tag) & 0x80 ) )
  105. #define ISAPNP_LARGE_TAG_NAME(tag) (tag)
  106. #define ISAPNP_TAG_MEMRANGE 0x81
  107. #define ISAPNP_TAG_ANSISTR 0x82
  108. #define ISAPNP_TAG_UNICODESTR 0x83
  109. #define ISAPNP_TAG_VENDORLONG 0x84
  110. #define ISAPNP_TAG_MEM32RANGE 0x85
  111. #define ISAPNP_TAG_FIXEDMEM32RANGE 0x86
  112. #define ISAPNP_TAG_RSVDLONG0 0xF0
  113. #define ISAPNP_TAG_RSVDLONG1 0xF1
  114. #define ISAPNP_TAG_RSVDLONG2 0xF2
  115. #define ISAPNP_TAG_RSVDLONG3 0xF3
  116. #define ISAPNP_TAG_RSVDLONG4 0xF4
  117. #define ISAPNP_TAG_RSVDLONG5 0xF5
  118. #define ISAPNP_TAG_RSVDLONG6 0xF6
  119. #define ISAPNP_TAG_RSVDLONG7 0xF7
  120. #define ISAPNP_TAG_RSVDLONG8 0xF8
  121. #define ISAPNP_TAG_RSVDLONG9 0xF9
  122. #define ISAPNP_TAG_RSVDLONGA 0xFA
  123. #define ISAPNP_TAG_RSVDLONGB 0xFB
  124. #define ISAPNP_TAG_RSVDLONGC 0xFC
  125. #define ISAPNP_TAG_RSVDLONGD 0xFD
  126. #define ISAPNP_TAG_RSVDLONGE 0xFE
  127. #define ISAPNP_TAG_RSVDLONGF 0xFF
  128. #define ISAPNP_TAG_PSEUDO_NEWBOARD 0x100
  129. /** An ISAPnP serial identifier */
  130. struct isapnp_identifier {
  131. /** Vendor ID */
  132. uint16_t vendor_id;
  133. /** Product ID */
  134. uint16_t prod_id;
  135. /** Serial number */
  136. uint32_t serial;
  137. /** Checksum */
  138. uint8_t checksum;
  139. } __attribute__ (( packed ));
  140. /** An ISAPnP logical device ID structure */
  141. struct isapnp_logdevid {
  142. /** Vendor ID */
  143. uint16_t vendor_id;
  144. /** Product ID */
  145. uint16_t prod_id;
  146. /** Flags */
  147. uint16_t flags;
  148. } __attribute__ (( packed ));
  149. /** An ISAPnP device ID list entry */
  150. struct isapnp_device_id {
  151. /** Name */
  152. const char *name;
  153. /** Vendor ID */
  154. uint16_t vendor_id;
  155. /** Product ID */
  156. uint16_t prod_id;
  157. };
  158. /** An ISAPnP device */
  159. struct isapnp_device {
  160. /** Generic device */
  161. struct device dev;
  162. /** Vendor ID */
  163. uint16_t vendor_id;
  164. /** Product ID */
  165. uint16_t prod_id;
  166. /** I/O address */
  167. uint16_t ioaddr;
  168. /** Interrupt number */
  169. uint8_t irqno;
  170. /** Card Select Number */
  171. uint8_t csn;
  172. /** Logical Device ID */
  173. uint8_t logdev;
  174. /** Driver for this device */
  175. struct isapnp_driver *driver;
  176. /** Driver-private data
  177. *
  178. * Use isapnp_set_drvdata() and isapnp_get_drvdata() to access
  179. * this field.
  180. */
  181. void *priv;
  182. /** Driver name */
  183. const char *driver_name;
  184. };
  185. /** An ISAPnP driver */
  186. struct isapnp_driver {
  187. /** ISAPnP ID table */
  188. struct isapnp_device_id *ids;
  189. /** Number of entries in ISAPnP ID table */
  190. unsigned int id_count;
  191. /**
  192. * Probe device
  193. *
  194. * @v isapnp ISAPnP device
  195. * @v id Matching entry in ID table
  196. * @ret rc Return status code
  197. */
  198. int ( * probe ) ( struct isapnp_device *isapnp,
  199. const struct isapnp_device_id *id );
  200. /**
  201. * Remove device
  202. *
  203. * @v isapnp ISAPnP device
  204. */
  205. void ( * remove ) ( struct isapnp_device *isapnp );
  206. };
  207. /** Declare an ISAPnP driver */
  208. #define __isapnp_driver __table ( struct isapnp_driver, isapnp_drivers, 01 )
  209. extern uint16_t isapnp_read_port;
  210. extern void isapnp_device_activation ( struct isapnp_device *isapnp,
  211. int activation );
  212. /**
  213. * Activate ISAPnP device
  214. *
  215. * @v isapnp ISAPnP device
  216. */
  217. static inline void activate_isapnp_device ( struct isapnp_device *isapnp ) {
  218. isapnp_device_activation ( isapnp, 1 );
  219. }
  220. /**
  221. * Deactivate ISAPnP device
  222. *
  223. * @v isapnp ISAPnP device
  224. */
  225. static inline void deactivate_isapnp_device ( struct isapnp_device *isapnp ) {
  226. isapnp_device_activation ( isapnp, 0 );
  227. }
  228. /**
  229. * Set ISAPnP driver-private data
  230. *
  231. * @v isapnp ISAPnP device
  232. * @v priv Private data
  233. */
  234. static inline void isapnp_set_drvdata ( struct isapnp_device *isapnp,
  235. void *priv ) {
  236. isapnp->priv = priv;
  237. }
  238. /**
  239. * Get ISAPnP driver-private data
  240. *
  241. * @v isapnp ISAPnP device
  242. * @ret priv Private data
  243. */
  244. static inline void * isapnp_get_drvdata ( struct isapnp_device *isapnp ) {
  245. return isapnp->priv;
  246. }
  247. #endif /* ISAPNP_H */