xref: /netbsd-src/sys/dev/isa/pcppi.c (revision 404fbe5fb94ca1e054339640cabb2801ce52dd30)
1 /* $NetBSD: pcppi.c,v 1.32 2008/03/05 22:46:43 cube Exp $ */
2 
3 /*
4  * Copyright (c) 1996 Carnegie-Mellon University.
5  * All rights reserved.
6  *
7  * Author: Chris G. Demetriou
8  *
9  * Permission to use, copy, modify and distribute this software and
10  * its documentation is hereby granted, provided that both the copyright
11  * notice and this permission notice appear in all copies of the
12  * software, derivative works or modified versions, and any portions
13  * thereof, and that both notices appear in supporting documentation.
14  *
15  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
16  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
17  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
18  *
19  * Carnegie Mellon requests users of this software to return to
20  *
21  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
22  *  School of Computer Science
23  *  Carnegie Mellon University
24  *  Pittsburgh PA 15213-3890
25  *
26  * any improvements or extensions that they make and grant Carnegie the
27  * rights to redistribute these changes.
28  */
29 
30 #include <sys/cdefs.h>
31 __KERNEL_RCSID(0, "$NetBSD: pcppi.c,v 1.32 2008/03/05 22:46:43 cube Exp $");
32 
33 #include "attimer.h"
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/callout.h>
38 #include <sys/kernel.h>
39 #include <sys/proc.h>
40 #include <sys/device.h>
41 #include <sys/errno.h>
42 
43 #include <sys/bus.h>
44 
45 #include <dev/ic/attimervar.h>
46 
47 #include <dev/isa/isareg.h>
48 #include <dev/isa/isavar.h>
49 #include <dev/isa/pcppireg.h>
50 #include <dev/isa/pcppivar.h>
51 
52 #include "pckbd.h"
53 #if NPCKBD > 0
54 #include <dev/pckbport/pckbdvar.h>
55 
56 void	pcppi_pckbd_bell(void *, u_int, u_int, u_int, int);
57 #endif
58 
59 int	pcppi_match(device_t, cfdata_t, void *);
60 void	pcppi_isa_attach(device_t, device_t, void *);
61 void	pcppi_childdet(device_t, device_t);
62 
63 CFATTACH_DECL2_NEW(pcppi, sizeof(struct pcppi_softc),
64     pcppi_match, pcppi_isa_attach, pcppi_detach, NULL, NULL, pcppi_childdet);
65 
66 static int pcppisearch(device_t, cfdata_t, const int *, void *);
67 static void pcppi_bell_stop(void*);
68 
69 #if NATTIMER > 0
70 static void pcppi_attach_speaker(device_t);
71 #endif
72 
73 #define PCPPIPRI (PZERO - 1)
74 
75 int
76 pcppi_match(device_t parent, cfdata_t match, void *aux)
77 {
78 	struct isa_attach_args *ia = aux;
79 	bus_space_handle_t ppi_ioh;
80 	int have_ppi, rv;
81 	u_int8_t v, nv;
82 
83 	if (ISA_DIRECT_CONFIG(ia))
84 		return (0);
85 
86 	/* If values are hardwired to something that they can't be, punt. */
87 	if (ia->ia_nio < 1 ||
88 	    (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
89 	    ia->ia_io[0].ir_addr != IO_PPI))
90 		return (0);
91 
92 	if (ia->ia_niomem > 0 &&
93 	    (ia->ia_iomem[0].ir_addr != ISA_UNKNOWN_IOMEM))
94 		return (0);
95 
96 	if (ia->ia_nirq > 0 &&
97 	    (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ))
98 		return (0);
99 
100 	if (ia->ia_ndrq > 0 &&
101 	    (ia->ia_drq[0].ir_drq != ISA_UNKNOWN_DRQ))
102 		return (0);
103 
104 	rv = 0;
105 	have_ppi = 0;
106 
107 	if (bus_space_map(ia->ia_iot, IO_PPI, 1, 0, &ppi_ioh))
108 		goto lose;
109 	have_ppi = 1;
110 
111 	/*
112 	 * Check for existence of PPI.  Realistically, this is either going to
113 	 * be here or nothing is going to be here.
114 	 *
115 	 * We don't want to have any chance of changing speaker output (which
116 	 * this test might, if it crashes in the middle, or something;
117 	 * normally it's be to quick to produce anthing audible), but
118 	 * many "combo chip" mock-PPI's don't seem to support the top bit
119 	 * of Port B as a settable bit.  The bottom bit has to be settable,
120 	 * since the speaker driver hardware still uses it.
121 	 */
122 	v = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
123 	bus_space_write_1(ia->ia_iot, ppi_ioh, 0, v ^ 0x01);	/* XXX */
124 	nv = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
125 	if (((nv ^ v) & 0x01) == 0x01)
126 		rv = 1;
127 	bus_space_write_1(ia->ia_iot, ppi_ioh, 0, v);		/* XXX */
128 	nv = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
129 	if (((nv ^ v) & 0x01) != 0x00) {
130 		rv = 0;
131 		goto lose;
132 	}
133 
134 	/*
135 	 * We assume that the programmable interval timer is there.
136 	 */
137 
138 lose:
139 	if (have_ppi)
140 		bus_space_unmap(ia->ia_iot, ppi_ioh, 1);
141 	if (rv) {
142 		ia->ia_io[0].ir_addr = IO_PPI;
143 		ia->ia_io[0].ir_size = 1;
144 		ia->ia_nio = 1;
145 
146 		ia->ia_niomem = 0;
147 		ia->ia_nirq = 0;
148 		ia->ia_ndrq = 0;
149 	}
150 	return (rv);
151 }
152 
153 void
154 pcppi_isa_attach(device_t parent, device_t self, void *aux)
155 {
156         struct pcppi_softc *sc = device_private(self);
157         struct isa_attach_args *ia = aux;
158         bus_space_tag_t iot;
159 
160 	sc->sc_dv = self;
161         sc->sc_iot = iot = ia->ia_iot;
162 
163         sc->sc_size = 1;
164         if (bus_space_map(iot, IO_PPI, sc->sc_size, 0, &sc->sc_ppi_ioh))
165                 panic("pcppi_attach: couldn't map");
166 
167         printf("\n");
168 
169         pcppi_attach(sc);
170 }
171 
172 void
173 pcppi_childdet(device_t self, device_t child)
174 {
175 	/* we hold no child references, so do nothing */
176 }
177 
178 int
179 pcppi_detach(device_t self, int flags)
180 {
181 	int rc;
182 	struct pcppi_softc *sc = device_private(self);
183 
184 	if ((rc = config_detach_children(sc->sc_dv, flags)) != 0)
185 		return rc;
186 
187 	pmf_device_deregister(self);
188 
189 #if NPCKBD > 0
190 	pckbd_unhook_bell(pcppi_pckbd_bell, sc);
191 #endif
192 	pcppi_bell_stop(sc);
193 
194 	callout_stop(&sc->sc_bell_ch);
195 	callout_destroy(&sc->sc_bell_ch);
196 	bus_space_unmap(sc->sc_iot, sc->sc_ppi_ioh, sc->sc_size);
197 	return 0;
198 }
199 
200 void
201 pcppi_attach(struct pcppi_softc *sc)
202 {
203         struct pcppi_attach_args pa;
204 	device_t self = sc->sc_dv;
205 
206         callout_init(&sc->sc_bell_ch, 0);
207 
208         sc->sc_bellactive = sc->sc_bellpitch = sc->sc_slp = 0;
209 
210 #if NPCKBD > 0
211 	/* Provide a beeper for the PC Keyboard, if there isn't one already. */
212 	pckbd_hookup_bell(pcppi_pckbd_bell, sc);
213 #endif
214 #if NATTIMER > 0
215 	config_defer(sc->sc_dv, pcppi_attach_speaker);
216 #endif
217         if (!device_pmf_is_registered(self))
218 		if (!pmf_device_register(self, NULL, NULL))
219 			aprint_error_dev(self,
220 			    "couldn't establish power handler\n");
221 
222 	pa.pa_cookie = sc;
223 	config_search_loc(pcppisearch, sc->sc_dv, "pcppi", NULL, &pa);
224 }
225 
226 static int
227 pcppisearch(device_t parent, cfdata_t cf, const int *locs, void *aux)
228 {
229 
230 	if (config_match(parent, cf, aux))
231 		config_attach_loc(parent, cf, locs, aux, NULL);
232 
233 	return 0;
234 }
235 
236 #if NATTIMER > 0
237 static void
238 pcppi_attach_speaker(device_t self)
239 {
240 	struct pcppi_softc *sc = device_private(self);
241 
242 	if ((sc->sc_timer = attimer_attach_speaker()) == NULL)
243 		aprint_error_dev(self, "could not find any available timer\n");
244 	else {
245 		aprint_normal_dev(sc->sc_timer, "attached to %s\n",
246 		    device_xname(self));
247 	}
248 }
249 #endif
250 
251 void
252 pcppi_bell(pcppi_tag_t self, int pitch, int period, int slp)
253 {
254 	struct pcppi_softc *sc = self;
255 	int s;
256 
257 	s = spltty(); /* ??? */
258 	if (sc->sc_bellactive) {
259 		if (sc->sc_timeout) {
260 			sc->sc_timeout = 0;
261 			callout_stop(&sc->sc_bell_ch);
262 		}
263 		if (sc->sc_slp)
264 			wakeup(pcppi_bell_stop);
265 	}
266 	if (pitch == 0 || period == 0) {
267 		pcppi_bell_stop(sc);
268 		sc->sc_bellpitch = 0;
269 		splx(s);
270 		return;
271 	}
272 	if (!sc->sc_bellactive || sc->sc_bellpitch != pitch) {
273 #if NATTIMER > 0
274 		if (sc->sc_timer != NULL)
275 			attimer_set_pitch(sc->sc_timer, pitch);
276 #endif
277 		/* enable speaker */
278 		bus_space_write_1(sc->sc_iot, sc->sc_ppi_ioh, 0,
279 			bus_space_read_1(sc->sc_iot, sc->sc_ppi_ioh, 0)
280 			| PIT_SPKR);
281 	}
282 	sc->sc_bellpitch = pitch;
283 
284 	sc->sc_bellactive = 1;
285 	if (slp & PCPPI_BELL_POLL) {
286 		delay((period * 1000000) / hz);
287 		pcppi_bell_stop(sc);
288 	} else {
289 		sc->sc_timeout = 1;
290 		callout_reset(&sc->sc_bell_ch, period, pcppi_bell_stop, sc);
291 		if (slp & PCPPI_BELL_SLEEP) {
292 			sc->sc_slp = 1;
293 			tsleep(pcppi_bell_stop, PCPPIPRI | PCATCH, "bell", 0);
294 			sc->sc_slp = 0;
295 		}
296 	}
297 	splx(s);
298 }
299 
300 static void
301 pcppi_bell_stop(void *arg)
302 {
303 	struct pcppi_softc *sc = arg;
304 	int s;
305 
306 	s = spltty(); /* ??? */
307 	sc->sc_timeout = 0;
308 
309 	/* disable bell */
310 	bus_space_write_1(sc->sc_iot, sc->sc_ppi_ioh, 0,
311 			  bus_space_read_1(sc->sc_iot, sc->sc_ppi_ioh, 0)
312 			  & ~PIT_SPKR);
313 	sc->sc_bellactive = 0;
314 	if (sc->sc_slp)
315 		wakeup(pcppi_bell_stop);
316 	splx(s);
317 }
318 
319 #if NPCKBD > 0
320 void
321 pcppi_pckbd_bell(void *arg, u_int pitch, u_int period, u_int volume,
322     int poll)
323 {
324 
325 	/*
326 	 * Comes in as ms, goes out at ticks; volume ignored.
327 	 */
328 	pcppi_bell(arg, pitch, (period * hz) / 1000,
329 	    poll ? PCPPI_BELL_POLL : 0);
330 }
331 #endif /* NPCKBD > 0 */
332