atkbdc_subr.c revision 127135
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: head/sys/dev/atkbdc/atkbdc_subr.c 127135 2004-03-17 17:50:55Z njl $"); 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/bus.h> 36#include <sys/malloc.h> 37#include <machine/bus_pio.h> 38#include <machine/bus.h> 39#include <machine/resource.h> 40#include <sys/rman.h> 41 42#include <dev/kbd/atkbdcreg.h> 43 44#include <isa/isareg.h> 45#include <isa/isavar.h> 46 47static MALLOC_DEFINE(M_ATKBDDEV, "atkbddev", "AT Keyboard device"); 48 49/* children */ 50typedef struct atkbdc_device { 51 struct resource_list resources; 52 int rid; 53 u_int32_t vendorid; 54 u_int32_t serial; 55 u_int32_t logicalid; 56 u_int32_t compatid; 57} atkbdc_device_t; 58 59/* kbdc */ 60static devclass_t atkbdc_devclass; 61 62static int atkbdc_probe(device_t dev); 63static int atkbdc_attach(device_t dev); 64static device_t atkbdc_add_child(device_t bus, int order, char *name, 65 int unit); 66static int atkbdc_print_child(device_t bus, device_t dev); 67static int atkbdc_read_ivar(device_t bus, device_t dev, int index, 68 uintptr_t *val); 69static int atkbdc_write_ivar(device_t bus, device_t dev, int index, 70 uintptr_t val); 71static struct resource_list 72 *atkbdc_get_resource_list (device_t bus, device_t dev); 73static struct resource 74 *atkbdc_alloc_resource(device_t bus, device_t dev, int type, 75 int *rid, u_long start, u_long end, 76 u_long count, u_int flags); 77static int atkbdc_release_resource(device_t bus, device_t dev, int type, 78 int rid, struct resource *res); 79 80static device_method_t atkbdc_methods[] = { 81 DEVMETHOD(device_probe, atkbdc_probe), 82 DEVMETHOD(device_attach, atkbdc_attach), 83 DEVMETHOD(device_suspend, bus_generic_suspend), 84 DEVMETHOD(device_resume, bus_generic_resume), 85 86 DEVMETHOD(bus_add_child, atkbdc_add_child), 87 DEVMETHOD(bus_print_child, atkbdc_print_child), 88 DEVMETHOD(bus_read_ivar, atkbdc_read_ivar), 89 DEVMETHOD(bus_write_ivar, atkbdc_write_ivar), 90 DEVMETHOD(bus_get_resource_list,atkbdc_get_resource_list), 91 DEVMETHOD(bus_alloc_resource, atkbdc_alloc_resource), 92 DEVMETHOD(bus_release_resource, atkbdc_release_resource), 93 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 94 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 95 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 96 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 97 DEVMETHOD(bus_delete_resource, bus_generic_rl_delete_resource), 98 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 99 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 100 101 { 0, 0 } 102}; 103 104static driver_t atkbdc_driver = { 105 ATKBDC_DRIVER_NAME, 106 atkbdc_methods, 107 sizeof(atkbdc_softc_t *), 108}; 109 110static struct isa_pnp_id atkbdc_ids[] = { 111 { 0x0303d041, "Keyboard controller (i8042)" }, /* PNP0303 */ 112 { 0 } 113}; 114 115static int 116atkbdc_probe(device_t dev) 117{ 118 struct resource *port0; 119 struct resource *port1; 120 u_long start; 121 u_long count; 122 int error; 123 int rid; 124 125 /* check PnP IDs */ 126 if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO) 127 return ENXIO; 128 129 device_set_desc(dev, "Keyboard controller (i8042)"); 130 131 /* 132 * Adjust I/O port resources. 133 * The AT keyboard controller uses two ports (a command/data port 134 * 0x60 and a status port 0x64), which may be given to us in 135 * one resource (0x60 through 0x64) or as two separate resources 136 * (0x60 and 0x64). Furthermore, /boot/device.hints may contain 137 * just one port, 0x60. We shall adjust resource settings 138 * so that these two ports are available as two separate resources. 139 */ 140 device_quiet(dev); 141 rid = 0; 142 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count) != 0) 143 return ENXIO; 144 if (count > 1) /* adjust the count */ 145 bus_set_resource(dev, SYS_RES_IOPORT, rid, start, 1); 146 port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE); 147 if (port0 == NULL) 148 return ENXIO; 149 rid = 1; 150 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, NULL, NULL) != 0) 151 bus_set_resource(dev, SYS_RES_IOPORT, 1, 152 start + KBD_STATUS_PORT, 1); 153 port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE); 154 if (port1 == NULL) { 155 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 156 return ENXIO; 157 } 158 device_verbose(dev); 159 160 error = atkbdc_probe_unit(device_get_unit(dev), port0, port1); 161 if (error == 0) 162 bus_generic_probe(dev); 163 164 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 165 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1); 166 167 return error; 168} 169 170static int 171atkbdc_attach(device_t dev) 172{ 173 atkbdc_softc_t *sc; 174 int unit; 175 int error; 176 int rid; 177 178 unit = device_get_unit(dev); 179 sc = *(atkbdc_softc_t **)device_get_softc(dev); 180 if (sc == NULL) { 181 /* 182 * We have to maintain two copies of the kbdc_softc struct, 183 * as the low-level console needs to have access to the 184 * keyboard controller before kbdc is probed and attached. 185 * kbdc_soft[] contains the default entry for that purpose. 186 * See atkbdc.c. XXX 187 */ 188 sc = atkbdc_get_softc(unit); 189 if (sc == NULL) 190 return ENOMEM; 191 } 192 193 rid = 0; 194 sc->port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, 195 RF_ACTIVE); 196 if (sc->port0 == NULL) 197 return ENXIO; 198 rid = 1; 199 sc->port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, 200 RF_ACTIVE); 201 if (sc->port1 == NULL) { 202 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 203 return ENXIO; 204 } 205 206 error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1); 207 if (error) { 208 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 209 bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1); 210 return error; 211 } 212 *(atkbdc_softc_t **)device_get_softc(dev) = sc; 213 214 bus_generic_attach(dev); 215 216 return 0; 217} 218 219static device_t 220atkbdc_add_child(device_t bus, int order, char *name, int unit) 221{ 222 atkbdc_device_t *ivar; 223 device_t child; 224 int t; 225 226 ivar = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV, 227 M_NOWAIT | M_ZERO); 228 if (!ivar) 229 return NULL; 230 231 child = device_add_child_ordered(bus, order, name, unit); 232 if (child == NULL) { 233 free(ivar, M_ATKBDDEV); 234 return child; 235 } 236 237 resource_list_init(&ivar->resources); 238 ivar->rid = order; 239 240 /* 241 * If the device is not created by the PnP BIOS or ACPI, 242 * refer to device hints for IRQ. 243 */ 244 if (ISA_PNP_PROBE(device_get_parent(bus), bus, atkbdc_ids) != 0) { 245 if (resource_int_value(name, unit, "irq", &t) != 0) 246 t = -1; 247 } else { 248 t = bus_get_resource_start(bus, SYS_RES_IRQ, ivar->rid); 249 } 250 if (t > 0) 251 resource_list_add(&ivar->resources, SYS_RES_IRQ, ivar->rid, 252 t, t, 1); 253 254 if (resource_int_value(name, unit, "flags", &t) == 0) 255 device_set_flags(child, t); 256 if (resource_disabled(name, unit)) 257 device_disable(child); 258 259 device_set_ivars(child, ivar); 260 261 return child; 262} 263 264static int 265atkbdc_print_child(device_t bus, device_t dev) 266{ 267 atkbdc_device_t *kbdcdev; 268 u_long irq; 269 int flags; 270 int retval = 0; 271 272 kbdcdev = (atkbdc_device_t *)device_get_ivars(dev); 273 274 retval += bus_print_child_header(bus, dev); 275 flags = device_get_flags(dev); 276 if (flags != 0) 277 retval += printf(" flags 0x%x", flags); 278 irq = bus_get_resource_start(dev, SYS_RES_IRQ, kbdcdev->rid); 279 if (irq != 0) 280 retval += printf(" irq %ld", irq); 281 retval += bus_print_child_footer(bus, dev); 282 283 return (retval); 284} 285 286static int 287atkbdc_read_ivar(device_t bus, device_t dev, int index, uintptr_t *val) 288{ 289 atkbdc_device_t *ivar; 290 291 ivar = (atkbdc_device_t *)device_get_ivars(dev); 292 switch (index) { 293 case KBDC_IVAR_VENDORID: 294 *val = (u_long)ivar->vendorid; 295 break; 296 case KBDC_IVAR_SERIAL: 297 *val = (u_long)ivar->serial; 298 break; 299 case KBDC_IVAR_LOGICALID: 300 *val = (u_long)ivar->logicalid; 301 break; 302 case KBDC_IVAR_COMPATID: 303 *val = (u_long)ivar->compatid; 304 break; 305 default: 306 return ENOENT; 307 } 308 return 0; 309} 310 311static int 312atkbdc_write_ivar(device_t bus, device_t dev, int index, uintptr_t val) 313{ 314 atkbdc_device_t *ivar; 315 316 ivar = (atkbdc_device_t *)device_get_ivars(dev); 317 switch (index) { 318 case KBDC_IVAR_VENDORID: 319 ivar->vendorid = (u_int32_t)val; 320 break; 321 case KBDC_IVAR_SERIAL: 322 ivar->serial = (u_int32_t)val; 323 break; 324 case KBDC_IVAR_LOGICALID: 325 ivar->logicalid = (u_int32_t)val; 326 break; 327 case KBDC_IVAR_COMPATID: 328 ivar->compatid = (u_int32_t)val; 329 break; 330 default: 331 return ENOENT; 332 } 333 return 0; 334} 335 336static struct resource_list 337*atkbdc_get_resource_list (device_t bus, device_t dev) 338{ 339 atkbdc_device_t *ivar; 340 341 ivar = (atkbdc_device_t *)device_get_ivars(dev); 342 return &ivar->resources; 343} 344 345static struct resource 346*atkbdc_alloc_resource(device_t bus, device_t dev, int type, int *rid, 347 u_long start, u_long end, u_long count, u_int flags) 348{ 349 atkbdc_device_t *ivar; 350 351 ivar = (atkbdc_device_t *)device_get_ivars(dev); 352 return resource_list_alloc(&ivar->resources, bus, dev, type, rid, 353 start, end, count, flags); 354} 355 356static int 357atkbdc_release_resource(device_t bus, device_t dev, int type, int rid, 358 struct resource *res) 359{ 360 atkbdc_device_t *ivar; 361 362 ivar = (atkbdc_device_t *)device_get_ivars(dev); 363 return resource_list_release(&ivar->resources, bus, dev, type, rid, 364 res); 365} 366 367DRIVER_MODULE(atkbdc, isa, atkbdc_driver, atkbdc_devclass, 0, 0); 368DRIVER_MODULE(atkbdc, acpi, atkbdc_driver, atkbdc_devclass, 0, 0); 369