xref: /netbsd-src/sys/dev/acpi/pckbc_acpi.c (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1 /*	$NetBSD: pckbc_acpi.c,v 1.15 2004/05/01 12:03:48 kochi 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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the NetBSD
21  *	Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * ACPI attachment for the PC Keyboard Controller driver.
41  *
42  * This is a little wonky.  The keyboard controller actually
43  * has 2 ACPI nodes: one for the controller and the keyboard
44  * interrupt, and one for the aux port (mouse) interrupt.
45  *
46  * For this reason, we actually attach *two* instances of this
47  * driver.  After both of them have been found, then we attach
48  * sub-devices.
49  */
50 
51 #include <sys/cdefs.h>
52 __KERNEL_RCSID(0, "$NetBSD: pckbc_acpi.c,v 1.15 2004/05/01 12:03:48 kochi Exp $");
53 
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
57 #include <sys/proc.h>
58 #include <sys/device.h>
59 #include <sys/malloc.h>
60 #include <sys/errno.h>
61 #include <sys/queue.h>
62 #include <sys/lock.h>
63 
64 #include <machine/bus.h>
65 
66 #include <dev/isa/isareg.h>
67 #include <dev/isa/isavar.h>
68 
69 #include <dev/ic/i8042reg.h>
70 #include <dev/ic/pckbcvar.h>
71 
72 #include <dev/acpi/acpivar.h>
73 
74 static int	pckbc_acpi_match(struct device *, struct cfdata *, void *);
75 static void	pckbc_acpi_attach(struct device *, struct device *, void *);
76 
77 struct pckbc_acpi_softc {
78 	struct pckbc_softc sc_pckbc;
79 
80 	isa_chipset_tag_t sc_ic;
81 	int sc_irq;
82 	int sc_ist;
83 	pckbc_slot_t sc_slot;
84 };
85 
86 /* Save first port: */
87 static struct pckbc_acpi_softc *first;
88 
89 extern struct cfdriver pckbc_cd;
90 
91 CFATTACH_DECL(pckbc_acpi, sizeof(struct pckbc_acpi_softc),
92     pckbc_acpi_match, pckbc_acpi_attach, NULL, NULL);
93 
94 static void	pckbc_acpi_intr_establish(struct pckbc_softc *, pckbc_slot_t);
95 
96 /*
97  * Supported Device IDs
98  */
99 
100 static const char * const pckbc_acpi_ids_kbd[] = {
101 	"PNP03??",	/* Standard PC KBD port */
102 	NULL
103 };
104 
105 static const char * const pckbc_acpi_ids_ms[] = {
106 	"PNP0F03",
107 	"PNP0F0E",
108 	"PNP0F12",
109 	"PNP0F13",
110 	"PNP0F19",
111 	"PNP0F1B",
112 	"PNP0F1C",
113 	NULL
114 };
115 
116 /*
117  * pckbc_acpi_match: autoconf(9) match routine
118  */
119 static int
120 pckbc_acpi_match(struct device *parent, struct cfdata *match, void *aux)
121 {
122 	struct acpi_attach_args *aa = aux;
123 	int rv;
124 
125 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
126 		return 0;
127 
128 	rv = acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_kbd);
129 	if (rv)
130 		return rv;
131 	rv = acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_ms);
132 	if (rv)
133 		return rv;
134 	return 0;
135 }
136 
137 static void
138 pckbc_acpi_attach(struct device *parent,
139     struct device *self,
140     void *aux)
141 {
142 	struct pckbc_acpi_softc *psc = (void *) self;
143 	struct pckbc_softc *sc = &psc->sc_pckbc;
144 	struct pckbc_internal *t;
145 	struct acpi_attach_args *aa = aux;
146 	bus_space_handle_t ioh_d, ioh_c;
147 	pckbc_slot_t peer;
148 	struct acpi_resources res;
149 	struct acpi_io *io0, *io1;
150 	struct acpi_irq *irq;
151 	ACPI_STATUS rv;
152 
153 	psc->sc_ic = aa->aa_ic;
154 
155 	if (acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_kbd)) {
156 		psc->sc_slot = PCKBC_KBD_SLOT;
157 		peer = PCKBC_AUX_SLOT;
158 	} else if (acpi_match_hid(aa->aa_node->ad_devinfo, pckbc_acpi_ids_ms)) {
159 		psc->sc_slot = PCKBC_AUX_SLOT;
160 		peer = PCKBC_KBD_SLOT;
161 	} else {
162 		printf(": unknown port!\n");
163 		panic("pckbc_acpi_attach: impossible");
164 	}
165 
166 	printf(": %s port\n", pckbc_slot_names[psc->sc_slot]);
167 
168 	/* parse resources */
169 	rv = acpi_resource_parse(&sc->sc_dv, aa->aa_node->ad_handle, "_CRS",
170 	    &res, &acpi_resource_parse_ops_default);
171 	if (ACPI_FAILURE(rv))
172 		return;
173 
174 	/* find our IRQ */
175 	irq = acpi_res_irq(&res, 0);
176 	if (irq == NULL) {
177 		printf("%s: unable to find irq resource\n", sc->sc_dv.dv_xname);
178 		goto out;
179 	}
180 	psc->sc_irq = irq->ar_irq;
181 	psc->sc_ist = (irq->ar_type == ACPI_EDGE_SENSITIVE) ? IST_EDGE : IST_LEVEL;
182 
183 	if (psc->sc_slot == PCKBC_KBD_SLOT)
184 		first = psc;
185 
186 	if ((!first || !first->sc_pckbc.id) &&
187 	    (psc->sc_slot == PCKBC_KBD_SLOT)) {
188 
189 		io0 = acpi_res_io(&res, 0);
190 		if (io0 == NULL) {
191 			printf("%s: unable to find i/o resources\n",
192 			    sc->sc_dv.dv_xname);
193 			goto out;
194 		}
195 
196 		if (pckbc_is_console(aa->aa_iot, io0->ar_base)) {
197 			t = &pckbc_consdata;
198 			ioh_d = t->t_ioh_d;
199 			ioh_c = t->t_ioh_c;
200 			pckbc_console_attached = 1;
201 			/* t->t_cmdbyte was initialized by cnattach */
202 		} else {
203 			io1 = acpi_res_io(&res, 1);
204 			if (io1 == NULL) {
205 				printf("%s: unable to find i/o resources\n",
206 				    sc->sc_dv.dv_xname);
207 				goto out;
208 			}
209 			if (bus_space_map(aa->aa_iot, io0->ar_base,
210 					  io0->ar_length, 0, &ioh_d) ||
211 			    bus_space_map(aa->aa_iot, io1->ar_base,
212 					  io1->ar_length, 0, &ioh_c))
213 				panic("pckbc_acpi_attach: couldn't map");
214 
215 			t = malloc(sizeof(struct pckbc_internal),
216 			    M_DEVBUF, M_WAITOK);
217 			memset(t, 0, sizeof(*t));
218 			t->t_iot = aa->aa_iot;
219 			t->t_ioh_d = ioh_d;
220 			t->t_ioh_c = ioh_c;
221 			t->t_addr = io0->ar_base;
222 			t->t_cmdbyte = KC8_CPU;	/* Enable ports */
223 			callout_init(&t->t_cleanup);
224 		}
225 
226 		t->t_sc = &first->sc_pckbc;
227 		first->sc_pckbc.id = t;
228 
229 		first->sc_pckbc.intr_establish = pckbc_acpi_intr_establish;
230 		config_defer(&first->sc_pckbc.sc_dv,
231 			     (void(*)(struct device *))pckbc_attach);
232 	}
233  out:
234 	acpi_resource_cleanup(&res);
235 }
236 
237 static void
238 pckbc_acpi_intr_establish(struct pckbc_softc *sc,
239     pckbc_slot_t slot)
240 {
241 	struct pckbc_acpi_softc *psc;
242 	isa_chipset_tag_t ic = NULL;
243 	void *rv = NULL;
244 	int irq = 0, ist = 0; /* XXX: gcc */
245 	int i;
246 
247 	/*
248 	 * Note we're always called with sc == first.
249 	 */
250 	for (i = 0; i < pckbc_cd.cd_ndevs; i++) {
251 		psc = pckbc_cd.cd_devs[i];
252 		if (psc && psc->sc_slot == slot) {
253 			irq = psc->sc_irq;
254 			ist = psc->sc_ist;
255 			ic = psc->sc_ic;
256 			break;
257 		}
258 	}
259 	if (i < pckbc_cd.cd_ndevs)
260 		rv = isa_intr_establish(ic, irq, ist, IPL_TTY, pckbcintr, sc);
261 	if (rv == NULL) {
262 		printf("%s: unable to establish interrupt for %s slot\n",
263 		    sc->sc_dv.dv_xname, pckbc_slot_names[slot]);
264 	} else {
265 		printf("%s: using irq %d for %s slot\n", sc->sc_dv.dv_xname,
266 		    irq, pckbc_slot_names[slot]);
267 	}
268 }
269