2 * Copyright (c) 2004 Nate Lawson (SDG)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/kernel.h>
34 #include <sys/malloc.h>
35 #include <sys/module.h>
38 #include <contrib/dev/acpica/acpi.h>
39 #include <dev/acpica/acpivar.h>
40 #include <dev/fdc/fdcvar.h>
42 static int fdc_acpi_probe(device_t dev);
43 static int fdc_acpi_attach(device_t dev);
44 static int fdc_acpi_probe_children(device_t bus, device_t dev,
46 static ACPI_STATUS fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev,
47 int level, void *arg);
49 /* Maximum number of child devices of a controller (4 floppy + 1 tape.) */
50 #define ACPI_FDC_MAXDEVS 5
52 /* Standard size of buffer returned by the _FDE method. */
53 #define ACPI_FDC_FDE_LEN (ACPI_FDC_MAXDEVS * sizeof(uint32_t))
56 * Parameters for the tape drive (5th device). Some BIOS authors use this
57 * for all drives, not just the tape drive (e.g., ASUS K8V). This isn't
58 * grossly incompatible with the spec since it says the first four devices
59 * are simple booleans.
61 #define ACPI_FD_UNKNOWN 0
62 #define ACPI_FD_PRESENT 1
63 #define ACPI_FD_NEVER_PRESENT 2
65 /* Temporary buf length for evaluating _FDE and _FDI. */
66 #define ACPI_FDC_BUFLEN 1024
68 /* Context for walking FDC child devices. */
70 uint32_t fd_present[ACPI_FDC_MAXDEVS];
77 fdc_acpi_probe(device_t dev)
80 static char *fdc_ids[] = { "PNP0700", "PNP0701", NULL };
82 bus = device_get_parent(dev);
83 if (ACPI_ID_PROBE(bus, dev, fdc_ids) == NULL)
86 if (ACPI_SUCCESS(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, NULL)))
87 device_set_desc(dev, "floppy drive controller (FDE)");
89 device_set_desc(dev, "floppy drive controller");
94 fdc_acpi_attach(device_t dev)
99 int error, fde_count, i;
100 ACPI_OBJECT *obj, *pkg;
101 uint32_t fde[ACPI_FDC_MAXDEVS];
103 /* Get our softc and use the same accessor as ISA. */
104 sc = device_get_softc(dev);
107 /* Initialize variables and get a temporary buffer for _FDE. */
109 buf.Length = ACPI_FDC_BUFLEN;
110 buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO);
111 if (buf.Pointer == NULL)
114 /* Allocate resources the same as the ISA attachment. */
115 error = fdc_isa_alloc_resources(dev, sc);
119 /* Call common attach code in fdc(4) first. */
120 error = fdc_attach(dev);
125 * Enumerate _FDE, which lists floppy drives that are present. If
126 * this fails, fall back to the ISA hints-based probe method.
128 bus = device_get_parent(dev);
129 if (ACPI_FAILURE(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, &buf))) {
134 /* Parse the output of _FDE in various ways. */
135 obj = pkg = (ACPI_OBJECT *)buf.Pointer;
137 case ACPI_TYPE_BUFFER:
139 * The spec says _FDE should be a buffer of five 32-bit
140 * integers. In violation of the spec, some systems use
141 * five bytes instead.
143 switch (obj->Buffer.Length) {
144 case ACPI_FDC_FDE_LEN:
145 bcopy(obj->Buffer.Pointer, fde, ACPI_FDC_FDE_LEN);
147 case ACPI_FDC_MAXDEVS:
148 for (i = 0; i < ACPI_FDC_MAXDEVS; i++)
149 fde[i] = ((uint8_t *)obj->Buffer.Pointer)[i];
152 device_printf(dev, "_FDE wrong length: %d\n",
158 case ACPI_TYPE_PACKAGE:
160 * In violation of the spec, systems including the ASUS
161 * K8V return a package of five integers instead of a
162 * buffer of five 32-bit integers.
164 fde_count = min(ACPI_FDC_MAXDEVS, pkg->Package.Count);
165 for (i = 0; i < fde_count; i++) {
166 obj = &pkg->Package.Elements[i];
167 if (obj->Type == ACPI_TYPE_INTEGER)
168 fde[i] = (uint32_t)obj->Integer.Value;
172 device_printf(dev, "invalid _FDE type %d\n", obj->Type);
177 /* Add fd child devices as specified. */
178 error = fdc_acpi_probe_children(bus, dev, fde);
182 * If there was a problem with the _FDE drive enumeration, fall
183 * back to the hints-based probe.
186 error = fdc_hints_probe(dev);
190 free(buf.Pointer, M_TEMP);
192 fdc_release_resources(sc);
198 fdc_acpi_probe_children(device_t bus, device_t dev, void *fde)
200 struct fdc_walk_ctx *ctx;
204 /* Setup the context and walk all child devices. */
205 ctx = malloc(sizeof(struct fdc_walk_ctx), M_TEMP, M_NOWAIT);
207 device_printf(dev, "no memory for walking children\n");
210 bcopy(fde, ctx->fd_present, sizeof(ctx->fd_present));
214 ACPI_SCAN_CHILDREN(ctx->acpi_dev, dev, 1, fdc_acpi_probe_child,
217 /* Add any devices not represented by an AML Device handle/node. */
218 fd_dc = devclass_find("fd");
219 for (i = 0; i < ACPI_FDC_MAXDEVS; i++)
220 if (ctx->fd_present[i] == ACPI_FD_PRESENT &&
221 devclass_get_device(fd_dc, i) == NULL) {
222 if (fdc_add_child(dev, "fd", i) == NULL)
223 device_printf(dev, "fd add failed\n");
227 /* Attach any children found during the probe. */
228 return (bus_generic_attach(dev));
232 fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev, int level, void *arg)
234 struct fdc_walk_ctx *ctx;
235 device_t child, old_child;
237 ACPI_OBJECT *pkg, *obj;
240 ctx = (struct fdc_walk_ctx *)arg;
244 * The first four ints are booleans that indicate whether fd0-3 are
245 * present or not. The last is for a tape device, which we don't
246 * bother supporting for now.
251 /* This device is not present, move on to the next. */
252 if (ctx->fd_present[ctx->index] != ACPI_FD_PRESENT)
255 /* Create a device for the child with the given index. */
256 child = fdc_add_child(ctx->dev, "fd", ctx->index);
262 /* Get temporary buffer for _FDI probe. */
263 buf.Length = ACPI_FDC_BUFLEN;
264 buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO);
265 if (buf.Pointer == NULL)
269 * Evaluate _FDI to get drive type to pass to the child. We use the
270 * old child here since it has a valid ACPI_HANDLE since it is a
271 * child of acpi. A better way to implement this would be to make fdc
272 * support the ACPI handle ivar for its children.
274 status = ACPI_EVALUATE_OBJECT(ctx->acpi_dev, old_child, "_FDI", NULL,
276 if (ACPI_FAILURE(status)) {
277 if (status != AE_NOT_FOUND)
278 device_printf(ctx->dev, "_FDI failed - %#x\n", status);
281 pkg = (ACPI_OBJECT *)buf.Pointer;
282 if (!ACPI_PKG_VALID(pkg, 16)) {
283 device_printf(ctx->dev, "invalid _FDI package\n");
286 obj = &pkg->Package.Elements[1];
287 if (obj == NULL || obj->Type != ACPI_TYPE_INTEGER) {
288 device_printf(ctx->dev, "invalid type object in _FDI\n");
291 fdc_set_fdtype(child, obj->Integer.Value);
296 free(buf.Pointer, M_TEMP);
300 static device_method_t fdc_acpi_methods[] = {
301 /* Device interface */
302 DEVMETHOD(device_probe, fdc_acpi_probe),
303 DEVMETHOD(device_attach, fdc_acpi_attach),
304 DEVMETHOD(device_detach, fdc_detach),
307 DEVMETHOD(bus_print_child, fdc_print_child),
308 DEVMETHOD(bus_read_ivar, fdc_read_ivar),
309 DEVMETHOD(bus_write_ivar, fdc_write_ivar),
314 static driver_t fdc_acpi_driver = {
317 sizeof(struct fdc_data)
320 DRIVER_MODULE(fdc, acpi, fdc_acpi_driver, fdc_devclass, 0, 0);