xref: /netbsd-src/sys/dev/isa/wss_isa.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: wss_isa.c,v 1.10 2001/07/18 20:39:53 thorpej Exp $	*/
2 
3 /*
4  * Copyright (c) 1994 John Brezak
5  * Copyright (c) 1991-1993 Regents of the University of California.
6  * All rights reserved.
7  *
8  * MAD support:
9  * Copyright (c) 1996 Lennart Augustsson
10  * Based on code which is
11  * Copyright (c) 1994 Hannu Savolainen
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. All advertising materials mentioning features or use of this software
22  *    must display the following acknowledgement:
23  *	This product includes software developed by the Computer Systems
24  *	Engineering Group at Lawrence Berkeley Laboratory.
25  * 4. Neither the name of the University nor of the Laboratory may be used
26  *    to endorse or promote products derived from this software without
27  *    specific prior written permission.
28  *
29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39  * SUCH DAMAGE.
40  *
41  */
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/device.h>
45 #include <sys/errno.h>
46 
47 #include <machine/cpu.h>
48 #include <machine/intr.h>
49 #include <machine/bus.h>
50 
51 #include <sys/audioio.h>
52 #include <dev/audio_if.h>
53 
54 #include <dev/isa/isavar.h>
55 #include <dev/isa/isadmavar.h>
56 
57 #include <dev/ic/ad1848reg.h>
58 #include <dev/isa/ad1848var.h>
59 #include <dev/isa/wssreg.h>
60 #include <dev/isa/wssvar.h>
61 #include <dev/isa/madreg.h>
62 
63 #ifdef AUDIO_DEBUG
64 #define DPRINTF(x)	if (wssdebug) printf x
65 extern int	wssdebug;
66 #else
67 #define DPRINTF(x)
68 #endif
69 
70 static int	wssfind __P((struct device *, struct wss_softc *, struct isa_attach_args *));
71 
72 static void	madprobe __P((struct wss_softc *, int));
73 static void	madunmap __P((struct wss_softc *));
74 static int	detect_mad16 __P((struct wss_softc *, int));
75 
76 int		wss_isa_probe __P((struct device *, struct cfdata *, void *));
77 void		wss_isa_attach __P((struct device *, struct device *, void *));
78 
79 struct cfattach wss_isa_ca = {
80 	sizeof(struct wss_softc), wss_isa_probe, wss_isa_attach
81 };
82 
83 /*
84  * Probe for the Microsoft Sound System hardware.
85  */
86 int
87 wss_isa_probe(parent, match, aux)
88     struct device *parent;
89     struct cfdata *match;
90     void *aux;
91 {
92     struct wss_softc probesc, *sc = &probesc;
93     struct ad1848_softc *ac = (struct ad1848_softc *)&sc->sc_ad1848;
94 
95     memset(sc, 0, sizeof *sc);
96     ac->sc_dev.dv_cfdata = match;
97     if (wssfind(parent, sc, aux)) {
98         bus_space_unmap(sc->sc_iot, sc->sc_ioh, WSS_CODEC);
99         ad1848_isa_unmap(&sc->sc_ad1848);
100         madunmap(sc);
101         return 1;
102     } else
103         /* Everything is already unmapped */
104         return 0;
105 }
106 
107 static int
108 wssfind(parent, sc, ia)
109     struct device *parent;
110     struct wss_softc *sc;
111     struct isa_attach_args *ia;
112 {
113     struct ad1848_softc *ac = &sc->sc_ad1848.sc_ad1848;
114     static u_char interrupt_bits[12] = {
115 	-1, -1, -1, -1, -1, -1, -1, 0x08, -1, 0x10, 0x18, 0x20
116     };
117     static u_char dma_bits[4] = {1, 2, 0, 3};
118 
119     sc->sc_iot = ia->ia_iot;
120     if (ac->sc_dev.dv_cfdata->cf_flags & 1)
121 	madprobe(sc, ia->ia_iobase);
122     else
123 	sc->mad_chip_type = MAD_NONE;
124 
125 #if 0
126     if (!WSS_BASE_VALID(ia->ia_iobase)) {
127 	DPRINTF(("wss: configured iobase %x invalid\n", ia->ia_iobase));
128 	goto bad1;
129     }
130 #endif
131 
132     /* Map the ports upto the AD1848 port */
133     if (bus_space_map(sc->sc_iot, ia->ia_iobase, WSS_CODEC, 0, &sc->sc_ioh))
134 	goto bad1;
135 
136     ac->sc_iot = sc->sc_iot;
137 
138     /* Is there an ad1848 chip at (WSS iobase + WSS_CODEC)? */
139     if (ad1848_isa_mapprobe(&sc->sc_ad1848, ia->ia_iobase + WSS_CODEC) == 0)
140 	goto bad;
141 
142     ia->ia_iosize = WSS_NPORT;
143 
144 #if 0
145     /* Setup WSS interrupt and DMA */
146     if (!WSS_DRQ_VALID(ia->ia_drq)) {
147 	DPRINTF(("wss: configured dma chan %d invalid\n", ia->ia_drq));
148 	goto bad;
149     }
150 #endif
151     sc->wss_playdrq = ia->ia_drq;
152     sc->wss_ic      = ia->ia_ic;
153 
154     if (sc->wss_playdrq != DRQUNK && !isa_drq_isfree(sc->wss_ic, sc->wss_playdrq))
155 	    goto bad;
156 
157 #if 0
158     if (!WSS_IRQ_VALID(ia->ia_irq)) {
159 	DPRINTF(("wss: configured interrupt %d invalid\n", ia->ia_irq));
160 	goto bad;
161     }
162 #endif
163 
164     sc->wss_irq = ia->ia_irq;
165 
166     if (ac->mode <= 1)
167 	ia->ia_drq2 = DRQUNK;
168     sc->wss_recdrq =
169 	ac->mode > 1 && ia->ia_drq2 != DRQUNK ?
170 	ia->ia_drq2 : ia->ia_drq;
171     if (sc->wss_recdrq != sc->wss_playdrq && !isa_drq_isfree(sc->wss_ic,
172       sc->wss_recdrq))
173 	goto bad;
174 
175     /* XXX recdrq */
176     bus_space_write_1(sc->sc_iot, sc->sc_ioh, WSS_CONFIG,
177 		      (interrupt_bits[ia->ia_irq] | dma_bits[ia->ia_drq]));
178 
179     return 1;
180 
181 bad:
182     bus_space_unmap(sc->sc_iot, sc->sc_ioh, WSS_CODEC);
183 bad1:
184     madunmap(sc);
185     return 0;
186 }
187 
188 /*
189  * Attach hardware to driver, attach hardware driver to audio
190  * pseudo-device driver .
191  */
192 void
193 wss_isa_attach(parent, self, aux)
194     struct device *parent, *self;
195     void *aux;
196 {
197     struct wss_softc *sc = (struct wss_softc *)self;
198     struct ad1848_softc *ac = (struct ad1848_softc *)&sc->sc_ad1848;
199     struct isa_attach_args *ia = (struct isa_attach_args *)aux;
200 
201     if (!wssfind(parent, sc, ia)) {
202         printf("%s: wssfind failed\n", ac->sc_dev.dv_xname);
203         return;
204     }
205 
206     sc->wss_ic = ia->ia_ic;
207 
208     wssattach(sc);
209 }
210 
211 /*
212  * Copyright by Hannu Savolainen 1994
213  *
214  * Redistribution and use in source and binary forms, with or without
215  * modification, are permitted provided that the following conditions are
216  * met: 1. Redistributions of source code must retain the above copyright
217  * notice, this list of conditions and the following disclaimer. 2.
218  * Redistributions in binary form must reproduce the above copyright notice,
219  * this list of conditions and the following disclaimer in the documentation
220  * and/or other materials provided with the distribution.
221  *
222  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
223  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
224  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
225  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
226  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
227  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
228  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
229  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
230  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
231  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
232  * SUCH DAMAGE.
233  *
234  */
235 
236 /*
237  * Initialization code for OPTi MAD16 compatible audio chips. Including
238  *
239  *      OPTi 82C928     MAD16           (replaced by C929)
240  *      OAK OTI-601D    Mozart
241  *      OPTi 82C929     MAD16 Pro
242  *	OPTi 82C931
243  */
244 
245 static int
246 detect_mad16(sc, chip_type)
247     struct wss_softc *sc;
248     int chip_type;
249 {
250     unsigned char tmp, tmp2;
251 
252     sc->mad_chip_type = chip_type;
253     /*
254      * Check that reading a register doesn't return bus float (0xff)
255      * when the card is accessed using password. This may fail in case
256      * the card is in low power mode. Normally at least the power saving mode
257      * bit should be 0.
258      */
259     if ((tmp = mad_read(sc, MC1_PORT)) == 0xff) {
260 	DPRINTF(("MC1_PORT returned 0xff\n"));
261 	return 0;
262     }
263 
264     /*
265      * Now check that the gate is closed on first I/O after writing
266      * the password. (This is how a MAD16 compatible card works).
267      */
268     if ((tmp2 = bus_space_read_1(sc->sc_iot, sc->mad_ioh, MC1_PORT)) == tmp)	{
269 	DPRINTF(("MC1_PORT didn't close after read (0x%02x)\n", tmp2));
270 	return 0;
271     }
272 
273     mad_write(sc, MC1_PORT, tmp ^ 0x80);	/* Toggle a bit */
274 
275     /* Compare the bit */
276     if ((tmp2 = mad_read(sc, MC1_PORT)) != (tmp ^ 0x80)) {
277 	mad_write(sc, MC1_PORT, tmp);	/* Restore */
278 	DPRINTF(("Bit revert test failed (0x%02x, 0x%02x)\n", tmp, tmp2));
279 	return 0;
280     }
281 
282     mad_write(sc, MC1_PORT, tmp);	/* Restore */
283     return 1;
284 }
285 
286 static void
287 madprobe(sc, iobase)
288     struct wss_softc *sc;
289     int iobase;
290 {
291     static int valid_ports[M_WSS_NPORTS] =
292         { M_WSS_PORT0, M_WSS_PORT1, M_WSS_PORT2, M_WSS_PORT3 };
293     int i;
294 
295     /* Allocate bus space that the MAD chip wants */
296     if (bus_space_map(sc->sc_iot, MAD_BASE, MAD_NPORT, 0, &sc->mad_ioh))
297 	goto bad0;
298     if (bus_space_map(sc->sc_iot, MAD_REG1, MAD_LEN1, 0, &sc->mad_ioh1))
299         goto bad1;
300     if (bus_space_map(sc->sc_iot, MAD_REG2, MAD_LEN2, 0, &sc->mad_ioh2))
301         goto bad2;
302     if (bus_space_map(sc->sc_iot, MAD_REG3, MAD_LEN3, 0, &sc->sc_opl_ioh))
303         goto bad3;
304 
305     DPRINTF(("mad: Detect using password = 0xE2\n"));
306     if (!detect_mad16(sc, MAD_82C928)) {
307 	/* No luck. Try different model */
308 	DPRINTF(("mad: Detect using password = 0xE3\n"));
309 	if (!detect_mad16(sc, MAD_82C929))
310 	    goto bad;
311 	sc->mad_chip_type = MAD_82C929;
312 	DPRINTF(("mad: 82C929 detected\n"));
313     } else {
314 	sc->mad_chip_type = MAD_82C928;
315 	if ((mad_read(sc, MC3_PORT) & 0x03) == 0x03) {
316 	    DPRINTF(("mad: Mozart detected\n"));
317 	    sc->mad_chip_type = MAD_OTI601D;
318 	} else {
319 	    DPRINTF(("mad: 82C928 detected?\n"));
320 	    sc->mad_chip_type = MAD_82C928;
321 	}
322     }
323 
324 #ifdef AUDIO_DEBUG
325     if (wssdebug)
326 	for (i = MC1_PORT; i <= MC7_PORT; i++)
327 	    printf("mad: port %03x = %02x\n", i, mad_read(sc, i));
328 #endif
329 
330     /* Set the WSS address. */
331     for (i = 0; i < M_WSS_NPORTS; i++)
332 	if (valid_ports[i] == iobase)
333 	    break;
334     if (i >= M_WSS_NPORTS) {		/* Not a valid port */
335 	printf("mad: Bad WSS base address 0x%x\n", iobase);
336 	goto bad;
337     }
338     sc->mad_ioindex = i;
339     /* enable WSS emulation at the I/O port, no joystick */
340     mad_write(sc, MC1_PORT, M_WSS_PORT_SELECT(i) | MC1_JOYDISABLE);
341     mad_write(sc, MC2_PORT, 0x03); /* ? */
342     mad_write(sc, MC3_PORT, 0xf0); /* Disable SB */
343     return;
344 
345 bad:
346     bus_space_unmap(sc->sc_iot, sc->sc_opl_ioh, MAD_LEN3);
347 bad3:
348     bus_space_unmap(sc->sc_iot, sc->mad_ioh2, MAD_LEN2);
349 bad2:
350     bus_space_unmap(sc->sc_iot, sc->mad_ioh1, MAD_LEN1);
351 bad1:
352     bus_space_unmap(sc->sc_iot, sc->mad_ioh, MAD_NPORT);
353 bad0:
354     sc->mad_chip_type = MAD_NONE;
355 }
356 
357 static void
358 madunmap(sc)
359     struct wss_softc *sc;
360 {
361     if (sc->mad_chip_type == MAD_NONE)
362         return;
363     bus_space_unmap(sc->sc_iot, sc->mad_ioh, MAD_NPORT);
364     bus_space_unmap(sc->sc_iot, sc->mad_ioh1, MAD_LEN1);
365     bus_space_unmap(sc->sc_iot, sc->mad_ioh2, MAD_LEN2);
366     bus_space_unmap(sc->sc_iot, sc->sc_opl_ioh, MAD_LEN3);
367 }
368