xref: /openbsd-src/sys/dev/isa/pas.c (revision a0747c9f67a4ae71ccb71e62a28d1ea19e06a63c)
1 /*	$OpenBSD: pas.c,v 1.30 2021/03/07 06:17:04 jsg 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 
57 #include <machine/cpu.h>
58 #include <machine/intr.h>
59 #include <machine/bus.h>
60 
61 #include <sys/audioio.h>
62 #include <dev/audio_if.h>
63 #include <dev/midi_if.h>
64 
65 #include <dev/isa/isavar.h>
66 #include <dev/isa/isadmavar.h>
67 
68 #include <dev/isa/sbdspvar.h>
69 #include <dev/isa/sbreg.h>
70 
71 #define DEFINE_TRANSLATIONS
72 #include <dev/isa/pasreg.h>
73 
74 #ifdef AUDIO_DEBUG
75 #define DPRINTF(x)	if (pasdebug) printf x
76 int	pasdebug = 0;
77 #else
78 #define DPRINTF(x)
79 #endif
80 
81 /*
82  * Software state, per SoundBlaster card.
83  * The soundblaster has multiple functionality, which we must demultiplex.
84  * One approach is to have one major device number for the soundblaster card,
85  * and use different minor numbers to indicate which hardware function
86  * we want.  This would make for one large driver.  Instead our approach
87  * is to partition the design into a set of drivers that share an underlying
88  * piece of hardware.  Most things are hard to share, for example, the audio
89  * and midi ports.  For audio, we might want to mix two processes' signals,
90  * and for midi we might want to merge streams (this is hard due to
91  * running status).  Moreover, we should be able to re-use the high-level
92  * modules with other kinds of hardware.  In this module, we only handle the
93  * most basic communications with the sb card.
94  */
95 struct pas_softc {
96 	struct sbdsp_softc sc_sbdsp;	/* use sc_dev, sc_id, sc_ih,
97 					 *     sc_iobase, sc_irq, sc_drq
98 					 * from here */
99 	int model;	/* unique to PAS */
100 	int rev;
101 
102 };
103 
104 void	pasconf(int, int, int, int);
105 
106 
107 /*
108  * Define our interface to the higher level audio driver.
109  */
110 
111 struct audio_hw_if pas_hw_if = {
112 	sbdsp_open,
113 	sbdsp_close,
114 	sbdsp_set_params,
115 	sbdsp_round_blocksize,
116 	0,
117 	0,
118 	0,
119 	0,
120 	0,
121 	sbdsp_haltdma,
122 	sbdsp_haltdma,
123 	sbdsp_speaker_ctl,
124 	0,
125 	sbdsp_mixer_set_port,
126 	sbdsp_mixer_get_port,
127 	sbdsp_mixer_query_devinfo,
128 	sb_malloc,
129 	sb_free,
130 	sb_round,
131 	sbdsp_get_props,
132 	sbdsp_trigger_output,
133 	sbdsp_trigger_input
134 };
135 
136 /* The Address Translation code is used to convert I/O register addresses to
137    be relative to the given base -register */
138 
139 static char *pasnames[] = {
140 	"",
141 	"Plus",
142 	"CDPC",
143 	"16",
144 	"16Basic"
145 };
146 
147 /*XXX assume default I/O base address */
148 #define pasread(p) inb(p)
149 #define paswrite(d, p) outb(p, d)
150 
151 void
152 pasconf(int model, int sbbase, int sbirq, int sbdrq)
153 {
154 	paswrite(0x00, INTERRUPT_MASK);
155 	/* Local timer control register */
156 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
157 	/* Sample rate timer (16 bit) */
158 	paswrite(0x36, SAMPLE_RATE_TIMER);
159 	paswrite(0, SAMPLE_RATE_TIMER);
160 	/* Local timer control register */
161 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
162 	/* Sample count register (16 bit) */
163 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
164 	paswrite(0, SAMPLE_BUFFER_COUNTER);
165 
166 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
167 		  P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
168 		  PCM_CONTROL);
169 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
170 		  S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
171 
172 /*XXX*/
173 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
174 
175 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
176 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
177 
178 #ifdef BROKEN_BUS_CLOCK
179 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
180 		  S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
181 #else
182 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
183 		  SYSTEM_CONFIGURATION_1);
184 #endif
185 
186 	/*XXX*/
187 	paswrite(0, SYSTEM_CONFIGURATION_2);
188 	paswrite(0, SYSTEM_CONFIGURATION_3);
189 
190 	/* Sets mute off and selects filter rate of 17.897 kHz */
191 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
192 
193 	if (model == PAS_16 || model == PAS_16BASIC)
194 		paswrite(8, PRESCALE_DIVIDER);
195 	else
196 		paswrite(0, PRESCALE_DIVIDER);
197 
198 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
199 	paswrite(5, PARALLEL_MIXER);
200 
201 	/*
202 	 * Setup SoundBlaster emulation.
203 	 */
204 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
205 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
206 		 EMULATION_CONFIGURATION);
207 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
208 
209 	/*
210 	 * Set mid-range levels.
211 	 */
212 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
213 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
214 
215 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
216 	paswrite(50, PARALLEL_MIXER);
217 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
218 	paswrite(50, PARALLEL_MIXER);
219 
220 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB, PARALLEL_MIXER);
221 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
222 
223 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC, PARALLEL_MIXER);
224 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
225 }
226 
227 int	pasprobe(struct device *, void *, void *);
228 void	pasattach(struct device *, struct device *, void *);
229 
230 struct cfattach pas_ca = {
231 	sizeof(struct pas_softc), pasprobe, pasattach
232 };
233 
234 struct cfdriver pas_cd = {
235 	NULL, "pas", DV_DULL
236 };
237 
238 /*
239  * Probe / attach routines.
240  */
241 
242 /*
243  * Probe for the soundblaster hardware.
244  */
245 int
246 pasprobe(struct device *parent, void *match, void *aux)
247 {
248 	struct pas_softc *sc = match;
249 	struct isa_attach_args *ia = aux;
250 	int iobase;
251 	u_char id, t;
252 
253         /* ensure we can set this up as a sound blaster */
254        	if (!SB_BASE_VALID(ia->ia_iobase)) {
255 		DPRINTF(("pas: configured SB iobase 0x%x invalid\n", ia->ia_iobase));
256 		return 0;
257 	}
258 
259 	/*
260 	 * WARNING: Setting an option like W:1 or so that disables
261 	 * warm boot reset of the card will screw up this detect code
262 	 * something fierce.  Adding code to handle this means possibly
263 	 * interfering with other cards on the bus if you have something
264 	 * on base port 0x388.  SO be forewarned.
265 	 */
266 	/* Talk to first board */
267 	outb(MASTER_DECODE, 0xbc);
268 	/* Set base address */
269 
270 #if 0
271 	/* XXX Need to setup pseudo device */
272 	/* XXX What are good io addrs ? */
273 	if (iobase != PAS_DEFAULT_BASE) {
274 		DPRINTF(("pas: configured iobase %d invalid\n", iobase));
275 		return 0;
276 	}
277 #else
278 	/* Start out talking to native PAS */
279 	iobase = PAS_DEFAULT_BASE;
280 #endif
281 
282 	outb(MASTER_DECODE, iobase >> 2);
283 	/* One wait-state */
284 	paswrite(1, WAIT_STATE);
285 
286 	id = pasread(INTERRUPT_MASK);
287 	if (id == 0xff || id == 0xfe) {
288 		/* sanity */
289 		DPRINTF(("pas: bogus card id\n"));
290 		return 0;
291 	}
292 	/*
293 	 * We probably have a PAS-series board, now check for a
294 	 * PAS2-series board by trying to change the board revision
295 	 * bits.  PAS2-series hardware won't let you do this because
296 	 * the bits are read-only.
297 	 */
298 	t = id ^ 0xe0;
299 	paswrite(t, INTERRUPT_MASK);
300 	t = inb(INTERRUPT_MASK);
301 	paswrite(id, INTERRUPT_MASK);
302 
303 	if (t != id) {
304 		/* Not a PAS2 */
305 		DPRINTF(("pas: detected card but PAS2 test failed\n"));
306 		return 0;
307 	}
308 	/*XXX*/
309 	t = pasread(OPERATION_MODE_1) & 0xf;
310 	sc->model = O_M_1_to_card[t];
311 	if (sc->model != 0) {
312 		sc->rev = pasread(BOARD_REV_ID);
313 	}
314 	else {
315 		DPRINTF(("pas: bogus model id\n"));
316 		return 0;
317 	}
318 
319         if (sc->model >= 0) {
320                 if (ia->ia_irq == IRQUNK) {
321                         DPRINTF(("pas: sb emulation requires known irq\n"));
322                         return (0);
323                 }
324                 pasconf(sc->model, ia->ia_iobase, ia->ia_irq, 1);
325         } else {
326                 DPRINTF(("pas: could not probe pas\n"));
327                 return (0);
328         }
329 
330 	/* Now a SoundBlaster, so set up proper bus-space hooks
331          * appropriately
332          */
333 
334 	sc->sc_sbdsp.sc_iobase = ia->ia_iobase;
335 	sc->sc_sbdsp.sc_iot = ia->ia_iot;
336 
337 	/* Map i/o space [we map 24 ports which is the max of the sb and pro */
338 	if (bus_space_map(sc->sc_sbdsp.sc_iot, ia->ia_iobase, SBP_NPORT, 0,
339 	    &sc->sc_sbdsp.sc_ioh)) {
340 		DPRINTF(("pas: can't map i/o space 0x%x/%d in probe\n",
341 		    ia->ia_iobase, SBP_NPORT));
342 		return 0;
343 	}
344 
345 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
346 		DPRINTF(("pas: couldn't reset card\n"));
347 		goto unmap;
348 	}
349 
350 	/*
351 	 * Cannot auto-discover DMA channel.
352 	 */
353 	if (!SB_DRQ_VALID(ia->ia_drq)) {
354 		DPRINTF(("pas: configured dma chan %d invalid\n", ia->ia_drq));
355 		goto unmap;
356 	}
357 	if (!SB_IRQ_VALID(ia->ia_irq)) {
358 		DPRINTF(("pas: configured irq chan %d invalid\n", ia->ia_irq));
359 		goto unmap;
360 	}
361 
362 	sc->sc_sbdsp.sc_irq = ia->ia_irq;
363 	sc->sc_sbdsp.sc_drq8 = ia->ia_drq;
364 	sc->sc_sbdsp.sc_drq16 = -1; /* XXX */
365 	sc->sc_sbdsp.sc_ic = ia->ia_ic;
366 
367 	if (sbdsp_probe(&sc->sc_sbdsp) == 0) {
368 		DPRINTF(("pas: sbdsp probe failed\n"));
369 		goto unmap;
370 	}
371 
372 	ia->ia_iosize = SB_NPORT;
373 	return 1;
374 
375  unmap:
376 	bus_space_unmap(sc->sc_sbdsp.sc_iot, sc->sc_sbdsp.sc_ioh, SBP_NPORT);
377 	return 0;
378 }
379 
380 /*
381  * Attach hardware to driver, attach hardware driver to audio
382  * pseudo-device driver .
383  */
384 void
385 pasattach(struct device *parent, struct device *self, void *aux)
386 {
387 	struct pas_softc *sc = (struct pas_softc *)self;
388 	struct isa_attach_args *ia = (struct isa_attach_args *)aux;
389 	int iobase = ia->ia_iobase;
390 
391 	sc->sc_sbdsp.sc_isa = parent;
392 	sc->sc_sbdsp.sc_iobase = iobase;
393 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq,
394 	    IST_EDGE, IPL_AUDIO | IPL_MPSAFE,
395 	    sbdsp_intr, &sc->sc_sbdsp, sc->sc_sbdsp.sc_dev.dv_xname);
396 
397 	printf(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model], sc->rev);
398 
399 	sbdsp_attach(&sc->sc_sbdsp);
400 
401 	audio_attach_mi(&pas_hw_if, &sc->sc_sbdsp, &sc->sc_sbdsp.sc_dev);
402 }
403