xref: /netbsd-src/sys/dev/isa/pas.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: pas.c,v 1.62 2005/12/11 12:22:03 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 1991-1993 Regents of the University of California.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the Computer Systems
18  *	Engineering Group at Lawrence Berkeley Laboratory.
19  * 4. Neither the name of the University nor of the Laboratory may be used
20  *    to endorse or promote products derived from this software without
21  *    specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  */
36 /*
37  * jfw 7/13/97 - The soundblaster code requires the generic bus-space
38  * structures to be set up properly.  Rather than go to the effort of making
39  * code for a dead line fully generic, properly set up the SB structures and
40  * leave the rest x86/ISA/default-configuration specific.  If you have a
41  * REAL computer, go buy a REAL sound card.
42  */
43 /*
44  * Todo:
45  *	- look at other PAS drivers (for PAS native suport)
46  *	- use common sb.c once emulation is setup
47  */
48 /*
49  * jfw 6/21/98 - WARNING:  the PAS native IO ports are scattered all around
50  * IO port space (0x0388, 0x738B, 0xBF88, 0x2789, ...) which will make proper
51  * reservation a real pain, so I'm not going to do it (while fixing the
52  * current reservation code to "work").  As a sanity check, I reserve the
53  * 0x0388 base address, but you probably shouldn't even think of trying this
54  * driver unless you're certain you have the hardware installed and it doesn't
55  * conflict with other hardware...
56  */
57 
58 
59 #include <sys/cdefs.h>
60 __KERNEL_RCSID(0, "$NetBSD: pas.c,v 1.62 2005/12/11 12:22:03 christos Exp $");
61 
62 #include <sys/param.h>
63 #include <sys/systm.h>
64 #include <sys/errno.h>
65 #include <sys/ioctl.h>
66 #include <sys/syslog.h>
67 #include <sys/device.h>
68 #include <sys/proc.h>
69 
70 #include <machine/cpu.h>
71 #include <machine/intr.h>
72 #include <machine/bus.h>
73 #include <machine/pio.h>
74 
75 #include <sys/audioio.h>
76 #include <dev/audio_if.h>
77 #include <dev/midi_if.h>
78 
79 #include <dev/isa/isavar.h>
80 #include <dev/isa/isadmavar.h>
81 
82 #include <dev/isa/sbdspvar.h>
83 #include <dev/isa/sbreg.h>
84 
85 #define DEFINE_TRANSLATIONS
86 #include <dev/isa/pasreg.h>
87 
88 #ifdef AUDIO_DEBUG
89 #define DPRINTF(x)	if (pasdebug) printf x
90 int	pasdebug = 0;
91 #else
92 #define DPRINTF(x)
93 #endif
94 
95 /*
96  * Software state, per SoundBlaster card.
97  * The soundblaster has multiple functionality, which we must demultiplex.
98  * One approach is to have one major device number for the soundblaster card,
99  * and use different minor numbers to indicate which hardware function
100  * we want.  This would make for one large driver.  Instead our approach
101  * is to partition the design into a set of drivers that share an underlying
102  * piece of hardware.  Most things are hard to share, for example, the audio
103  * and midi ports.  For audio, we might want to mix two processes' signals,
104  * and for midi we might want to merge streams (this is hard due to
105  * running status).  Moreover, we should be able to re-use the high-level
106  * modules with other kinds of hardware.  In this module, we only handle the
107  * most basic communications with the sb card.
108  */
109 struct pas_softc {
110 	struct sbdsp_softc sc_sbdsp;	/* base device, &c. */
111 	bus_space_handle_t pas_port_handle;    /* the pas-specific port */
112 
113 	int model;
114 	int rev;
115 };
116 
117 int	pas_getdev(void *, struct audio_device *);
118 void	pasconf(int, int, int, int);
119 
120 
121 /*
122  * Define our interface to the higher level audio driver.
123  */
124 
125 const struct audio_hw_if pas_hw_if = {
126 	sbdsp_open,
127 	sbdsp_close,
128 	0,
129 	sbdsp_query_encoding,
130 	sbdsp_set_params,
131 	sbdsp_round_blocksize,
132 	0,
133 	0,
134 	0,
135 	0,
136 	0,
137 	sbdsp_halt_output,
138 	sbdsp_halt_input,
139 	sbdsp_speaker_ctl,
140 	pas_getdev,
141 	0,
142 	sbdsp_mixer_set_port,
143 	sbdsp_mixer_get_port,
144 	sbdsp_mixer_query_devinfo,
145 	sb_malloc,
146 	sb_free,
147 	sb_round_buffersize,
148 	sb_mappage,
149 	sbdsp_get_props,
150 	sbdsp_trigger_output,
151 	sbdsp_trigger_input,
152 	0,
153 };
154 
155 /* The Address Translation code is used to convert I/O register addresses to
156    be relative to the given base -register */
157 
158 static const char *pasnames[] = {
159 	"",
160 	"Plus",
161 	"CDPC",
162 	"16",
163 	"16Basic"
164 };
165 
166 static struct audio_device pas_device = {
167 	"PAS,??",
168 	"",
169 	"pas"
170 };
171 
172 /*XXX assume default I/O base address */
173 #define pasread(p) inb((p))
174 #define paswrite(d, p) outb((p), (d))
175 
176 void
177 pasconf(int model, int sbbase, int sbirq, int sbdrq)
178 {
179 
180 	paswrite(0x00, INTERRUPT_MASK);
181 	/* Local timer control register */
182 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
183 	/* Sample rate timer (16 bit) */
184 	paswrite(0x36, SAMPLE_RATE_TIMER);
185 	paswrite(0, SAMPLE_RATE_TIMER);
186 	/* Local timer control register */
187 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
188 	/* Sample count register (16 bit) */
189 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
190 	paswrite(0, SAMPLE_BUFFER_COUNTER);
191 
192 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
193 	    P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
194 	    PCM_CONTROL);
195 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
196 	    S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
197 
198 /*XXX*/
199 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
200 
201 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
202 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
203 
204 #ifdef BROKEN_BUS_CLOCK
205 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
206 	    S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
207 #else
208 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
209 	    SYSTEM_CONFIGURATION_1);
210 #endif
211 
212 	/*XXX*/
213 	paswrite(0, SYSTEM_CONFIGURATION_2);
214 	paswrite(0, SYSTEM_CONFIGURATION_3);
215 
216 	/* Sets mute off and selects filter rate of 17.897 kHz */
217 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
218 
219 	if (model == PAS_16 || model == PAS_16BASIC)
220 		paswrite(8, PRESCALE_DIVIDER);
221 	else
222 		paswrite(0, PRESCALE_DIVIDER);
223 
224 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
225 	paswrite(5, PARALLEL_MIXER);
226 
227 	/*
228 	 * Setup SoundBlaster emulation.
229 	 */
230 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
231 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
232 	    EMULATION_CONFIGURATION);
233 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
234 
235 	/*
236 	 * Set mid-range levels.
237 	 */
238 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
239 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
240 
241 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
242 	paswrite(50, PARALLEL_MIXER);
243 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
244 	paswrite(50, PARALLEL_MIXER);
245 
246 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB,
247 	    PARALLEL_MIXER);
248 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
249 
250 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC,
251 	    PARALLEL_MIXER);
252 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
253 }
254 
255 int	pasprobe(struct device *, struct cfdata *, void *);
256 void	pasattach(struct device *, struct device *, void *);
257 static	int pasfind(struct device *, struct pas_softc *,
258     struct isa_attach_args *, int);
259 /* argument to pasfind */
260 #define PASPROBE  1
261 #define PASATTACH 0
262 
263 CFATTACH_DECL(pas, sizeof(struct pas_softc),
264     pasprobe, pasattach, NULL, NULL);
265 
266 /*
267  * Probe / attach routines.
268  */
269 
270 int
271 pasprobe(struct device *parent, struct cfdata *match, void *aux)
272 {
273 	struct isa_attach_args *ia;
274 	struct pas_softc probesc, *sc;
275 
276 	ia = aux;
277 	sc = &probesc;
278 	if (ia->ia_nio < 1)
279 		return 0;
280 	if (ia->ia_nirq < 1)
281 		return 0;
282 	if (ia->ia_ndrq < 1)
283 		return 0;
284 
285 	if (ISA_DIRECT_CONFIG(ia))
286 		return 0;
287 
288 	memset(sc, 0, sizeof *sc);
289 	sc->sc_sbdsp.sc_dev.dv_cfdata = match;
290 	strcpy(sc->sc_sbdsp.sc_dev.dv_xname, "pas");
291 	return pasfind(parent, sc, aux, PASPROBE);
292 }
293 
294 /*
295  * Probe for the soundblaster hardware.
296  */
297 static int
298 pasfind(struct device *parent, struct pas_softc *sc,
299     struct isa_attach_args *ia, int probing)
300 {
301 	int iobase;
302 	u_char id, t;
303 	int rc;
304 
305 	rc = 0;			/* failure */
306 	/* ensure we can set this up as a sound blaster */
307 	if (!SB_BASE_VALID(ia->ia_io[0].ir_addr)) {
308 		printf("pas: configured SB iobase 0x%x invalid\n",
309 		    ia->ia_io[0].ir_addr);
310 		return 0;
311 	}
312 
313 	if (bus_space_map(sc->sc_sbdsp.sc_iot, PAS_DEFAULT_BASE, 1, 0,
314 	    &sc->pas_port_handle)) {
315 		printf("pas: can't map base register %x in probe\n",
316 		    PAS_DEFAULT_BASE);
317 		return 0;
318 	}
319 
320 	/*
321 	 * WARNING: Setting an option like W:1 or so that disables
322 	 * warm boot reset of the card will screw up this detect code
323 	 * something fierce.  Adding code to handle this means possibly
324 	 * interfering with other cards on the bus if you have something
325 	 * on base port 0x388.  SO be forewarned.
326 	 */
327 	/* Talk to first board */
328 	outb(MASTER_DECODE, 0xbc);
329 	/* Set base address */
330 
331 #if 0
332 	/* XXX Need to setup pseudo device */
333 	/* XXX What are good io addrs ? */
334 	if (iobase != PAS_DEFAULT_BASE) {
335 		printf("pas: configured iobase %d invalid\n", iobase);
336 		return 0;
337 	}
338 #else
339 	/* Start out talking to native PAS */
340 	iobase = PAS_DEFAULT_BASE;
341 #endif
342 
343 	outb(MASTER_DECODE, iobase >> 2);
344 	/* One wait-state */
345 	paswrite(1, WAIT_STATE);
346 
347 	id = pasread(INTERRUPT_MASK);
348 	if (id == 0xff || id == 0xfe) {
349 		/* sanity */
350 		DPRINTF(("pas: bogus card id\n"));
351 		goto unmap1;
352 	}
353 	/*
354 	 * We probably have a PAS-series board, now check for a
355 	 * PAS2-series board by trying to change the board revision
356 	 * bits.  PAS2-series hardware won't let you do this because
357 	 * the bits are read-only.
358 	 */
359 	t = id ^ 0xe0;
360 	paswrite(t, INTERRUPT_MASK);
361 	t = inb(INTERRUPT_MASK);
362 	paswrite(id, INTERRUPT_MASK);
363 
364 	if (t != id) {
365 		/* Not a PAS2 */
366 		printf("pas: detected card but PAS2 test failed\n");
367 		goto unmap1;
368 	}
369 	/*XXX*/
370 	t = pasread(OPERATION_MODE_1) & 0xf;
371 	sc->model = O_M_1_to_card[t];
372 	if (sc->model != 0) {
373 		sc->rev = pasread(BOARD_REV_ID);
374 	} else {
375 		DPRINTF(("pas: bogus model id\n"));
376 		goto unmap1;
377 	}
378 
379 	if (sc->model >= 0) {
380 		if (ia->ia_irq[0].ir_irq == ISA_UNKNOWN_IRQ) {
381 			printf("pas: sb emulation requires known irq\n");
382 			goto unmap1;
383 		}
384 		pasconf(sc->model, ia->ia_io[0].ir_addr,
385 		    ia->ia_irq[0].ir_irq, 1);
386 	} else {
387 		DPRINTF(("pas: could not probe pas\n"));
388 		goto unmap1;
389 	}
390 
391 	/* Now a SoundBlaster, so set up proper bus-space hooks
392          * appropriately
393          */
394 
395 	sc->sc_sbdsp.sc_iobase = ia->ia_io[0].ir_addr;
396 	sc->sc_sbdsp.sc_iot = ia->ia_iot;
397 
398 	/* Map i/o space [we map 24 ports which is the max of the sb and pro */
399 	if (bus_space_map(sc->sc_sbdsp.sc_iot, ia->ia_io[0].ir_addr,
400 	    SBP_NPORT, 0, &sc->sc_sbdsp.sc_ioh)) {
401 		printf("pas: can't map i/o space 0x%x/%d in probe\n",
402 		    ia->ia_io[0].ir_addr, SBP_NPORT);
403 		goto unmap1;
404 	}
405 
406 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
407 		DPRINTF(("pas: couldn't reset card\n"));
408 		goto unmap;
409 	}
410 
411 	/*
412 	 * Cannot auto-discover DMA channel.
413 	 */
414 	if (!SB_DRQ_VALID(ia->ia_drq[0].ir_drq)) {
415 		printf("pas: configured DMA chan %d invalid\n",
416 		    ia->ia_drq[0].ir_drq);
417 		goto unmap;
418 	}
419 	if (!SB_IRQ_VALID(ia->ia_irq[0].ir_irq)) {
420 		printf("pas: configured irq chan %d invalid\n",
421 		    ia->ia_drq[0].ir_drq);
422 		goto unmap;
423 	}
424 
425 	sc->sc_sbdsp.sc_irq = ia->ia_irq[0].ir_irq;
426 	sc->sc_sbdsp.sc_drq8 = ia->ia_drq[0].ir_drq;
427 	sc->sc_sbdsp.sc_drq16 = -1; /* XXX */
428 
429 	if (sbdsp_probe(&sc->sc_sbdsp) == 0) {
430 		DPRINTF(("pas: sbdsp probe failed\n"));
431 		goto unmap;
432 	}
433 
434 	rc = 1;
435 
436 	if (probing) {
437 		ia->ia_nio = 1;
438 		ia->ia_io[0].ir_size = SBP_NPORT;
439 
440 		ia->ia_nirq = 1;
441 		ia->ia_ndrq = 1;
442 
443 		ia->ia_niomem = 0;
444 	}
445 
446  unmap:
447 	if (rc == 0 || probing)
448 		bus_space_unmap(sc->sc_sbdsp.sc_iot, sc->sc_sbdsp.sc_ioh,
449 		    SBP_NPORT);
450  unmap1:
451 	if (rc == 0 || probing)
452 		bus_space_unmap(sc->sc_sbdsp.sc_iot, PAS_DEFAULT_BASE, 1);
453 	return rc;
454 }
455 
456 /*
457  * Attach hardware to driver, attach hardware driver to audio
458  * pseudo-device driver .
459  */
460 void
461 pasattach(struct device *parent, struct device *self, void *aux)
462 {
463 	struct pas_softc *sc;
464 	struct isa_attach_args *ia;
465 	int iobase;
466 
467 	sc = (struct pas_softc *)self;
468 	ia = (struct isa_attach_args *)aux;
469 	iobase = ia->ia_io[0].ir_addr;
470 	if (!pasfind(parent, sc, ia, PASATTACH)) {
471 		printf("%s: pasfind failed\n", sc->sc_sbdsp.sc_dev.dv_xname);
472 		return;
473 	}
474 
475 	sc->sc_sbdsp.sc_ic = ia->ia_ic;
476 	sc->sc_sbdsp.sc_iobase = iobase;
477 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq[0].ir_irq,
478 	    IST_EDGE, IPL_AUDIO, sbdsp_intr, &sc->sc_sbdsp);
479 
480 	printf(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model],
481 	    sc->rev);
482 
483 	sbdsp_attach(&sc->sc_sbdsp);
484 
485 	snprintf(pas_device.name, sizeof(pas_device.name), "pas,%s",
486 	    pasnames[sc->model]);
487 	snprintf(pas_device.version, sizeof(pas_device.version), "%d",
488 	    sc->rev);
489 
490 	audio_attach_mi(&pas_hw_if, &sc->sc_sbdsp, &sc->sc_sbdsp.sc_dev);
491 }
492 
493 int
494 pas_getdev(void *addr, struct audio_device *retp)
495 {
496 
497 	*retp = pas_device;
498 	return 0;
499 }
500