xref: /netbsd-src/sys/dev/acpi/pckbc_acpi.c (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: pckbc_acpi.c,v 1.4 2003/01/27 19:18:46 jmcneill 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.4 2003/01/27 19:18:46 jmcneill 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 int	pckbc_acpi_match(struct device *, struct cfdata *, void *);
75 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 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[] = {
101 	"PNP0303",	/* Standard PC KBD/MS port */
102 	"PNP0320",	/* Japanese 106 */
103 	"PNP0F13",
104 	"PNP0F03",
105 	"IBM3780",	/* IBM pointing device */
106 	NULL
107 };
108 
109 /*
110  * pckbc_acpi_match: autoconf(9) match routine
111  */
112 int
113 pckbc_acpi_match(struct device *parent, struct cfdata *match, void *aux)
114 {
115 	struct acpi_attach_args *aa = aux;
116 	const char *id;
117 	int i;
118 
119 	if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE)
120 		return (0);
121 
122 	for (i = 0; (id = pckbc_acpi_ids[i]) != NULL; ++i) {
123 		if (strcmp(aa->aa_node->ad_devinfo.HardwareId, id) == 0)
124 			return (1);
125 	}
126 
127 	/* No matches found */
128 	return (0);
129 }
130 
131 void
132 pckbc_acpi_attach(struct device *parent,
133     struct device *self,
134     void *aux)
135 {
136 	struct pckbc_acpi_softc *psc = (void *) self;
137 	struct pckbc_softc *sc = &psc->sc_pckbc;
138 	struct pckbc_internal *t;
139 	struct acpi_attach_args *aa = aux;
140 	bus_space_handle_t ioh_d, ioh_c;
141 	const char *idstr = aa->aa_node->ad_devinfo.HardwareId;
142 	pckbc_slot_t peer;
143 	struct acpi_resources res;
144 	struct acpi_io *io0, *io1;
145 	struct acpi_irq *irq;
146 	ACPI_STATUS rv;
147 
148 	psc->sc_ic = aa->aa_ic;
149 
150 	if (strncmp(idstr, "PNP03", 5) == 0) {
151 		psc->sc_slot = PCKBC_KBD_SLOT;
152 		peer = PCKBC_AUX_SLOT;
153 	} else if (strncmp(idstr, "PNP0F", 5) == 0 ||
154 			strcmp(idstr, "IBM3780") == 0) {
155 		psc->sc_slot = PCKBC_AUX_SLOT;
156 		peer = PCKBC_KBD_SLOT;
157 	} else {
158 		printf(": unknown port!\n");
159 		panic("pckbc_acpi_attach: impossible");
160 	}
161 
162 	printf(": %s port\n", pckbc_slot_names[psc->sc_slot]);
163 
164 	/* parse resources */
165 	rv = acpi_resource_parse(&sc->sc_dv, aa->aa_node, &res,
166 	    &acpi_resource_parse_ops_default);
167 	if (rv != AE_OK) {
168 		printf("%s: unable to parse resources\n", sc->sc_dv.dv_xname);
169 		return;
170 	}
171 
172 	/* find our IRQ */
173 	irq = acpi_res_irq(&res, 0);
174 	if (irq == NULL) {
175 		printf("%s: unable to find irq resource\n", sc->sc_dv.dv_xname);
176 		return;
177 	}
178 	psc->sc_irq = irq->ar_irq;
179 	psc->sc_ist = (irq->ar_type == ACPI_EDGE_SENSITIVE) ? IST_EDGE : IST_LEVEL;
180 
181 	if (psc->sc_slot == PCKBC_KBD_SLOT)
182 		first = psc;
183 
184 	if ((!first || !first->sc_pckbc.id) &&
185 	    (psc->sc_slot == PCKBC_KBD_SLOT)) {
186 
187 		io0 = acpi_res_io(&res, 0);
188 		if (io0 == NULL) {
189 			printf("%s: unable to find i/o resources\n",
190 			    sc->sc_dv.dv_xname);
191 			return;
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 			io1 = acpi_res_io(&res, 1);
202 			if (io1 == NULL) {
203 				printf("%s: unable to find i/o resources\n",
204 				    sc->sc_dv.dv_xname);
205 				return;
206 			}
207 			if (bus_space_map(aa->aa_iot, io0->ar_base,
208 					  io0->ar_length, 0, &ioh_d) ||
209 			    bus_space_map(aa->aa_iot, io1->ar_base,
210 					  io1->ar_length, 0, &ioh_c))
211 				panic("pckbc_acpi_attach: couldn't map");
212 
213 			t = malloc(sizeof(struct pckbc_internal),
214 			    M_DEVBUF, M_WAITOK);
215 			memset(t, 0, sizeof(*t));
216 			t->t_iot = aa->aa_iot;
217 			t->t_ioh_d = ioh_d;
218 			t->t_ioh_c = ioh_c;
219 			t->t_addr = io0->ar_base;
220 			t->t_cmdbyte = KC8_CPU;	/* Enable ports */
221 			callout_init(&t->t_cleanup);
222 		}
223 
224 		t->t_sc = &first->sc_pckbc;
225 		first->sc_pckbc.id = t;
226 
227 		first->sc_pckbc.intr_establish = pckbc_acpi_intr_establish;
228 		config_defer(&first->sc_pckbc.sc_dv,
229 			     (void(*)(struct device *))pckbc_attach);
230 	}
231 }
232 
233 void
234 pckbc_acpi_intr_establish(struct pckbc_softc *sc,
235     pckbc_slot_t slot)
236 {
237 	struct pckbc_acpi_softc *psc;
238 	isa_chipset_tag_t ic = NULL;
239 	void *rv = NULL;
240 	int irq, ist;
241 	int i;
242 
243 	/*
244 	 * Note we're always called with sc == first.
245 	 */
246 	for (i = 0; i < pckbc_cd.cd_ndevs; i++) {
247 		psc = pckbc_cd.cd_devs[i];
248 		if (psc && psc->sc_slot == slot) {
249 			irq = psc->sc_irq;
250 			ist = psc->sc_ist;
251 			ic = psc->sc_ic;
252 			break;
253 		}
254 	}
255 	if (i < pckbc_cd.cd_ndevs)
256 		rv = isa_intr_establish(ic, irq, ist, IPL_TTY, pckbcintr, sc);
257 	if (rv == NULL) {
258 		printf("%s: unable to establish interrupt for %s slot\n",
259 		    sc->sc_dv.dv_xname, pckbc_slot_names[slot]);
260 	} else {
261 		printf("%s: using irq %d for %s slot\n", sc->sc_dv.dv_xname,
262 		    irq, pckbc_slot_names[slot]);
263 	}
264 }
265