sys/dev/atkbdc/atkbdc_isa.c

   1 /*-
   2  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
   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 as
  10  *    the first lines of this file unmodified.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_kbd.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/module.h>
  36 #include <sys/bus.h>
  37 #include <sys/malloc.h>
  38 #include <machine/resource.h>
  39 #include <sys/rman.h>
  40 #include <machine/bus.h>
  41
  42 #include <dev/atkbdc/atkbdc_subr.h>
  43 #include <dev/atkbdc/atkbdcreg.h>
  44
  45 #include <isa/isareg.h>
  46 #include <isa/isavar.h>
  47
  48 static int      atkbdc_isa_probe(device_t dev);
  49 static int      atkbdc_isa_attach(device_t dev);
  50 static device_t atkbdc_isa_add_child(device_t bus, u_int order, const char *name,
  51                     int unit);
  52
  53 static device_method_t atkbdc_isa_methods[] = {
  54         DEVMETHOD(device_probe,         atkbdc_isa_probe),
  55         DEVMETHOD(device_attach,        atkbdc_isa_attach),
  56         DEVMETHOD(device_suspend,       bus_generic_suspend),
  57         DEVMETHOD(device_resume,        bus_generic_resume),
  58
  59         DEVMETHOD(bus_add_child,        atkbdc_isa_add_child),
  60         DEVMETHOD(bus_print_child,      atkbdc_print_child),
  61         DEVMETHOD(bus_read_ivar,        atkbdc_read_ivar),
  62         DEVMETHOD(bus_write_ivar,       atkbdc_write_ivar),
  63         DEVMETHOD(bus_get_resource_list,atkbdc_get_resource_list),
  64         DEVMETHOD(bus_alloc_resource,   bus_generic_rl_alloc_resource),
  65         DEVMETHOD(bus_release_resource, bus_generic_rl_release_resource),
  66         DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
  67         DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
  68         DEVMETHOD(bus_get_resource,     bus_generic_rl_get_resource),
  69         DEVMETHOD(bus_set_resource,     bus_generic_rl_set_resource),
  70         DEVMETHOD(bus_delete_resource,  bus_generic_rl_delete_resource),
  71         DEVMETHOD(bus_setup_intr,       bus_generic_setup_intr),
  72         DEVMETHOD(bus_teardown_intr,    bus_generic_teardown_intr),
  73
  74         { 0, 0 }
  75 };
  76
  77 static driver_t atkbdc_isa_driver = {
  78         ATKBDC_DRIVER_NAME,
  79         atkbdc_isa_methods,
  80         sizeof(atkbdc_softc_t *),
  81 };
  82
  83 static struct isa_pnp_id atkbdc_ids[] = {
  84         { 0x0303d041, "Keyboard controller (i8042)" },  /* PNP0303 */
  85         { 0x2003d041, "Keyboard controller (i8042)" },  /* PNP0320 */
  86         { 0 }
  87 };
  88
  89 static int
  90 atkbdc_isa_probe(device_t dev)
  91 {
  92         struct resource *port0;
  93         struct resource *port1;
  94         u_long          start;
  95         u_long          count;
  96         int             error;
  97         int             rid;
  98 #if defined(__i386__)
  99         bus_space_tag_t tag;
 100         bus_space_handle_t ioh1;
 101         volatile int    i;
 102         register_t      flags;
 103 #endif
 104
 105         /* check PnP IDs */
 106         if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO)
 107                 return ENXIO;
 108
 109         device_set_desc(dev, "Keyboard controller (i8042)");
 110
 111         /*
 112          * Adjust I/O port resources.
 113          * The AT keyboard controller uses two ports (a command/data port
 114          * 0x60 and a status port 0x64), which may be given to us in
 115          * one resource (0x60 through 0x64) or as two separate resources
 116          * (0x60 and 0x64). Some brain-damaged ACPI BIOS has reversed
 117          * command/data port and status port. Furthermore, /boot/device.hints
 118          * may contain just one port, 0x60. We shall adjust resource settings
 119          * so that these two ports are available as two separate resources
 120          * in correct order.
 121          */
 122         device_quiet(dev);
 123         rid = 0;
 124         if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count) != 0)
 125                 return ENXIO;
 126         if (start == IO_KBD + KBD_STATUS_PORT) {
 127                 start = IO_KBD;
 128                 count++;
 129         }
 130         if (count > 1)  /* adjust the count and/or start port */
 131                 bus_set_resource(dev, SYS_RES_IOPORT, rid, start, 1);
 132         port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
 133         if (port0 == NULL)
 134                 return ENXIO;
 135         rid = 1;
 136         if (bus_get_resource(dev, SYS_RES_IOPORT, rid, NULL, NULL) != 0)
 137                 bus_set_resource(dev, SYS_RES_IOPORT, 1,
 138                                  start + KBD_STATUS_PORT, 1);
 139         port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
 140         if (port1 == NULL) {
 141                 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
 142                 return ENXIO;
 143         }
 144
 145 #if defined(__i386__)
 146         /*
 147          * Check if we really have AT keyboard controller. Poll status
 148          * register until we get "all clear" indication. If no such
 149          * indication comes, it probably means that there is no AT
 150          * keyboard controller present. Give up in such case. Check relies
 151          * on the fact that reading from non-existing in/out port returns
 152          * 0xff on i386. May or may not be true on other platforms.
 153          */
 154         tag = rman_get_bustag(port0);
 155         ioh1 = rman_get_bushandle(port1);
 156         flags = intr_disable();
 157         for (i = 0; i != 65535; i++) {
 158                 if ((bus_space_read_1(tag, ioh1, 0) & 0x2) == 0)
 159                         break;
 160         }
 161         intr_restore(flags);
 162         if (i == 65535) {
 163                 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
 164                 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1);
 165                 return ENXIO;
 166         }
 167 #endif
 168
 169         device_verbose(dev);
 170
 171         error = atkbdc_probe_unit(device_get_unit(dev), port0, port1);
 172         if (error == 0)
 173                 bus_generic_probe(dev);
 174
 175         bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
 176         bus_release_resource(dev, SYS_RES_IOPORT, 1, port1);
 177
 178         return error;
 179 }
 180
 181 static int
 182 atkbdc_isa_attach(device_t dev)
 183 {
 184         atkbdc_softc_t  *sc;
 185         int             unit;
 186         int             error;
 187         int             rid;
 188
 189         unit = device_get_unit(dev);
 190         sc = *(atkbdc_softc_t **)device_get_softc(dev);
 191         if (sc == NULL) {
 192                 /*
 193                  * We have to maintain two copies of the kbdc_softc struct,
 194                  * as the low-level console needs to have access to the
 195                  * keyboard controller before kbdc is probed and attached.
 196                  * kbdc_soft[] contains the default entry for that purpose.
 197                  * See atkbdc.c. XXX
 198                  */
 199                 sc = atkbdc_get_softc(unit);
 200                 if (sc == NULL)
 201                         return ENOMEM;
 202         }
 203
 204         rid = 0;
 205         sc->port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
 206                                            RF_ACTIVE);
 207         if (sc->port0 == NULL)
 208                 return ENXIO;
 209         rid = 1;
 210         sc->port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
 211                                            RF_ACTIVE);
 212         if (sc->port1 == NULL) {
 213                 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
 214                 return ENXIO;
 215         }
 216
 217         error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1);
 218         if (error) {
 219                 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
 220                 bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1);
 221                 return error;
 222         }
 223         *(atkbdc_softc_t **)device_get_softc(dev) = sc;
 224
 225         bus_generic_attach(dev);
 226
 227         return 0;
 228 }
 229
 230 static device_t
 231 atkbdc_isa_add_child(device_t bus, u_int order, const char *name, int unit)
 232 {
 233         atkbdc_device_t *ivar;
 234         device_t        child;
 235         int             t;
 236
 237         ivar = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV,
 238                 M_NOWAIT | M_ZERO);
 239         if (!ivar)
 240                 return NULL;
 241
 242         child = device_add_child_ordered(bus, order, name, unit);
 243         if (child == NULL) {
 244                 free(ivar, M_ATKBDDEV);
 245                 return child;
 246         }
 247
 248         resource_list_init(&ivar->resources);
 249         ivar->rid = order;
 250
 251         /*
 252          * If the device is not created by the PnP BIOS or ACPI,
 253          * refer to device hints for IRQ.
 254          */
 255         if (ISA_PNP_PROBE(device_get_parent(bus), bus, atkbdc_ids) != 0) {
 256                 if (resource_int_value(name, unit, "irq", &t) != 0)
 257                         t = -1;
 258         } else {
 259                 t = bus_get_resource_start(bus, SYS_RES_IRQ, ivar->rid);
 260         }
 261         if (t > 0)
 262                 resource_list_add(&ivar->resources, SYS_RES_IRQ, ivar->rid,
 263                                   t, t, 1);
 264
 265         if (resource_disabled(name, unit))
 266                 device_disable(child);
 267
 268         device_set_ivars(child, ivar);
 269
 270         return child;
 271 }
 272
 273 DRIVER_MODULE(atkbdc, isa, atkbdc_isa_driver, atkbdc_devclass, 0, 0);
 274 DRIVER_MODULE(atkbdc, acpi, atkbdc_isa_driver, atkbdc_devclass, 0, 0);