atkbdc_subr.c revision 116181
143105Sdfr/*- 243105Sdfr * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 343105Sdfr * All rights reserved. 443105Sdfr * 543105Sdfr * Redistribution and use in source and binary forms, with or without 643105Sdfr * modification, are permitted provided that the following conditions 743105Sdfr * are met: 843105Sdfr * 1. Redistributions of source code must retain the above copyright 943105Sdfr * notice, this list of conditions and the following disclaimer as 1043105Sdfr * the first lines of this file unmodified. 1143105Sdfr * 2. Redistributions in binary form must reproduce the above copyright 1243105Sdfr * notice, this list of conditions and the following disclaimer in the 1343105Sdfr * documentation and/or other materials provided with the distribution. 1443105Sdfr * 1543105Sdfr * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 1643105Sdfr * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1743105Sdfr * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 1843105Sdfr * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, 1943105Sdfr * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2043105Sdfr * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2143105Sdfr * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2243105Sdfr * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2343105Sdfr * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2443105Sdfr * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2543105Sdfr */ 2643105Sdfr 27116181Sobrien#include <sys/cdefs.h> 28116181Sobrien__FBSDID("$FreeBSD: head/sys/dev/atkbdc/atkbdc_subr.c 116181 2003-06-11 00:34:37Z obrien $"); 29116181Sobrien 3043105Sdfr#include "opt_kbd.h" 3143105Sdfr 3243105Sdfr#include <sys/param.h> 3343105Sdfr#include <sys/systm.h> 3443105Sdfr#include <sys/kernel.h> 3543105Sdfr#include <sys/bus.h> 3643105Sdfr#include <sys/malloc.h> 3758271Syokota#include <machine/bus_pio.h> 3847400Sdfr#include <machine/bus.h> 3947400Sdfr#include <machine/resource.h> 4047400Sdfr#include <sys/rman.h> 4143105Sdfr 4243105Sdfr#include <dev/kbd/atkbdcreg.h> 4343105Sdfr 4443105Sdfr#include <isa/isareg.h> 4543105Sdfr#include <isa/isavar.h> 4643105Sdfr 4769774Sphkstatic MALLOC_DEFINE(M_ATKBDDEV, "atkbddev", "AT Keyboard device"); 4843105Sdfr 4943105Sdfr/* children */ 5043105Sdfrtypedef struct atkbdc_device { 5183147Syokota struct resource_list resources; 5283147Syokota int rid; 5358272Syokota u_int32_t vendorid; 5458272Syokota u_int32_t serial; 5558272Syokota u_int32_t logicalid; 5658272Syokota u_int32_t compatid; 5743105Sdfr} atkbdc_device_t; 5843105Sdfr 5943105Sdfr/* kbdc */ 60114293Smarkmstatic devclass_t atkbdc_devclass; 6143105Sdfr 6243105Sdfrstatic int atkbdc_probe(device_t dev); 6343105Sdfrstatic int atkbdc_attach(device_t dev); 6483147Syokotastatic device_t atkbdc_add_child(device_t bus, int order, char *name, 6583147Syokota int unit); 6649195Smdoddstatic int atkbdc_print_child(device_t bus, device_t dev); 6743105Sdfrstatic int atkbdc_read_ivar(device_t bus, device_t dev, int index, 6859783Sbde uintptr_t *val); 6943105Sdfrstatic int atkbdc_write_ivar(device_t bus, device_t dev, int index, 7059783Sbde uintptr_t val); 7183147Syokotastatic struct resource_list 7283147Syokota *atkbdc_get_resource_list (device_t bus, device_t dev); 7383147Syokotastatic struct resource 7483147Syokota *atkbdc_alloc_resource(device_t bus, device_t dev, int type, 7583147Syokota int *rid, u_long start, u_long end, 7683147Syokota u_long count, u_int flags); 7783147Syokotastatic int atkbdc_release_resource(device_t bus, device_t dev, int type, 7883147Syokota int rid, struct resource *res); 7943105Sdfr 8043105Sdfrstatic device_method_t atkbdc_methods[] = { 8143105Sdfr DEVMETHOD(device_probe, atkbdc_probe), 8243105Sdfr DEVMETHOD(device_attach, atkbdc_attach), 8347296Syokota DEVMETHOD(device_suspend, bus_generic_suspend), 8447296Syokota DEVMETHOD(device_resume, bus_generic_resume), 8543105Sdfr 8683147Syokota DEVMETHOD(bus_add_child, atkbdc_add_child), 8743105Sdfr DEVMETHOD(bus_print_child, atkbdc_print_child), 8843105Sdfr DEVMETHOD(bus_read_ivar, atkbdc_read_ivar), 8943105Sdfr DEVMETHOD(bus_write_ivar, atkbdc_write_ivar), 9083147Syokota DEVMETHOD(bus_get_resource_list,atkbdc_get_resource_list), 9183147Syokota DEVMETHOD(bus_alloc_resource, atkbdc_alloc_resource), 9283147Syokota DEVMETHOD(bus_release_resource, atkbdc_release_resource), 9343105Sdfr DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 9443105Sdfr DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 9583147Syokota DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource), 9683147Syokota DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource), 9783147Syokota DEVMETHOD(bus_delete_resource, bus_generic_rl_delete_resource), 9843105Sdfr DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 9943105Sdfr DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 10043105Sdfr 10143105Sdfr { 0, 0 } 10243105Sdfr}; 10343105Sdfr 10443105Sdfrstatic driver_t atkbdc_driver = { 10543105Sdfr ATKBDC_DRIVER_NAME, 10643105Sdfr atkbdc_methods, 10743105Sdfr sizeof(atkbdc_softc_t *), 10843105Sdfr}; 10943105Sdfr 11058271Syokotastatic struct isa_pnp_id atkbdc_ids[] = { 11158271Syokota { 0x0303d041, "Keyboard controller (i8042)" }, /* PNP0303 */ 11258271Syokota { 0 } 11358271Syokota}; 11458271Syokota 11543105Sdfrstatic int 11643105Sdfratkbdc_probe(device_t dev) 11743105Sdfr{ 11858271Syokota struct resource *port0; 11958271Syokota struct resource *port1; 12083147Syokota u_long start; 12183147Syokota u_long count; 12258271Syokota int error; 12358271Syokota int rid; 12443105Sdfr 12558271Syokota /* check PnP IDs */ 12658271Syokota if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO) 12758271Syokota return ENXIO; 12847618Sdfr 12958271Syokota device_set_desc(dev, "Keyboard controller (i8042)"); 13058271Syokota 13183147Syokota /* 13283147Syokota * Adjust I/O port resources. 13383147Syokota * The AT keyboard controller uses two ports (a command/data port 13483147Syokota * 0x60 and a status port 0x64), which may be given to us in 13583147Syokota * one resource (0x60 through 0x64) or as two separate resources 13683147Syokota * (0x60 and 0x64). Furthermore, /boot/device.hints may contain 13783147Syokota * just one port, 0x60. We shall adjust resource settings 13883147Syokota * so that these two ports are available as two separate resources. 13983147Syokota */ 14083147Syokota device_quiet(dev); 14147400Sdfr rid = 0; 14283147Syokota if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count) != 0) 14383147Syokota return ENXIO; 14483147Syokota if (count > 1) /* adjust the count */ 14583147Syokota bus_set_resource(dev, SYS_RES_IOPORT, rid, start, 1); 14658271Syokota port0 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, 14758271Syokota RF_ACTIVE); 14858271Syokota if (port0 == NULL) 14947400Sdfr return ENXIO; 15083147Syokota rid = 1; 15183147Syokota if (bus_get_resource(dev, SYS_RES_IOPORT, rid, NULL, NULL) != 0) 15258271Syokota bus_set_resource(dev, SYS_RES_IOPORT, 1, 15383147Syokota start + KBD_STATUS_PORT, 1); 15458271Syokota port1 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, 15558271Syokota RF_ACTIVE); 15658271Syokota if (port1 == NULL) { 15758271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 15858271Syokota return ENXIO; 15958271Syokota } 16083147Syokota device_verbose(dev); 16158271Syokota 16258271Syokota error = atkbdc_probe_unit(device_get_unit(dev), port0, port1); 16383147Syokota if (error == 0) 16483147Syokota bus_generic_probe(dev); 16558271Syokota 16658271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 0, port0); 16758271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 1, port1); 16858271Syokota 16943105Sdfr return error; 17043105Sdfr} 17143105Sdfr 17243105Sdfrstatic int 17343105Sdfratkbdc_attach(device_t dev) 17443105Sdfr{ 17543105Sdfr atkbdc_softc_t *sc; 17683147Syokota int unit; 17747296Syokota int error; 17848341Syokota int rid; 17943105Sdfr 18047296Syokota unit = device_get_unit(dev); 18143105Sdfr sc = *(atkbdc_softc_t **)device_get_softc(dev); 18247296Syokota if (sc == NULL) { 18347296Syokota /* 18447296Syokota * We have to maintain two copies of the kbdc_softc struct, 18547296Syokota * as the low-level console needs to have access to the 18647296Syokota * keyboard controller before kbdc is probed and attached. 18747296Syokota * kbdc_soft[] contains the default entry for that purpose. 18847296Syokota * See atkbdc.c. XXX 18947296Syokota */ 19047296Syokota sc = atkbdc_get_softc(unit); 19147296Syokota if (sc == NULL) 19247296Syokota return ENOMEM; 19347296Syokota } 19443105Sdfr 19548341Syokota rid = 0; 19658271Syokota sc->port0 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, 19758271Syokota RF_ACTIVE); 19858271Syokota if (sc->port0 == NULL) 19948341Syokota return ENXIO; 20058271Syokota rid = 1; 20158271Syokota sc->port1 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, 20258271Syokota RF_ACTIVE); 20358271Syokota if (sc->port1 == NULL) { 20458271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 20558271Syokota return ENXIO; 20658271Syokota } 20758271Syokota 20858271Syokota error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1); 20958271Syokota if (error) { 21058271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0); 21158271Syokota bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1); 21247296Syokota return error; 21358271Syokota } 21447296Syokota *(atkbdc_softc_t **)device_get_softc(dev) = sc; 21547296Syokota 21683147Syokota bus_generic_attach(dev); 21743105Sdfr 21883147Syokota return 0; 21983147Syokota} 22083147Syokota 22183147Syokotastatic device_t 22283147Syokotaatkbdc_add_child(device_t bus, int order, char *name, int unit) 22383147Syokota{ 22483147Syokota atkbdc_device_t *ivar; 22583147Syokota device_t child; 22683147Syokota int t; 22783147Syokota 22883147Syokota ivar = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV, 22983147Syokota M_NOWAIT | M_ZERO); 23083147Syokota if (!ivar) 23183147Syokota return NULL; 23283147Syokota 23383931Syokota child = device_add_child_ordered(bus, order, name, unit); 23483147Syokota if (child == NULL) { 23583147Syokota free(ivar, M_ATKBDDEV); 23683147Syokota return child; 23783147Syokota } 23883147Syokota 23983147Syokota resource_list_init(&ivar->resources); 24083147Syokota ivar->rid = order; 24183147Syokota 24243105Sdfr /* 24383147Syokota * If the device is not created by the PnP BIOS or ACPI, 24483147Syokota * refer to device hints for IRQ. 24543105Sdfr */ 24683147Syokota if (ISA_PNP_PROBE(device_get_parent(bus), bus, atkbdc_ids) != 0) { 24783147Syokota if (resource_int_value(name, unit, "irq", &t) != 0) 24883147Syokota t = -1; 24983147Syokota } else { 25083147Syokota t = bus_get_resource_start(bus, SYS_RES_IRQ, ivar->rid); 25183147Syokota } 25283147Syokota if (t > 0) 25383147Syokota resource_list_add(&ivar->resources, SYS_RES_IRQ, ivar->rid, 25483147Syokota t, t, 1); 25543105Sdfr 25683147Syokota if (resource_int_value(name, unit, "flags", &t) == 0) 25783147Syokota device_set_flags(child, t); 25883147Syokota if (resource_int_value(name, unit, "disabled", &t) == 0 && t != 0) 25983147Syokota device_disable(child); 26043105Sdfr 26183147Syokota device_set_ivars(child, ivar); 26283147Syokota 26383147Syokota return child; 26443105Sdfr} 26543105Sdfr 26649195Smdoddstatic int 26743105Sdfratkbdc_print_child(device_t bus, device_t dev) 26843105Sdfr{ 26943105Sdfr atkbdc_device_t *kbdcdev; 27083147Syokota u_long irq; 27183147Syokota int flags; 27249195Smdodd int retval = 0; 27343105Sdfr 27443105Sdfr kbdcdev = (atkbdc_device_t *)device_get_ivars(dev); 27543105Sdfr 27649195Smdodd retval += bus_print_child_header(bus, dev); 27783147Syokota flags = device_get_flags(dev); 27883147Syokota if (flags != 0) 27983147Syokota retval += printf(" flags 0x%x", flags); 28083147Syokota irq = bus_get_resource_start(dev, SYS_RES_IRQ, kbdcdev->rid); 28183147Syokota if (irq != 0) 28283147Syokota retval += printf(" irq %ld", irq); 28349195Smdodd retval += bus_print_child_footer(bus, dev); 28443105Sdfr 28549195Smdodd return (retval); 28643105Sdfr} 28743105Sdfr 28843105Sdfrstatic int 28959783Sbdeatkbdc_read_ivar(device_t bus, device_t dev, int index, uintptr_t *val) 29043105Sdfr{ 29143105Sdfr atkbdc_device_t *ivar; 29243105Sdfr 29343105Sdfr ivar = (atkbdc_device_t *)device_get_ivars(dev); 29443105Sdfr switch (index) { 29558272Syokota case KBDC_IVAR_VENDORID: 29658272Syokota *val = (u_long)ivar->vendorid; 29758272Syokota break; 29858272Syokota case KBDC_IVAR_SERIAL: 29958272Syokota *val = (u_long)ivar->serial; 30058272Syokota break; 30158272Syokota case KBDC_IVAR_LOGICALID: 30258272Syokota *val = (u_long)ivar->logicalid; 30358272Syokota break; 30458272Syokota case KBDC_IVAR_COMPATID: 30558272Syokota *val = (u_long)ivar->compatid; 30658272Syokota break; 30743105Sdfr default: 30843105Sdfr return ENOENT; 30943105Sdfr } 31043105Sdfr return 0; 31143105Sdfr} 31243105Sdfr 31343105Sdfrstatic int 31459783Sbdeatkbdc_write_ivar(device_t bus, device_t dev, int index, uintptr_t val) 31543105Sdfr{ 31643105Sdfr atkbdc_device_t *ivar; 31743105Sdfr 31843105Sdfr ivar = (atkbdc_device_t *)device_get_ivars(dev); 31943105Sdfr switch (index) { 32058272Syokota case KBDC_IVAR_VENDORID: 32158272Syokota ivar->vendorid = (u_int32_t)val; 32258272Syokota break; 32358272Syokota case KBDC_IVAR_SERIAL: 32458272Syokota ivar->serial = (u_int32_t)val; 32558272Syokota break; 32658272Syokota case KBDC_IVAR_LOGICALID: 32758272Syokota ivar->logicalid = (u_int32_t)val; 32858272Syokota break; 32958272Syokota case KBDC_IVAR_COMPATID: 33058272Syokota ivar->compatid = (u_int32_t)val; 33158272Syokota break; 33243105Sdfr default: 33343105Sdfr return ENOENT; 33443105Sdfr } 33543105Sdfr return 0; 33643105Sdfr} 33743105Sdfr 33883147Syokotastatic struct resource_list 33983147Syokota*atkbdc_get_resource_list (device_t bus, device_t dev) 34083147Syokota{ 34183147Syokota atkbdc_device_t *ivar; 34283147Syokota 34383147Syokota ivar = (atkbdc_device_t *)device_get_ivars(dev); 34483147Syokota return &ivar->resources; 34583147Syokota} 34683147Syokota 34783147Syokotastatic struct resource 34883147Syokota*atkbdc_alloc_resource(device_t bus, device_t dev, int type, int *rid, 34983147Syokota u_long start, u_long end, u_long count, u_int flags) 35083147Syokota{ 35183147Syokota atkbdc_device_t *ivar; 35283147Syokota 35383147Syokota ivar = (atkbdc_device_t *)device_get_ivars(dev); 35483147Syokota return resource_list_alloc(&ivar->resources, bus, dev, type, rid, 35583147Syokota start, end, count, flags); 35683147Syokota} 35783147Syokota 35883147Syokotastatic int 35983147Syokotaatkbdc_release_resource(device_t bus, device_t dev, int type, int rid, 36083147Syokota struct resource *res) 36183147Syokota{ 36283147Syokota atkbdc_device_t *ivar; 36383147Syokota 36483147Syokota ivar = (atkbdc_device_t *)device_get_ivars(dev); 36583147Syokota return resource_list_release(&ivar->resources, bus, dev, type, rid, 36683147Syokota res); 36783147Syokota} 36883147Syokota 36943105SdfrDRIVER_MODULE(atkbdc, isa, atkbdc_driver, atkbdc_devclass, 0, 0); 37082555SmsmithDRIVER_MODULE(atkbdc, acpi, atkbdc_driver, atkbdc_devclass, 0, 0); 371