xref: /freebsd/sys/dev/atkbdc/atkbdc_subr.c (revision 6e8394b8baa7d5d9153ab90de6824bcd19b3b4e1)
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  * $Id: atkbdc_isa.c,v 1.7 1999/05/22 15:47:33 dfr Exp $
27  */
28 
29 #include "atkbdc.h"
30 #include "opt_kbd.h"
31 
32 #if NATKBDC > 0
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/bus.h>
38 #include <sys/malloc.h>
39 #include <machine/bus.h>
40 #include <machine/resource.h>
41 #include <sys/rman.h>
42 
43 #include <dev/kbd/atkbdcreg.h>
44 
45 #include <isa/isareg.h>
46 #include <isa/isavar.h>
47 
48 MALLOC_DEFINE(M_ATKBDDEV, "atkbddev", "AT Keyboard device");
49 
50 /* children */
51 typedef struct atkbdc_device {
52 	int flags;	/* configuration flags */
53 	int port;	/* port number (same as the controller's) */
54 	int irq;	/* ISA IRQ mask */
55 } atkbdc_device_t;
56 
57 /* kbdc */
58 devclass_t atkbdc_devclass;
59 
60 static int	atkbdc_probe(device_t dev);
61 static int	atkbdc_attach(device_t dev);
62 static void	atkbdc_print_child(device_t bus, device_t dev);
63 static int	atkbdc_read_ivar(device_t bus, device_t dev, int index,
64 				 u_long *val);
65 static int	atkbdc_write_ivar(device_t bus, device_t dev, int index,
66 				  u_long val);
67 
68 static device_method_t atkbdc_methods[] = {
69 	DEVMETHOD(device_probe,		atkbdc_probe),
70 	DEVMETHOD(device_attach,	atkbdc_attach),
71 	DEVMETHOD(device_suspend,	bus_generic_suspend),
72 	DEVMETHOD(device_resume,	bus_generic_resume),
73 
74 	DEVMETHOD(bus_print_child,	atkbdc_print_child),
75 	DEVMETHOD(bus_read_ivar,	atkbdc_read_ivar),
76 	DEVMETHOD(bus_write_ivar,	atkbdc_write_ivar),
77 	DEVMETHOD(bus_alloc_resource,	bus_generic_alloc_resource),
78 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
79 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
80 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
81 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
82 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
83 
84 	{ 0, 0 }
85 };
86 
87 static driver_t atkbdc_driver = {
88 	ATKBDC_DRIVER_NAME,
89 	atkbdc_methods,
90 	sizeof(atkbdc_softc_t *),
91 };
92 
93 static int
94 atkbdc_probe(device_t dev)
95 {
96 	int error;
97 	int rid;
98 	struct resource *port;
99 
100 	/* Check isapnp ids */
101 	if (isa_get_vendorid(dev))
102 		return (ENXIO);
103 
104 	device_set_desc(dev, "keyboard controller (i8042)");
105 	rid = 0;
106 	port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
107 				  0, ~0, IO_KBDSIZE, RF_ACTIVE);
108 	if (!port)
109 		return ENXIO;
110 	error = atkbdc_probe_unit(device_get_unit(dev), rman_get_start(port));
111 	bus_release_resource(dev, SYS_RES_IOPORT, rid, port);
112 	return error;
113 }
114 
115 static void
116 atkbdc_add_device(device_t dev, const char *name, int unit)
117 {
118 	atkbdc_softc_t	*sc = *(atkbdc_softc_t **)device_get_softc(dev);
119 	atkbdc_device_t	*kdev;
120 	device_t	child;
121 	int		t;
122 	int rid;
123 	struct resource *port;
124 
125 	kdev = malloc(sizeof(struct atkbdc_device), M_ATKBDDEV, M_NOWAIT);
126 	if (!kdev)
127 		return;
128 	bzero(kdev, sizeof *kdev);
129 
130 	/* XXX should track resource in softc */
131 	port = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
132 				  0, ~0, IO_KBDSIZE, RF_ACTIVE);
133 	kdev->port = sc->port;
134 
135 	if (resource_int_value(name, unit, "irq", &t) == 0)
136 		kdev->irq = t;
137 	else
138 		kdev->irq = -1;
139 
140 	if (resource_int_value(name, unit, "flags", &t) == 0)
141 		kdev->flags = t;
142 	else
143 		kdev->flags = 0;
144 
145 	child = device_add_child(dev, name, unit, kdev);
146 }
147 
148 static int
149 atkbdc_attach(device_t dev)
150 {
151 	atkbdc_softc_t	*sc;
152 	int		unit;
153 	int		error;
154 	int		i;
155 
156 	unit = device_get_unit(dev);
157 	sc = *(atkbdc_softc_t **)device_get_softc(dev);
158 	if (sc == NULL) {
159 		/*
160 		 * We have to maintain two copies of the kbdc_softc struct,
161 		 * as the low-level console needs to have access to the
162 		 * keyboard controller before kbdc is probed and attached.
163 		 * kbdc_soft[] contains the default entry for that purpose.
164 		 * See atkbdc.c. XXX
165 		 */
166 		sc = atkbdc_get_softc(unit);
167 		if (sc == NULL)
168 			return ENOMEM;
169 	}
170 
171 	error = atkbdc_attach_unit(unit, sc, isa_get_port(dev));
172 	if (error)
173 		return error;
174 	*(atkbdc_softc_t **)device_get_softc(dev) = sc;
175 
176 	/*
177 	 * Add all devices configured to be attached to atkbdc0.
178 	 */
179 	for (i = resource_query_string(-1, "at", "atkbdc0");
180 	     i != -1;
181 	     i = resource_query_string(i, "at", "atkbdc0")) {
182 		atkbdc_add_device(dev, resource_query_name(i),
183 				  resource_query_unit(i));
184 	}
185 
186 	/*
187 	 * and atkbdc?
188 	 */
189 	for (i = resource_query_string(-1, "at", "atkbdc");
190 	     i != -1;
191 	     i = resource_query_string(i, "at", "atkbdc")) {
192 		atkbdc_add_device(dev, resource_query_name(i),
193 				  resource_query_unit(i));
194 	}
195 
196 	bus_generic_attach(dev);
197 
198 	return 0;
199 }
200 
201 static void
202 atkbdc_print_child(device_t bus, device_t dev)
203 {
204 	atkbdc_device_t *kbdcdev;
205 
206 	kbdcdev = (atkbdc_device_t *)device_get_ivars(dev);
207 
208 	if (kbdcdev->flags != 0)
209 		printf(" flags 0x%x", kbdcdev->flags);
210 	if (kbdcdev->irq != -1)
211 		printf(" irq %d", kbdcdev->irq);
212 
213 	printf(" on %s%d", device_get_name(bus), device_get_unit(bus));
214 }
215 
216 static int
217 atkbdc_read_ivar(device_t bus, device_t dev, int index, u_long *val)
218 {
219 	atkbdc_device_t *ivar;
220 
221 	ivar = (atkbdc_device_t *)device_get_ivars(dev);
222 	switch (index) {
223 	case KBDC_IVAR_PORT:
224 		*val = (u_long)ivar->port;
225 		break;
226 	case KBDC_IVAR_IRQ:
227 		*val = (u_long)ivar->irq;
228 		break;
229 	case KBDC_IVAR_FLAGS:
230 		*val = (u_long)ivar->flags;
231 		break;
232 	default:
233 		return ENOENT;
234 	}
235 	return 0;
236 }
237 
238 static int
239 atkbdc_write_ivar(device_t bus, device_t dev, int index, u_long val)
240 {
241 	atkbdc_device_t *ivar;
242 
243 	ivar = (atkbdc_device_t *)device_get_ivars(dev);
244 	switch (index) {
245 	case KBDC_IVAR_PORT:
246 		ivar->port = (int)val;
247 		break;
248 	case KBDC_IVAR_IRQ:
249 		ivar->irq = (int)val;
250 		break;
251 	case KBDC_IVAR_FLAGS:
252 		ivar->flags = (int)val;
253 		break;
254 	default:
255 		return ENOENT;
256 	}
257 	return 0;
258 }
259 
260 DRIVER_MODULE(atkbdc, isa, atkbdc_driver, atkbdc_devclass, 0, 0);
261 
262 #endif /* NATKBDC > 0 */
263