2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer as
12 * the first lines of this file unmodified.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
39 #include <sys/malloc.h>
40 #include <machine/resource.h>
42 #include <machine/bus.h>
44 #include <dev/atkbdc/atkbdc_subr.h>
45 #include <dev/atkbdc/atkbdcreg.h>
47 #include <isa/isareg.h>
48 #include <isa/isavar.h>
50 static int atkbdc_isa_probe(device_t dev);
51 static int atkbdc_isa_attach(device_t dev);
52 static device_t atkbdc_isa_add_child(device_t bus, u_int order, const char *name,
54 static struct resource *atkbdc_isa_alloc_resource(device_t dev, device_t child,
55 int type, int *rid, rman_res_t start, rman_res_t end,
56 rman_res_t count, u_int flags);
57 static int atkbdc_isa_release_resource(device_t dev, device_t child,
58 int type, int rid, struct resource *r);
60 static device_method_t atkbdc_isa_methods[] = {
61 DEVMETHOD(device_probe, atkbdc_isa_probe),
62 DEVMETHOD(device_attach, atkbdc_isa_attach),
63 DEVMETHOD(device_suspend, bus_generic_suspend),
64 DEVMETHOD(device_resume, bus_generic_resume),
66 DEVMETHOD(bus_add_child, atkbdc_isa_add_child),
67 DEVMETHOD(bus_print_child, atkbdc_print_child),
68 DEVMETHOD(bus_read_ivar, atkbdc_read_ivar),
69 DEVMETHOD(bus_write_ivar, atkbdc_write_ivar),
70 DEVMETHOD(bus_get_resource_list,atkbdc_get_resource_list),
71 DEVMETHOD(bus_alloc_resource, atkbdc_isa_alloc_resource),
72 DEVMETHOD(bus_release_resource, atkbdc_isa_release_resource),
73 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
74 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
75 DEVMETHOD(bus_get_resource, bus_generic_rl_get_resource),
76 DEVMETHOD(bus_set_resource, bus_generic_rl_set_resource),
77 DEVMETHOD(bus_delete_resource, bus_generic_rl_delete_resource),
78 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
79 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
84 static driver_t atkbdc_isa_driver = {
87 sizeof(atkbdc_softc_t *),
90 static struct isa_pnp_id atkbdc_ids[] = {
91 { 0x0303d041, "Keyboard controller (i8042)" }, /* PNP0303 */
92 { 0x0b03d041, "Keyboard controller (i8042)" }, /* PNP030B */
93 { 0x2003d041, "Keyboard controller (i8042)" }, /* PNP0320 */
98 atkbdc_isa_probe(device_t dev)
100 struct resource *port0;
101 struct resource *port1;
106 #if defined(__i386__) || defined(__amd64__)
108 bus_space_handle_t ioh1;
114 if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO)
117 device_set_desc(dev, "Keyboard controller (i8042)");
120 * Adjust I/O port resources.
121 * The AT keyboard controller uses two ports (a command/data port
122 * 0x60 and a status port 0x64), which may be given to us in
123 * one resource (0x60 through 0x64) or as two separate resources
124 * (0x60 and 0x64). Some brain-damaged ACPI BIOS has reversed
125 * command/data port and status port. Furthermore, /boot/device.hints
126 * may contain just one port, 0x60. We shall adjust resource settings
127 * so that these two ports are available as two separate resources
132 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &start, &count) != 0)
134 if (start == IO_KBD + KBD_STATUS_PORT) {
138 if (count > 1) /* adjust the count and/or start port */
139 bus_set_resource(dev, SYS_RES_IOPORT, rid, start, 1);
140 port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
144 if (bus_get_resource(dev, SYS_RES_IOPORT, rid, NULL, NULL) != 0)
145 bus_set_resource(dev, SYS_RES_IOPORT, 1,
146 start + KBD_STATUS_PORT, 1);
147 port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
149 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
153 #if defined(__i386__) || defined(__amd64__)
155 * Check if we really have AT keyboard controller. Poll status
156 * register until we get "all clear" indication. If no such
157 * indication comes, it probably means that there is no AT
158 * keyboard controller present. Give up in such case. Check relies
159 * on the fact that reading from non-existing in/out port returns
160 * 0xff on i386. May or may not be true on other platforms.
162 tag = rman_get_bustag(port0);
163 ioh1 = rman_get_bushandle(port1);
164 flags = intr_disable();
165 for (i = 0; i != 65535; i++) {
166 if ((bus_space_read_1(tag, ioh1, 0) & 0x2) == 0)
171 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
172 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1);
174 device_printf(dev, "AT keyboard controller not found\n");
181 error = atkbdc_probe_unit(device_get_unit(dev), port0, port1);
183 bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
184 bus_release_resource(dev, SYS_RES_IOPORT, 1, port1);
190 atkbdc_isa_attach(device_t dev)
197 unit = device_get_unit(dev);
198 sc = *(atkbdc_softc_t **)device_get_softc(dev);
201 * We have to maintain two copies of the kbdc_softc struct,
202 * as the low-level console needs to have access to the
203 * keyboard controller before kbdc is probed and attached.
204 * kbdc_soft[] contains the default entry for that purpose.
207 sc = atkbdc_get_softc(unit);
214 sc->port0 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
216 if (sc->port0 == NULL)
219 sc->port1 = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
221 if (sc->port1 == NULL) {
222 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
227 * If the device is not created by the PnP BIOS or ACPI, then
228 * the hint for the IRQ is on the child atkbd device, not the
229 * keyboard controller, so this can fail.
232 sc->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
234 error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1);
236 bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
237 bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1);
239 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq);
242 *(atkbdc_softc_t **)device_get_softc(dev) = sc;
244 bus_generic_probe(dev);
245 bus_generic_attach(dev);
251 atkbdc_isa_add_child(device_t bus, u_int order, const char *name, int unit)
253 atkbdc_device_t *ivar;
258 sc = *(atkbdc_softc_t **)device_get_softc(bus);
259 ivar = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV,
264 child = device_add_child_ordered(bus, order, name, unit);
266 free(ivar, M_ATKBDDEV);
270 resource_list_init(&ivar->resources);
274 * If the device is not created by the PnP BIOS or ACPI, refer
275 * to device hints for IRQ. We always populate the resource
276 * list entry so we can use a standard bus_get_resource()
279 if (order == KBDC_RID_KBD) {
280 if (sc->irq == NULL) {
281 if (resource_int_value(name, unit, "irq", &t) != 0)
284 t = rman_get_start(sc->irq);
286 resource_list_add(&ivar->resources, SYS_RES_IRQ,
290 if (resource_disabled(name, unit))
291 device_disable(child);
293 device_set_ivars(child, ivar);
299 atkbdc_isa_alloc_resource(device_t dev, device_t child, int type, int *rid,
300 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
304 sc = *(atkbdc_softc_t **)device_get_softc(dev);
305 if (type == SYS_RES_IRQ && *rid == KBDC_RID_KBD && sc->irq != NULL)
307 return (bus_generic_rl_alloc_resource(dev, child, type, rid, start,
312 atkbdc_isa_release_resource(device_t dev, device_t child, int type, int rid,
317 sc = *(atkbdc_softc_t **)device_get_softc(dev);
318 if (type == SYS_RES_IRQ && rid == KBDC_RID_KBD && r == sc->irq)
320 return (bus_generic_rl_release_resource(dev, child, type, rid, r));
323 DRIVER_MODULE(atkbdc, isa, atkbdc_isa_driver, atkbdc_devclass, 0, 0);
324 DRIVER_MODULE(atkbdc, acpi, atkbdc_isa_driver, atkbdc_devclass, 0, 0);
325 ISA_PNP_INFO(atkbdc_ids);