xref: /netbsd/sys/dev/acpi/pckbc_acpi.c (revision 6550d01e)
1 /*	$NetBSD: pckbc_acpi.c,v 1.33 2010/03/05 14:00:17 jruoho 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.33 2010/03/05 14:00:17 jruoho 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 
55 #include <dev/isa/isareg.h>
56 
57 #include <dev/ic/i8042reg.h>
58 #include <dev/ic/pckbcvar.h>
59 
60 static int	pckbc_acpi_match(device_t, cfdata_t, void *);
61 static void	pckbc_acpi_attach(device_t, device_t, void *);
62 
63 struct pckbc_acpi_softc {
64 	struct pckbc_softc sc_pckbc;
65 
66 	isa_chipset_tag_t sc_ic;
67 	int sc_irq;
68 	int sc_ist;
69 	pckbc_slot_t sc_slot;
70 };
71 
72 /* Save first port: */
73 static struct pckbc_acpi_softc *first;
74 
75 extern struct cfdriver pckbc_cd;
76 
77 CFATTACH_DECL_NEW(pckbc_acpi, sizeof(struct pckbc_acpi_softc),
78     pckbc_acpi_match, pckbc_acpi_attach, NULL, NULL);
79 
80 static void	pckbc_acpi_intr_establish(struct pckbc_softc *, pckbc_slot_t);
81 static void	pckbc_acpi_finish_attach(device_t);
82 
83 /*
84  * Supported Device IDs
85  */
86 
87 static const char * const pckbc_acpi_ids_kbd[] = {
88 	"PNP03??",	/* Standard PC KBD port */
89 	NULL
90 };
91 
92 static const char * const pckbc_acpi_ids_ms[] = {
93 	"PNP0F03",
94 	"PNP0F0E",
95 	"PNP0F12",
96 	"PNP0F13",
97 	"PNP0F19",
98 	"PNP0F1B",
99 	"PNP0F1C",
100 	"SYN0302",
101 	NULL
102 };
103 
104 /*
105  * pckbc_acpi_match: autoconf(9) match routine
106  */
107 static int
108 pckbc_acpi_match(device_t parent, cfdata_t match, void *aux)
109 {
110 	struct acpi_attach_args *aa = aux;
111 	int rv;
112 
113 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
114 		return 0;
115 
116 	rv = acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_kbd);
117 	if (rv)
118 		return rv;
119 	rv = acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_ms);
120 	if (rv)
121 		return rv;
122 	return 0;
123 }
124 
125 static void
126 pckbc_acpi_attach(device_t parent, device_t self, void *aux)
127 {
128 	struct pckbc_acpi_softc *psc = device_private(self);
129 	struct pckbc_softc *sc = &psc->sc_pckbc;
130 	struct pckbc_internal *t;
131 	struct acpi_attach_args *aa = aux;
132 	bus_space_handle_t ioh_d, ioh_c;
133 	pckbc_slot_t peer;
134 	struct acpi_resources res;
135 	struct acpi_io *io0, *io1, *ioswap;
136 	struct acpi_irq *irq;
137 	ACPI_STATUS rv;
138 
139 	sc->sc_dv = self;
140 	psc->sc_ic = aa->aa_ic;
141 
142 	if (acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_kbd)) {
143 		psc->sc_slot = PCKBC_KBD_SLOT;
144 		peer = PCKBC_AUX_SLOT;
145 	} else if (acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_ms)) {
146 		psc->sc_slot = PCKBC_AUX_SLOT;
147 		peer = PCKBC_KBD_SLOT;
148 	} else {
149 		aprint_error(": unknown port!\n");
150 		panic("pckbc_acpi_attach: impossible");
151 	}
152 
153 	aprint_normal(" (%s port)", pckbc_slot_names[psc->sc_slot]);
154 
155 	/* parse resources */
156 	rv = acpi_resource_parse(sc->sc_dv, aa->aa_node->ad_handle, "_CRS",
157 	    &res, &acpi_resource_parse_ops_default);
158 	if (ACPI_FAILURE(rv))
159 		return;
160 
161 	/* find our IRQ */
162 	irq = acpi_res_irq(&res, 0);
163 	if (irq == NULL) {
164 		aprint_error_dev(self, "unable to find irq resource\n");
165 		goto out;
166 	}
167 	psc->sc_irq = irq->ar_irq;
168 	psc->sc_ist = (irq->ar_type == ACPI_EDGE_SENSITIVE) ? IST_EDGE : IST_LEVEL;
169 
170 	if (psc->sc_slot == PCKBC_KBD_SLOT)
171 		first = psc;
172 
173 	if ((!first || !first->sc_pckbc.id) &&
174 	    (psc->sc_slot == PCKBC_KBD_SLOT)) {
175 
176 		io0 = acpi_res_io(&res, 0);
177 		io1 = acpi_res_io(&res, 1);
178 		if (io0 == NULL || io1 == NULL) {
179 			aprint_error_dev(self,
180 			    "unable to find i/o resources\n");
181 			goto out;
182 		}
183 
184 		/*
185 		 * JDM: Some firmware doesn't report resources in the order we
186 		 * expect; sort IO resources here (lowest first)
187 		 */
188 		if (io0->ar_base > io1->ar_base) {
189 			ioswap = io0;
190 			io0 = io1;
191 			io1 = ioswap;
192 		}
193 
194 		if (pckbc_is_console(aa->aa_iot, io0->ar_base)) {
195 			t = &pckbc_consdata;
196 			ioh_d = t->t_ioh_d;
197 			ioh_c = t->t_ioh_c;
198 			pckbc_console_attached = 1;
199 			/* t->t_cmdbyte was initialized by cnattach */
200 		} else {
201 			if (bus_space_map(aa->aa_iot, io0->ar_base,
202 					  io0->ar_length, 0, &ioh_d) ||
203 			    bus_space_map(aa->aa_iot, io1->ar_base,
204 					  io1->ar_length, 0, &ioh_c)) {
205 				aprint_error_dev(self,
206 				    "unable to map registers\n");
207 				goto out;
208 			}
209 
210 			t = malloc(sizeof(struct pckbc_internal),
211 			    M_DEVBUF, M_WAITOK|M_ZERO);
212 			t->t_iot = aa->aa_iot;
213 			t->t_ioh_d = ioh_d;
214 			t->t_ioh_c = ioh_c;
215 			t->t_addr = io0->ar_base;
216 			t->t_cmdbyte = KC8_CPU;	/* Enable ports */
217 			callout_init(&t->t_cleanup, 0);
218 		}
219 
220 		t->t_sc = &first->sc_pckbc;
221 		first->sc_pckbc.id = t;
222 
223 		if (!pmf_device_register(self, NULL, pckbc_resume))
224 			aprint_error_dev(self,
225 			    "couldn't establish power handler\n");
226 
227 		first->sc_pckbc.intr_establish = pckbc_acpi_intr_establish;
228 		config_defer(first->sc_pckbc.sc_dv, pckbc_acpi_finish_attach);
229 	}
230 
231 out:
232 	if (!pmf_device_register(self, NULL, NULL))
233 		aprint_error_dev(self, "couldn't establish power handler\n");
234 	acpi_resource_cleanup(&res);
235 }
236 
237 static void
238 pckbc_acpi_intr_establish(struct pckbc_softc *sc, pckbc_slot_t slot)
239 {
240 	struct pckbc_acpi_softc *psc;
241 	isa_chipset_tag_t ic = NULL;
242 	void *rv = NULL;
243 	int irq = 0, ist = 0; /* XXX: gcc */
244 	int i;
245 
246 	/*
247 	 * Note we're always called with sc == first.
248 	 */
249 	for (i = 0; i < pckbc_cd.cd_ndevs; i++) {
250 		psc = device_lookup_private(&pckbc_cd, i);
251 		if (psc && psc->sc_slot == slot) {
252 			irq = psc->sc_irq;
253 			ist = psc->sc_ist;
254 			ic = psc->sc_ic;
255 			break;
256 		}
257 	}
258 	if (i < pckbc_cd.cd_ndevs)
259 		rv = isa_intr_establish(ic, irq, ist, IPL_TTY, pckbcintr, sc);
260 	if (rv == NULL) {
261 		aprint_error_dev(sc->sc_dv,
262 		    "unable to establish interrupt for %s slot\n",
263 		    pckbc_slot_names[slot]);
264 	} else {
265 		aprint_normal_dev(sc->sc_dv, "using irq %d for %s slot\n",
266 		    irq, pckbc_slot_names[slot]);
267 	}
268 }
269 
270 static void
271 pckbc_acpi_finish_attach(device_t dv)
272 {
273 
274 	pckbc_attach(device_private(dv));
275 }
276