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