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