The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/fdc/fdc_acpi.c

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * Copyright (c) 2004 Nate Lawson (SDG)
    3  * All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    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.
   13  *
   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
   24  * SUCH DAMAGE.
   25  */
   26 
   27 #include <sys/cdefs.h>
   28 __FBSDID("$FreeBSD: releng/7.3/sys/dev/fdc/fdc_acpi.c 155870 2006-02-21 03:19:24Z njl $");
   29 
   30 #include <sys/param.h>
   31 #include <sys/kernel.h>
   32 #include <sys/bio.h>
   33 #include <sys/bus.h>
   34 #include <sys/malloc.h>
   35 #include <sys/module.h>
   36 #include <sys/proc.h>
   37 
   38 #include <contrib/dev/acpica/acpi.h>
   39 #include <dev/acpica/acpivar.h>
   40 #include <dev/fdc/fdcvar.h>
   41 
   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,
   45                             void *fde);
   46 static ACPI_STATUS      fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev,
   47                             int level, void *arg);
   48 
   49 /* Maximum number of child devices of a controller (4 floppy + 1 tape.) */
   50 #define ACPI_FDC_MAXDEVS        5
   51 
   52 /* Standard size of buffer returned by the _FDE method. */
   53 #define ACPI_FDC_FDE_LEN        (ACPI_FDC_MAXDEVS * sizeof(uint32_t))
   54 
   55 /*
   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.
   60  */
   61 #define ACPI_FD_UNKNOWN         0
   62 #define ACPI_FD_PRESENT         1
   63 #define ACPI_FD_NEVER_PRESENT   2
   64 
   65 /* Temporary buf length for evaluating _FDE and _FDI. */
   66 #define ACPI_FDC_BUFLEN         1024
   67 
   68 /* Context for walking FDC child devices. */
   69 struct fdc_walk_ctx {
   70         uint32_t        fd_present[ACPI_FDC_MAXDEVS];
   71         int             index;
   72         device_t        acpi_dev;
   73         device_t        dev;
   74 };
   75 
   76 static int
   77 fdc_acpi_probe(device_t dev)
   78 {
   79         device_t bus;
   80         static char *fdc_ids[] = { "PNP0700", "PNP0701", NULL };
   81 
   82         bus = device_get_parent(dev);
   83         if (ACPI_ID_PROBE(bus, dev, fdc_ids) == NULL)
   84                 return (ENXIO);
   85 
   86         if (ACPI_SUCCESS(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, NULL)))
   87                 device_set_desc(dev, "floppy drive controller (FDE)");
   88         else
   89                 device_set_desc(dev, "floppy drive controller");
   90         return (0);
   91 }
   92 
   93 static int
   94 fdc_acpi_attach(device_t dev)
   95 {
   96         struct fdc_data *sc;
   97         ACPI_BUFFER buf;
   98         device_t bus;
   99         int error, fde_count, i;
  100         ACPI_OBJECT *obj, *pkg;
  101         uint32_t fde[ACPI_FDC_MAXDEVS];
  102 
  103         /* Get our softc and use the same accessor as ISA. */
  104         sc = device_get_softc(dev);
  105         sc->fdc_dev = dev;
  106 
  107         /* Initialize variables and get a temporary buffer for _FDE. */
  108         error = ENXIO;
  109         buf.Length = ACPI_FDC_BUFLEN;
  110         buf.Pointer = malloc(buf.Length, M_TEMP, M_NOWAIT | M_ZERO);
  111         if (buf.Pointer == NULL)
  112                 goto out;
  113 
  114         /* Allocate resources the same as the ISA attachment. */
  115         error = fdc_isa_alloc_resources(dev, sc);
  116         if (error != 0)
  117                 goto out;
  118 
  119         /* Call common attach code in fdc(4) first. */
  120         error = fdc_attach(dev);
  121         if (error != 0)
  122                 goto out;
  123 
  124         /*
  125          * Enumerate _FDE, which lists floppy drives that are present.  If
  126          * this fails, fall back to the ISA hints-based probe method.
  127          */
  128         bus = device_get_parent(dev);
  129         if (ACPI_FAILURE(ACPI_EVALUATE_OBJECT(bus, dev, "_FDE", NULL, &buf))) {
  130                 error = ENXIO;
  131                 goto out_hintsprobe;
  132         }
  133 
  134         /* Parse the output of _FDE in various ways. */
  135         obj = pkg = (ACPI_OBJECT *)buf.Pointer;
  136         switch (obj->Type) {
  137         case ACPI_TYPE_BUFFER:
  138                 /*
  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.
  142                  */
  143                 switch (obj->Buffer.Length) {
  144                 case ACPI_FDC_FDE_LEN:
  145                         bcopy(obj->Buffer.Pointer, fde, ACPI_FDC_FDE_LEN);
  146                         break;
  147                 case ACPI_FDC_MAXDEVS:
  148                         for (i = 0; i < ACPI_FDC_MAXDEVS; i++)
  149                                 fde[i] = ((uint8_t *)obj->Buffer.Pointer)[i];
  150                         break;
  151                 default:
  152                         device_printf(dev, "_FDE wrong length: %d\n",
  153                             obj->Buffer.Length);
  154                         error = ENXIO;
  155                         goto out_hintsprobe;
  156                 }
  157                 break;
  158         case ACPI_TYPE_PACKAGE:
  159                 /*
  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.
  163                  */
  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;
  169                 }
  170                 break;
  171         default:
  172                 device_printf(dev, "invalid _FDE type %d\n", obj->Type);
  173                 error = ENXIO;
  174                 goto out_hintsprobe;
  175         }
  176 
  177         /* Add fd child devices as specified. */
  178         error = fdc_acpi_probe_children(bus, dev, fde);
  179 
  180 out_hintsprobe:
  181         /*
  182          * If there was a problem with the _FDE drive enumeration, fall
  183          * back to the hints-based probe.
  184          */
  185         if (error)
  186                 error = fdc_hints_probe(dev);
  187 
  188 out:
  189         if (buf.Pointer)
  190                 free(buf.Pointer, M_TEMP);
  191         if (error != 0)
  192                 fdc_release_resources(sc);
  193 
  194         return (error);
  195 }
  196 
  197 static int
  198 fdc_acpi_probe_children(device_t bus, device_t dev, void *fde)
  199 {
  200         struct fdc_walk_ctx *ctx;
  201         devclass_t fd_dc;
  202         int i;
  203 
  204         /* Setup the context and walk all child devices. */
  205         ctx = malloc(sizeof(struct fdc_walk_ctx), M_TEMP, M_NOWAIT);
  206         if (ctx == NULL) {
  207                 device_printf(dev, "no memory for walking children\n");
  208                 return (ENOMEM);
  209         }
  210         bcopy(fde, ctx->fd_present, sizeof(ctx->fd_present));
  211         ctx->index = 0;
  212         ctx->dev = dev;
  213         ctx->acpi_dev = bus;
  214         ACPI_SCAN_CHILDREN(ctx->acpi_dev, dev, 1, fdc_acpi_probe_child,
  215             ctx);
  216 
  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");
  224                 }
  225         free(ctx, M_TEMP);
  226 
  227         /* Attach any children found during the probe. */
  228         return (bus_generic_attach(dev));
  229 }
  230 
  231 static ACPI_STATUS
  232 fdc_acpi_probe_child(ACPI_HANDLE h, device_t *dev, int level, void *arg)
  233 {
  234         struct fdc_walk_ctx *ctx;
  235         device_t child, old_child;
  236         ACPI_BUFFER buf;
  237         ACPI_OBJECT *pkg, *obj;
  238         ACPI_STATUS status;
  239 
  240         ctx = (struct fdc_walk_ctx *)arg;
  241         buf.Pointer = NULL;
  242 
  243         /*
  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.
  247          */
  248         if (ctx->index > 3)
  249                 return (AE_OK);
  250 
  251         /* This device is not present, move on to the next. */
  252         if (ctx->fd_present[ctx->index] != ACPI_FD_PRESENT)
  253                 goto out;
  254 
  255         /* Create a device for the child with the given index. */
  256         child = fdc_add_child(ctx->dev, "fd", ctx->index);
  257         if (child == NULL)
  258                 goto out;
  259         old_child = *dev;
  260         *dev = child;
  261 
  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)
  266                 goto out;
  267 
  268         /*
  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.
  273          */
  274         status = ACPI_EVALUATE_OBJECT(ctx->acpi_dev, old_child, "_FDI", NULL,
  275             &buf);
  276         if (ACPI_FAILURE(status)) {
  277                 if (status != AE_NOT_FOUND)
  278                         device_printf(ctx->dev, "_FDI failed - %#x\n", status);
  279                 goto out;
  280         }
  281         pkg = (ACPI_OBJECT *)buf.Pointer;
  282         if (!ACPI_PKG_VALID(pkg, 16)) {
  283                 device_printf(ctx->dev, "invalid _FDI package\n");
  284                 goto out;
  285         }
  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");
  289                 goto out;
  290         }
  291         fdc_set_fdtype(child, obj->Integer.Value);
  292 
  293 out:
  294         ctx->index++;
  295         if (buf.Pointer)
  296                 free(buf.Pointer, M_TEMP);
  297         return (AE_OK);
  298 }
  299 
  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),
  305 
  306         /* Bus interface */
  307         DEVMETHOD(bus_print_child,      fdc_print_child),
  308         DEVMETHOD(bus_read_ivar,        fdc_read_ivar),
  309         DEVMETHOD(bus_write_ivar,       fdc_write_ivar),
  310 
  311         {0, 0}
  312 };
  313 
  314 static driver_t fdc_acpi_driver = {
  315         "fdc",
  316         fdc_acpi_methods,
  317         sizeof(struct fdc_data)
  318 };
  319 
  320 DRIVER_MODULE(fdc, acpi, fdc_acpi_driver, fdc_devclass, 0, 0);

Cache object: 3f63abacc40613f9b5dc6f15204b9b62


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.