1479ab7f0SSascha Wildner /*-
2479ab7f0SSascha Wildner * Copyright (c) 1998, Michael Smith
3479ab7f0SSascha Wildner * Copyright (c) 1996, Sujal M. Patel
4479ab7f0SSascha Wildner * All rights reserved.
5479ab7f0SSascha Wildner *
6479ab7f0SSascha Wildner * Redistribution and use in source and binary forms, with or without
7479ab7f0SSascha Wildner * modification, are permitted provided that the following conditions
8479ab7f0SSascha Wildner * are met:
9479ab7f0SSascha Wildner * 1. Redistributions of source code must retain the above copyright
10479ab7f0SSascha Wildner * notice, this list of conditions and the following disclaimer.
11479ab7f0SSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
12479ab7f0SSascha Wildner * notice, this list of conditions and the following disclaimer in the
13479ab7f0SSascha Wildner * documentation and/or other materials provided with the distribution.
14479ab7f0SSascha Wildner *
15479ab7f0SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16479ab7f0SSascha Wildner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17479ab7f0SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18479ab7f0SSascha Wildner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19479ab7f0SSascha Wildner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20479ab7f0SSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21479ab7f0SSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22479ab7f0SSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23479ab7f0SSascha Wildner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24479ab7f0SSascha Wildner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25479ab7f0SSascha Wildner * SUCH DAMAGE.
26479ab7f0SSascha Wildner *
27479ab7f0SSascha Wildner * $FreeBSD: src/sys/boot/common/isapnp.c,v 1.7 2003/08/25 23:30:41 obrien Exp $
28479ab7f0SSascha Wildner */
29479ab7f0SSascha Wildner
30479ab7f0SSascha Wildner /*
31*e782c7f6SSascha Wildner * Machine-independent ISA PnP enumerator implementing a subset of the
32479ab7f0SSascha Wildner * ISA PnP specification.
33479ab7f0SSascha Wildner */
34479ab7f0SSascha Wildner #include <stand.h>
35479ab7f0SSascha Wildner #include <string.h>
36479ab7f0SSascha Wildner #include <bootstrap.h>
37479ab7f0SSascha Wildner #include <isapnp.h>
38479ab7f0SSascha Wildner
39479ab7f0SSascha Wildner #define inb(x) (archsw.arch_isainb((x)))
40479ab7f0SSascha Wildner #define outb(x,y) (archsw.arch_isaoutb((x),(y)))
41479ab7f0SSascha Wildner
42479ab7f0SSascha Wildner static void isapnp_write(int d, int r);
43479ab7f0SSascha Wildner static void isapnp_send_Initiation_LFSR(void);
44479ab7f0SSascha Wildner static int isapnp_get_serial(u_int8_t *p);
45479ab7f0SSascha Wildner static int isapnp_isolation_protocol(void);
46479ab7f0SSascha Wildner static void isapnp_enumerate(void);
47479ab7f0SSascha Wildner
48479ab7f0SSascha Wildner /* PnP read data port */
49479ab7f0SSascha Wildner int isapnp_readport = 0;
50479ab7f0SSascha Wildner
51479ab7f0SSascha Wildner #define _PNP_ID_LEN 9
52479ab7f0SSascha Wildner
53479ab7f0SSascha Wildner struct pnphandler isapnphandler =
54479ab7f0SSascha Wildner {
55479ab7f0SSascha Wildner "ISA bus",
56479ab7f0SSascha Wildner isapnp_enumerate
57479ab7f0SSascha Wildner };
58479ab7f0SSascha Wildner
59479ab7f0SSascha Wildner static void
isapnp_write(int d,int r)60479ab7f0SSascha Wildner isapnp_write(int d, int r)
61479ab7f0SSascha Wildner {
62479ab7f0SSascha Wildner outb (_PNP_ADDRESS, d);
63479ab7f0SSascha Wildner outb (_PNP_WRITE_DATA, r);
64479ab7f0SSascha Wildner }
65479ab7f0SSascha Wildner
66479ab7f0SSascha Wildner /*
67479ab7f0SSascha Wildner * Send Initiation LFSR as described in "Plug and Play ISA Specification",
68479ab7f0SSascha Wildner * Intel May 94.
69479ab7f0SSascha Wildner */
70479ab7f0SSascha Wildner static void
isapnp_send_Initiation_LFSR(void)71479ab7f0SSascha Wildner isapnp_send_Initiation_LFSR(void)
72479ab7f0SSascha Wildner {
73479ab7f0SSascha Wildner int cur, i;
74479ab7f0SSascha Wildner
75479ab7f0SSascha Wildner /* Reset the LSFR */
76479ab7f0SSascha Wildner outb(_PNP_ADDRESS, 0);
77479ab7f0SSascha Wildner outb(_PNP_ADDRESS, 0); /* yes, we do need it twice! */
78479ab7f0SSascha Wildner
79479ab7f0SSascha Wildner cur = 0x6a;
80479ab7f0SSascha Wildner outb(_PNP_ADDRESS, cur);
81479ab7f0SSascha Wildner
82479ab7f0SSascha Wildner for (i = 1; i < 32; i++) {
83479ab7f0SSascha Wildner cur = (cur >> 1) | (((cur ^ (cur >> 1)) << 7) & 0xff);
84479ab7f0SSascha Wildner outb(_PNP_ADDRESS, cur);
85479ab7f0SSascha Wildner }
86479ab7f0SSascha Wildner }
87479ab7f0SSascha Wildner
88479ab7f0SSascha Wildner /*
89479ab7f0SSascha Wildner * Get the device's serial number. Returns 1 if the serial is valid.
90479ab7f0SSascha Wildner */
91479ab7f0SSascha Wildner static int
isapnp_get_serial(u_int8_t * data)92479ab7f0SSascha Wildner isapnp_get_serial(u_int8_t *data)
93479ab7f0SSascha Wildner {
94479ab7f0SSascha Wildner int i, bit, valid = 0, sum = 0x6a;
95479ab7f0SSascha Wildner
96479ab7f0SSascha Wildner bzero(data, _PNP_ID_LEN);
97479ab7f0SSascha Wildner outb(_PNP_ADDRESS, SERIAL_ISOLATION);
98479ab7f0SSascha Wildner for (i = 0; i < 72; i++) {
99479ab7f0SSascha Wildner bit = inb(isapnp_readport) == 0x55;
100479ab7f0SSascha Wildner delay(250); /* Delay 250 usec */
101479ab7f0SSascha Wildner
102479ab7f0SSascha Wildner /* Can't Short Circuit the next evaluation, so 'and' is last */
103479ab7f0SSascha Wildner bit = (inb(isapnp_readport) == 0xaa) && bit;
104479ab7f0SSascha Wildner delay(250); /* Delay 250 usec */
105479ab7f0SSascha Wildner
106479ab7f0SSascha Wildner valid = valid || bit;
107479ab7f0SSascha Wildner
108479ab7f0SSascha Wildner if (i < 64)
109479ab7f0SSascha Wildner sum = (sum >> 1) |
110479ab7f0SSascha Wildner (((sum ^ (sum >> 1) ^ bit) << 7) & 0xff);
111479ab7f0SSascha Wildner
112479ab7f0SSascha Wildner data[i / 8] = (data[i / 8] >> 1) | (bit ? 0x80 : 0);
113479ab7f0SSascha Wildner }
114479ab7f0SSascha Wildner
115479ab7f0SSascha Wildner valid = valid && (data[8] == sum);
116479ab7f0SSascha Wildner
117479ab7f0SSascha Wildner return valid;
118479ab7f0SSascha Wildner }
119479ab7f0SSascha Wildner
120479ab7f0SSascha Wildner /*
121479ab7f0SSascha Wildner * Fills the buffer with resource info from the device.
122479ab7f0SSascha Wildner * Returns nonzero if the device fails to report
123479ab7f0SSascha Wildner */
124479ab7f0SSascha Wildner static int
isapnp_get_resource_info(u_int8_t * buffer,int len)125479ab7f0SSascha Wildner isapnp_get_resource_info(u_int8_t *buffer, int len)
126479ab7f0SSascha Wildner {
127479ab7f0SSascha Wildner int i, j;
128479ab7f0SSascha Wildner u_char temp;
129479ab7f0SSascha Wildner
130479ab7f0SSascha Wildner for (i = 0; i < len; i++) {
131479ab7f0SSascha Wildner outb(_PNP_ADDRESS, STATUS);
132479ab7f0SSascha Wildner for (j = 0; j < 100; j++) {
133479ab7f0SSascha Wildner if ((inb(isapnp_readport)) & 0x1)
134479ab7f0SSascha Wildner break;
135479ab7f0SSascha Wildner delay(1);
136479ab7f0SSascha Wildner }
137479ab7f0SSascha Wildner if (j == 100) {
138479ab7f0SSascha Wildner printf("PnP device failed to report resource data\n");
139479ab7f0SSascha Wildner return(1);
140479ab7f0SSascha Wildner }
141479ab7f0SSascha Wildner outb(_PNP_ADDRESS, RESOURCE_DATA);
142479ab7f0SSascha Wildner temp = inb(isapnp_readport);
143479ab7f0SSascha Wildner if (buffer != NULL)
144479ab7f0SSascha Wildner buffer[i] = temp;
145479ab7f0SSascha Wildner }
146479ab7f0SSascha Wildner return(0);
147479ab7f0SSascha Wildner }
148479ab7f0SSascha Wildner
149479ab7f0SSascha Wildner /*
150479ab7f0SSascha Wildner * Scan Resource Data for useful information.
151479ab7f0SSascha Wildner *
152479ab7f0SSascha Wildner * We scan the resource data for compatible device IDs and
153479ab7f0SSascha Wildner * identifier strings; we only take the first identifier string
154479ab7f0SSascha Wildner * and assume it's for the card as a whole.
155479ab7f0SSascha Wildner *
156479ab7f0SSascha Wildner * Returns 0 if the scan completed OK, nonzero on error.
157479ab7f0SSascha Wildner */
158479ab7f0SSascha Wildner static int
isapnp_scan_resdata(struct pnpinfo * pi)159479ab7f0SSascha Wildner isapnp_scan_resdata(struct pnpinfo *pi)
160479ab7f0SSascha Wildner {
161479ab7f0SSascha Wildner u_char tag, resinfo[8];
162479ab7f0SSascha Wildner u_int limit;
163479ab7f0SSascha Wildner size_t large_len;
164479ab7f0SSascha Wildner u_char *str;
165479ab7f0SSascha Wildner
166479ab7f0SSascha Wildner limit = 1000;
167479ab7f0SSascha Wildner while ((limit-- > 0) && !isapnp_get_resource_info(&tag, 1)) {
168479ab7f0SSascha Wildner if (PNP_RES_TYPE(tag) == 0) {
169479ab7f0SSascha Wildner /* Small resource */
170479ab7f0SSascha Wildner switch (PNP_SRES_NUM(tag)) {
171479ab7f0SSascha Wildner
172479ab7f0SSascha Wildner case COMP_DEVICE_ID:
173479ab7f0SSascha Wildner /* Got a compatible device id resource */
174479ab7f0SSascha Wildner if (isapnp_get_resource_info(resinfo, PNP_SRES_LEN(tag)))
175479ab7f0SSascha Wildner return(1);
176479ab7f0SSascha Wildner pnp_addident(pi, pnp_eisaformat(resinfo));
177479ab7f0SSascha Wildner
178479ab7f0SSascha Wildner case END_TAG:
179479ab7f0SSascha Wildner return(0);
180479ab7f0SSascha Wildner break;
181479ab7f0SSascha Wildner
182479ab7f0SSascha Wildner default:
183479ab7f0SSascha Wildner /* Skip this resource */
184479ab7f0SSascha Wildner if (isapnp_get_resource_info(NULL, PNP_SRES_LEN(tag)))
185479ab7f0SSascha Wildner return(1);
186479ab7f0SSascha Wildner break;
187479ab7f0SSascha Wildner }
188479ab7f0SSascha Wildner } else {
189479ab7f0SSascha Wildner /* Large resource */
190479ab7f0SSascha Wildner if (isapnp_get_resource_info(resinfo, 2))
191479ab7f0SSascha Wildner return(1);
192479ab7f0SSascha Wildner
193479ab7f0SSascha Wildner large_len = resinfo[1];
194479ab7f0SSascha Wildner large_len = (large_len << 8) + resinfo[0];
195479ab7f0SSascha Wildner
196479ab7f0SSascha Wildner switch(PNP_LRES_NUM(tag)) {
197479ab7f0SSascha Wildner
198479ab7f0SSascha Wildner case ID_STRING_ANSI:
199479ab7f0SSascha Wildner str = malloc(large_len + 1);
200479ab7f0SSascha Wildner if (isapnp_get_resource_info(str, (ssize_t)large_len)) {
201479ab7f0SSascha Wildner free(str);
202479ab7f0SSascha Wildner return(1);
203479ab7f0SSascha Wildner }
204479ab7f0SSascha Wildner str[large_len] = 0;
205479ab7f0SSascha Wildner if (pi->pi_desc == NULL) {
206479ab7f0SSascha Wildner pi->pi_desc = (char *)str;
207479ab7f0SSascha Wildner } else {
208479ab7f0SSascha Wildner free(str);
209479ab7f0SSascha Wildner }
210479ab7f0SSascha Wildner break;
211479ab7f0SSascha Wildner
212479ab7f0SSascha Wildner default:
213479ab7f0SSascha Wildner /* Large resource, skip it */
214479ab7f0SSascha Wildner if (isapnp_get_resource_info(NULL, (ssize_t)large_len))
215479ab7f0SSascha Wildner return(1);
216479ab7f0SSascha Wildner }
217479ab7f0SSascha Wildner }
218479ab7f0SSascha Wildner }
219479ab7f0SSascha Wildner return(1);
220479ab7f0SSascha Wildner }
221479ab7f0SSascha Wildner
222479ab7f0SSascha Wildner /*
223479ab7f0SSascha Wildner * Run the isolation protocol. Upon exiting, all cards are aware that
224479ab7f0SSascha Wildner * they should use isapnp_readport as the READ_DATA port.
225479ab7f0SSascha Wildner */
226479ab7f0SSascha Wildner static int
isapnp_isolation_protocol(void)227479ab7f0SSascha Wildner isapnp_isolation_protocol(void)
228479ab7f0SSascha Wildner {
229479ab7f0SSascha Wildner int csn;
230479ab7f0SSascha Wildner struct pnpinfo *pi;
231479ab7f0SSascha Wildner u_int8_t cardid[_PNP_ID_LEN];
232479ab7f0SSascha Wildner int ndevs;
233479ab7f0SSascha Wildner
234479ab7f0SSascha Wildner isapnp_send_Initiation_LFSR();
235479ab7f0SSascha Wildner ndevs = 0;
236479ab7f0SSascha Wildner
237479ab7f0SSascha Wildner isapnp_write(CONFIG_CONTROL, 0x04); /* Reset CSN for All Cards */
238479ab7f0SSascha Wildner
239479ab7f0SSascha Wildner for (csn = 1; ; csn++) {
240479ab7f0SSascha Wildner /* Wake up cards without a CSN (ie. all of them) */
241479ab7f0SSascha Wildner isapnp_write(WAKE, 0);
242479ab7f0SSascha Wildner isapnp_write(SET_RD_DATA, (isapnp_readport >> 2));
243479ab7f0SSascha Wildner outb(_PNP_ADDRESS, SERIAL_ISOLATION);
244479ab7f0SSascha Wildner delay(1000); /* Delay 1 msec */
245479ab7f0SSascha Wildner
246479ab7f0SSascha Wildner if (isapnp_get_serial(cardid)) {
247479ab7f0SSascha Wildner isapnp_write(SET_CSN, csn);
248479ab7f0SSascha Wildner pi = pnp_allocinfo();
249479ab7f0SSascha Wildner ndevs++;
250479ab7f0SSascha Wildner pnp_addident(pi, pnp_eisaformat(cardid));
251479ab7f0SSascha Wildner /* scan the card obtaining all the identifiers it holds */
252479ab7f0SSascha Wildner if (isapnp_scan_resdata(pi)) {
253479ab7f0SSascha Wildner pnp_freeinfo(pi); /* error getting data, ignore */
254479ab7f0SSascha Wildner } else {
255479ab7f0SSascha Wildner pnp_addinfo(pi);
256479ab7f0SSascha Wildner }
257479ab7f0SSascha Wildner } else {
258479ab7f0SSascha Wildner break;
259479ab7f0SSascha Wildner }
260479ab7f0SSascha Wildner }
261479ab7f0SSascha Wildner /* Move all cards to wait-for-key state */
262479ab7f0SSascha Wildner while (--csn > 0) {
263479ab7f0SSascha Wildner isapnp_send_Initiation_LFSR();
264479ab7f0SSascha Wildner isapnp_write(WAKE, csn);
265479ab7f0SSascha Wildner isapnp_write(CONFIG_CONTROL, 0x02);
266479ab7f0SSascha Wildner delay(1000); /* XXX is it really necessary ? */
267479ab7f0SSascha Wildner csn--;
268479ab7f0SSascha Wildner }
269479ab7f0SSascha Wildner return(ndevs);
270479ab7f0SSascha Wildner }
271479ab7f0SSascha Wildner
272479ab7f0SSascha Wildner /*
273479ab7f0SSascha Wildner * Locate ISA-PnP devices and populate the supplied list.
274479ab7f0SSascha Wildner */
275479ab7f0SSascha Wildner static void
isapnp_enumerate(void)276479ab7f0SSascha Wildner isapnp_enumerate(void)
277479ab7f0SSascha Wildner {
278479ab7f0SSascha Wildner int pnp_rd_port;
279479ab7f0SSascha Wildner
280479ab7f0SSascha Wildner /* Check for I/O port access */
281479ab7f0SSascha Wildner if ((archsw.arch_isainb == NULL) || (archsw.arch_isaoutb == NULL))
282479ab7f0SSascha Wildner return;
283479ab7f0SSascha Wildner
284479ab7f0SSascha Wildner /*
285479ab7f0SSascha Wildner * Validate a possibly-suggested read port value. If the autoscan failed
286479ab7f0SSascha Wildner * last time, this will return us to autoscan mode again.
287479ab7f0SSascha Wildner */
288479ab7f0SSascha Wildner if ((isapnp_readport > 0) &&
289479ab7f0SSascha Wildner (((isapnp_readport < 0x203) ||
290479ab7f0SSascha Wildner (isapnp_readport > 0x3ff) ||
291479ab7f0SSascha Wildner (isapnp_readport & 0x3) != 0x3)))
292479ab7f0SSascha Wildner /* invalid, go look for ourselves */
293479ab7f0SSascha Wildner isapnp_readport = 0;
294479ab7f0SSascha Wildner
295479ab7f0SSascha Wildner if (isapnp_readport < 0) {
296479ab7f0SSascha Wildner /* someone is telling us there is no ISA in the system */
297479ab7f0SSascha Wildner return;
298479ab7f0SSascha Wildner
299479ab7f0SSascha Wildner } else if (isapnp_readport > 0) {
300479ab7f0SSascha Wildner /* Someone has told us where the port is/should be, or we found one last time */
301479ab7f0SSascha Wildner isapnp_isolation_protocol();
302479ab7f0SSascha Wildner
303479ab7f0SSascha Wildner } else {
304479ab7f0SSascha Wildner /* No clues, look for it ourselves */
305479ab7f0SSascha Wildner for (pnp_rd_port = 0x80; pnp_rd_port < 0xff; pnp_rd_port += 0x10) {
306479ab7f0SSascha Wildner /* Look for something, quit when we find it */
307479ab7f0SSascha Wildner isapnp_readport = (pnp_rd_port << 2) | 0x3;
308479ab7f0SSascha Wildner if (isapnp_isolation_protocol() > 0)
309479ab7f0SSascha Wildner break;
310479ab7f0SSascha Wildner }
311479ab7f0SSascha Wildner }
312479ab7f0SSascha Wildner }
313