1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2004 Nate Lawson (SDG) 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. 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. 15 * 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 26 * SUCH DAMAGE. 27 */ 28 29 #include <sys/cdefs.h> 30 __FBSDID("$FreeBSD$"); 31 32 #include <sys/param.h> 33 #include <sys/kernel.h> 34 #include <sys/bio.h> 35 #include <sys/bus.h> 36 #include <sys/malloc.h> 37 #include <sys/module.h> 38 #include <sys/proc.h> 39 40 #include <contrib/dev/acpica/include/acpi.h> 41 42 #include <dev/acpica/acpivar.h> 43 #include <dev/fdc/fdcvar.h> 44 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, 48 void *fde); 49 static ACPI_STATUS fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev, 50 int level, void *arg); 51 52 /* Maximum number of child devices of a controller (4 floppy + 1 tape.) */ 53 #define ACPI_FDC_MAXDEVS 5 54 55 /* Standard size of buffer returned by the _FDE method. */ 56 #define ACPI_FDC_FDE_LEN (ACPI_FDC_MAXDEVS * sizeof(uint32_t)) 57 58 /* 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. 63 */ 64 #define ACPI_FD_UNKNOWN 0 65 #define ACPI_FD_PRESENT 1 66 #define ACPI_FD_NEVER_PRESENT 2 67 68 /* Temporary buf length for evaluating _FDE and _FDI. */ 69 #define ACPI_FDC_BUFLEN 1024 70 71 /* Context for walking FDC child devices. */ 72 struct fdc_walk_ctx { 73 uint32_t fd_present[ACPI_FDC_MAXDEVS]; 74 int index; 75 device_t acpi_dev; 76 device_t dev; 77 }; 78 79 static int 80 fdc_acpi_probe(device_t dev) 81 { 82 device_t bus; 83 static char *fdc_ids[] = { "PNP0700", "PNP0701", NULL }; 84 85 bus = device_get_parent(dev); 86 if (ACPI_ID_PROBE(bus, dev, fdc_ids) == NULL) 87 return (ENXIO); 88 89 if (ACPI_SUCCESS(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, NULL))) 90 device_set_desc(dev, "floppy drive controller (FDE)"); 91 else 92 device_set_desc(dev, "floppy drive controller"); 93 return (0); 94 } 95 96 static int 97 fdc_acpi_attach(device_t dev) 98 { 99 struct fdc_data *sc; 100 ACPI_BUFFER buf; 101 ACPI_OBJECT *obj; 102 device_t bus; 103 int error; 104 105 /* Get our softc and use the same accessor as ISA. */ 106 sc = device_get_softc(dev); 107 sc->fdc_dev = dev; 108 109 /* Initialize variables and get a temporary buffer for _FDE. */ 110 error = ENXIO; 111 buf.Length = ACPI_FDC_BUFLEN; 112 buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO); 113 if (buf.Pointer == NULL) 114 goto out; 115 116 /* Allocate resources the same as the ISA attachment. */ 117 error = fdc_isa_alloc_resources(dev, sc); 118 if (error != 0) 119 goto out; 120 121 /* Call common attach code in fdc(4) first. */ 122 error = fdc_attach(dev); 123 if (error != 0) 124 goto out; 125 126 /* 127 * Enumerate _FDE, which lists floppy drives that are present. If 128 * this fails, fall back to the ISA hints-based probe method. 129 */ 130 bus = device_get_parent(dev); 131 if (ACPI_FAILURE(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, &buf))) { 132 error = fdc_hints_probe(dev); 133 goto out; 134 } 135 136 /* Add fd child devices as specified. */ 137 obj = buf.Pointer; 138 error = fdc_acpi_probe_children(bus, dev, obj->Buffer.Pointer); 139 140 out: 141 if (buf.Pointer) 142 free(buf.Pointer, M_TEMP); 143 if (error != 0) 144 fdc_release_resources(sc); 145 else 146 fdc_start_worker(dev); 147 148 return (error); 149 } 150 151 static int 152 fdc_acpi_probe_children(device_t bus, device_t dev, void *fde) 153 { 154 struct fdc_walk_ctx *ctx; 155 devclass_t fd_dc; 156 int i; 157 158 /* Setup the context and walk all child devices. */ 159 ctx = malloc(sizeof(struct fdc_walk_ctx), M_TEMP, M_NOWAIT); 160 if (ctx == NULL) { 161 device_printf(dev, "no memory for walking children\n"); 162 return (ENOMEM); 163 } 164 bcopy(fde, ctx->fd_present, sizeof(ctx->fd_present)); 165 ctx->index = 0; 166 ctx->dev = dev; 167 ctx->acpi_dev = bus; 168 ACPI_SCAN_CHILDREN(ctx->acpi_dev, dev, 1, fdc_acpi_probe_child, 169 ctx); 170 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"); 178 } 179 free(ctx, M_TEMP); 180 181 /* Attach any children found during the probe. */ 182 return (bus_generic_attach(dev)); 183 } 184 185 static ACPI_STATUS 186 fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev, int level, void *arg) 187 { 188 struct fdc_walk_ctx *ctx; 189 device_t child, old_child; 190 ACPI_BUFFER buf; 191 ACPI_OBJECT *pkg, *obj; 192 ACPI_STATUS status; 193 194 ctx = (struct fdc_walk_ctx *)arg; 195 buf.Pointer = NULL; 196 197 /* 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. 201 */ 202 if (ctx->index > 3) 203 return (AE_OK); 204 205 /* This device is not present, move on to the next. */ 206 if (ctx->fd_present[ctx->index] != ACPI_FD_PRESENT) 207 goto out; 208 209 /* Create a device for the child with the given index. */ 210 child = fdc_add_child(ctx->dev, "fd", ctx->index); 211 if (child == NULL) 212 goto out; 213 old_child = *dev; 214 *dev = child; 215 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) 220 goto out; 221 222 /* 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. 227 */ 228 status = ACPI_EVALUATE_OBJECT(ctx->acpi_dev, old_child, "_FDI", NULL, 229 &buf); 230 if (ACPI_FAILURE(status)) { 231 if (status != AE_NOT_FOUND) 232 device_printf(ctx->dev, "_FDI failed - %#x\n", status); 233 goto out; 234 } 235 pkg = (ACPI_OBJECT *)buf.Pointer; 236 if (!ACPI_PKG_VALID(pkg, 16)) { 237 device_printf(ctx->dev, "invalid _FDI package\n"); 238 goto out; 239 } 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"); 243 goto out; 244 } 245 fdc_set_fdtype(child, obj->Integer.Value); 246 247 out: 248 ctx->index++; 249 if (buf.Pointer) 250 free(buf.Pointer, M_TEMP); 251 return (AE_OK); 252 } 253 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), 259 260 /* Bus interface */ 261 DEVMETHOD(bus_print_child, fdc_print_child), 262 DEVMETHOD(bus_read_ivar, fdc_read_ivar), 263 DEVMETHOD(bus_write_ivar, fdc_write_ivar), 264 265 DEVMETHOD_END 266 }; 267 268 static driver_t fdc_acpi_driver = { 269 "fdc", 270 fdc_acpi_methods, 271 sizeof(struct fdc_data) 272 }; 273 274 DRIVER_MODULE(fdc, acpi, fdc_acpi_driver, fdc_devclass, 0, 0); 275