xref: /netbsd-src/sys/dev/isa/pcppi.c (revision f89f6560d453f5e37386cc7938c072d2f528b9fa)
1 /* $NetBSD: pcppi.c,v 1.43 2014/12/08 16:16:45 msaitoh 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.43 2014/12/08 16:16:45 msaitoh 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 #include <sys/bus.h>
43 #include <sys/mutex.h>
44 #include <sys/condvar.h>
45 #include <sys/tty.h>
46 
47 #include <dev/ic/attimervar.h>
48 
49 #include <dev/isa/isareg.h>
50 #include <dev/isa/isavar.h>
51 #include <dev/isa/pcppireg.h>
52 #include <dev/isa/pcppivar.h>
53 
54 #include "pckbd.h"
55 #if NPCKBD > 0
56 #include <dev/pckbport/pckbdvar.h>
57 
58 void	pcppi_pckbd_bell(void *, u_int, u_int, u_int, int);
59 #endif
60 
61 int	pcppi_match(device_t, cfdata_t, void *);
62 void	pcppi_isa_attach(device_t, device_t, void *);
63 void	pcppi_childdet(device_t, device_t);
64 
65 CFATTACH_DECL3_NEW(pcppi, sizeof(struct pcppi_softc),
66     pcppi_match, pcppi_isa_attach, pcppi_detach, NULL, NULL, pcppi_childdet,
67     DVF_DETACH_SHUTDOWN);
68 
69 static int pcppisearch(device_t, cfdata_t, const int *, void *);
70 static void pcppi_bell_stop(struct pcppi_softc *);
71 static void pcppi_bell_callout(void *);
72 
73 #if NATTIMER > 0
74 static void pcppi_attach_speaker(device_t);
75 static void pcppi_detach_speaker(struct pcppi_softc *);
76 #endif
77 
78 int
79 pcppi_match(device_t parent, cfdata_t match, void *aux)
80 {
81 	struct isa_attach_args *ia = aux;
82 	bus_space_handle_t ppi_ioh;
83 	int have_ppi, rv;
84 	u_int8_t v, nv;
85 
86 	if (ISA_DIRECT_CONFIG(ia))
87 		return (0);
88 
89 	/* If values are hardwired to something that they can't be, punt. */
90 	if (ia->ia_nio < 1 ||
91 	    (ia->ia_io[0].ir_addr != ISA_UNKNOWN_PORT &&
92 	    ia->ia_io[0].ir_addr != IO_PPI))
93 		return (0);
94 
95 	if (ia->ia_niomem > 0 &&
96 	    (ia->ia_iomem[0].ir_addr != ISA_UNKNOWN_IOMEM))
97 		return (0);
98 
99 	if (ia->ia_nirq > 0 &&
100 	    (ia->ia_irq[0].ir_irq != ISA_UNKNOWN_IRQ))
101 		return (0);
102 
103 	if (ia->ia_ndrq > 0 &&
104 	    (ia->ia_drq[0].ir_drq != ISA_UNKNOWN_DRQ))
105 		return (0);
106 
107 	rv = 0;
108 	have_ppi = 0;
109 
110 	if (bus_space_map(ia->ia_iot, IO_PPI, 1, 0, &ppi_ioh))
111 		goto lose;
112 	have_ppi = 1;
113 
114 	/*
115 	 * Check for existence of PPI.  Realistically, this is either going to
116 	 * be here or nothing is going to be here.
117 	 *
118 	 * We don't want to have any chance of changing speaker output (which
119 	 * this test might, if it crashes in the middle, or something;
120 	 * normally it's be to quick to produce anthing audible), but
121 	 * many "combo chip" mock-PPI's don't seem to support the top bit
122 	 * of Port B as a settable bit.  The bottom bit has to be settable,
123 	 * since the speaker driver hardware still uses it.
124 	 */
125 	v = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
126 	bus_space_write_1(ia->ia_iot, ppi_ioh, 0, v ^ 0x01);	/* XXX */
127 	nv = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
128 	if (((nv ^ v) & 0x01) == 0x01)
129 		rv = 1;
130 	bus_space_write_1(ia->ia_iot, ppi_ioh, 0, v);		/* XXX */
131 	nv = bus_space_read_1(ia->ia_iot, ppi_ioh, 0);		/* XXX */
132 	if (((nv ^ v) & 0x01) != 0x00) {
133 		rv = 0;
134 		goto lose;
135 	}
136 
137 	/*
138 	 * We assume that the programmable interval timer is there.
139 	 */
140 
141 lose:
142 	if (have_ppi)
143 		bus_space_unmap(ia->ia_iot, ppi_ioh, 1);
144 	if (rv) {
145 		ia->ia_io[0].ir_addr = IO_PPI;
146 		ia->ia_io[0].ir_size = 1;
147 		ia->ia_nio = 1;
148 
149 		ia->ia_niomem = 0;
150 		ia->ia_nirq = 0;
151 		ia->ia_ndrq = 0;
152 	}
153 	return (rv);
154 }
155 
156 void
157 pcppi_isa_attach(device_t parent, device_t self, void *aux)
158 {
159         struct pcppi_softc *sc = device_private(self);
160         struct isa_attach_args *ia = aux;
161         bus_space_tag_t iot;
162 
163 	sc->sc_dv = self;
164         sc->sc_iot = iot = ia->ia_iot;
165 
166         sc->sc_size = 1;
167         if (bus_space_map(iot, IO_PPI, sc->sc_size, 0, &sc->sc_ppi_ioh))
168                 panic("pcppi_attach: couldn't map");
169 
170 	aprint_naive("\n");
171 	aprint_normal("\n");
172         pcppi_attach(sc);
173 }
174 
175 void
176 pcppi_childdet(device_t self, device_t child)
177 {
178 
179 	/* we hold no child references, so do nothing */
180 }
181 
182 int
183 pcppi_detach(device_t self, int flags)
184 {
185 	int rc;
186 	struct pcppi_softc *sc = device_private(self);
187 
188 #if NATTIMER > 0
189 	pcppi_detach_speaker(sc);
190 #endif
191 
192 	if ((rc = config_detach_children(sc->sc_dv, flags)) != 0)
193 		return rc;
194 
195 	pmf_device_deregister(self);
196 
197 #if NPCKBD > 0
198 	pckbd_unhook_bell(pcppi_pckbd_bell, sc);
199 #endif
200 	mutex_spin_enter(&tty_lock);
201 	pcppi_bell_stop(sc);
202 	mutex_spin_exit(&tty_lock);
203 
204 	callout_halt(&sc->sc_bell_ch, NULL);
205 	callout_destroy(&sc->sc_bell_ch);
206 
207 	cv_destroy(&sc->sc_slp);
208 
209 	bus_space_unmap(sc->sc_iot, sc->sc_ppi_ioh, sc->sc_size);
210 
211 	return 0;
212 }
213 
214 void
215 pcppi_attach(struct pcppi_softc *sc)
216 {
217         struct pcppi_attach_args pa;
218 	device_t self = sc->sc_dv;
219 
220 	callout_init(&sc->sc_bell_ch, CALLOUT_MPSAFE);
221 	callout_setfunc(&sc->sc_bell_ch, pcppi_bell_callout, sc);
222 	cv_init(&sc->sc_slp, "bell");
223 
224         sc->sc_bellactive = sc->sc_bellpitch = 0;
225 
226 #if NPCKBD > 0
227 	/* Provide a beeper for the PC Keyboard, if there isn't one already. */
228 	pckbd_hookup_bell(pcppi_pckbd_bell, sc);
229 #endif
230 #if NATTIMER > 0
231 	config_defer(sc->sc_dv, pcppi_attach_speaker);
232 #endif
233 	if (!pmf_device_register(self, NULL, NULL))
234 		aprint_error_dev(self, "couldn't establish power handler\n");
235 
236 	pa.pa_cookie = sc;
237 	config_search_loc(pcppisearch, sc->sc_dv, "pcppi", NULL, &pa);
238 }
239 
240 static int
241 pcppisearch(device_t parent, cfdata_t cf, const int *locs, void *aux)
242 {
243 
244 	if (config_match(parent, cf, aux))
245 		config_attach_loc(parent, cf, locs, aux, NULL);
246 
247 	return 0;
248 }
249 
250 #if NATTIMER > 0
251 static void
252 pcppi_detach_speaker(struct pcppi_softc *sc)
253 {
254 	if (sc->sc_timer != NULL) {
255 		attimer_detach_speaker(sc->sc_timer);
256 		sc->sc_timer = NULL;
257 	}
258 }
259 
260 static void
261 pcppi_attach_speaker(device_t self)
262 {
263 	struct pcppi_softc *sc = device_private(self);
264 
265 	if ((sc->sc_timer = attimer_attach_speaker()) == NULL)
266 		aprint_error_dev(self, "could not find any available timer\n");
267 	else {
268 		aprint_normal_dev(sc->sc_timer, "attached to %s\n",
269 		    device_xname(self));
270 	}
271 }
272 #endif
273 
274 void
275 pcppi_bell(pcppi_tag_t self, int pitch, int period, int slp)
276 {
277 
278 	mutex_spin_enter(&tty_lock);
279 	pcppi_bell_locked(self, pitch, period, slp);
280 	mutex_spin_exit(&tty_lock);
281 }
282 
283 void
284 pcppi_bell_locked(pcppi_tag_t self, int pitch, int period, int slp)
285 {
286 	struct pcppi_softc *sc = self;
287 
288 	if (sc->sc_bellactive) {
289 		if (sc->sc_timeout) {
290 			sc->sc_timeout = 0;
291 			callout_stop(&sc->sc_bell_ch);
292 		}
293 		cv_broadcast(&sc->sc_slp);
294 	}
295 	if (pitch == 0 || period == 0) {
296 		pcppi_bell_stop(sc);
297 		sc->sc_bellpitch = 0;
298 		return;
299 	}
300 	if (!sc->sc_bellactive || sc->sc_bellpitch != pitch) {
301 #if NATTIMER > 0
302 		if (sc->sc_timer != NULL)
303 			attimer_set_pitch(sc->sc_timer, pitch);
304 #endif
305 		/* enable speaker */
306 		bus_space_write_1(sc->sc_iot, sc->sc_ppi_ioh, 0,
307 			bus_space_read_1(sc->sc_iot, sc->sc_ppi_ioh, 0)
308 			| PIT_SPKR);
309 	}
310 	sc->sc_bellpitch = pitch;
311 
312 	sc->sc_bellactive = 1;
313 	if (slp & PCPPI_BELL_POLL) {
314 		delay((period * 1000000) / hz);
315 		pcppi_bell_stop(sc);
316 	} else {
317 		sc->sc_timeout = 1;
318 		callout_schedule(&sc->sc_bell_ch, period);
319 		if (slp & PCPPI_BELL_SLEEP) {
320 			cv_wait_sig(&sc->sc_slp, &tty_lock);
321 		}
322 	}
323 }
324 
325 static void
326 pcppi_bell_callout(void *arg)
327 {
328 	struct pcppi_softc *sc = arg;
329 
330 	mutex_spin_enter(&tty_lock);
331 	if (sc->sc_timeout != 0) {
332 		pcppi_bell_stop(sc);
333 	}
334 	mutex_spin_exit(&tty_lock);
335 }
336 
337 static void
338 pcppi_bell_stop(struct pcppi_softc *sc)
339 {
340 
341 	sc->sc_timeout = 0;
342 
343 	/* disable bell */
344 	bus_space_write_1(sc->sc_iot, sc->sc_ppi_ioh, 0,
345 			  bus_space_read_1(sc->sc_iot, sc->sc_ppi_ioh, 0)
346 			  & ~PIT_SPKR);
347 	sc->sc_bellactive = 0;
348 	cv_broadcast(&sc->sc_slp);
349 }
350 
351 #if NPCKBD > 0
352 void
353 pcppi_pckbd_bell(void *arg, u_int pitch, u_int period, u_int volume,
354     int poll)
355 {
356 
357 	/*
358 	 * Comes in as ms, goes out at ticks; volume ignored.
359 	 */
360 	pcppi_bell_locked(arg, pitch, (period * hz) / 1000,
361 	    poll ? PCPPI_BELL_POLL : 0);
362 }
363 #endif /* NPCKBD > 0 */
364