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