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 48static int atkbdc_isa_probe(device_t dev); 49static int atkbdc_isa_attach(device_t dev); 50static device_t atkbdc_isa_add_child(device_t bus, u_int order, const char *name, 51 int unit); 52static struct resource *atkbdc_isa_alloc_resource(device_t dev, device_t child, 53 int type, int *rid, u_long start, u_long end, 54 u_long count, u_int flags); 55static int atkbdc_isa_release_resource(device_t dev, device_t child, 56 int type, int rid, struct resource *r); 57 58static device_method_t atkbdc_isa_methods[] = { 59 DEVMETHOD(device_probe, atkbdc_isa_probe), 60 DEVMETHOD(device_attach, atkbdc_isa_attach), 61 DEVMETHOD(device_suspend, bus_generic_suspend), 62 DEVMETHOD(device_resume, bus_generic_resume), 63 64 DEVMETHOD(bus_add_child, atkbdc_isa_add_child), 65 DEVMETHOD(bus_print_child, atkbdc_print_child), 66 DEVMETHOD(bus_read_ivar, atkbdc_read_ivar), 67 DEVMETHOD(bus_write_ivar, atkbdc_write_ivar), 68 DEVMETHOD(bus_get_resource_list,atkbdc_get_resource_list), 69 DEVMETHOD(bus_alloc_resource, atkbdc_isa_alloc_resource), 70 DEVMETHOD(bus_release_resource, atkbdc_isa_release_resource), 71 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 72 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 73 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 74 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 75 DEVMETHOD(bus_delete_resource, bus_generic_rl_delete_resource), 76 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 77 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 78 79 { 0, 0 } 80}; 81 82static driver_t atkbdc_isa_driver = { 83 ATKBDC_DRIVER_NAME, 84 atkbdc_isa_methods, 85 sizeof(atkbdc_softc_t *), 86}; 87 88static struct isa_pnp_id atkbdc_ids[] = { 89 { 0x0303d041, "Keyboard controller (i8042)" }, /* PNP0303 */ 90 { 0x0b03d041, "Keyboard controller (i8042)" }, /* PNP030B */ 91 { 0x2003d041, "Keyboard controller (i8042)" }, /* PNP0320 */ 92 { 0 } 93}; 94 95static int 96atkbdc_isa_probe(device_t dev) 97{ 98 struct resource *port0; 99 struct resource *port1; 100 u_long start; 101 u_long count; 102 int error; 103 int rid; 104#if defined(__i386__) || defined(__amd64__) 105 bus_space_tag_t tag; 106 bus_space_handle_t ioh1; 107 volatile int i; 108 register_t flags; 109#endif 110 111 /* check PnP IDs */ 112 if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO) 113 return ENXIO; 114 115 device_set_desc(dev, "Keyboard controller (i8042)"); 116 117 /* 118 * Adjust I/O port resources. 119 * The AT keyboard controller uses two ports (a command/data port 120 * 0x60 and a status port 0x64), which may be given to us in 121 * one resource (0x60 through 0x64) or as two separate resources 122 * (0x60 and 0x64). Some brain-damaged ACPI BIOS has reversed 123 * command/data port and status port. Furthermore, /boot/device.hints 124 * may contain just one port, 0x60. We shall adjust resource settings 125 * so that these two ports are available as two separate resources 126 * in correct order. 127 */ 128 device_quiet(dev); 129 rid = 0; 130 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count) != 0) 131 return ENXIO; 132 if (start == IO_KBD + KBD_STATUS_PORT) { 133 start = IO_KBD; 134 count++; 135 } 136 if (count > 1) /* adjust the count and/or start port */ 137 bus_set_resource(dev, SYS_RES_IOPORT, rid, start, 1); 138 port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE); 139 if (port0 == NULL) 140 return ENXIO; 141 rid = 1; 142 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, NULL, NULL) != 0) 143 bus_set_resource(dev, SYS_RES_IOPORT, 1, 144 start + KBD_STATUS_PORT, 1); 145 port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE); 146 if (port1 == NULL) { 147 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 148 return ENXIO; 149 } 150 151#if defined(__i386__) || defined(__amd64__) 152 /* 153 * Check if we really have AT keyboard controller. Poll status 154 * register until we get "all clear" indication. If no such 155 * indication comes, it probably means that there is no AT 156 * keyboard controller present. Give up in such case. Check relies 157 * on the fact that reading from non-existing in/out port returns 158 * 0xff on i386. May or may not be true on other platforms. 159 */ 160 tag = rman_get_bustag(port0); 161 ioh1 = rman_get_bushandle(port1); 162 flags = intr_disable(); 163 for (i = 0; i != 65535; i++) { 164 if ((bus_space_read_1(tag, ioh1, 0) & 0x2) == 0) 165 break; 166 } 167 intr_restore(flags); 168 if (i == 65535) { 169 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 170 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1); 171 if (bootverbose) 172 device_printf(dev, "AT keyboard controller not found\n"); 173 return ENXIO; 174 } 175#endif 176 177 device_verbose(dev); 178 179 error = atkbdc_probe_unit(device_get_unit(dev), port0, port1); 180 181 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 182 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1); 183 184 return error; 185} 186 187static int 188atkbdc_isa_attach(device_t dev) 189{ 190 atkbdc_softc_t *sc; 191 int unit; 192 int error; 193 int rid; 194 195 unit = device_get_unit(dev); 196 sc = *(atkbdc_softc_t **)device_get_softc(dev); 197 if (sc == NULL) { 198 /* 199 * We have to maintain two copies of the kbdc_softc struct, 200 * as the low-level console needs to have access to the 201 * keyboard controller before kbdc is probed and attached. 202 * kbdc_soft[] contains the default entry for that purpose. 203 * See atkbdc.c. XXX 204 */ 205 sc = atkbdc_get_softc(unit); 206 if (sc == NULL) 207 return ENOMEM; 208 } 209 210 rid = 0; 211 sc->retry = 5000; 212 sc->port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, 213 RF_ACTIVE); 214 if (sc->port0 == NULL) 215 return ENXIO; 216 rid = 1; 217 sc->port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, 218 RF_ACTIVE); 219 if (sc->port1 == NULL) { 220 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 221 return ENXIO; 222 } 223 224 /* 225 * If the device is not created by the PnP BIOS or ACPI, then 226 * the hint for the IRQ is on the child atkbd device, not the 227 * keyboard controller, so this can fail. 228 */ 229 rid = 0; 230 sc->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE); 231 232 error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1); 233 if (error) { 234 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 235 bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1); 236 if (sc->irq != NULL) 237 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq); 238 return error; 239 } 240 *(atkbdc_softc_t **)device_get_softc(dev) = sc; 241 242 bus_generic_probe(dev); 243 bus_generic_attach(dev); 244 245 return 0; 246} 247 248static device_t 249atkbdc_isa_add_child(device_t bus, u_int order, const char *name, int unit) 250{ 251 atkbdc_device_t *ivar; 252 atkbdc_softc_t *sc; 253 device_t child; 254 int t; 255 256 sc = *(atkbdc_softc_t **)device_get_softc(bus); 257 ivar = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV, 258 M_NOWAIT | M_ZERO); 259 if (!ivar) 260 return NULL; 261 262 child = device_add_child_ordered(bus, order, name, unit); 263 if (child == NULL) { 264 free(ivar, M_ATKBDDEV); 265 return child; 266 } 267 268 resource_list_init(&ivar->resources); 269 ivar->rid = order; 270 271 /* 272 * If the device is not created by the PnP BIOS or ACPI, refer 273 * to device hints for IRQ. We always populate the resource 274 * list entry so we can use a standard bus_get_resource() 275 * method. 276 */ 277 if (order == KBDC_RID_KBD) { 278 if (sc->irq == NULL) { 279 if (resource_int_value(name, unit, "irq", &t) != 0) 280 t = -1; 281 } else 282 t = rman_get_start(sc->irq); 283 if (t > 0) 284 resource_list_add(&ivar->resources, SYS_RES_IRQ, 285 ivar->rid, t, t, 1); 286 } 287 288 if (resource_disabled(name, unit)) 289 device_disable(child); 290 291 device_set_ivars(child, ivar); 292 293 return child; 294} 295 296struct resource * 297atkbdc_isa_alloc_resource(device_t dev, device_t child, int type, int *rid, 298 u_long start, u_long end, u_long count, u_int flags) 299{ 300 atkbdc_softc_t *sc; 301 302 sc = *(atkbdc_softc_t **)device_get_softc(dev); 303 if (type == SYS_RES_IRQ && *rid == KBDC_RID_KBD && sc->irq != NULL) 304 return (sc->irq); 305 return (bus_generic_rl_alloc_resource(dev, child, type, rid, start, 306 end, count, flags)); 307} 308 309static int 310atkbdc_isa_release_resource(device_t dev, device_t child, int type, int rid, 311 struct resource *r) 312{ 313 atkbdc_softc_t *sc; 314 315 sc = *(atkbdc_softc_t **)device_get_softc(dev); 316 if (type == SYS_RES_IRQ && rid == KBDC_RID_KBD && r == sc->irq) 317 return (0); 318 return (bus_generic_rl_release_resource(dev, child, type, rid, r)); 319} 320 321DRIVER_MODULE(atkbdc, isa, atkbdc_isa_driver, atkbdc_devclass, 0, 0); 322DRIVER_MODULE(atkbdc, acpi, atkbdc_isa_driver, atkbdc_devclass, 0, 0); 323