Optimise ISAPNP_READ_PORT_STEP
[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 "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   0x10    /* Can be any multiple of 4
57                                          * according to the spec, but
58                                          * since ISA I/O addresses are
59                                          * allocated in blocks of 16,
60                                          * it makes no sense to use
61                                          * any value less than 16.
62                                          */
63
64 /* Registers */
65 #define ISAPNP_READPORT                 0x00
66 #define ISAPNP_SERIALISOLATION          0x01
67 #define ISAPNP_CONFIGCONTROL            0x02
68 #define ISAPNP_WAKE                     0x03
69 #define ISAPNP_RESOURCEDATA             0x04
70 #define ISAPNP_STATUS                   0x05
71 #define ISAPNP_CARDSELECTNUMBER         0x06
72 #define ISAPNP_LOGICALDEVICENUMBER      0x07
73 #define ISAPNP_ACTIVATE                 0x30
74 #define ISAPNP_IORANGECHECK             0x31
75 #define ISAPNP_IOBASE(n)                ( 0x60 + ( (n) * 2 ) )
76 #define ISAPNP_IRQNO(n)                 ( 0x70 + ( (n) * 2 ) )
77 #define ISAPNP_IRQTYPE(n)               ( 0x71 + ( (n) * 2 ) )
78
79 /* Bits in the CONFIGCONTROL register */
80 #define ISAPNP_CONFIG_RESET             ( 1 << 0 )
81 #define ISAPNP_CONFIG_WAIT_FOR_KEY      ( 1 << 1 )
82 #define ISAPNP_CONFIG_RESET_CSN         ( 1 << 2 )
83 #define ISAPNP_CONFIG_RESET_DRV         ( ISAPNP_CONFIG_RESET |         \
84                                           ISAPNP_CONFIG_WAIT_FOR_KEY |  \
85                                           ISAPNP_CONFIG_RESET_CSN )
86
87 /* The LFSR used for the initiation key and for checksumming */
88 #define ISAPNP_LFSR_SEED                0x6a
89
90 /* Small tags */
91 #define ISAPNP_IS_SMALL_TAG(tag)        ( ! ( (tag) & 0x80 ) )
92 #define ISAPNP_SMALL_TAG_NAME(tag)      ( ( (tag) >> 3 ) & 0xf )
93 #define ISAPNP_SMALL_TAG_LEN(tag)       ( ( (tag) & 0x7 ) )
94 #define ISAPNP_TAG_PNPVERNO             0x01
95 #define ISAPNP_TAG_LOGDEVID             0x02
96 #define ISAPNP_TAG_COMPATDEVID          0x03
97 #define ISAPNP_TAG_IRQ                  0x04
98 #define ISAPNP_TAG_DMA                  0x05
99 #define ISAPNP_TAG_STARTDEP             0x06
100 #define ISAPNP_TAG_ENDDEP               0x07
101 #define ISAPNP_TAG_IOPORT               0x08
102 #define ISAPNP_TAG_FIXEDIO              0x09
103 #define ISAPNP_TAG_RSVDSHORTA           0x0A
104 #define ISAPNP_TAG_RSVDSHORTB           0x0B
105 #define ISAPNP_TAG_RSVDSHORTC           0x0C
106 #define ISAPNP_TAG_RSVDSHORTD           0x0D
107 #define ISAPNP_TAG_VENDORSHORT          0x0E
108 #define ISAPNP_TAG_END                  0x0F
109 /* Large tags */
110 #define ISAPNP_IS_LARGE_TAG(tag)        ( ( (tag) & 0x80 ) )
111 #define ISAPNP_LARGE_TAG_NAME(tag)      (tag)
112 #define ISAPNP_TAG_MEMRANGE             0x81
113 #define ISAPNP_TAG_ANSISTR              0x82
114 #define ISAPNP_TAG_UNICODESTR           0x83
115 #define ISAPNP_TAG_VENDORLONG           0x84
116 #define ISAPNP_TAG_MEM32RANGE           0x85
117 #define ISAPNP_TAG_FIXEDMEM32RANGE      0x86
118 #define ISAPNP_TAG_RSVDLONG0            0xF0
119 #define ISAPNP_TAG_RSVDLONG1            0xF1
120 #define ISAPNP_TAG_RSVDLONG2            0xF2
121 #define ISAPNP_TAG_RSVDLONG3            0xF3
122 #define ISAPNP_TAG_RSVDLONG4            0xF4
123 #define ISAPNP_TAG_RSVDLONG5            0xF5
124 #define ISAPNP_TAG_RSVDLONG6            0xF6
125 #define ISAPNP_TAG_RSVDLONG7            0xF7
126 #define ISAPNP_TAG_RSVDLONG8            0xF8
127 #define ISAPNP_TAG_RSVDLONG9            0xF9
128 #define ISAPNP_TAG_RSVDLONGA            0xFA
129 #define ISAPNP_TAG_RSVDLONGB            0xFB
130 #define ISAPNP_TAG_RSVDLONGC            0xFC
131 #define ISAPNP_TAG_RSVDLONGD            0xFD
132 #define ISAPNP_TAG_RSVDLONGE            0xFE
133 #define ISAPNP_TAG_RSVDLONGF            0xFF
134 #define ISAPNP_TAG_PSEUDO_NEWBOARD      0x100
135
136 /*
137  * An ISAPnP serial identifier
138  *
139  */
140 struct isapnp_identifier {
141         uint16_t vendor_id;
142         uint16_t prod_id;
143         uint32_t serial;
144         uint8_t checksum;
145 } __attribute__ (( packed ));
146
147 /*
148  * An ISAPnP logical device ID structure
149  *
150  */
151 struct isapnp_logdevid {
152         uint16_t vendor_id;
153         uint16_t prod_id;
154         uint16_t flags;
155 } __attribute__ (( packed ));
156
157 /*
158  * A physical ISAPnP device
159  *
160  */
161 struct isapnp_device {
162         char *magic; /* must be first */
163         const char *name;
164         uint8_t csn;
165         uint8_t logdev;
166         uint16_t vendor_id;
167         uint16_t prod_id;
168         uint16_t ioaddr;
169         uint8_t irqno;
170         int already_tried;
171 };
172
173 /*
174  * An individual ISAPnP device identified by ID
175  *
176  */
177 struct isapnp_id {
178         const char *name;
179         uint16_t vendor_id, prod_id;
180 };
181
182 /*
183  * An ISAPnP driver, with a device ID (struct isapnp_id) table.
184  *
185  */
186 struct isapnp_driver {
187         const char *name;
188         struct isapnp_id *ids;
189         unsigned int id_count;
190 };
191
192 /*
193  * Define an ISAPnP driver
194  *
195  */
196 #define ISAPNP_DRIVER( driver_name, isapnp_ids ) {                      \
197         .name = driver_name,                                            \
198         .ids = isapnp_ids,                                              \
199         .id_count = sizeof ( isapnp_ids ) / sizeof ( isapnp_ids[0] ),   \
200 }
201
202 /*
203  * Functions in isapnp.c
204  *
205  */
206 extern int find_isapnp_device ( struct isapnp_device *isapnp,
207                                 struct isapnp_driver *driver );
208 extern int find_isapnp_boot_device ( struct dev *dev,
209                                      struct isapnp_driver *driver );
210 extern void activate_isapnp_device ( struct isapnp_device *isapnp,
211                                      int active );
212
213 #endif /* ISAPNP_H */