xref: /openbsd-src/sys/dev/isa/pas.c (revision c8819f5db69635e0013fbb92bd980ff98e8cde15)
1 /*	$OpenBSD: pas.c,v 1.37 2022/11/02 10:41:34 kn 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 const struct audio_hw_if pas_hw_if = {
112 	.open = sbdsp_open,
113 	.close = sbdsp_close,
114 	.set_params = sbdsp_set_params,
115 	.round_blocksize = sbdsp_round_blocksize,
116 	.halt_output = sbdsp_haltdma,
117 	.halt_input = sbdsp_haltdma,
118 	.set_port = sbdsp_mixer_set_port,
119 	.get_port = sbdsp_mixer_get_port,
120 	.query_devinfo = sbdsp_mixer_query_devinfo,
121 	.allocm = sb_malloc,
122 	.freem = sb_free,
123 	.round_buffersize = sb_round,
124 	.trigger_output = sbdsp_trigger_output,
125 	.trigger_input = sbdsp_trigger_input,
126 };
127 
128 /* The Address Translation code is used to convert I/O register addresses to
129    be relative to the given base -register */
130 
131 static const char *pasnames[] = {
132 	"",
133 	"Plus",
134 	"CDPC",
135 	"16",
136 	"16Basic"
137 };
138 
139 /*XXX assume default I/O base address */
140 #define pasread(p) inb(p)
141 #define paswrite(d, p) outb(p, d)
142 
143 void
pasconf(int model,int sbbase,int sbirq,int sbdrq)144 pasconf(int model, int sbbase, int sbirq, int sbdrq)
145 {
146 	paswrite(0x00, INTERRUPT_MASK);
147 	/* Local timer control register */
148 	paswrite(0x36, SAMPLE_COUNTER_CONTROL);
149 	/* Sample rate timer (16 bit) */
150 	paswrite(0x36, SAMPLE_RATE_TIMER);
151 	paswrite(0, SAMPLE_RATE_TIMER);
152 	/* Local timer control register */
153 	paswrite(0x74, SAMPLE_COUNTER_CONTROL);
154 	/* Sample count register (16 bit) */
155 	paswrite(0x74, SAMPLE_BUFFER_COUNTER);
156 	paswrite(0, SAMPLE_BUFFER_COUNTER);
157 
158 	paswrite(P_C_PCM_MONO | P_C_PCM_DAC_MODE |
159 		  P_C_MIXER_CROSS_L_TO_L | P_C_MIXER_CROSS_R_TO_R,
160 		  PCM_CONTROL);
161 	paswrite(S_M_PCM_RESET | S_M_FM_RESET |
162 		  S_M_SB_RESET | S_M_MIXER_RESET, SERIAL_MIXER);
163 
164 /*XXX*/
165 	paswrite(I_C_1_BOOT_RESET_ENABLE|1, IO_CONFIGURATION_1);
166 
167 	paswrite(I_C_2_PCM_DMA_DISABLED, IO_CONFIGURATION_2);
168 	paswrite(I_C_3_PCM_IRQ_DISABLED, IO_CONFIGURATION_3);
169 
170 #ifdef BROKEN_BUS_CLOCK
171 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND |
172 		  S_C_1_FM_EMULATE_CLOCK, SYSTEM_CONFIGURATION_1);
173 #else
174 	paswrite(S_C_1_PCS_ENABLE | S_C_1_PCS_STEREO | S_C_1_PCS_REALSOUND,
175 		  SYSTEM_CONFIGURATION_1);
176 #endif
177 
178 	/*XXX*/
179 	paswrite(0, SYSTEM_CONFIGURATION_2);
180 	paswrite(0, SYSTEM_CONFIGURATION_3);
181 
182 	/* Sets mute off and selects filter rate of 17.897 kHz */
183 	paswrite(F_F_MIXER_UNMUTE | 0x01, FILTER_FREQUENCY);
184 
185 	if (model == PAS_16 || model == PAS_16BASIC)
186 		paswrite(8, PRESCALE_DIVIDER);
187 	else
188 		paswrite(0, PRESCALE_DIVIDER);
189 
190 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_PCM, PARALLEL_MIXER);
191 	paswrite(5, PARALLEL_MIXER);
192 
193 	/*
194 	 * Setup SoundBlaster emulation.
195 	 */
196 	paswrite((sbbase >> 4) & 0xf, EMULATION_ADDRESS);
197 	paswrite(E_C_SB_IRQ_translate[sbirq] | E_C_SB_DMA_translate[sbdrq],
198 		 EMULATION_CONFIGURATION);
199 	paswrite(C_E_SB_ENABLE, COMPATIBILITY_ENABLE);
200 
201 	/*
202 	 * Set mid-range levels.
203 	 */
204 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MODE, PARALLEL_MIXER);
205 	paswrite(P_M_MV508_LOUDNESS | P_M_MV508_ENHANCE_NONE, PARALLEL_MIXER);
206 
207 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_A, PARALLEL_MIXER);
208 	paswrite(50, PARALLEL_MIXER);
209 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MASTER_B, PARALLEL_MIXER);
210 	paswrite(50, PARALLEL_MIXER);
211 
212 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_SB, PARALLEL_MIXER);
213 	paswrite(P_M_MV508_OUTPUTMIX | 30, PARALLEL_MIXER);
214 
215 	paswrite(P_M_MV508_ADDRESS | P_M_MV508_MIXER | P_M_MV508_MIC, PARALLEL_MIXER);
216 	paswrite(P_M_MV508_INPUTMIX | 30, PARALLEL_MIXER);
217 }
218 
219 int	pasprobe(struct device *, void *, void *);
220 void	pasattach(struct device *, struct device *, void *);
221 
222 const struct cfattach pas_ca = {
223 	sizeof(struct pas_softc), pasprobe, pasattach
224 };
225 
226 struct cfdriver pas_cd = {
227 	NULL, "pas", DV_DULL
228 };
229 
230 /*
231  * Probe / attach routines.
232  */
233 
234 /*
235  * Probe for the soundblaster hardware.
236  */
237 int
pasprobe(struct device * parent,void * match,void * aux)238 pasprobe(struct device *parent, void *match, void *aux)
239 {
240 	struct pas_softc *sc = match;
241 	struct isa_attach_args *ia = aux;
242 	int iobase;
243 	u_char id, t;
244 
245         /* ensure we can set this up as a sound blaster */
246        	if (!SB_BASE_VALID(ia->ia_iobase)) {
247 		DPRINTF(("pas: configured SB iobase 0x%x invalid\n", ia->ia_iobase));
248 		return 0;
249 	}
250 
251 	/*
252 	 * WARNING: Setting an option like W:1 or so that disables
253 	 * warm boot reset of the card will screw up this detect code
254 	 * something fierce.  Adding code to handle this means possibly
255 	 * interfering with other cards on the bus if you have something
256 	 * on base port 0x388.  SO be forewarned.
257 	 */
258 	/* Talk to first board */
259 	outb(MASTER_DECODE, 0xbc);
260 	/* Set base address */
261 
262 #if 0
263 	/* XXX Need to setup pseudo device */
264 	/* XXX What are good io addrs ? */
265 	if (iobase != PAS_DEFAULT_BASE) {
266 		DPRINTF(("pas: configured iobase %d invalid\n", iobase));
267 		return 0;
268 	}
269 #else
270 	/* Start out talking to native PAS */
271 	iobase = PAS_DEFAULT_BASE;
272 #endif
273 
274 	outb(MASTER_DECODE, iobase >> 2);
275 	/* One wait-state */
276 	paswrite(1, WAIT_STATE);
277 
278 	id = pasread(INTERRUPT_MASK);
279 	if (id == 0xff || id == 0xfe) {
280 		/* sanity */
281 		DPRINTF(("pas: bogus card id\n"));
282 		return 0;
283 	}
284 	/*
285 	 * We probably have a PAS-series board, now check for a
286 	 * PAS2-series board by trying to change the board revision
287 	 * bits.  PAS2-series hardware won't let you do this because
288 	 * the bits are read-only.
289 	 */
290 	t = id ^ 0xe0;
291 	paswrite(t, INTERRUPT_MASK);
292 	t = inb(INTERRUPT_MASK);
293 	paswrite(id, INTERRUPT_MASK);
294 
295 	if (t != id) {
296 		/* Not a PAS2 */
297 		DPRINTF(("pas: detected card but PAS2 test failed\n"));
298 		return 0;
299 	}
300 	/*XXX*/
301 	t = pasread(OPERATION_MODE_1) & 0xf;
302 	sc->model = O_M_1_to_card[t];
303 	if (sc->model != 0) {
304 		sc->rev = pasread(BOARD_REV_ID);
305 	}
306 	else {
307 		DPRINTF(("pas: bogus model id\n"));
308 		return 0;
309 	}
310 
311         if (sc->model >= 0) {
312                 if (ia->ia_irq == IRQUNK) {
313                         DPRINTF(("pas: sb emulation requires known irq\n"));
314                         return (0);
315                 }
316                 pasconf(sc->model, ia->ia_iobase, ia->ia_irq, 1);
317         } else {
318                 DPRINTF(("pas: could not probe pas\n"));
319                 return (0);
320         }
321 
322 	/* Now a SoundBlaster, so set up proper bus-space hooks
323          * appropriately
324          */
325 
326 	sc->sc_sbdsp.sc_iobase = ia->ia_iobase;
327 	sc->sc_sbdsp.sc_iot = ia->ia_iot;
328 
329 	/* Map i/o space [we map 24 ports which is the max of the sb and pro */
330 	if (bus_space_map(sc->sc_sbdsp.sc_iot, ia->ia_iobase, SBP_NPORT, 0,
331 	    &sc->sc_sbdsp.sc_ioh)) {
332 		DPRINTF(("pas: can't map i/o space 0x%x/%d in probe\n",
333 		    ia->ia_iobase, SBP_NPORT));
334 		return 0;
335 	}
336 
337 	if (sbdsp_reset(&sc->sc_sbdsp) < 0) {
338 		DPRINTF(("pas: couldn't reset card\n"));
339 		goto unmap;
340 	}
341 
342 	/*
343 	 * Cannot auto-discover DMA channel.
344 	 */
345 	if (!SB_DRQ_VALID(ia->ia_drq)) {
346 		DPRINTF(("pas: configured dma chan %d invalid\n", ia->ia_drq));
347 		goto unmap;
348 	}
349 	if (!SB_IRQ_VALID(ia->ia_irq)) {
350 		DPRINTF(("pas: configured irq chan %d invalid\n", ia->ia_irq));
351 		goto unmap;
352 	}
353 
354 	sc->sc_sbdsp.sc_irq = ia->ia_irq;
355 	sc->sc_sbdsp.sc_drq8 = ia->ia_drq;
356 	sc->sc_sbdsp.sc_drq16 = -1; /* XXX */
357 	sc->sc_sbdsp.sc_ic = ia->ia_ic;
358 
359 	if (sbdsp_probe(&sc->sc_sbdsp) == 0) {
360 		DPRINTF(("pas: sbdsp probe failed\n"));
361 		goto unmap;
362 	}
363 
364 	ia->ia_iosize = SB_NPORT;
365 	return 1;
366 
367  unmap:
368 	bus_space_unmap(sc->sc_sbdsp.sc_iot, sc->sc_sbdsp.sc_ioh, SBP_NPORT);
369 	return 0;
370 }
371 
372 /*
373  * Attach hardware to driver, attach hardware driver to audio
374  * pseudo-device driver .
375  */
376 void
pasattach(struct device * parent,struct device * self,void * aux)377 pasattach(struct device *parent, struct device *self, void *aux)
378 {
379 	struct pas_softc *sc = (struct pas_softc *)self;
380 	struct isa_attach_args *ia = (struct isa_attach_args *)aux;
381 	int iobase = ia->ia_iobase;
382 
383 	sc->sc_sbdsp.sc_isa = parent;
384 	sc->sc_sbdsp.sc_iobase = iobase;
385 	sc->sc_sbdsp.sc_ih = isa_intr_establish(ia->ia_ic, ia->ia_irq,
386 	    IST_EDGE, IPL_AUDIO | IPL_MPSAFE,
387 	    sbdsp_intr, &sc->sc_sbdsp, sc->sc_sbdsp.sc_dev.dv_xname);
388 
389 	printf(" ProAudio Spectrum %s [rev %d] ", pasnames[sc->model], sc->rev);
390 
391 	sbdsp_attach(&sc->sc_sbdsp);
392 
393 	audio_attach_mi(&pas_hw_if, &sc->sc_sbdsp, NULL, &sc->sc_sbdsp.sc_dev);
394 }
395