Added friendly enable/disable functions
[people/xl0/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 "stdint.h"
40 #include "nic.h"
41 #include "isa_ids.h"
42
43 /*
44  * ISAPnP constants
45  *
46  */
47
48 /* Port addresses */
49 #define ISAPNP_ADDRESS          0x279
50 #define ISAPNP_WRITE_DATA       0xa79
51 #define ISAPNP_READ_PORT_MIN    0x213   /* ISAPnP spec says 0x203, but
52                                          * Linux ISAPnP starts at
53                                          * 0x213 with no explanatory
54                                          * comment.  0x203 probably
55                                          * clashes with something. */
56 #define ISAPNP_READ_PORT_MAX    0x3ff
57 #define ISAPNP_READ_PORT_STEP   0x10    /* Can be any multiple of 4
58                                          * according to the spec, but
59                                          * since ISA I/O addresses are
60                                          * allocated in blocks of 16,
61                                          * it makes no sense to use
62                                          * any value less than 16.
63                                          */
64
65 /* Registers */
66 #define ISAPNP_READPORT                 0x00
67 #define ISAPNP_SERIALISOLATION          0x01
68 #define ISAPNP_CONFIGCONTROL            0x02
69 #define ISAPNP_WAKE                     0x03
70 #define ISAPNP_RESOURCEDATA             0x04
71 #define ISAPNP_STATUS                   0x05
72 #define ISAPNP_CARDSELECTNUMBER         0x06
73 #define ISAPNP_LOGICALDEVICENUMBER      0x07
74 #define ISAPNP_ACTIVATE                 0x30
75 #define ISAPNP_IORANGECHECK             0x31
76 #define ISAPNP_IOBASE(n)                ( 0x60 + ( (n) * 2 ) )
77 #define ISAPNP_IRQNO(n)                 ( 0x70 + ( (n) * 2 ) )
78 #define ISAPNP_IRQTYPE(n)               ( 0x71 + ( (n) * 2 ) )
79
80 /* Bits in the CONFIGCONTROL register */
81 #define ISAPNP_CONFIG_RESET             ( 1 << 0 )
82 #define ISAPNP_CONFIG_WAIT_FOR_KEY      ( 1 << 1 )
83 #define ISAPNP_CONFIG_RESET_CSN         ( 1 << 2 )
84 #define ISAPNP_CONFIG_RESET_DRV         ( ISAPNP_CONFIG_RESET |         \
85                                           ISAPNP_CONFIG_WAIT_FOR_KEY |  \
86                                           ISAPNP_CONFIG_RESET_CSN )
87
88 /* The LFSR used for the initiation key and for checksumming */
89 #define ISAPNP_LFSR_SEED                0x6a
90
91 /* Small tags */
92 #define ISAPNP_IS_SMALL_TAG(tag)        ( ! ( (tag) & 0x80 ) )
93 #define ISAPNP_SMALL_TAG_NAME(tag)      ( ( (tag) >> 3 ) & 0xf )
94 #define ISAPNP_SMALL_TAG_LEN(tag)       ( ( (tag) & 0x7 ) )
95 #define ISAPNP_TAG_PNPVERNO             0x01
96 #define ISAPNP_TAG_LOGDEVID             0x02
97 #define ISAPNP_TAG_COMPATDEVID          0x03
98 #define ISAPNP_TAG_IRQ                  0x04
99 #define ISAPNP_TAG_DMA                  0x05
100 #define ISAPNP_TAG_STARTDEP             0x06
101 #define ISAPNP_TAG_ENDDEP               0x07
102 #define ISAPNP_TAG_IOPORT               0x08
103 #define ISAPNP_TAG_FIXEDIO              0x09
104 #define ISAPNP_TAG_RSVDSHORTA           0x0A
105 #define ISAPNP_TAG_RSVDSHORTB           0x0B
106 #define ISAPNP_TAG_RSVDSHORTC           0x0C
107 #define ISAPNP_TAG_RSVDSHORTD           0x0D
108 #define ISAPNP_TAG_VENDORSHORT          0x0E
109 #define ISAPNP_TAG_END                  0x0F
110 /* Large tags */
111 #define ISAPNP_IS_LARGE_TAG(tag)        ( ( (tag) & 0x80 ) )
112 #define ISAPNP_LARGE_TAG_NAME(tag)      (tag)
113 #define ISAPNP_TAG_MEMRANGE             0x81
114 #define ISAPNP_TAG_ANSISTR              0x82
115 #define ISAPNP_TAG_UNICODESTR           0x83
116 #define ISAPNP_TAG_VENDORLONG           0x84
117 #define ISAPNP_TAG_MEM32RANGE           0x85
118 #define ISAPNP_TAG_FIXEDMEM32RANGE      0x86
119 #define ISAPNP_TAG_RSVDLONG0            0xF0
120 #define ISAPNP_TAG_RSVDLONG1            0xF1
121 #define ISAPNP_TAG_RSVDLONG2            0xF2
122 #define ISAPNP_TAG_RSVDLONG3            0xF3
123 #define ISAPNP_TAG_RSVDLONG4            0xF4
124 #define ISAPNP_TAG_RSVDLONG5            0xF5
125 #define ISAPNP_TAG_RSVDLONG6            0xF6
126 #define ISAPNP_TAG_RSVDLONG7            0xF7
127 #define ISAPNP_TAG_RSVDLONG8            0xF8
128 #define ISAPNP_TAG_RSVDLONG9            0xF9
129 #define ISAPNP_TAG_RSVDLONGA            0xFA
130 #define ISAPNP_TAG_RSVDLONGB            0xFB
131 #define ISAPNP_TAG_RSVDLONGC            0xFC
132 #define ISAPNP_TAG_RSVDLONGD            0xFD
133 #define ISAPNP_TAG_RSVDLONGE            0xFE
134 #define ISAPNP_TAG_RSVDLONGF            0xFF
135 #define ISAPNP_TAG_PSEUDO_NEWBOARD      0x100
136
137 /*
138  * An ISAPnP serial identifier
139  *
140  */
141 struct isapnp_identifier {
142         uint16_t vendor_id;
143         uint16_t prod_id;
144         uint32_t serial;
145         uint8_t checksum;
146 } __attribute__ (( packed ));
147
148 /*
149  * An ISAPnP logical device ID structure
150  *
151  */
152 struct isapnp_logdevid {
153         uint16_t vendor_id;
154         uint16_t prod_id;
155         uint16_t flags;
156 } __attribute__ (( packed ));
157
158 /*
159  * A location on an ISAPnP bus
160  *
161  */
162 struct isapnp_loc {
163         uint8_t csn;
164         uint8_t logdev;
165 };
166
167 /*
168  * A physical ISAPnP device
169  *
170  */
171 struct isapnp_device {
172         const char *name;
173         uint8_t csn;
174         uint8_t logdev;
175         uint16_t vendor_id;
176         uint16_t prod_id;
177         uint16_t ioaddr;
178         uint8_t irqno;
179 };
180
181 /*
182  * An individual ISAPnP device identified by ID
183  *
184  */
185 struct isapnp_id {
186         const char *name;
187         uint16_t vendor_id, prod_id;
188 };
189
190 /*
191  * An ISAPnP driver, with a device ID (struct isapnp_id) table.
192  *
193  */
194 struct isapnp_driver {
195         struct isapnp_id *ids;
196         unsigned int id_count;
197 };
198
199 /*
200  * Define an ISAPnP driver
201  *
202  */
203 #define ISAPNP_DRIVER( _ids ) {                                 \
204         .ids = _ids,                                            \
205         .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),       \
206 }
207
208 /*
209  * Functions in isapnp.c
210  *
211  */
212 extern void isapnp_device_activation ( struct isapnp_device *isapnp,
213                                        int activation );
214 extern void isapnp_fill_nic ( struct nic *nic, struct isapnp_device *isapnp );
215
216 static inline void activate_isapnp_device ( struct isapnp_device *isapnp ) {
217         isapnp_device_activation ( isapnp, 1 );
218 }
219 static inline void deactivate_isapnp_device ( struct isapnp_device *isapnp ) {
220         isapnp_device_activation ( isapnp, 0 );
221 }
222
223 /*
224  * ISAPnP bus global definition
225  *
226  */
227 extern struct bus_driver isapnp_driver;
228
229 /*
230  * ISAPnP read port.  ROM prefix may be able to set this address.
231  *
232  */
233 extern uint16_t isapnp_read_port;
234
235 #endif /* ISAPNP_H */