2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2004 Nate Lawson (SDG)
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
40 #include <contrib/dev/acpica/include/acpi.h>
42 #include <dev/acpica/acpivar.h>
43 #include <dev/fdc/fdcvar.h>
45 static int fdc_acpi_probe(device_t dev);
46 static int fdc_acpi_attach(device_t dev);
47 static int fdc_acpi_probe_children(device_t bus, device_t dev,
49 static ACPI_STATUS fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev,
50 int level, void *arg);
52 /* Maximum number of child devices of a controller (4 floppy + 1 tape.) */
53 #define ACPI_FDC_MAXDEVS 5
55 /* Standard size of buffer returned by the _FDE method. */
56 #define ACPI_FDC_FDE_LEN (ACPI_FDC_MAXDEVS * sizeof(uint32_t))
59 * Parameters for the tape drive (5th device). Some BIOS authors use this
60 * for all drives, not just the tape drive (e.g., ASUS K8V). This isn't
61 * grossly incompatible with the spec since it says the first four devices
62 * are simple booleans.
64 #define ACPI_FD_UNKNOWN 0
65 #define ACPI_FD_PRESENT 1
66 #define ACPI_FD_NEVER_PRESENT 2
68 /* Temporary buf length for evaluating _FDE and _FDI. */
69 #define ACPI_FDC_BUFLEN 1024
71 /* Context for walking FDC child devices. */
73 uint32_t fd_present[ACPI_FDC_MAXDEVS];
80 fdc_acpi_probe(device_t dev)
83 static char *fdc_ids[] = { "PNP0700", "PNP0701", NULL };
85 bus = device_get_parent(dev);
86 if (ACPI_ID_PROBE(bus, dev, fdc_ids) == NULL)
89 if (ACPI_SUCCESS(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, NULL)))
90 device_set_desc(dev, "floppy drive controller (FDE)");
92 device_set_desc(dev, "floppy drive controller");
97 fdc_acpi_attach(device_t dev)
105 /* Get our softc and use the same accessor as ISA. */
106 sc = device_get_softc(dev);
109 /* Initialize variables and get a temporary buffer for _FDE. */
111 buf.Length = ACPI_FDC_BUFLEN;
112 buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO);
113 if (buf.Pointer == NULL)
116 /* Allocate resources the same as the ISA attachment. */
117 error = fdc_isa_alloc_resources(dev, sc);
121 /* Call common attach code in fdc(4) first. */
122 error = fdc_attach(dev);
127 * Enumerate _FDE, which lists floppy drives that are present. If
128 * this fails, fall back to the ISA hints-based probe method.
130 bus = device_get_parent(dev);
131 if (ACPI_FAILURE(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, &buf))) {
132 error = fdc_hints_probe(dev);
136 /* Add fd child devices as specified. */
138 error = fdc_acpi_probe_children(bus, dev, obj->Buffer.Pointer);
142 free(buf.Pointer, M_TEMP);
144 fdc_release_resources(sc);
146 fdc_start_worker(dev);
152 fdc_acpi_probe_children(device_t bus, device_t dev, void *fde)
154 struct fdc_walk_ctx *ctx;
158 /* Setup the context and walk all child devices. */
159 ctx = malloc(sizeof(struct fdc_walk_ctx), M_TEMP, M_NOWAIT);
161 device_printf(dev, "no memory for walking children\n");
164 bcopy(fde, ctx->fd_present, sizeof(ctx->fd_present));
168 ACPI_SCAN_CHILDREN(ctx->acpi_dev, dev, 1, fdc_acpi_probe_child,
171 /* Add any devices not represented by an AML Device handle/node. */
172 fd_dc = devclass_find("fd");
173 for (i = 0; i < ACPI_FDC_MAXDEVS; i++)
174 if (ctx->fd_present[i] == ACPI_FD_PRESENT &&
175 devclass_get_device(fd_dc, i) == NULL) {
176 if (fdc_add_child(dev, "fd", i) == NULL)
177 device_printf(dev, "fd add failed\n");
181 /* Attach any children found during the probe. */
182 return (bus_generic_attach(dev));
186 fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev, int level, void *arg)
188 struct fdc_walk_ctx *ctx;
189 device_t child, old_child;
191 ACPI_OBJECT *pkg, *obj;
194 ctx = (struct fdc_walk_ctx *)arg;
198 * The first four ints are booleans that indicate whether fd0-3 are
199 * present or not. The last is for a tape device, which we don't
200 * bother supporting for now.
205 /* This device is not present, move on to the next. */
206 if (ctx->fd_present[ctx->index] != ACPI_FD_PRESENT)
209 /* Create a device for the child with the given index. */
210 child = fdc_add_child(ctx->dev, "fd", ctx->index);
216 /* Get temporary buffer for _FDI probe. */
217 buf.Length = ACPI_FDC_BUFLEN;
218 buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO);
219 if (buf.Pointer == NULL)
223 * Evaluate _FDI to get drive type to pass to the child. We use the
224 * old child here since it has a valid ACPI_HANDLE since it is a
225 * child of acpi. A better way to implement this would be to make fdc
226 * support the ACPI handle ivar for its children.
228 status = ACPI_EVALUATE_OBJECT(ctx->acpi_dev, old_child, "_FDI", NULL,
230 if (ACPI_FAILURE(status)) {
231 if (status != AE_NOT_FOUND)
232 device_printf(ctx->dev, "_FDI failed - %#x\n", status);
235 pkg = (ACPI_OBJECT *)buf.Pointer;
236 if (!ACPI_PKG_VALID(pkg, 16)) {
237 device_printf(ctx->dev, "invalid _FDI package\n");
240 obj = &pkg->Package.Elements[1];
241 if (obj == NULL || obj->Type != ACPI_TYPE_INTEGER) {
242 device_printf(ctx->dev, "invalid type object in _FDI\n");
245 fdc_set_fdtype(child, obj->Integer.Value);
250 free(buf.Pointer, M_TEMP);
254 static device_method_t fdc_acpi_methods[] = {
255 /* Device interface */
256 DEVMETHOD(device_probe, fdc_acpi_probe),
257 DEVMETHOD(device_attach, fdc_acpi_attach),
258 DEVMETHOD(device_detach, fdc_detach),
261 DEVMETHOD(bus_print_child, fdc_print_child),
262 DEVMETHOD(bus_read_ivar, fdc_read_ivar),
263 DEVMETHOD(bus_write_ivar, fdc_write_ivar),
268 static driver_t fdc_acpi_driver = {
271 sizeof(struct fdc_data)
274 DRIVER_MODULE(fdc, acpi, fdc_acpi_driver, fdc_devclass, 0, 0);