Now known to work with an old Adaptec 1505 that I found lying around.
[people/lynusvaz/gpxe.git] / src / include / isapnp.h
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
36 #ifndef ISAPNP_H
37 #define ISAPNP_H
38
39 #include "isa_ids.h"
40 #include "dev.h"
41
42 /*
43  * ISAPnP constants
44  *
45  */
46
47 /* Port addresses */
48 #define ISAPNP_ADDRESS          0x279
49 #define ISAPNP_WRITE_DATA       0xa79
50 #define ISAPNP_READ_PORT_MIN    0x213   /* ISAPnP spec says 0x203, but
51                                          * Linux ISAPnP starts at
52                                          * 0x213 with no explanatory
53                                          * comment.  0x203 probably
54                                          * clashes with something. */
55 #define ISAPNP_READ_PORT_MAX    0x3ff
56 #define ISAPNP_READ_PORT_STEP   0x08    /* Can be any multiple of 4 */
57
58 /* Registers */
59 #define ISAPNP_READPORT                 0x00
60 #define ISAPNP_SERIALISOLATION          0x01
61 #define ISAPNP_CONFIGCONTROL            0x02
62 #define ISAPNP_WAKE                     0x03
63 #define ISAPNP_RESOURCEDATA             0x04
64 #define ISAPNP_STATUS                   0x05
65 #define ISAPNP_CARDSELECTNUMBER         0x06
66 #define ISAPNP_LOGICALDEVICENUMBER      0x07
67 #define ISAPNP_ACTIVATE                 0x30
68 #define ISAPNP_IORANGECHECK             0x31
69 #define ISAPNP_IOBASE(n)                ( 0x60 + ( (n) * 2 ) )
70 #define ISAPNP_IRQNO(n)                 ( 0x70 + ( (n) * 2 ) )
71 #define ISAPNP_IRQTYPE(n)               ( 0x71 + ( (n) * 2 ) )
72
73 /* Bits in the CONFIGCONTROL register */
74 #define ISAPNP_CONFIG_RESET             ( 1 << 0 )
75 #define ISAPNP_CONFIG_WAIT_FOR_KEY      ( 1 << 1 )
76 #define ISAPNP_CONFIG_RESET_CSN         ( 1 << 2 )
77 #define ISAPNP_CONFIG_RESET_DRV         ( ISAPNP_CONFIG_RESET |         \
78                                           ISAPNP_CONFIG_WAIT_FOR_KEY |  \
79                                           ISAPNP_CONFIG_RESET_CSN )
80
81 /* The LFSR used for the initiation key and for checksumming */
82 #define ISAPNP_LFSR_SEED                0x6a
83
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
130 /*
131  * An ISAPnP serial identifier
132  *
133  */
134 struct isapnp_identifier {
135         uint16_t vendor_id;
136         uint16_t prod_id;
137         uint32_t serial;
138         uint8_t checksum;
139 } __attribute__ (( packed ));
140
141 /*
142  * An ISAPnP logical device ID structure
143  *
144  */
145 struct isapnp_logdevid {
146         uint16_t vendor_id;
147         uint16_t prod_id;
148         uint16_t flags;
149 } __attribute__ (( packed ));
150
151 /*
152  * A physical ISAPnP device
153  *
154  */
155 struct isapnp_device {
156         char *magic; /* must be first */
157         const char *name;
158         uint8_t csn;
159         uint8_t logdev;
160         uint16_t vendor_id;
161         uint16_t prod_id;
162         uint16_t ioaddr;
163         uint8_t irqno;
164         int already_tried;
165 };
166
167 /*
168  * An individual ISAPnP device identified by ID
169  *
170  */
171 struct isapnp_id {
172         const char *name;
173         uint16_t vendor_id, prod_id;
174 };
175
176 /*
177  * An ISAPnP driver, with a device ID (struct isapnp_id) table.
178  *
179  */
180 struct isapnp_driver {
181         const char *name;
182         struct isapnp_id *ids;
183         unsigned int id_count;
184 };
185
186 /*
187  * Define an ISAPnP driver
188  *
189  */
190 #define ISAPNP_DRIVER( driver_name, isapnp_ids ) {                      \
191         .name = driver_name,                                            \
192         .ids = isapnp_ids,                                              \
193         .id_count = sizeof ( isapnp_ids ) / sizeof ( isapnp_ids[0] ),   \
194 }
195
196 /*
197  * Functions in isapnp.c
198  *
199  */
200 extern int find_isapnp_device ( struct isapnp_device *isapnp,
201                                 struct isapnp_driver *driver );
202 extern int find_isapnp_boot_device ( struct dev *dev,
203                                      struct isapnp_driver *driver );
204 extern void activate_isapnp_device ( struct isapnp_device *isapnp,
205                                      int active );
206
207 #endif /* ISAPNP_H */