xref: /netbsd-src/sys/dev/acpi/fdc_acpi.c (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /* $NetBSD: fdc_acpi.c,v 1.23 2004/10/28 07:07:39 yamt Exp $ */
2 
3 /*
4  * Copyright (c) 2002 Jared D. McNeill <jmcneill@invisible.ca>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. The name of the author may not be used to endorse or promote products
13  *    derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 /*
29  * ACPI attachment for the PC Floppy Controller driver, based on
30  * sys/arch/i386/pnpbios/fdc_pnpbios.c by Jason R. Thorpe
31  */
32 
33 #include <sys/cdefs.h>
34 __KERNEL_RCSID(0, "$NetBSD: fdc_acpi.c,v 1.23 2004/10/28 07:07:39 yamt Exp $");
35 
36 #include "rnd.h"
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/callout.h>
41 #include <sys/device.h>
42 #include <sys/buf.h>
43 #include <sys/bufq.h>
44 #include <sys/queue.h>
45 #include <sys/disk.h>
46 #if NRND > 0
47 #include <sys/rnd.h>
48 #endif
49 
50 #include <machine/bus.h>
51 #include <machine/intr.h>
52 
53 #include <dev/isa/isavar.h>
54 #include <dev/isa/isadmavar.h>
55 
56 #include <dev/acpi/acpica.h>
57 #include <dev/acpi/acpireg.h>
58 #include <dev/acpi/acpivar.h>
59 
60 #include <dev/isa/fdcvar.h>
61 #include <dev/isa/fdvar.h>
62 #include <dev/isa/fdreg.h>
63 
64 #include <dev/acpi/fdc_acpireg.h>
65 
66 static int	fdc_acpi_match(struct device *, struct cfdata *, void *);
67 static void	fdc_acpi_attach(struct device *, struct device *, void *);
68 
69 struct fdc_acpi_softc {
70 	struct fdc_softc sc_fdc;
71 	bus_space_handle_t sc_baseioh;
72 	struct acpi_devnode *sc_node;	/* ACPI devnode */
73 };
74 
75 static int	fdc_acpi_enumerate(struct fdc_acpi_softc *);
76 static void	fdc_acpi_getknownfds(struct fdc_acpi_softc *);
77 
78 static const struct fd_type *fdc_acpi_nvtotype(char *, int, int);
79 
80 CFATTACH_DECL(fdc_acpi, sizeof(struct fdc_acpi_softc), fdc_acpi_match,
81     fdc_acpi_attach, NULL, NULL);
82 
83 /*
84  * Supported device IDs
85  */
86 
87 static const char * const fdc_acpi_ids[] = {
88 	"PNP07??",	/* PC standard floppy disk controller */
89 	NULL
90 };
91 
92 /*
93  * fdc_acpi_match: autoconf(9) match routine
94  */
95 static int
96 fdc_acpi_match(struct device *parent, struct cfdata *match, void *aux)
97 {
98 	struct acpi_attach_args *aa = aux;
99 
100 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
101 		return 0;
102 
103 	return acpi_match_hid(aa->aa_node->ad_devinfo, fdc_acpi_ids);
104 }
105 
106 /*
107  * fdc_acpi_attach: autoconf(9) attach routine
108  */
109 static void
110 fdc_acpi_attach(struct device *parent, struct device *self, void *aux)
111 {
112 	struct fdc_acpi_softc *asc = (struct fdc_acpi_softc *)self;
113 	struct fdc_softc *sc = &asc->sc_fdc;
114 	struct acpi_attach_args *aa = aux;
115 	struct acpi_io *io, *ctlio;
116 	struct acpi_irq *irq;
117 	struct acpi_drq *drq;
118 	struct acpi_resources res;
119 	ACPI_STATUS rv;
120 
121 	printf("\n");
122 
123 	sc->sc_ic = aa->aa_ic;
124 	asc->sc_node = aa->aa_node;
125 
126 	/* parse resources */
127 	rv = acpi_resource_parse(&sc->sc_dev, aa->aa_node->ad_handle, "_CRS",
128 	    &res, &acpi_resource_parse_ops_default);
129 	if (ACPI_FAILURE(rv))
130 		return;
131 
132 	/* find our i/o registers */
133 	io = acpi_res_io(&res, 0);
134 	if (io == NULL) {
135 		printf("%s: unable to find i/o register resource\n",
136 		    sc->sc_dev.dv_xname);
137 		goto out;
138 	}
139 
140 	/* find our IRQ */
141 	irq = acpi_res_irq(&res, 0);
142 	if (irq == NULL) {
143 		printf("%s: unable to find irq resource\n",
144 		    sc->sc_dev.dv_xname);
145 		goto out;
146 	}
147 
148 	/* find our DRQ */
149 	drq = acpi_res_drq(&res, 0);
150 	if (drq == NULL) {
151 		printf("%s: unable to find drq resource\n",
152 		    sc->sc_dev.dv_xname);
153 		goto out;
154 	}
155 	sc->sc_drq = drq->ar_drq;
156 
157 	sc->sc_iot = aa->aa_iot;
158 	if (bus_space_map(sc->sc_iot, io->ar_base, io->ar_length,
159 		    0, &asc->sc_baseioh)) {
160 		printf("%s: can't map i/o space\n", sc->sc_dev.dv_xname);
161 		goto out;
162 	}
163 
164 	switch (io->ar_length) {
165 	case 4:
166 		sc->sc_ioh = asc->sc_baseioh;
167 		break;
168 	case 6:
169 		if (bus_space_subregion(sc->sc_iot, asc->sc_baseioh, 2, 4,
170 		    &sc->sc_ioh)) {
171 			printf("%s: unable to subregion i/o space\n",
172 			    sc->sc_dev.dv_xname);
173 			goto out;
174 		}
175 		break;
176 	default:
177 		printf("%s: unknown size: %d of io mapping\n",
178 		    sc->sc_dev.dv_xname, io->ar_length);
179 		goto out;
180 	}
181 
182 	/*
183 	 * omitting the controller I/O port. (One has to exist for there to
184 	 * be a working fdc). Just try and force the mapping in.
185 	 */
186 	ctlio = acpi_res_io(&res, 1);
187 	if (ctlio == NULL) {
188 		if (bus_space_map(sc->sc_iot, io->ar_base + io->ar_length + 1,
189 		    1, 0, &sc->sc_fdctlioh)) {
190 			printf("%s: unable to force map ctl i/o space\n",
191 			    sc->sc_dev.dv_xname);
192 			goto out;
193 		}
194 		printf("%s: ctl io %x did't probe. Forced attach\n",
195 		    sc->sc_dev.dv_xname, io->ar_base + io->ar_length + 1);
196 	} else {
197 		if (bus_space_map(sc->sc_iot, ctlio->ar_base, ctlio->ar_length,
198 		    0, &sc->sc_fdctlioh)) {
199 			printf("%s: unable to map ctl i/o space\n",
200 			    sc->sc_dev.dv_xname);
201 			goto out;
202 		}
203 	}
204 
205 	sc->sc_ih = isa_intr_establish(aa->aa_ic, irq->ar_irq,
206 	    (irq->ar_type == ACPI_EDGE_SENSITIVE) ? IST_EDGE : IST_LEVEL,
207 	    IPL_BIO, fdcintr, sc);
208 
209 	/* Setup direct configuration of floppy drives */
210 	sc->sc_present = fdc_acpi_enumerate(asc);
211 	if (sc->sc_present >= 0) {
212 		sc->sc_known = 1;
213 		fdc_acpi_getknownfds(asc);
214 	} else {
215 		/*
216 		 * XXX if there is no _FDE control method, attempt to
217 		 * probe without pnp
218 		 */
219 #ifdef ACPI_FDC_DEBUG
220 		printf("%s: unable to enumerate, attempting normal probe\n",
221 		    sc->sc_dev.dv_xname);
222 #endif
223 	}
224 
225 	fdcattach(sc);
226 
227  out:
228 	acpi_resource_cleanup(&res);
229 }
230 
231 static int
232 fdc_acpi_enumerate(struct fdc_acpi_softc *asc)
233 {
234 	struct fdc_softc *sc = &asc->sc_fdc;
235 	ACPI_OBJECT *fde;
236 	ACPI_BUFFER buf;
237 	ACPI_STATUS rv;
238 	UINT32 *p;
239 	int i, drives = -1;
240 
241 	rv = acpi_eval_struct(asc->sc_node->ad_handle, "_FDE", &buf);
242 	if (ACPI_FAILURE(rv)) {
243 #ifdef ACPI_FDC_DEBUG
244 		printf("%s: failed to evaluate _FDE: %s\n",
245 		    sc->sc_dev.dv_xname, rv, AcpiFormatException(rv));
246 #endif
247 		return drives;
248 	}
249 	fde = (ACPI_OBJECT *)buf.Pointer;
250 	if (fde->Type != ACPI_TYPE_BUFFER) {
251 		printf("%s: expected BUFFER, got %d\n", sc->sc_dev.dv_xname,
252 		    fde->Type);
253 		goto out;
254 	}
255 	if (fde->Buffer.Length < 5 * sizeof(UINT32)) {
256 		printf("%s: expected buffer len of %lu, got %d\n",
257 		    sc->sc_dev.dv_xname,
258 		    (unsigned long)(5 * sizeof(UINT32)), fde->Buffer.Length);
259 		goto out;
260 	}
261 
262 	p = (UINT32 *) fde->Buffer.Pointer;
263 
264 	/*
265 	 * Indexes 0 through 3 are each UINT32 booleans. True if a drive
266 	 * is present.
267 	 */
268 	drives = 0;
269 	for (i = 0; i < 4; i++) {
270 		if (p[i]) drives |= (1 << i);
271 #ifdef ACPI_FDC_DEBUG
272 		printf("%s: drive %d %sattached\n", sc->sc_dev.dv_xname, i,
273 		    p[i] ? "" : "not ");
274 #endif
275 	}
276 
277 	/*
278 	 * p[4] reports tape presence. Possible values:
279 	 * 	0	- Unknown if device is present
280 	 *	1	- Device is present
281 	 *	2	- Device is never present
282 	 *	>2	- Reserved
283 	 *
284 	 * we don't currently use this.
285 	 */
286 
287 out:
288 	AcpiOsFree(buf.Pointer);
289 	return drives;
290 }
291 
292 static void
293 fdc_acpi_getknownfds(struct fdc_acpi_softc *asc)
294 {
295 	struct fdc_softc *sc = &asc->sc_fdc;
296 	ACPI_OBJECT *fdi, *e;
297 	ACPI_BUFFER buf;
298 	ACPI_STATUS rv;
299 	int i;
300 
301 	for (i = 0; i < 4; i++) {
302 		if ((sc->sc_present & (1 << i)) == 0)
303 			continue;
304 		rv = acpi_eval_struct(asc->sc_node->ad_handle, "_FDI", &buf);
305 		if (ACPI_FAILURE(rv)) {
306 #ifdef ACPI_FDC_DEBUG
307 			printf("%s: failed to evaluate _FDI: %s on drive %d\n",
308 			    sc->sc_dev.dv_xname, AcpiFormatException(rv), i);
309 #endif
310 			/* XXX if _FDI fails, assume 1.44MB floppy */
311 			sc->sc_knownfds[i] = &fdc_acpi_fdtypes[0];
312 			continue;
313 		}
314 		fdi = (ACPI_OBJECT *)buf.Pointer;
315 		if (fdi->Type != ACPI_TYPE_PACKAGE) {
316 			printf("%s: expected PACKAGE, got %d\n",
317 			    sc->sc_dev.dv_xname, fdi->Type);
318 			goto out;
319 		}
320 		e = fdi->Package.Elements;
321 		sc->sc_knownfds[i] = fdc_acpi_nvtotype(sc->sc_dev.dv_xname,
322 		    e[1].Integer.Value, e[0].Integer.Value);
323 
324 		/* if fdc_acpi_nvtotype returns NULL, don't attach drive */
325 		if (!sc->sc_knownfds[i])
326 			sc->sc_present &= ~(1 << i);
327 
328 out:
329 		AcpiOsFree(buf.Pointer);
330 	}
331 }
332 
333 static const struct fd_type *
334 fdc_acpi_nvtotype(char *fdc, int nvraminfo, int drive)
335 {
336 	int type;
337 
338 	type = (drive == 0 ? nvraminfo : nvraminfo << 4) & 0xf0;
339 	switch (type) {
340 	case ACPI_FDC_DISKETTE_NONE:
341 		return NULL;
342 	case ACPI_FDC_DISKETTE_12M:
343 		return &fdc_acpi_fdtypes[1];
344 	case ACPI_FDC_DISKETTE_TYPE5:
345 	case ACPI_FDC_DISKETTE_TYPE6:
346 	case ACPI_FDC_DISKETTE_144M:
347 		return &fdc_acpi_fdtypes[0];
348 	case ACPI_FDC_DISKETTE_360K:
349 		return &fdc_acpi_fdtypes[3];
350 	case ACPI_FDC_DISKETTE_720K:
351 		return &fdc_acpi_fdtypes[4];
352 	default:
353 #ifdef ACPI_FDC_DEBUG
354 		printf("%s: drive %d: unknown device type 0x%x\n",
355 		    fdc, drive, type);
356 #endif
357 		return NULL;
358 	}
359 }
360