xref: /netbsd-src/sys/dev/isa/pas.c (revision 220b5c059a84c51ea44107ea8951a57ffaecdc8c)
1 /*	$NetBSD: pas.c,v 1.51 2001/11/13 08:01:27 lukem 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.51 2001/11/13 08:01:27 lukem 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 __P((void *, struct audio_device *));
118 void	pasconf __P((int, int, int, int));
119 
120 
121 /*
122  * Define our interface to the higher level audio driver.
123  */
124 
125 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 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(model, sbbase, sbirq, sbdrq)
178 	int model;
179 	int sbbase;
180 	int sbirq;
181 	int sbdrq;
182 {
183 	paswrite(0x00, INTERRUPT_MASK);
184 	/* Local timer control register */
185 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
186 	/* Sample rate timer (16 bit) */
187 	paswrite(0x36, SAMPLE_RATE_TIMER);
188 	paswrite(0, SAMPLE_RATE_TIMER);
189 	/* Local timer control register */
190 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
191 	/* Sample count register (16 bit) */
192 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
193 	paswrite(0, SAMPLE_BUFFER_COUNTER);
194 
195 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
196 		  P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
197 		  PCM_CONTROL);
198 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
199 		  S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
200 
201 /*XXX*/
202 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
203 
204 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
205 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
206 
207 #ifdef BROKEN_BUS_CLOCK
208 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
209 		  S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
210 #else
211 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
212 		  SYSTEM_CONFIGURATION_1);
213 #endif
214 
215 	/*XXX*/
216 	paswrite(0, SYSTEM_CONFIGURATION_2);
217 	paswrite(0, SYSTEM_CONFIGURATION_3);
218 
219 	/* Sets mute off and selects filter rate of 17.897 kHz */
220 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
221 
222 	if (model == PAS_16 || model == PAS_16BASIC)
223 		paswrite(8, PRESCALE_DIVIDER);
224 	else
225 		paswrite(0, PRESCALE_DIVIDER);
226 
227 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
228 	paswrite(5, PARALLEL_MIXER);
229 
230 	/*
231 	 * Setup SoundBlaster emulation.
232 	 */
233 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
234 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
235 		 EMULATION_CONFIGURATION);
236 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
237 
238 	/*
239 	 * Set mid-range levels.
240 	 */
241 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
242 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
243 
244 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
245 	paswrite(50, PARALLEL_MIXER);
246 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
247 	paswrite(50, PARALLEL_MIXER);
248 
249 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB, PARALLEL_MIXER);
250 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
251 
252 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC, PARALLEL_MIXER);
253 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
254 }
255 
256 int	pasprobe __P((struct device *, struct cfdata *, void *));
257 void	pasattach __P((struct device *, struct device *, void *));
258 static	int pasfind __P((struct device *, struct pas_softc *,
259 			struct isa_attach_args *, int));
260 /* argument to pasfind */
261 #define PASPROBE  1
262 #define PASATTACH 0
263 
264 struct cfattach pas_ca = {
265 	sizeof(struct pas_softc), pasprobe, pasattach
266 };
267 
268 /*
269  * Probe / attach routines.
270  */
271 
272 int
273 pasprobe(parent, match, aux)
274 	struct device *parent;
275 	struct cfdata *match;
276 	void *aux;
277 {
278 	struct pas_softc probesc, *sc = &probesc;
279 
280 	memset(sc, 0, sizeof *sc);
281 	sc->sc_sbdsp.sc_dev.dv_cfdata = match;
282 	strcpy(sc->sc_sbdsp.sc_dev.dv_xname, "pas");
283 	return pasfind(parent, sc, aux, PASPROBE);
284 }
285 
286 /*
287  * Probe for the soundblaster hardware.
288  */
289 static int
290 pasfind(parent, sc, ia, probing)
291 	struct device *parent;
292 	struct pas_softc *sc;
293 	struct isa_attach_args *ia;
294 	int probing;
295 {
296 	int iobase;
297 	u_char id, t;
298 	int rc = 0;  /* failure */
299 
300         /* ensure we can set this up as a sound blaster */
301        	if (!SB_BASE_VALID(ia->ia_iobase)) {
302 		printf("pas: configured SB iobase 0x%x invalid\n", ia->ia_iobase);
303 		return 0;
304 	}
305 
306 	if (bus_space_map(sc->sc_sbdsp.sc_iot, PAS_DEFAULT_BASE, 1, 0,
307                           &sc->pas_port_handle)) {
308 		printf("pas: can't map base register %x in probe\n",
309 		       PAS_DEFAULT_BASE);
310 		return 0;
311 	}
312 
313 	/*
314 	 * WARNING: Setting an option like W:1 or so that disables
315 	 * warm boot reset of the card will screw up this detect code
316 	 * something fierce.  Adding code to handle this means possibly
317 	 * interfering with other cards on the bus if you have something
318 	 * on base port 0x388.  SO be forewarned.
319 	 */
320 	/* Talk to first board */
321 	outb(MASTER_DECODE, 0xbc);
322 	/* Set base address */
323 
324 #if 0
325 	/* XXX Need to setup pseudo device */
326 	/* XXX What are good io addrs ? */
327 	if (iobase != PAS_DEFAULT_BASE) {
328 		printf("pas: configured iobase %d invalid\n", iobase);
329 		return 0;
330 	}
331 #else
332 	/* Start out talking to native PAS */
333 	iobase = PAS_DEFAULT_BASE;
334 #endif
335 
336 	outb(MASTER_DECODE, iobase >> 2);
337 	/* One wait-state */
338 	paswrite(1, WAIT_STATE);
339 
340 	id = pasread(INTERRUPT_MASK);
341 	if (id == 0xff || id == 0xfe) {
342 		/* sanity */
343 		DPRINTF(("pas: bogus card id\n"));
344 		goto unmap1;
345 	}
346 	/*
347 	 * We probably have a PAS-series board, now check for a
348 	 * PAS2-series board by trying to change the board revision
349 	 * bits.  PAS2-series hardware won't let you do this because
350 	 * the bits are read-only.
351 	 */
352 	t = id ^ 0xe0;
353 	paswrite(t, INTERRUPT_MASK);
354 	t = inb(INTERRUPT_MASK);
355 	paswrite(id, INTERRUPT_MASK);
356 
357 	if (t != id) {
358 		/* Not a PAS2 */
359 		printf("pas: detected card but PAS2 test failed\n");
360 		goto unmap1;
361 	}
362 	/*XXX*/
363 	t = pasread(OPERATION_MODE_1) & 0xf;
364 	sc->model = O_M_1_to_card[t];
365 	if (sc->model != 0) {
366 		sc->rev = pasread(BOARD_REV_ID);
367 	}
368 	else {
369 		DPRINTF(("pas: bogus model id\n"));
370 		goto unmap1;
371 	}
372 
373         if (sc->model >= 0) {
374                 if (ia->ia_irq == IRQUNK) {
375                         printf("pas: sb emulation requires known irq\n");
376 			goto unmap1;
377                 }
378                 pasconf(sc->model, ia->ia_iobase, ia->ia_irq, 1);
379         } else {
380                 DPRINTF(("pas: could not probe pas\n"));
381 		goto unmap1;
382         }
383 
384 	/* Now a SoundBlaster, so set up proper bus-space hooks
385          * appropriately
386          */
387 
388 	sc->sc_sbdsp.sc_iobase = ia->ia_iobase;
389 	sc->sc_sbdsp.sc_iot = ia->ia_iot;
390 
391 	/* Map i/o space [we map 24 ports which is the max of the sb and pro */
392 	if (bus_space_map(sc->sc_sbdsp.sc_iot, ia->ia_iobase, SBP_NPORT, 0,
393 	    &sc->sc_sbdsp.sc_ioh)) {
394 		printf("pas: can't map i/o space 0x%x/%d in probe\n",
395 		    ia->ia_iobase, SBP_NPORT);
396 		goto unmap1;
397 	}
398 
399 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
400 		DPRINTF(("pas: couldn't reset card\n"));
401 		goto unmap;
402 	}
403 
404 	/*
405 	 * Cannot auto-discover DMA channel.
406 	 */
407 	if (!SB_DRQ_VALID(ia->ia_drq)) {
408 		printf("pas: configured dma chan %d invalid\n", ia->ia_drq);
409 		goto unmap;
410 	}
411 #ifdef NEWCONFIG
412 	/*
413 	 * If the IRQ wasn't compiled in, auto-detect it.
414 	 */
415 	if (ia->ia_irq == IRQUNK) {
416 		ia->ia_irq = isa_discoverintr(pasforceintr, aux);
417 		sbdsp_reset(&sc->sc_sbdsp);
418 		if (!SB_IRQ_VALID(ia->ia_irq)) {
419 			printf("pas: couldn't auto-detect interrupt");
420 			goto unmap;
421 		}
422 	} else
423 #endif
424 	if (!SB_IRQ_VALID(ia->ia_irq)) {
425 		printf("pas: configured irq chan %d invalid\n", ia->ia_irq);
426 		goto unmap;
427 	}
428 
429 	sc->sc_sbdsp.sc_irq = ia->ia_irq;
430 	sc->sc_sbdsp.sc_drq8 = ia->ia_drq;
431 	sc->sc_sbdsp.sc_drq16 = -1; /* XXX */
432 
433 	if (sbdsp_probe(&sc->sc_sbdsp) == 0) {
434 		DPRINTF(("pas: sbdsp probe failed\n"));
435 		goto unmap;
436 	}
437 
438 	rc = 1;
439 	ia->ia_iosize = SB_NPORT;
440 
441  unmap:
442 	if (rc == 0 || probing)
443 	        bus_space_unmap(sc->sc_sbdsp.sc_iot, sc->sc_sbdsp.sc_ioh, SBP_NPORT);
444  unmap1:
445 	if (rc == 0 || probing)
446 	        bus_space_unmap(sc->sc_sbdsp.sc_iot, PAS_DEFAULT_BASE, 1);
447 	return rc;
448 }
449 
450 #ifdef NEWCONFIG
451 void
452 pasforceintr(aux)
453 	void *aux;
454 {
455 	static char dmabuf;
456 	struct isa_attach_args *ia = aux;
457 	int iobase = ia->ia_iobase;
458 
459 	/*
460 	 * Set up a DMA read of one byte.
461 	 * XXX Note that at this point we haven't called
462 	 * at_setup_dmachan().  This is okay because it just
463 	 * allocates a buffer in case it needs to make a copy,
464 	 * and it won't need to make a copy for a 1 byte buffer.
465 	 * (I think that calling at_setup_dmachan() should be optional;
466 	 * if you don't call it, it will be called the first time
467 	 * it is needed (and you pay the latency).  Also, you might
468 	 * never need the buffer anyway.)
469 	 */
470 	at_dma(DMAMODE_READ, &dmabuf, 1, ia->ia_drq);
471 	if (pas_wdsp(iobase, SB_DSP_RDMA) == 0) {
472 		(void)pas_wdsp(iobase, 0);
473 		(void)pas_wdsp(iobase, 0);
474 	}
475 }
476 #endif
477 
478 /*
479  * Attach hardware to driver, attach hardware driver to audio
480  * pseudo-device driver .
481  */
482 void
483 pasattach(parent, self, aux)
484 	struct device *parent, *self;
485 	void *aux;
486 {
487 	struct pas_softc *sc = (struct pas_softc *)self;
488 	struct isa_attach_args *ia = (struct isa_attach_args *)aux;
489 	int iobase = ia->ia_iobase;
490 
491 	if (!pasfind(parent, sc, ia, PASATTACH)) {
492 		printf("%s: pasfind failed\n", sc->sc_sbdsp.sc_dev.dv_xname);
493 		return;
494 	}
495 
496 	sc->sc_sbdsp.sc_ic = ia->ia_ic;
497 	sc->sc_sbdsp.sc_iobase = iobase;
498 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq,
499 	    IST_EDGE, IPL_AUDIO, sbdsp_intr, &sc->sc_sbdsp);
500 
501 	printf(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model],
502 	    sc->rev);
503 
504 	sbdsp_attach(&sc->sc_sbdsp);
505 
506 	sprintf(pas_device.name, "pas,%s", pasnames[sc->model]);
507 	sprintf(pas_device.version, "%d", sc->rev);
508 
509 	audio_attach_mi(&pas_hw_if, &sc->sc_sbdsp, &sc->sc_sbdsp.sc_dev);
510 }
511 
512 int
513 pas_getdev(addr, retp)
514 	void *addr;
515 	struct audio_device *retp;
516 {
517 	*retp = pas_device;
518 	return 0;
519 }
520