1 /*-
2  * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer as
10  *    the first lines of this file unmodified.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/isa/atkbdc_isa.c,v 1.14.2.1 2000/03/31 12:52:05 yokota Exp $
27  * $DragonFly: src/sys/dev/misc/atkbdc_layer/atkbdc_isa.c,v 1.7 2006/12/22 23:26:17 swildner Exp $
28  */
29 
30 #include "opt_kbd.h"
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/malloc.h>
37 #include <sys/rman.h>
38 
39 #include <dev/misc/kbd/atkbdcreg.h>
40 
41 #include <bus/isa/isareg.h>
42 #include <bus/isa/isavar.h>
43 
44 MALLOC_DEFINE(M_ATKBDDEV, "atkbddev", "AT Keyboard device");
45 
46 /* children */
47 typedef struct atkbdc_device {
48 	int flags;	/* configuration flags */
49 	int irq;	/* ISA IRQ mask */
50 	u_int32_t vendorid;
51 	u_int32_t serial;
52 	u_int32_t logicalid;
53 	u_int32_t compatid;
54 } atkbdc_device_t;
55 
56 /* kbdc */
57 devclass_t atkbdc_devclass;
58 
59 static int	atkbdc_probe(device_t dev);
60 static int	atkbdc_attach(device_t dev);
61 static int	atkbdc_print_child(device_t bus, device_t dev);
62 static int	atkbdc_read_ivar(device_t bus, device_t dev, int index,
63 				 u_long *val);
64 static int	atkbdc_write_ivar(device_t bus, device_t dev, int index,
65 				  u_long val);
66 
67 static device_method_t atkbdc_methods[] = {
68 	DEVMETHOD(device_probe,		atkbdc_probe),
69 	DEVMETHOD(device_attach,	atkbdc_attach),
70 	DEVMETHOD(device_suspend,	bus_generic_suspend),
71 	DEVMETHOD(device_resume,	bus_generic_resume),
72 
73 	DEVMETHOD(bus_print_child,	atkbdc_print_child),
74 	DEVMETHOD(bus_read_ivar,	atkbdc_read_ivar),
75 	DEVMETHOD(bus_write_ivar,	atkbdc_write_ivar),
76 	DEVMETHOD(bus_alloc_resource,	bus_generic_alloc_resource),
77 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
78 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
79 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
80 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
81 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
82 
83 	{ 0, 0 }
84 };
85 
86 static driver_t atkbdc_driver = {
87 	ATKBDC_DRIVER_NAME,
88 	atkbdc_methods,
89 	sizeof(atkbdc_softc_t *),
90 };
91 
92 static struct isa_pnp_id atkbdc_ids[] = {
93 	{ 0x0303d041, "Keyboard controller (i8042)" },	/* PNP0303 */
94 	{ 0 }
95 };
96 
97 static int
98 atkbdc_probe(device_t dev)
99 {
100 	struct resource	*port0;
101 	struct resource	*port1;
102 	int		error;
103 	int		rid;
104 
105 	/* check PnP IDs */
106 	if (ISA_PNP_PROBE(device_get_parent(dev), dev, atkbdc_ids) == ENXIO)
107 		return ENXIO;
108 
109 	device_set_desc(dev, "Keyboard controller (i8042)");
110 
111 	rid = 0;
112 	port0 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1,
113 				   RF_ACTIVE);
114 	if (port0 == NULL)
115 		return ENXIO;
116 	/* XXX */
117 	if (bus_get_resource_start(dev, SYS_RES_IOPORT, 1) <= 0) {
118 		bus_set_resource(dev, SYS_RES_IOPORT, 1,
119 				 rman_get_start(port0) + KBD_STATUS_PORT, 1);
120 	}
121 	rid = 1;
122 	port1 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1,
123 				   RF_ACTIVE);
124 	if (port1 == NULL) {
125 		bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
126 		return ENXIO;
127 	}
128 
129 	error = atkbdc_probe_unit(device_get_unit(dev), port0, port1);
130 
131 	bus_release_resource(dev, SYS_RES_IOPORT, 0, port0);
132 	bus_release_resource(dev, SYS_RES_IOPORT, 1, port1);
133 
134 	return error;
135 }
136 
137 static void
138 atkbdc_add_device(device_t dev, const char *name, int unit)
139 {
140 	atkbdc_device_t	*kdev;
141 	device_t	child;
142 	int		t;
143 
144 	if (resource_int_value(name, unit, "disabled", &t) == 0 && t != 0)
145 		return;
146 
147 	kdev = kmalloc(sizeof(struct atkbdc_device), M_ATKBDDEV,
148 			M_WAITOK | M_ZERO);
149 
150 	if (resource_int_value(name, unit, "irq", &t) == 0)
151 		kdev->irq = t;
152 	else
153 		kdev->irq = -1;
154 
155 	if (resource_int_value(name, unit, "flags", &t) == 0)
156 		kdev->flags = t;
157 	else
158 		kdev->flags = 0;
159 
160 	child = device_add_child(dev, name, unit);
161 	device_set_ivars(child, kdev);
162 }
163 
164 static int
165 atkbdc_attach(device_t dev)
166 {
167 	atkbdc_softc_t	*sc;
168 	int		unit;
169 	int		error;
170 	int		rid;
171 	int		i;
172 
173 	unit = device_get_unit(dev);
174 	sc = *(atkbdc_softc_t **)device_get_softc(dev);
175 	if (sc == NULL) {
176 		/*
177 		 * We have to maintain two copies of the kbdc_softc struct,
178 		 * as the low-level console needs to have access to the
179 		 * keyboard controller before kbdc is probed and attached.
180 		 * kbdc_soft[] contains the default entry for that purpose.
181 		 * See atkbdc.c. XXX
182 		 */
183 		sc = atkbdc_get_softc(unit);
184 		if (sc == NULL)
185 			return ENOMEM;
186 	}
187 
188 	rid = 0;
189 	sc->port0 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1,
190 				       RF_ACTIVE);
191 	if (sc->port0 == NULL)
192 		return ENXIO;
193 	rid = 1;
194 	sc->port1 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1,
195 				       RF_ACTIVE);
196 	if (sc->port1 == NULL) {
197 		bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
198 		return ENXIO;
199 	}
200 
201 	error = atkbdc_attach_unit(unit, sc, sc->port0, sc->port1);
202 	if (error) {
203 		bus_release_resource(dev, SYS_RES_IOPORT, 0, sc->port0);
204 		bus_release_resource(dev, SYS_RES_IOPORT, 1, sc->port1);
205 		return error;
206 	}
207 	*(atkbdc_softc_t **)device_get_softc(dev) = sc;
208 
209 	/*
210 	 * Add all devices configured to be attached to atkbdc0.
211 	 */
212 	for (i = resource_query_string(-1, "at", device_get_nameunit(dev));
213 	     i != -1;
214 	     i = resource_query_string(i, "at", device_get_nameunit(dev))) {
215 		atkbdc_add_device(dev, resource_query_name(i),
216 				  resource_query_unit(i));
217 	}
218 
219 	/*
220 	 * and atkbdc?
221 	 */
222 	for (i = resource_query_string(-1, "at", device_get_name(dev));
223 	     i != -1;
224 	     i = resource_query_string(i, "at", device_get_name(dev))) {
225 		atkbdc_add_device(dev, resource_query_name(i),
226 				  resource_query_unit(i));
227 	}
228 
229 	bus_generic_attach(dev);
230 
231 	return 0;
232 }
233 
234 static int
235 atkbdc_print_child(device_t bus, device_t dev)
236 {
237 	atkbdc_device_t *kbdcdev;
238 	int retval = 0;
239 
240 	kbdcdev = (atkbdc_device_t *)device_get_ivars(dev);
241 
242 	retval += bus_print_child_header(bus, dev);
243 	if (kbdcdev->flags != 0)
244 		retval += kprintf(" flags 0x%x", kbdcdev->flags);
245 	if (kbdcdev->irq != -1)
246 		retval += kprintf(" irq %d", kbdcdev->irq);
247 	retval += bus_print_child_footer(bus, dev);
248 
249 	return (retval);
250 }
251 
252 static int
253 atkbdc_read_ivar(device_t bus, device_t dev, int index, u_long *val)
254 {
255 	atkbdc_device_t *ivar;
256 
257 	ivar = (atkbdc_device_t *)device_get_ivars(dev);
258 	switch (index) {
259 	case KBDC_IVAR_IRQ:
260 		*val = (u_long)ivar->irq;
261 		break;
262 	case KBDC_IVAR_FLAGS:
263 		*val = (u_long)ivar->flags;
264 		break;
265 	case KBDC_IVAR_VENDORID:
266 		*val = (u_long)ivar->vendorid;
267 		break;
268 	case KBDC_IVAR_SERIAL:
269 		*val = (u_long)ivar->serial;
270 		break;
271 	case KBDC_IVAR_LOGICALID:
272 		*val = (u_long)ivar->logicalid;
273 		break;
274 	case KBDC_IVAR_COMPATID:
275 		*val = (u_long)ivar->compatid;
276 		break;
277 	default:
278 		return ENOENT;
279 	}
280 	return 0;
281 }
282 
283 static int
284 atkbdc_write_ivar(device_t bus, device_t dev, int index, u_long val)
285 {
286 	atkbdc_device_t *ivar;
287 
288 	ivar = (atkbdc_device_t *)device_get_ivars(dev);
289 	switch (index) {
290 	case KBDC_IVAR_IRQ:
291 		ivar->irq = (int)val;
292 		break;
293 	case KBDC_IVAR_FLAGS:
294 		ivar->flags = (int)val;
295 		break;
296 	case KBDC_IVAR_VENDORID:
297 		ivar->vendorid = (u_int32_t)val;
298 		break;
299 	case KBDC_IVAR_SERIAL:
300 		ivar->serial = (u_int32_t)val;
301 		break;
302 	case KBDC_IVAR_LOGICALID:
303 		ivar->logicalid = (u_int32_t)val;
304 		break;
305 	case KBDC_IVAR_COMPATID:
306 		ivar->compatid = (u_int32_t)val;
307 		break;
308 	default:
309 		return ENOENT;
310 	}
311 	return 0;
312 }
313 
314 DRIVER_MODULE(atkbdc, isa, atkbdc_driver, atkbdc_devclass, 0, 0);
315