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