1/* $NetBSD: pckbc_acpi.c,v 1.39 2021/01/29 15:24:00 thorpej Exp $ */ 2 3/*- 4 * Copyright (c) 2000 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32/* 33 * ACPI attachment for the PC Keyboard Controller driver. 34 * 35 * This is a little wonky. The keyboard controller actually 36 * has 2 ACPI nodes: one for the controller and the keyboard 37 * interrupt, and one for the aux port (mouse) interrupt. 38 * 39 * For this reason, we actually attach *two* instances of this 40 * driver. After both of them have been found, then we attach 41 * sub-devices. 42 */ 43 44#include <sys/cdefs.h> 45__KERNEL_RCSID(0, "$NetBSD: pckbc_acpi.c,v 1.39 2021/01/29 15:24:00 thorpej Exp $"); 46 47#include <sys/param.h> 48#include <sys/callout.h> 49#include <sys/device.h> 50#include <sys/malloc.h> 51#include <sys/systm.h> 52 53#include <dev/acpi/acpivar.h> 54#include <dev/acpi/acpi_intr.h> 55 56#include <dev/isa/isareg.h> 57 58#include <dev/ic/i8042reg.h> 59#include <dev/ic/pckbcvar.h> 60 61#include "ioconf.h" 62 63static int pckbc_acpi_match(device_t, cfdata_t, void *); 64static void pckbc_acpi_attach(device_t, device_t, void *); 65 66struct pckbc_acpi_softc { 67 struct pckbc_softc sc_pckbc; 68 69 ACPI_HANDLE sc_handle; 70 pckbc_slot_t sc_slot; 71}; 72 73/* Save first port: */ 74static struct pckbc_acpi_softc *first; 75 76CFATTACH_DECL_NEW(pckbc_acpi, sizeof(struct pckbc_acpi_softc), 77 pckbc_acpi_match, pckbc_acpi_attach, NULL, NULL); 78 79static void pckbc_acpi_intr_establish(struct pckbc_softc *, pckbc_slot_t); 80static void pckbc_acpi_finish_attach(device_t); 81 82/* 83 * Supported Device IDs 84 */ 85 86static const struct device_compatible_entry compat_data[] = { 87 /* Standard PC KBD port */ 88 { .compat = "PNP03??", .value = PCKBC_KBD_SLOT }, 89 90 /* (Nobody else here but us mouses...) */ 91 { .compat = "PNP0F03", .value = PCKBC_AUX_SLOT }, 92 { .compat = "PNP0F0E", .value = PCKBC_AUX_SLOT }, 93 { .compat = "PNP0F12", .value = PCKBC_AUX_SLOT }, 94 { .compat = "PNP0F13", .value = PCKBC_AUX_SLOT }, 95 { .compat = "PNP0F19", .value = PCKBC_AUX_SLOT }, 96 { .compat = "PNP0F1B", .value = PCKBC_AUX_SLOT }, 97 { .compat = "PNP0F1C", .value = PCKBC_AUX_SLOT }, 98 { .compat = "SYN0302", .value = PCKBC_AUX_SLOT }, 99 100 DEVICE_COMPAT_EOL 101}; 102 103/* 104 * pckbc_acpi_match: autoconf(9) match routine 105 */ 106static int 107pckbc_acpi_match(device_t parent, cfdata_t match, void *aux) 108{ 109 struct acpi_attach_args *aa = aux; 110 111 return acpi_compatible_match(aa, compat_data); 112} 113 114static void 115pckbc_acpi_attach(device_t parent, device_t self, void *aux) 116{ 117 struct pckbc_acpi_softc *psc = device_private(self); 118 struct pckbc_softc *sc = &psc->sc_pckbc; 119 struct pckbc_internal *t; 120 struct acpi_attach_args *aa = aux; 121 const struct device_compatible_entry *dce; 122 bus_space_handle_t ioh_d, ioh_c; 123 struct acpi_resources res; 124 struct acpi_io *io0, *io1, *ioswap; 125 struct acpi_irq *irq; 126 ACPI_STATUS rv; 127 128 sc->sc_dv = self; 129 130 dce = acpi_compatible_lookup(aa, compat_data); 131 KASSERT(dce != NULL); 132 133 psc->sc_slot = dce->value; 134 135 aprint_normal(" (%s port)", pckbc_slot_names[psc->sc_slot]); 136 137 /* parse resources */ 138 rv = acpi_resource_parse(sc->sc_dv, aa->aa_node->ad_handle, "_CRS", 139 &res, &acpi_resource_parse_ops_default); 140 if (ACPI_FAILURE(rv)) 141 return; 142 143 /* find our IRQ */ 144 irq = acpi_res_irq(&res, 0); 145 if (irq == NULL) { 146 aprint_error_dev(self, "unable to find irq resource\n"); 147 goto out; 148 } 149 psc->sc_handle = aa->aa_node->ad_handle; 150 151 if (psc->sc_slot == PCKBC_KBD_SLOT) 152 first = psc; 153 154 if ((!first || !first->sc_pckbc.id) && 155 (psc->sc_slot == PCKBC_KBD_SLOT)) { 156 157 io0 = acpi_res_io(&res, 0); 158 io1 = acpi_res_io(&res, 1); 159 if (io0 == NULL || io1 == NULL) { 160 aprint_error_dev(self, 161 "unable to find i/o resources\n"); 162 goto out; 163 } 164 165 /* 166 * JDM: Some firmware doesn't report resources in the order we 167 * expect; sort IO resources here (lowest first) 168 */ 169 if (io0->ar_base > io1->ar_base) { 170 ioswap = io0; 171 io0 = io1; 172 io1 = ioswap; 173 } 174 175 if (pckbc_is_console(aa->aa_iot, io0->ar_base)) { 176 t = &pckbc_consdata; 177 ioh_d = t->t_ioh_d; 178 ioh_c = t->t_ioh_c; 179 pckbc_console_attached = 1; 180 /* t->t_cmdbyte was initialized by cnattach */ 181 } else { 182 if (bus_space_map(aa->aa_iot, io0->ar_base, 183 io0->ar_length, 0, &ioh_d) || 184 bus_space_map(aa->aa_iot, io1->ar_base, 185 io1->ar_length, 0, &ioh_c)) { 186 aprint_error_dev(self, 187 "unable to map registers\n"); 188 goto out; 189 } 190 191 t = malloc(sizeof(struct pckbc_internal), 192 M_DEVBUF, M_WAITOK|M_ZERO); 193 t->t_iot = aa->aa_iot; 194 t->t_ioh_d = ioh_d; 195 t->t_ioh_c = ioh_c; 196 t->t_addr = io0->ar_base; 197 t->t_cmdbyte = KC8_CPU; /* Enable ports */ 198 callout_init(&t->t_cleanup, 0); 199 } 200 201 t->t_sc = &first->sc_pckbc; 202 first->sc_pckbc.id = t; 203 204 if (!pmf_device_register(self, NULL, pckbc_resume)) 205 aprint_error_dev(self, 206 "couldn't establish power handler\n"); 207 208 first->sc_pckbc.intr_establish = pckbc_acpi_intr_establish; 209 config_defer(first->sc_pckbc.sc_dv, pckbc_acpi_finish_attach); 210 } 211 212out: 213 if (!pmf_device_register(self, NULL, NULL)) 214 aprint_error_dev(self, "couldn't establish power handler\n"); 215 acpi_resource_cleanup(&res); 216} 217 218static void 219pckbc_acpi_intr_establish(struct pckbc_softc *sc, pckbc_slot_t slot) 220{ 221 struct pckbc_acpi_softc *psc = NULL; /* XXX: gcc */ 222 void *rv = NULL; 223 ACPI_HANDLE handle; 224 char intr_name[64]; 225 int i; 226 227 /* 228 * Note we're always called with sc == first. 229 */ 230 for (i = 0; i < pckbc_cd.cd_ndevs; i++) { 231 psc = device_lookup_private(&pckbc_cd, i); 232 if (psc && psc->sc_slot == slot) { 233 handle = psc->sc_handle; 234 break; 235 } 236 } 237 if (i < pckbc_cd.cd_ndevs) { 238 snprintf(intr_name, sizeof(intr_name), "%s %s", 239 device_xname(psc->sc_pckbc.sc_dv), pckbc_slot_names[slot]); 240 241 rv = acpi_intr_establish(sc->sc_dv, (uint64_t)(uintptr_t)handle, 242 IPL_TTY, false, pckbcintr, sc, intr_name); 243 } 244 if (rv == NULL) { 245 aprint_error_dev(sc->sc_dv, 246 "unable to establish interrupt for %s slot\n", 247 pckbc_slot_names[slot]); 248 } else { 249 aprint_normal_dev(sc->sc_dv, "using %s for %s slot\n", 250 acpi_intr_string(rv, intr_name, sizeof(intr_name)), 251 pckbc_slot_names[slot]); 252 } 253} 254 255static void 256pckbc_acpi_finish_attach(device_t dv) 257{ 258 259 pckbc_attach(device_private(dv)); 260} 261