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