xref: /netbsd-src/sys/dev/isa/pas.c (revision 76dfffe33547c37f8bdd446e3e4ab0f3c16cea4b)
1 /*	$NetBSD: pas.c,v 1.20 1996/11/12 07:39:56 mikel 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  * Todo:
38  * 	- look at other PAS drivers (for PAS native suport)
39  * 	- use common sb.c once emulation is setup
40  */
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/errno.h>
45 #include <sys/ioctl.h>
46 #include <sys/syslog.h>
47 #include <sys/device.h>
48 #include <sys/proc.h>
49 
50 #include <machine/cpu.h>
51 #include <machine/intr.h>
52 #include <machine/pio.h>
53 
54 #include <sys/audioio.h>
55 #include <dev/audio_if.h>
56 #include <dev/mulaw.h>
57 
58 #include <dev/isa/isavar.h>
59 #include <dev/isa/isadmavar.h>
60 
61 #include <dev/isa/sbdspvar.h>
62 #include <dev/isa/sbreg.h>
63 
64 #define DEFINE_TRANSLATIONS
65 #include <dev/isa/pasreg.h>
66 
67 #ifdef AUDIO_DEBUG
68 #define DPRINTF(x)	if (pasdebug) printf x
69 int	pasdebug = 0;
70 #else
71 #define DPRINTF(x)
72 #endif
73 
74 /*
75  * Software state, per SoundBlaster card.
76  * The soundblaster has multiple functionality, which we must demultiplex.
77  * One approach is to have one major device number for the soundblaster card,
78  * and use different minor numbers to indicate which hardware function
79  * we want.  This would make for one large driver.  Instead our approach
80  * is to partition the design into a set of drivers that share an underlying
81  * piece of hardware.  Most things are hard to share, for example, the audio
82  * and midi ports.  For audio, we might want to mix two processes' signals,
83  * and for midi we might want to merge streams (this is hard due to
84  * running status).  Moreover, we should be able to re-use the high-level
85  * modules with other kinds of hardware.  In this module, we only handle the
86  * most basic communications with the sb card.
87  */
88 struct pas_softc {
89 	struct sbdsp_softc sc_sbdsp;	/* base device, &c. */
90 
91 	int model;
92 	int rev;
93 };
94 
95 int	pasopen __P((dev_t, int));
96 int	pas_getdev __P((void *, struct audio_device *));
97 void	pasconf __P((int, int, int, int));
98 
99 
100 /*
101  * Define our interface to the higher level audio driver.
102  */
103 
104 struct audio_hw_if pas_hw_if = {
105 	pasopen,
106 	sbdsp_close,
107 	NULL,
108 	sbdsp_set_in_sr,
109 	sbdsp_get_in_sr,
110 	sbdsp_set_out_sr,
111 	sbdsp_get_out_sr,
112 	sbdsp_query_encoding,
113 	sbdsp_set_encoding,
114 	sbdsp_get_encoding,
115 	sbdsp_set_precision,
116 	sbdsp_get_precision,
117 	sbdsp_set_channels,
118 	sbdsp_get_channels,
119 	sbdsp_round_blocksize,
120 	sbdsp_set_out_port,
121 	sbdsp_get_out_port,
122 	sbdsp_set_in_port,
123 	sbdsp_get_in_port,
124 	sbdsp_commit_settings,
125 	sbdsp_get_silence,
126 	mulaw_expand,
127 	mulaw_compress,
128 	sbdsp_dma_output,
129 	sbdsp_dma_input,
130 	sbdsp_haltdma,
131 	sbdsp_haltdma,
132 	sbdsp_contdma,
133 	sbdsp_contdma,
134 	sbdsp_speaker_ctl,
135 	pas_getdev,
136 	sbdsp_setfd,
137 	sbdsp_mixer_set_port,
138 	sbdsp_mixer_get_port,
139 	sbdsp_mixer_query_devinfo,
140 	0,	/* not full-duplex */
141 	0
142 };
143 
144 /* The Address Translation code is used to convert I/O register addresses to
145    be relative to the given base -register */
146 
147 static char *pasnames[] = {
148 	"",
149 	"Plus",
150 	"CDPC",
151 	"16",
152 	"16Basic"
153 };
154 
155 static struct audio_device pas_device = {
156 	"PAS,??",
157 	"",
158 	"pas"
159 };
160 
161 /*XXX assume default I/O base address */
162 #define pasread(p) inb(p)
163 #define paswrite(d, p) outb(p, d)
164 
165 void
166 pasconf(model, sbbase, sbirq, sbdrq)
167 	int model;
168 	int sbbase;
169 	int sbirq;
170 	int sbdrq;
171 {
172 	paswrite(0x00, INTERRUPT_MASK);
173 	/* Local timer control register */
174 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
175 	/* Sample rate timer (16 bit) */
176 	paswrite(0x36, SAMPLE_RATE_TIMER);
177 	paswrite(0, SAMPLE_RATE_TIMER);
178 	/* Local timer control register */
179 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
180 	/* Sample count register (16 bit) */
181 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
182 	paswrite(0, SAMPLE_BUFFER_COUNTER);
183 
184 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
185 		  P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
186 		  PCM_CONTROL);
187 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
188 		  S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
189 
190 /*XXX*/
191 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
192 
193 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
194 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
195 
196 #ifdef BROKEN_BUS_CLOCK
197 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
198 		  S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
199 #else
200 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
201 		  SYSTEM_CONFIGURATION_1);
202 #endif
203 
204 	/*XXX*/
205 	paswrite(0, SYSTEM_CONFIGURATION_2);
206 	paswrite(0, SYSTEM_CONFIGURATION_3);
207 
208 	/* Sets mute off and selects filter rate of 17.897 kHz */
209 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
210 
211 	if (model == PAS_16 || model == PAS_16BASIC)
212 		paswrite(8, PRESCALE_DIVIDER);
213 	else
214 		paswrite(0, PRESCALE_DIVIDER);
215 
216 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
217 	paswrite(5, PARALLEL_MIXER);
218 
219 	/*
220 	 * Setup SoundBlaster emulation.
221 	 */
222 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
223 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
224 		 EMULATION_CONFIGURATION);
225 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
226 
227 	/*
228 	 * Set mid-range levels.
229 	 */
230 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
231 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
232 
233 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
234 	paswrite(50, PARALLEL_MIXER);
235 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
236 	paswrite(50, PARALLEL_MIXER);
237 
238 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB, PARALLEL_MIXER);
239 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
240 
241 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC, PARALLEL_MIXER);
242 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
243 }
244 
245 int	pasprobe __P((struct device *, void *, void *));
246 void	pasattach __P((struct device *, struct device *, void *));
247 
248 struct cfattach pas_ca = {
249 	sizeof(struct pas_softc), pasprobe, pasattach
250 };
251 
252 struct cfdriver pas_cd = {
253 	NULL, "pas", DV_DULL
254 };
255 
256 /*
257  * Probe / attach routines.
258  */
259 
260 /*
261  * Probe for the soundblaster hardware.
262  */
263 int
264 pasprobe(parent, match, aux)
265 	struct device *parent;
266 	void *match, *aux;
267 {
268 	register struct pas_softc *sc = match;
269 	register struct isa_attach_args *ia = aux;
270 	register int iobase;
271 	u_char id, t;
272 
273 	/*
274 	 * WARNING: Setting an option like W:1 or so that disables
275 	 * warm boot reset of the card will screw up this detect code
276 	 * something fierce.  Adding code to handle this means possibly
277 	 * interfering with other cards on the bus if you have something
278 	 * on base port 0x388.  SO be forewarned.
279 	 */
280 	/* Talk to first board */
281 	outb(MASTER_DECODE, 0xbc);
282 	/* Set base address */
283 
284 #if 0
285 	/* XXX Need to setup pseudo device */
286 	/* XXX What are good io addrs ? */
287 	if (iobase != PAS_DEFAULT_BASE) {
288 		printf("pas: configured iobase %d invalid\n", iobase);
289 		return 0;
290 	}
291 #else
292 	/* Start out talking to native PAS */
293 	iobase = PAS_DEFAULT_BASE;
294 #endif
295 
296 	outb(MASTER_DECODE, iobase >> 2);
297 	/* One wait-state */
298 	paswrite(1, WAIT_STATE);
299 
300 	id = pasread(INTERRUPT_MASK);
301 	if (id == 0xff || id == 0xfe) {
302 		/* sanity */
303 		DPRINTF(("pas: bogus card id\n"));
304 		return 0;
305 	}
306 	/*
307 	 * We probably have a PAS-series board, now check for a
308 	 * PAS2-series board by trying to change the board revision
309 	 * bits.  PAS2-series hardware won't let you do this because
310 	 * the bits are read-only.
311 	 */
312 	t = id ^ 0xe0;
313 	paswrite(t, INTERRUPT_MASK);
314 	t = inb(INTERRUPT_MASK);
315 	paswrite(id, INTERRUPT_MASK);
316 
317 	if (t != id) {
318 		/* Not a PAS2 */
319 		printf("pas: detected card but PAS2 test failed\n");
320 		return 0;
321 	}
322 	/*XXX*/
323 	t = pasread(OPERATION_MODE_1) & 0xf;
324 	sc->model = O_M_1_to_card[t];
325 	if (sc->model != 0) {
326 		sc->rev = pasread(BOARD_REV_ID);
327 	}
328 	else {
329 		DPRINTF(("pas: bogus model id\n"));
330 		return 0;
331 	}
332 
333         if (sc->model >= 0) {
334                 if (ia->ia_irq == IRQUNK) {
335                         printf("pas: sb emulation requires known irq\n");
336                         return (0);
337                 }
338                 pasconf(sc->model, ia->ia_iobase, ia->ia_irq, 1);
339         } else {
340                 DPRINTF(("pas: could not probe pas\n"));
341                 return (0);
342         }
343 
344 	/* Now a SoundBlaster */
345 	sc->sc_sbdsp.sc_iobase = ia->ia_iobase;
346 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
347 		DPRINTF(("pas: couldn't reset card\n"));
348 		return 0;
349 	}
350 
351 	/*
352 	 * Cannot auto-discover DMA channel.
353 	 */
354 	if (!SB_DRQ_VALID(ia->ia_drq)) {
355 		printf("pas: configured dma chan %d invalid\n", ia->ia_drq);
356 		return 0;
357 	}
358 #ifdef NEWCONFIG
359 	/*
360 	 * If the IRQ wasn't compiled in, auto-detect it.
361 	 */
362 	if (ia->ia_irq == IRQUNK) {
363 		ia->ia_irq = isa_discoverintr(pasforceintr, aux);
364 		sbdsp_reset(&sc->sc_sbdsp);
365 		if (!SB_IRQ_VALID(ia->ia_irq)) {
366 			printf("pas: couldn't auto-detect interrupt");
367 			return 0;
368 		}
369 	} else
370 #endif
371 	if (!SB_IRQ_VALID(ia->ia_irq)) {
372 		printf("pas: configured irq chan %d invalid\n", ia->ia_irq);
373 		return 0;
374 	}
375 
376 	sc->sc_sbdsp.sc_irq = ia->ia_irq;
377 	sc->sc_sbdsp.sc_drq = ia->ia_drq;
378 
379 	if (sbdsp_probe(&sc->sc_sbdsp) == 0) {
380 		DPRINTF(("pas: sbdsp probe failed\n"));
381 		return 0;
382 	}
383 
384 	ia->ia_iosize = SB_NPORT;
385 	return 1;
386 }
387 
388 #ifdef NEWCONFIG
389 void
390 pasforceintr(aux)
391 	void *aux;
392 {
393 	static char dmabuf;
394 	struct isa_attach_args *ia = aux;
395 	int iobase = ia->ia_iobase;
396 
397 	/*
398 	 * Set up a DMA read of one byte.
399 	 * XXX Note that at this point we haven't called
400 	 * at_setup_dmachan().  This is okay because it just
401 	 * allocates a buffer in case it needs to make a copy,
402 	 * and it won't need to make a copy for a 1 byte buffer.
403 	 * (I think that calling at_setup_dmachan() should be optional;
404 	 * if you don't call it, it will be called the first time
405 	 * it is needed (and you pay the latency).  Also, you might
406 	 * never need the buffer anyway.)
407 	 */
408 	at_dma(DMAMODE_READ, &dmabuf, 1, ia->ia_drq);
409 	if (pas_wdsp(iobase, SB_DSP_RDMA) == 0) {
410 		(void)pas_wdsp(iobase, 0);
411 		(void)pas_wdsp(iobase, 0);
412 	}
413 }
414 #endif
415 
416 /*
417  * Attach hardware to driver, attach hardware driver to audio
418  * pseudo-device driver .
419  */
420 void
421 pasattach(parent, self, aux)
422 	struct device *parent, *self;
423 	void *aux;
424 {
425 	register struct pas_softc *sc = (struct pas_softc *)self;
426 	struct isa_attach_args *ia = (struct isa_attach_args *)aux;
427 	register int iobase = ia->ia_iobase;
428 	int err;
429 
430 	sc->sc_sbdsp.sc_iobase = iobase;
431 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq,
432 	    IST_EDGE, IPL_AUDIO, sbdsp_intr, &sc->sc_sbdsp);
433 
434 	printf(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model],
435 	    sc->rev);
436 
437 	sbdsp_attach(&sc->sc_sbdsp);
438 
439 	sprintf(pas_device.name, "pas,%s", pasnames[sc->model]);
440 	sprintf(pas_device.version, "%d", sc->rev);
441 
442 	if ((err = audio_hardware_attach(&pas_hw_if, &sc->sc_sbdsp)) != 0)
443 		printf("pas: could not attach to audio pseudo-device driver (%d)\n", err);
444 }
445 
446 int
447 pasopen(dev, flags)
448     dev_t dev;
449     int flags;
450 {
451     struct pas_softc *sc;
452     int unit = AUDIOUNIT(dev);
453 
454     if (unit >= pas_cd.cd_ndevs)
455 	return ENODEV;
456 
457     sc = pas_cd.cd_devs[unit];
458     if (!sc)
459 	return ENXIO;
460 
461     return sbdsp_open(&sc->sc_sbdsp, dev, flags);
462 }
463 
464 int
465 pas_getdev(addr, retp)
466 	void *addr;
467 	struct audio_device *retp;
468 {
469 	*retp = pas_device;
470 	return 0;
471 }
472