0c0376a46d3bc1056f74883cff2ef602dc5bf0ba
[dragonfly.git] / sys / dev / sound / isa / mss.c
1 /*-
2  * Copyright (c) 2001 George Reid <greid@ukug.uk.freebsd.org>
3  * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
4  * Copyright Luigi Rizzo, 1997,1998
5  * Copyright by Hannu Savolainen 1994, 1995
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  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: src/sys/dev/sound/isa/mss.c,v 1.95.2.3 2006/04/04 17:30:59 ariff Exp $
30  */
31
32 #include <sys/machintr.h>
33 #include <dev/sound/pcm/sound.h>
34
35 SND_DECLARE_FILE("$DragonFly: src/sys/dev/sound/isa/mss.c,v 1.11 2007/06/16 20:07:18 dillon Exp $");
36
37 /* board-specific include files */
38 #include <dev/sound/isa/mss.h>
39 #include <dev/sound/isa/sb.h>
40 #include <dev/sound/chip.h>
41
42 #include <bus/isa/isavar.h>
43
44 #include "mixer_if.h"
45
46 #define MSS_DEFAULT_BUFSZ (4096)
47 #define MSS_INDEXED_REGS 0x20
48 #define OPL_INDEXED_REGS 0x19
49
50 struct mss_info;
51
52 struct mss_chinfo {
53         struct mss_info *parent;
54         struct pcm_channel *channel;
55         struct snd_dbuf *buffer;
56         int dir;
57         u_int32_t fmt, blksz;
58 };
59
60 struct mss_info {
61     struct resource *io_base;   /* primary I/O address for the board */
62     int              io_rid;
63     struct resource *conf_base; /* and the opti931 also has a config space */
64     int              conf_rid;
65     struct resource *irq;
66     int              irq_rid;
67     struct resource *drq1; /* play */
68     int              drq1_rid;
69     struct resource *drq2; /* rec */
70     int              drq2_rid;
71     void            *ih;
72     bus_dma_tag_t    parent_dmat;
73     sndlock_t       lock;
74
75     char mss_indexed_regs[MSS_INDEXED_REGS];
76     char opl_indexed_regs[OPL_INDEXED_REGS];
77     int bd_id;      /* used to hold board-id info, eg. sb version,
78                      * mss codec type, etc. etc.
79                      */
80     int opti_offset;            /* offset from config_base for opti931 */
81     u_long  bd_flags;       /* board-specific flags */
82     int optibase;               /* base address for OPTi9xx config */
83     struct resource *indir;     /* Indirect register index address */
84     int indir_rid;
85     int password;               /* password for opti9xx cards */
86     int passwdreg;              /* password register */
87     unsigned int bufsize;
88     struct mss_chinfo pch, rch;
89 };
90
91 static int              mss_probe(device_t dev);
92 static int              mss_attach(device_t dev);
93
94 static driver_intr_t    mss_intr;
95
96 /* prototypes for local functions */
97 static int              mss_detect(device_t dev, struct mss_info *mss);
98 static int              opti_detect(device_t dev, struct mss_info *mss);
99 static char             *ymf_test(device_t dev, struct mss_info *mss);
100 static void             ad_unmute(struct mss_info *mss);
101
102 /* mixer set funcs */
103 static int              mss_mixer_set(struct mss_info *mss, int dev, int left, int right);
104 static int              mss_set_recsrc(struct mss_info *mss, int mask);
105
106 /* io funcs */
107 static int              ad_wait_init(struct mss_info *mss, int x);
108 static int              ad_read(struct mss_info *mss, int reg);
109 static void             ad_write(struct mss_info *mss, int reg, u_char data);
110 static void             ad_write_cnt(struct mss_info *mss, int reg, u_short data);
111 static void             ad_enter_MCE(struct mss_info *mss);
112 static void             ad_leave_MCE(struct mss_info *mss);
113
114 /* OPTi-specific functions */
115 static void             opti_write(struct mss_info *mss, u_char reg,
116                                    u_char data);
117 static u_char           opti_read(struct mss_info *mss, u_char reg);
118 static int              opti_init(device_t dev, struct mss_info *mss);
119
120 /* io primitives */
121 static void             conf_wr(struct mss_info *mss, u_char reg, u_char data);
122 static u_char           conf_rd(struct mss_info *mss, u_char reg);
123
124 static int              pnpmss_probe(device_t dev);
125 static int              pnpmss_attach(device_t dev);
126
127 static driver_intr_t    opti931_intr;
128
129 static u_int32_t mss_fmt[] = {
130         AFMT_U8,
131         AFMT_STEREO | AFMT_U8,
132         AFMT_S16_LE,
133         AFMT_STEREO | AFMT_S16_LE,
134         AFMT_MU_LAW,
135         AFMT_STEREO | AFMT_MU_LAW,
136         AFMT_A_LAW,
137         AFMT_STEREO | AFMT_A_LAW,
138         0
139 };
140 static struct pcmchan_caps mss_caps = {4000, 48000, mss_fmt, 0};
141
142 static u_int32_t guspnp_fmt[] = {
143         AFMT_U8,
144         AFMT_STEREO | AFMT_U8,
145         AFMT_S16_LE,
146         AFMT_STEREO | AFMT_S16_LE,
147         AFMT_A_LAW,
148         AFMT_STEREO | AFMT_A_LAW,
149         0
150 };
151 static struct pcmchan_caps guspnp_caps = {4000, 48000, guspnp_fmt, 0};
152
153 static u_int32_t opti931_fmt[] = {
154         AFMT_U8,
155         AFMT_STEREO | AFMT_U8,
156         AFMT_S16_LE,
157         AFMT_STEREO | AFMT_S16_LE,
158         0
159 };
160 static struct pcmchan_caps opti931_caps = {4000, 48000, opti931_fmt, 0};
161
162 #define MD_AD1848       0x91
163 #define MD_AD1845       0x92
164 #define MD_CS42XX       0xA1
165 #define MD_CS423X       0xA2
166 #define MD_OPTI930      0xB0
167 #define MD_OPTI931      0xB1
168 #define MD_OPTI925      0xB2
169 #define MD_OPTI924      0xB3
170 #define MD_GUSPNP       0xB8
171 #define MD_GUSMAX       0xB9
172 #define MD_YM0020       0xC1
173 #define MD_VIVO         0xD1
174
175 #define DV_F_TRUE_MSS   0x00010000      /* mss _with_ base regs */
176
177 #define FULL_DUPLEX(x) ((x)->bd_flags & BD_F_DUPLEX)
178
179 static void
180 mss_lock(struct mss_info *mss)
181 {
182         snd_mtxlock(mss->lock);
183 }
184
185 static void
186 mss_unlock(struct mss_info *mss)
187 {
188         snd_mtxunlock(mss->lock);
189 }
190
191 static int
192 port_rd(struct resource *port, int off)
193 {
194         if (port)
195                 return bus_space_read_1(rman_get_bustag(port),
196                                         rman_get_bushandle(port),
197                                         off);
198         else
199                 return -1;
200 }
201
202 static void
203 port_wr(struct resource *port, int off, u_int8_t data)
204 {
205         if (port)
206                 bus_space_write_1(rman_get_bustag(port),
207                                   rman_get_bushandle(port),
208                                   off, data);
209 }
210
211 static int
212 io_rd(struct mss_info *mss, int reg)
213 {
214         if (mss->bd_flags & BD_F_MSS_OFFSET) reg -= 4;
215         return port_rd(mss->io_base, reg);
216 }
217
218 static void
219 io_wr(struct mss_info *mss, int reg, u_int8_t data)
220 {
221         if (mss->bd_flags & BD_F_MSS_OFFSET) reg -= 4;
222         port_wr(mss->io_base, reg, data);
223 }
224
225 static void
226 conf_wr(struct mss_info *mss, u_char reg, u_char value)
227 {
228         port_wr(mss->conf_base, 0, reg);
229         port_wr(mss->conf_base, 1, value);
230 }
231
232 static u_char
233 conf_rd(struct mss_info *mss, u_char reg)
234 {
235         port_wr(mss->conf_base, 0, reg);
236         return port_rd(mss->conf_base, 1);
237 }
238
239 static void
240 opti_wr(struct mss_info *mss, u_char reg, u_char value)
241 {
242         port_wr(mss->conf_base, mss->opti_offset + 0, reg);
243         port_wr(mss->conf_base, mss->opti_offset + 1, value);
244 }
245
246 static u_char
247 opti_rd(struct mss_info *mss, u_char reg)
248 {
249         port_wr(mss->conf_base, mss->opti_offset + 0, reg);
250         return port_rd(mss->conf_base, mss->opti_offset + 1);
251 }
252
253 static void
254 gus_wr(struct mss_info *mss, u_char reg, u_char value)
255 {
256         port_wr(mss->conf_base, 3, reg);
257         port_wr(mss->conf_base, 5, value);
258 }
259
260 static u_char
261 gus_rd(struct mss_info *mss, u_char reg)
262 {
263         port_wr(mss->conf_base, 3, reg);
264         return port_rd(mss->conf_base, 5);
265 }
266
267 static void
268 mss_release_resources(struct mss_info *mss, device_t dev)
269 {
270         if (mss->irq) {
271                 if (mss->ih)
272                         bus_teardown_intr(dev, mss->irq, mss->ih);
273                 bus_release_resource(dev, SYS_RES_IRQ, mss->irq_rid,
274                                      mss->irq);
275                 mss->irq = NULL;
276         }
277         if (mss->drq2) {
278                 if (mss->drq2 != mss->drq1) {
279                         isa_dma_release(rman_get_start(mss->drq2));
280                         bus_release_resource(dev, SYS_RES_DRQ, mss->drq2_rid,
281                                         mss->drq2);
282                 }
283                 mss->drq2 = NULL;
284         }
285         if (mss->drq1) {
286                 isa_dma_release(rman_get_start(mss->drq1));
287                 bus_release_resource(dev, SYS_RES_DRQ, mss->drq1_rid,
288                                      mss->drq1);
289                 mss->drq1 = NULL;
290         }
291         if (mss->io_base) {
292                 bus_release_resource(dev, SYS_RES_IOPORT, mss->io_rid,
293                                      mss->io_base);
294                 mss->io_base = NULL;
295         }
296         if (mss->conf_base) {
297                 bus_release_resource(dev, SYS_RES_IOPORT, mss->conf_rid,
298                                      mss->conf_base);
299                 mss->conf_base = NULL;
300         }
301         if (mss->indir) {
302                 bus_release_resource(dev, SYS_RES_IOPORT, mss->indir_rid,
303                                      mss->indir);
304                 mss->indir = NULL;
305         }
306         if (mss->parent_dmat) {
307                 bus_dma_tag_destroy(mss->parent_dmat);
308                 mss->parent_dmat = 0;
309         }
310         if (mss->lock) snd_mtxfree(mss->lock);
311
312         kfree(mss, M_DEVBUF);
313 }
314
315 static int
316 mss_alloc_resources(struct mss_info *mss, device_t dev)
317 {
318         int pdma, rdma, ok = 1;
319         if (!mss->io_base)
320                 mss->io_base = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
321                                                       &mss->io_rid, RF_ACTIVE);
322         if (!mss->irq)
323                 mss->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
324                                                   &mss->irq_rid, RF_ACTIVE);
325         if (!mss->drq1)
326                 mss->drq1 = bus_alloc_resource_any(dev, SYS_RES_DRQ,
327                                                    &mss->drq1_rid,
328                                                    RF_ACTIVE);
329         if (mss->conf_rid >= 0 && !mss->conf_base)
330                 mss->conf_base = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
331                                                         &mss->conf_rid,
332                                                         RF_ACTIVE);
333         if (mss->drq2_rid >= 0 && !mss->drq2)
334                 mss->drq2 = bus_alloc_resource_any(dev, SYS_RES_DRQ,
335                                                    &mss->drq2_rid,
336                                                    RF_ACTIVE);
337
338         if (!mss->io_base || !mss->drq1 || !mss->irq) ok = 0;
339         if (mss->conf_rid >= 0 && !mss->conf_base) ok = 0;
340         if (mss->drq2_rid >= 0 && !mss->drq2) ok = 0;
341
342         if (ok) {
343                 pdma = rman_get_start(mss->drq1);
344                 isa_dma_acquire(pdma);
345                 isa_dmainit(pdma, mss->bufsize);
346                 mss->bd_flags &= ~BD_F_DUPLEX;
347                 if (mss->drq2) {
348                         rdma = rman_get_start(mss->drq2);
349                         isa_dma_acquire(rdma);
350                         isa_dmainit(rdma, mss->bufsize);
351                         mss->bd_flags |= BD_F_DUPLEX;
352                 } else mss->drq2 = mss->drq1;
353         }
354         return ok;
355 }
356
357 /*
358  * The various mixers use a variety of bitmasks etc. The Voxware
359  * driver had a very nice technique to describe a mixer and interface
360  * to it. A table defines, for each channel, which register, bits,
361  * offset, polarity to use. This procedure creates the new value
362  * using the table and the old value.
363  */
364
365 static void
366 change_bits(mixer_tab *t, u_char *regval, int dev, int chn, int newval)
367 {
368         u_char mask;
369         int shift;
370
371         DEB(kprintf("ch_bits dev %d ch %d val %d old 0x%02x "
372                 "r %d p %d bit %d off %d\n",
373                 dev, chn, newval, *regval,
374                 (*t)[dev][chn].regno, (*t)[dev][chn].polarity,
375                 (*t)[dev][chn].nbits, (*t)[dev][chn].bitoffs ) );
376
377         if ( (*t)[dev][chn].polarity == 1)      /* reverse */
378                 newval = 100 - newval ;
379
380         mask = (1 << (*t)[dev][chn].nbits) - 1;
381         newval = (int) ((newval * mask) + 50) / 100; /* Scale it */
382         shift = (*t)[dev][chn].bitoffs /*- (*t)[dev][LEFT_CHN].nbits + 1*/;
383
384         *regval &= ~(mask << shift);        /* Filter out the previous value */
385         *regval |= (newval & mask) << shift;        /* Set the new value */
386 }
387
388 /* -------------------------------------------------------------------- */
389 /* only one source can be set... */
390 static int
391 mss_set_recsrc(struct mss_info *mss, int mask)
392 {
393         u_char   recdev;
394
395         switch (mask) {
396         case SOUND_MASK_LINE:
397         case SOUND_MASK_LINE3:
398                 recdev = 0;
399                 break;
400
401         case SOUND_MASK_CD:
402         case SOUND_MASK_LINE1:
403                 recdev = 0x40;
404                 break;
405
406         case SOUND_MASK_IMIX:
407                 recdev = 0xc0;
408                 break;
409
410         case SOUND_MASK_MIC:
411         default:
412                 mask = SOUND_MASK_MIC;
413                 recdev = 0x80;
414         }
415         ad_write(mss, 0, (ad_read(mss, 0) & 0x3f) | recdev);
416         ad_write(mss, 1, (ad_read(mss, 1) & 0x3f) | recdev);
417         return mask;
418 }
419
420 /* there are differences in the mixer depending on the actual sound card. */
421 static int
422 mss_mixer_set(struct mss_info *mss, int dev, int left, int right)
423 {
424         int        regoffs;
425         mixer_tab *mix_d;
426         u_char     old, val;
427
428         switch (mss->bd_id) {
429                 case MD_OPTI931:
430                         mix_d = &opti931_devices;
431                         break;
432                 case MD_OPTI930:
433                         mix_d = &opti930_devices;
434                         break;
435                 default:
436                         mix_d = &mix_devices;
437         }
438
439         if ((*mix_d)[dev][LEFT_CHN].nbits == 0) {
440                 DEB(kprintf("nbits = 0 for dev %d\n", dev));
441                 return -1;
442         }
443
444         if ((*mix_d)[dev][RIGHT_CHN].nbits == 0) right = left; /* mono */
445
446         /* Set the left channel */
447
448         regoffs = (*mix_d)[dev][LEFT_CHN].regno;
449         old = val = ad_read(mss, regoffs);
450         /* if volume is 0, mute chan. Otherwise, unmute. */
451         if (regoffs != 0) val = (left == 0)? old | 0x80 : old & 0x7f;
452         change_bits(mix_d, &val, dev, LEFT_CHN, left);
453         ad_write(mss, regoffs, val);
454
455         DEB(kprintf("LEFT: dev %d reg %d old 0x%02x new 0x%02x\n",
456                 dev, regoffs, old, val));
457
458         if ((*mix_d)[dev][RIGHT_CHN].nbits != 0) { /* have stereo */
459                 /* Set the right channel */
460                 regoffs = (*mix_d)[dev][RIGHT_CHN].regno;
461                 old = val = ad_read(mss, regoffs);
462                 if (regoffs != 1) val = (right == 0)? old | 0x80 : old & 0x7f;
463                 change_bits(mix_d, &val, dev, RIGHT_CHN, right);
464                 ad_write(mss, regoffs, val);
465
466                 DEB(kprintf("RIGHT: dev %d reg %d old 0x%02x new 0x%02x\n",
467                 dev, regoffs, old, val));
468         }
469         return 0; /* success */
470 }
471
472 /* -------------------------------------------------------------------- */
473
474 static int
475 mssmix_init(struct snd_mixer *m)
476 {
477         struct mss_info *mss = mix_getdevinfo(m);
478
479         mix_setdevs(m, MODE2_MIXER_DEVICES);
480         mix_setrecdevs(m, MSS_REC_DEVICES);
481         switch(mss->bd_id) {
482         case MD_OPTI930:
483                 mix_setdevs(m, OPTI930_MIXER_DEVICES);
484                 break;
485
486         case MD_OPTI931:
487                 mix_setdevs(m, OPTI931_MIXER_DEVICES);
488                 mss_lock(mss);
489                 ad_write(mss, 20, 0x88);
490                 ad_write(mss, 21, 0x88);
491                 mss_unlock(mss);
492                 break;
493
494         case MD_AD1848:
495                 mix_setdevs(m, MODE1_MIXER_DEVICES);
496                 break;
497
498         case MD_GUSPNP:
499         case MD_GUSMAX:
500                 /* this is only necessary in mode 3 ... */
501                 mss_lock(mss);
502                 ad_write(mss, 22, 0x88);
503                 ad_write(mss, 23, 0x88);
504                 mss_unlock(mss);
505                 break;
506         }
507         return 0;
508 }
509
510 static int
511 mssmix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
512 {
513         struct mss_info *mss = mix_getdevinfo(m);
514
515         mss_lock(mss);
516         mss_mixer_set(mss, dev, left, right);
517         mss_unlock(mss);
518
519         return left | (right << 8);
520 }
521
522 static int
523 mssmix_setrecsrc(struct snd_mixer *m, u_int32_t src)
524 {
525         struct mss_info *mss = mix_getdevinfo(m);
526
527         mss_lock(mss);
528         src = mss_set_recsrc(mss, src);
529         mss_unlock(mss);
530         return src;
531 }
532
533 static kobj_method_t mssmix_mixer_methods[] = {
534         KOBJMETHOD(mixer_init,          mssmix_init),
535         KOBJMETHOD(mixer_set,           mssmix_set),
536         KOBJMETHOD(mixer_setrecsrc,     mssmix_setrecsrc),
537         KOBJMETHOD_END
538 };
539 MIXER_DECLARE(mssmix_mixer);
540
541 /* -------------------------------------------------------------------- */
542
543 static int
544 ymmix_init(struct snd_mixer *m)
545 {
546         struct mss_info *mss = mix_getdevinfo(m);
547
548         mssmix_init(m);
549         mix_setdevs(m, mix_getdevs(m) | SOUND_MASK_VOLUME | SOUND_MASK_MIC
550                                       | SOUND_MASK_BASS | SOUND_MASK_TREBLE);
551         /* Set master volume */
552         mss_lock(mss);
553         conf_wr(mss, OPL3SAx_VOLUMEL, 7);
554         conf_wr(mss, OPL3SAx_VOLUMER, 7);
555         mss_unlock(mss);
556
557         return 0;
558 }
559
560 static int
561 ymmix_set(struct snd_mixer *m, unsigned dev, unsigned left, unsigned right)
562 {
563         struct mss_info *mss = mix_getdevinfo(m);
564         int t, l, r;
565
566         mss_lock(mss);
567         switch (dev) {
568         case SOUND_MIXER_VOLUME:
569                 if (left) t = 15 - (left * 15) / 100;
570                 else t = 0x80; /* mute */
571                 conf_wr(mss, OPL3SAx_VOLUMEL, t);
572                 if (right) t = 15 - (right * 15) / 100;
573                 else t = 0x80; /* mute */
574                 conf_wr(mss, OPL3SAx_VOLUMER, t);
575                 break;
576
577         case SOUND_MIXER_MIC:
578                 t = left;
579                 if (left) t = 31 - (left * 31) / 100;
580                 else t = 0x80; /* mute */
581                 conf_wr(mss, OPL3SAx_MIC, t);
582                 break;
583
584         case SOUND_MIXER_BASS:
585                 l = (left * 7) / 100;
586                 r = (right * 7) / 100;
587                 t = (r << 4) | l;
588                 conf_wr(mss, OPL3SAx_BASS, t);
589                 break;
590
591         case SOUND_MIXER_TREBLE:
592                 l = (left * 7) / 100;
593                 r = (right * 7) / 100;
594                 t = (r << 4) | l;
595                 conf_wr(mss, OPL3SAx_TREBLE, t);
596                 break;
597
598         default:
599                 mss_mixer_set(mss, dev, left, right);
600         }
601         mss_unlock(mss);
602
603         return left | (right << 8);
604 }
605
606 static int
607 ymmix_setrecsrc(struct snd_mixer *m, u_int32_t src)
608 {
609         struct mss_info *mss = mix_getdevinfo(m);
610         mss_lock(mss);
611         src = mss_set_recsrc(mss, src);
612         mss_unlock(mss);
613         return src;
614 }
615
616 static kobj_method_t ymmix_mixer_methods[] = {
617         KOBJMETHOD(mixer_init,          ymmix_init),
618         KOBJMETHOD(mixer_set,           ymmix_set),
619         KOBJMETHOD(mixer_setrecsrc,     ymmix_setrecsrc),
620         KOBJMETHOD_END
621 };
622 MIXER_DECLARE(ymmix_mixer);
623
624 /* -------------------------------------------------------------------- */
625 /*
626  * XXX This might be better off in the gusc driver.
627  */
628 static void
629 gusmax_setup(struct mss_info *mss, device_t dev, struct resource *alt)
630 {
631         static const unsigned char irq_bits[16] = {
632                 0, 0, 0, 3, 0, 2, 0, 4, 0, 1, 0, 5, 6, 0, 0, 7
633         };
634         static const unsigned char dma_bits[8] = {
635                 0, 1, 0, 2, 0, 3, 4, 5
636         };
637         device_t parent = device_get_parent(dev);
638         unsigned char irqctl, dmactl;
639
640         crit_enter();
641
642         port_wr(alt, 0x0f, 0x05);
643         port_wr(alt, 0x00, 0x0c);
644         port_wr(alt, 0x0b, 0x00);
645
646         port_wr(alt, 0x0f, 0x00);
647
648         irqctl = irq_bits[isa_get_irq(parent)];
649         /* Share the IRQ with the MIDI driver.  */
650         irqctl |= 0x40;
651         dmactl = dma_bits[isa_get_drq(parent)];
652         if (device_get_flags(parent) & DV_F_DUAL_DMA)
653                 dmactl |= dma_bits[device_get_flags(parent) & DV_F_DRQ_MASK]
654                     << 3;
655
656         /*
657          * Set the DMA and IRQ control latches.
658          */
659         port_wr(alt, 0x00, 0x0c);
660         port_wr(alt, 0x0b, dmactl | 0x80);
661         port_wr(alt, 0x00, 0x4c);
662         port_wr(alt, 0x0b, irqctl);
663
664         port_wr(alt, 0x00, 0x0c);
665         port_wr(alt, 0x0b, dmactl);
666         port_wr(alt, 0x00, 0x4c);
667         port_wr(alt, 0x0b, irqctl);
668
669         port_wr(mss->conf_base, 2, 0);
670         port_wr(alt, 0x00, 0x0c);
671         port_wr(mss->conf_base, 2, 0);
672
673         crit_exit();
674 }
675
676 static int
677 mss_init(struct mss_info *mss, device_t dev)
678 {
679         u_char r6, r9;
680         struct resource *alt;
681         int rid, tmp;
682
683         mss->bd_flags |= BD_F_MCE_BIT;
684         switch(mss->bd_id) {
685         case MD_OPTI931:
686                 /*
687                  * The MED3931 v.1.0 allocates 3 bytes for the config
688                  * space, whereas v.2.0 allocates 4 bytes. What I know
689                  * for sure is that the upper two ports must be used,
690                  * and they should end on a boundary of 4 bytes. So I
691                  * need the following trick.
692                  */
693                 mss->opti_offset =
694                         (rman_get_start(mss->conf_base) & ~3) + 2
695                         - rman_get_start(mss->conf_base);
696                 BVDDB(kprintf("mss_init: opti_offset=%d\n", mss->opti_offset));
697                 opti_wr(mss, 4, 0xd6); /* fifo empty, OPL3, audio enable, SB3.2 */
698                 ad_write(mss, 10, 2); /* enable interrupts */
699                 opti_wr(mss, 6, 2);  /* MCIR6: mss enable, sb disable */
700                 opti_wr(mss, 5, 0x28);  /* MCIR5: codec in exp. mode,fifo */
701                 break;
702
703         case MD_GUSPNP:
704         case MD_GUSMAX:
705                 gus_wr(mss, 0x4c /* _URSTI */, 0);/* Pull reset */
706                 DELAY(1000 * 30);
707                 /* release reset  and enable DAC */
708                 gus_wr(mss, 0x4c /* _URSTI */, 3);
709                 DELAY(1000 * 30);
710                 /* end of reset */
711
712                 rid = 0;
713                 alt = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
714                                              RF_ACTIVE);
715                 if (alt == NULL) {
716                         kprintf("XXX couldn't init GUS PnP/MAX\n");
717                         break;
718                 }
719                 port_wr(alt, 0, 0xC); /* enable int and dma */
720                 if (mss->bd_id == MD_GUSMAX)
721                         gusmax_setup(mss, dev, alt);
722                 bus_release_resource(dev, SYS_RES_IOPORT, rid, alt);
723
724                 /*
725                  * unmute left & right line. Need to go in mode3, unmute,
726                  * and back to mode 2
727                  */
728                 tmp = ad_read(mss, 0x0c);
729                 ad_write(mss, 0x0c, 0x6c); /* special value to enter mode 3 */
730                 ad_write(mss, 0x19, 0); /* unmute left */
731                 ad_write(mss, 0x1b, 0); /* unmute right */
732                 ad_write(mss, 0x0c, tmp); /* restore old mode */
733
734                 /* send codec interrupts on irq1 and only use that one */
735                 gus_wr(mss, 0x5a, 0x4f);
736
737                 /* enable access to hidden regs */
738                 tmp = gus_rd(mss, 0x5b /* IVERI */);
739                 gus_wr(mss, 0x5b, tmp | 1);
740                 BVDDB(kprintf("GUS: silicon rev %c\n", 'A' + ((tmp & 0xf) >> 4)));
741                 break;
742
743         case MD_YM0020:
744                 conf_wr(mss, OPL3SAx_DMACONF, 0xa9); /* dma-b rec, dma-a play */
745                 r6 = conf_rd(mss, OPL3SAx_DMACONF);
746                 r9 = conf_rd(mss, OPL3SAx_MISC); /* version */
747                 BVDDB(kprintf("Yamaha: ver 0x%x DMA config 0x%x\n", r6, r9);)
748                 /* yamaha - set volume to max */
749                 conf_wr(mss, OPL3SAx_VOLUMEL, 0);
750                 conf_wr(mss, OPL3SAx_VOLUMER, 0);
751                 conf_wr(mss, OPL3SAx_DMACONF, FULL_DUPLEX(mss)? 0xa9 : 0x8b);
752                 break;
753         }
754         if (FULL_DUPLEX(mss) && mss->bd_id != MD_OPTI931)
755                 ad_write(mss, 12, ad_read(mss, 12) | 0x40); /* mode 2 */
756         ad_enter_MCE(mss);
757         ad_write(mss, 9, FULL_DUPLEX(mss)? 0 : 4);
758         ad_leave_MCE(mss);
759         ad_write(mss, 10, 2); /* int enable */
760         io_wr(mss, MSS_STATUS, 0); /* Clear interrupt status */
761         /* the following seem required on the CS4232 */
762         ad_unmute(mss);
763         return 0;
764 }
765
766
767 /*
768  * main irq handler for the CS423x. The OPTi931 code is
769  * a separate one.
770  * The correct way to operate for a device with multiple internal
771  * interrupt sources is to loop on the status register and ack
772  * interrupts until all interrupts are served and none are reported. At
773  * this point the IRQ line to the ISA IRQ controller should go low
774  * and be raised at the next interrupt.
775  *
776  * Since the ISA IRQ controller is sent EOI _before_ passing control
777  * to the isr, it might happen that we serve an interrupt early, in
778  * which case the status register at the next interrupt should just
779  * say that there are no more interrupts...
780  */
781
782 static void
783 mss_intr(void *arg)
784 {
785         struct mss_info *mss = arg;
786         u_char c = 0, served = 0;
787         int i;
788
789         DEB(kprintf("mss_intr\n"));
790         mss_lock(mss);
791         ad_read(mss, 11); /* fake read of status bits */
792
793         /* loop until there are interrupts, but no more than 10 times. */
794         for (i = 10; i > 0 && io_rd(mss, MSS_STATUS) & 1; i--) {
795                 /* get exact reason for full-duplex boards */
796                 c = FULL_DUPLEX(mss)? ad_read(mss, 24) : 0x30;
797                 c &= ~served;
798                 if (sndbuf_runsz(mss->pch.buffer) && (c & 0x10)) {
799                         served |= 0x10;
800                         mss_unlock(mss);
801                         chn_intr(mss->pch.channel);
802                         mss_lock(mss);
803                 }
804                 if (sndbuf_runsz(mss->rch.buffer) && (c & 0x20)) {
805                         served |= 0x20;
806                         mss_unlock(mss);
807                         chn_intr(mss->rch.channel);
808                         mss_lock(mss);
809                 }
810                 /* now ack the interrupt */
811                 if (FULL_DUPLEX(mss)) ad_write(mss, 24, ~c); /* ack selectively */
812                 else io_wr(mss, MSS_STATUS, 0); /* Clear interrupt status */
813         }
814         if (i == 10) {
815                 BVDDB(kprintf("mss_intr: irq, but not from mss\n"));
816         } else if (served == 0) {
817                 BVDDB(kprintf("mss_intr: unexpected irq with reason %x\n", c));
818                 /*
819                 * this should not happen... I have no idea what to do now.
820                 * maybe should do a sanity check and restart dmas ?
821                 */
822                 io_wr(mss, MSS_STATUS, 0);      /* Clear interrupt status */
823         }
824         mss_unlock(mss);
825 }
826
827 /*
828  * AD_WAIT_INIT waits if we are initializing the board and
829  * we cannot modify its settings
830  */
831 static int
832 ad_wait_init(struct mss_info *mss, int x)
833 {
834         int arg = x, n = 0; /* to shut up the compiler... */
835         for (; x > 0; x--)
836                 if ((n = io_rd(mss, MSS_INDEX)) & MSS_IDXBUSY) DELAY(10);
837                 else return n;
838         kprintf("AD_WAIT_INIT FAILED %d 0x%02x\n", arg, n);
839         return n;
840 }
841
842 static int
843 ad_read(struct mss_info *mss, int reg)
844 {
845         int             x;
846
847         ad_wait_init(mss, 201000);
848         x = io_rd(mss, MSS_INDEX) & ~MSS_IDXMASK;
849         io_wr(mss, MSS_INDEX, (u_char)(reg & MSS_IDXMASK) | x);
850         x = io_rd(mss, MSS_IDATA);
851         /* kprintf("ad_read %d, %x\n", reg, x); */
852         return x;
853 }
854
855 static void
856 ad_write(struct mss_info *mss, int reg, u_char data)
857 {
858         int x;
859
860         /* kprintf("ad_write %d, %x\n", reg, data); */
861         ad_wait_init(mss, 1002000);
862         x = io_rd(mss, MSS_INDEX) & ~MSS_IDXMASK;
863         io_wr(mss, MSS_INDEX, (u_char)(reg & MSS_IDXMASK) | x);
864         io_wr(mss, MSS_IDATA, data);
865 }
866
867 static void
868 ad_write_cnt(struct mss_info *mss, int reg, u_short cnt)
869 {
870         ad_write(mss, reg+1, cnt & 0xff);
871         ad_write(mss, reg, cnt >> 8); /* upper base must be last */
872 }
873
874 static void
875 wait_for_calibration(struct mss_info *mss)
876 {
877         int t;
878
879         /*
880          * Wait until the auto calibration process has finished.
881          *
882          * 1) Wait until the chip becomes ready (reads don't return 0x80).
883          * 2) Wait until the ACI bit of I11 gets on
884          * 3) Wait until the ACI bit of I11 gets off
885          */
886
887         t = ad_wait_init(mss, 1000000);
888         if (t & MSS_IDXBUSY) kprintf("mss: Auto calibration timed out(1).\n");
889
890         /*
891          * The calibration mode for chips that support it is set so that
892          * we never see ACI go on.
893          */
894         if (mss->bd_id == MD_GUSMAX || mss->bd_id == MD_GUSPNP) {
895                 for (t = 100; t > 0 && (ad_read(mss, 11) & 0x20) == 0; t--);
896         } else {
897                 /*
898                  * XXX This should only be enabled for cards that *really*
899                  * need it.  Are there any?
900                  */
901                 for (t = 100; t > 0 && (ad_read(mss, 11) & 0x20) == 0; t--) DELAY(100);
902         }
903         for (t = 100; t > 0 && ad_read(mss, 11) & 0x20; t--) DELAY(100);
904 }
905
906 static void
907 ad_unmute(struct mss_info *mss)
908 {
909         ad_write(mss, 6, ad_read(mss, 6) & ~I6_MUTE);
910         ad_write(mss, 7, ad_read(mss, 7) & ~I6_MUTE);
911 }
912
913 static void
914 ad_enter_MCE(struct mss_info *mss)
915 {
916         int prev;
917
918         mss->bd_flags |= BD_F_MCE_BIT;
919         ad_wait_init(mss, 203000);
920         prev = io_rd(mss, MSS_INDEX);
921         prev &= ~MSS_TRD;
922         io_wr(mss, MSS_INDEX, prev | MSS_MCE);
923 }
924
925 static void
926 ad_leave_MCE(struct mss_info *mss)
927 {
928         u_char   prev;
929
930         if ((mss->bd_flags & BD_F_MCE_BIT) == 0) {
931                 DEB(kprintf("--- hey, leave_MCE: MCE bit was not set!\n"));
932                 return;
933         }
934
935         ad_wait_init(mss, 1000000);
936
937         mss->bd_flags &= ~BD_F_MCE_BIT;
938
939         prev = io_rd(mss, MSS_INDEX);
940         prev &= ~MSS_TRD;
941         io_wr(mss, MSS_INDEX, prev & ~MSS_MCE); /* Clear the MCE bit */
942         wait_for_calibration(mss);
943 }
944
945 static int
946 mss_speed(struct mss_chinfo *ch, int speed)
947 {
948         struct mss_info *mss = ch->parent;
949         /*
950         * In the CS4231, the low 4 bits of I8 are used to hold the
951         * sample rate.  Only a fixed number of values is allowed. This
952         * table lists them. The speed-setting routines scans the table
953         * looking for the closest match. This is the only supported method.
954         *
955         * In the CS4236, there is an alternate metod (which we do not
956         * support yet) which provides almost arbitrary frequency setting.
957         * In the AD1845, it looks like the sample rate can be
958         * almost arbitrary, and written directly to a register.
959         * In the OPTi931, there is a SB command which provides for
960         * almost arbitrary frequency setting.
961         *
962         */
963         ad_enter_MCE(mss);
964         if (mss->bd_id == MD_AD1845) { /* Use alternate speed select regs */
965                 ad_write(mss, 22, (speed >> 8) & 0xff); /* Speed MSB */
966                 ad_write(mss, 23, speed & 0xff);        /* Speed LSB */
967                 /* XXX must also do something in I27 for the ad1845 */
968         } else {
969                 int i, sel = 0; /* assume entry 0 does not contain -1 */
970                 static int speeds[] =
971                 {8000, 5512, 16000, 11025, 27429, 18900, 32000, 22050,
972                 -1, 37800, -1, 44100, 48000, 33075, 9600, 6615};
973
974 #define abs(i) (i < 0 ? -i : i)
975                 for (i = 1; i < 16; i++)
976                         if (speeds[i] > 0 &&
977                             abs(speed-speeds[i]) < abs(speed-speeds[sel])) sel = i;
978 #undef abs
979                 speed = speeds[sel];
980                 ad_write(mss, 8, (ad_read(mss, 8) & 0xf0) | sel);
981                 ad_wait_init(mss, 10000);
982         }
983         ad_leave_MCE(mss);
984
985         return speed;
986 }
987
988 /*
989  * mss_format checks that the format is supported (or defaults to AFMT_U8)
990  * and returns the bit setting for the 1848 register corresponding to
991  * the desired format.
992  *
993  * fixed lr970724
994  */
995
996 static int
997 mss_format(struct mss_chinfo *ch, u_int32_t format)
998 {
999         struct mss_info *mss = ch->parent;
1000         int i, arg = format & ~AFMT_STEREO;
1001
1002         /*
1003         * The data format uses 3 bits (just 2 on the 1848). For each
1004         * bit setting, the following array returns the corresponding format.
1005         * The code scans the array looking for a suitable format. In
1006         * case it is not found, default to AFMT_U8 (not such a good
1007         * choice, but let's do it for compatibility...).
1008         */
1009
1010         static int fmts[] =
1011                 {AFMT_U8, AFMT_MU_LAW, AFMT_S16_LE, AFMT_A_LAW,
1012                 -1, AFMT_IMA_ADPCM, AFMT_U16_BE, -1};
1013
1014         ch->fmt = format;
1015         for (i = 0; i < 8; i++) if (arg == fmts[i]) break;
1016         arg = i << 1;
1017         if (format & AFMT_STEREO) arg |= 1;
1018         arg <<= 4;
1019         ad_enter_MCE(mss);
1020         ad_write(mss, 8, (ad_read(mss, 8) & 0x0f) | arg);
1021         ad_wait_init(mss, 10000);
1022         if (ad_read(mss, 12) & 0x40) {  /* mode2? */
1023                 ad_write(mss, 28, arg); /* capture mode */
1024                 ad_wait_init(mss, 10000);
1025         }
1026         ad_leave_MCE(mss);
1027         return format;
1028 }
1029
1030 static int
1031 mss_trigger(struct mss_chinfo *ch, int go)
1032 {
1033         struct mss_info *mss = ch->parent;
1034         u_char m;
1035         int retry, wr, cnt, ss;
1036
1037         ss = 1;
1038         ss <<= (ch->fmt & AFMT_STEREO)? 1 : 0;
1039         ss <<= (ch->fmt & AFMT_16BIT)? 1 : 0;
1040
1041         wr = (ch->dir == PCMDIR_PLAY)? 1 : 0;
1042         m = ad_read(mss, 9);
1043         switch (go) {
1044         case PCMTRIG_START:
1045                 cnt = (ch->blksz / ss) - 1;
1046
1047                 DEB(if (m & 4) kprintf("OUCH! reg 9 0x%02x\n", m););
1048                 m |= wr? I9_PEN : I9_CEN; /* enable DMA */
1049                 ad_write_cnt(mss, (wr || !FULL_DUPLEX(mss))? 14 : 30, cnt);
1050                 break;
1051
1052         case PCMTRIG_STOP:
1053         case PCMTRIG_ABORT: /* XXX check this... */
1054                 m &= ~(wr? I9_PEN : I9_CEN); /* Stop DMA */
1055 #if 0
1056                 /*
1057                 * try to disable DMA by clearing count registers. Not sure it
1058                 * is needed, and it might cause false interrupts when the
1059                 * DMA is re-enabled later.
1060                 */
1061                 ad_write_cnt(mss, (wr || !FULL_DUPLEX(mss))? 14 : 30, 0);
1062 #endif
1063         }
1064         /* on the OPTi931 the enable bit seems hard to set... */
1065         for (retry = 10; retry > 0; retry--) {
1066                 ad_write(mss, 9, m);
1067                 if (ad_read(mss, 9) == m) break;
1068         }
1069         if (retry == 0) BVDDB(kprintf("stop dma, failed to set bit 0x%02x 0x%02x\n", \
1070                                m, ad_read(mss, 9)));
1071         return 0;
1072 }
1073
1074
1075 /*
1076  * the opti931 seems to miss interrupts when working in full
1077  * duplex, so we try some heuristics to catch them.
1078  */
1079 static void
1080 opti931_intr(void *arg)
1081 {
1082         struct mss_info *mss = (struct mss_info *)arg;
1083         u_char masked = 0, i11, mc11, c = 0;
1084         u_char reason; /* b0 = playback, b1 = capture, b2 = timer */
1085         int loops = 10;
1086
1087 #if 0
1088         reason = io_rd(mss, MSS_STATUS);
1089         if (!(reason & 1)) {/* no int, maybe a shared line ? */
1090                 DEB(kprintf("intr: flag 0, mcir11 0x%02x\n", ad_read(mss, 11)));
1091                 return;
1092         }
1093 #endif
1094         mss_lock(mss);
1095         i11 = ad_read(mss, 11); /* XXX what's for ? */
1096         again:
1097
1098         c = mc11 = FULL_DUPLEX(mss)? opti_rd(mss, 11) : 0xc;
1099         mc11 &= 0x0c;
1100         if (c & 0x10) {
1101                 DEB(kprintf("Warning: CD interrupt\n");)
1102                 mc11 |= 0x10;
1103         }
1104         if (c & 0x20) {
1105                 DEB(kprintf("Warning: MPU interrupt\n");)
1106                 mc11 |= 0x20;
1107         }
1108         if (mc11 & masked) BVDDB(kprintf("irq reset failed, mc11 0x%02x, 0x%02x\n",\
1109                                   mc11, masked));
1110         masked |= mc11;
1111         /*
1112         * the nice OPTi931 sets the IRQ line before setting the bits in
1113         * mc11. So, on some occasions I have to retry (max 10 times).
1114         */
1115         if (mc11 == 0) { /* perhaps can return ... */
1116                 reason = io_rd(mss, MSS_STATUS);
1117                 if (reason & 1) {
1118                         DEB(kprintf("one more try...\n");)
1119                         if (--loops) goto again;
1120                         else BVDDB(kprintf("intr, but mc11 not set\n");)
1121                 }
1122                 if (loops == 0) BVDDB(kprintf("intr, nothing in mcir11 0x%02x\n", mc11));
1123                 mss_unlock(mss);
1124                 return;
1125         }
1126
1127         if (sndbuf_runsz(mss->rch.buffer) && (mc11 & 8)) {
1128                 mss_unlock(mss);
1129                 chn_intr(mss->rch.channel);
1130                 mss_lock(mss);
1131         }
1132         if (sndbuf_runsz(mss->pch.buffer) && (mc11 & 4)) {
1133                 mss_unlock(mss);
1134                 chn_intr(mss->pch.channel);
1135                 mss_lock(mss);
1136         }
1137         opti_wr(mss, 11, ~mc11); /* ack */
1138         if (--loops) goto again;
1139         mss_unlock(mss);
1140         DEB(kprintf("xxx too many loops\n");)
1141 }
1142
1143 /* -------------------------------------------------------------------- */
1144 /* channel interface */
1145 static void *
1146 msschan_init(kobj_t obj, void *devinfo, struct snd_dbuf *b, struct pcm_channel *c, int dir)
1147 {
1148         struct mss_info *mss = devinfo;
1149         struct mss_chinfo *ch = (dir == PCMDIR_PLAY)? &mss->pch : &mss->rch;
1150
1151         ch->parent = mss;
1152         ch->channel = c;
1153         ch->buffer = b;
1154         ch->dir = dir;
1155         if (sndbuf_alloc(ch->buffer, mss->parent_dmat, mss->bufsize) != 0)
1156                 return NULL;
1157         sndbuf_dmasetup(ch->buffer, (dir == PCMDIR_PLAY)? mss->drq1 : mss->drq2);
1158         return ch;
1159 }
1160
1161 static int
1162 msschan_setformat(kobj_t obj, void *data, u_int32_t format)
1163 {
1164         struct mss_chinfo *ch = data;
1165         struct mss_info *mss = ch->parent;
1166
1167         mss_lock(mss);
1168         mss_format(ch, format);
1169         mss_unlock(mss);
1170         return 0;
1171 }
1172
1173 static int
1174 msschan_setspeed(kobj_t obj, void *data, u_int32_t speed)
1175 {
1176         struct mss_chinfo *ch = data;
1177         struct mss_info *mss = ch->parent;
1178         int r;
1179
1180         mss_lock(mss);
1181         r = mss_speed(ch, speed);
1182         mss_unlock(mss);
1183
1184         return r;
1185 }
1186
1187 static int
1188 msschan_setblocksize(kobj_t obj, void *data, u_int32_t blocksize)
1189 {
1190         struct mss_chinfo *ch = data;
1191
1192         ch->blksz = blocksize;
1193         sndbuf_resize(ch->buffer, 2, ch->blksz);
1194
1195         return ch->blksz;
1196 }
1197
1198 static int
1199 msschan_trigger(kobj_t obj, void *data, int go)
1200 {
1201         struct mss_chinfo *ch = data;
1202         struct mss_info *mss = ch->parent;
1203
1204         if (go == PCMTRIG_EMLDMAWR || go == PCMTRIG_EMLDMARD)
1205                 return 0;
1206
1207         sndbuf_dma(ch->buffer, go);
1208         mss_lock(mss);
1209         mss_trigger(ch, go);
1210         mss_unlock(mss);
1211         return 0;
1212 }
1213
1214 static int
1215 msschan_getptr(kobj_t obj, void *data)
1216 {
1217         struct mss_chinfo *ch = data;
1218         return sndbuf_dmaptr(ch->buffer);
1219 }
1220
1221 static struct pcmchan_caps *
1222 msschan_getcaps(kobj_t obj, void *data)
1223 {
1224         struct mss_chinfo *ch = data;
1225
1226         switch(ch->parent->bd_id) {
1227         case MD_OPTI931:
1228                 return &opti931_caps;
1229                 break;
1230
1231         case MD_GUSPNP:
1232         case MD_GUSMAX:
1233                 return &guspnp_caps;
1234                 break;
1235
1236         default:
1237                 return &mss_caps;
1238                 break;
1239         }
1240 }
1241
1242 static kobj_method_t msschan_methods[] = {
1243         KOBJMETHOD(channel_init,                msschan_init),
1244         KOBJMETHOD(channel_setformat,           msschan_setformat),
1245         KOBJMETHOD(channel_setspeed,            msschan_setspeed),
1246         KOBJMETHOD(channel_setblocksize,        msschan_setblocksize),
1247         KOBJMETHOD(channel_trigger,             msschan_trigger),
1248         KOBJMETHOD(channel_getptr,              msschan_getptr),
1249         KOBJMETHOD(channel_getcaps,             msschan_getcaps),
1250         KOBJMETHOD_END
1251 };
1252 CHANNEL_DECLARE(msschan);
1253
1254 /* -------------------------------------------------------------------- */
1255
1256 /*
1257  * mss_probe() is the probe routine. Note, it is not necessary to
1258  * go through this for PnP devices, since they are already
1259  * indentified precisely using their PnP id.
1260  *
1261  * The base address supplied in the device refers to the old MSS
1262  * specs where the four 4 registers in io space contain configuration
1263  * information. Some boards (as an example, early MSS boards)
1264  * has such a block of registers, whereas others (generally CS42xx)
1265  * do not.  In order to distinguish between the two and do not have
1266  * to supply two separate probe routines, the flags entry in isa_device
1267  * has a bit to mark this.
1268  *
1269  */
1270
1271 static int
1272 mss_probe(device_t dev)
1273 {
1274         u_char tmp, tmpx;
1275         int flags, irq, drq, result = ENXIO, setres = 0;
1276         struct mss_info *mss;
1277
1278         if (isa_get_logicalid(dev)) return ENXIO; /* not yet */
1279
1280         mss = kmalloc(sizeof *mss, M_DEVBUF, M_WAITOK | M_ZERO);
1281         mss->io_rid = 0;
1282         mss->conf_rid = -1;
1283         mss->irq_rid = 0;
1284         mss->drq1_rid = 0;
1285         mss->drq2_rid = -1;
1286         mss->io_base = bus_alloc_resource(dev, SYS_RES_IOPORT, &mss->io_rid,
1287                                         0, ~0, 8, RF_ACTIVE);
1288         if (!mss->io_base) {
1289                 BVDDB(kprintf("mss_probe: no address given, try 0x%x\n", 0x530));
1290                 mss->io_rid = 0;
1291                 /* XXX verify this */
1292                 setres = 1;
1293                 bus_set_resource(dev, SYS_RES_IOPORT, mss->io_rid,
1294                                 0x530, 8, -1);
1295                 mss->io_base = bus_alloc_resource(dev, SYS_RES_IOPORT, &mss->io_rid,
1296                                                 0, ~0, 8, RF_ACTIVE);
1297         }
1298         if (!mss->io_base) goto no;
1299
1300         /* got irq/dma regs? */
1301         flags = device_get_flags(dev);
1302         irq = isa_get_irq(dev);
1303         drq = isa_get_drq(dev);
1304
1305         if (!(device_get_flags(dev) & DV_F_TRUE_MSS)) goto mss_probe_end;
1306
1307         /*
1308         * Check if the IO port returns valid signature. The original MS
1309         * Sound system returns 0x04 while some cards
1310         * (AudioTriX Pro for example) return 0x00 or 0x0f.
1311         */
1312
1313         device_set_desc(dev, "MSS");
1314         tmpx = tmp = io_rd(mss, 3);
1315         if (tmp == 0xff) {      /* Bus float */
1316                 BVDDB(kprintf("I/O addr inactive (%x), try pseudo_mss\n", tmp));
1317                 device_set_flags(dev, flags & ~DV_F_TRUE_MSS);
1318                 goto mss_probe_end;
1319         }
1320         tmp &= 0x3f;
1321         if (!(tmp == 0x04 || tmp == 0x0f || tmp == 0x00)) {
1322                 BVDDB(kprintf("No MSS signature detected on port 0x%lx (0x%x)\n",
1323                         rman_get_start(mss->io_base), tmpx));
1324                 goto no;
1325         }
1326         if (irq > 11) {
1327                 kprintf("MSS: Bad IRQ %d\n", irq);
1328                 goto no;
1329         }
1330         if (!(drq == 0 || drq == 1 || drq == 3)) {
1331                 kprintf("MSS: Bad DMA %d\n", drq);
1332                 goto no;
1333         }
1334         if (tmpx & 0x80) {
1335                 /* 8-bit board: only drq1/3 and irq7/9 */
1336                 if (drq == 0) {
1337                         kprintf("MSS: Can't use DMA0 with a 8 bit card/slot\n");
1338                         goto no;
1339                 }
1340                 if (!(irq == 7 || irq == 9)) {
1341                         kprintf("MSS: Can't use IRQ%d with a 8 bit card/slot\n",
1342                                irq);
1343                         goto no;
1344                 }
1345         }
1346         mss_probe_end:
1347         result = mss_detect(dev, mss);
1348         no:
1349         mss_release_resources(mss, dev);
1350 #if 0
1351         if (setres) ISA_DELETE_RESOURCE(device_get_parent(dev), dev,
1352                                         SYS_RES_IOPORT, mss->io_rid); /* XXX ? */
1353 #endif
1354         return result;
1355 }
1356
1357 static int
1358 mss_detect(device_t dev, struct mss_info *mss)
1359 {
1360         int          i;
1361         u_char       tmp = 0, tmp1, tmp2;
1362         char        *name, *yamaha;
1363
1364         if (mss->bd_id != 0) {
1365                 device_printf(dev, "presel bd_id 0x%04x -- %s\n", mss->bd_id,
1366                         device_get_desc(dev));
1367                 return 0;
1368         }
1369
1370         name = "AD1848";
1371         mss->bd_id = MD_AD1848; /* AD1848 or CS4248 */
1372
1373         if (opti_detect(dev, mss)) {
1374                 switch (mss->bd_id) {
1375                         case MD_OPTI924:
1376                                 name = "OPTi924";
1377                                 break;
1378                         case MD_OPTI930:
1379                                 name = "OPTi930";
1380                                 break;
1381                 }
1382                 kprintf("Found OPTi device %s\n", name);
1383                 if (opti_init(dev, mss) == 0) goto gotit;
1384         }
1385
1386         /*
1387         * Check that the I/O address is in use.
1388         *
1389         * bit 7 of the base I/O port is known to be 0 after the chip has
1390         * performed its power on initialization. Just assume this has
1391         * happened before the OS is starting.
1392         *
1393         * If the I/O address is unused, it typically returns 0xff.
1394         */
1395
1396         for (i = 0; i < 10; i++)
1397                 if ((tmp = io_rd(mss, MSS_INDEX)) & MSS_IDXBUSY) DELAY(10000);
1398                 else break;
1399
1400         if (i >= 10) {  /* Not an AD1848 */
1401                 BVDDB(kprintf("mss_detect, busy still set (0x%02x)\n", tmp));
1402                 goto no;
1403         }
1404         /*
1405         * Test if it's possible to change contents of the indirect
1406         * registers. Registers 0 and 1 are ADC volume registers. The bit
1407         * 0x10 is read only so try to avoid using it.
1408         */
1409
1410         ad_write(mss, 0, 0xaa);
1411         ad_write(mss, 1, 0x45);/* 0x55 with bit 0x10 clear */
1412         tmp1 = ad_read(mss, 0);
1413         tmp2 = ad_read(mss, 1);
1414         if (tmp1 != 0xaa || tmp2 != 0x45) {
1415                 BVDDB(kprintf("mss_detect error - IREG (%x/%x)\n", tmp1, tmp2));
1416                 goto no;
1417         }
1418
1419         ad_write(mss, 0, 0x45);
1420         ad_write(mss, 1, 0xaa);
1421         tmp1 = ad_read(mss, 0);
1422         tmp2 = ad_read(mss, 1);
1423         if (tmp1 != 0x45 || tmp2 != 0xaa) {
1424                 BVDDB(kprintf("mss_detect error - IREG2 (%x/%x)\n", tmp1, tmp2));
1425                 goto no;
1426         }
1427
1428         /*
1429         * The indirect register I12 has some read only bits. Lets try to
1430         * change them.
1431         */
1432
1433         tmp = ad_read(mss, 12);
1434         ad_write(mss, 12, (~tmp) & 0x0f);
1435         tmp1 = ad_read(mss, 12);
1436
1437         if ((tmp & 0x0f) != (tmp1 & 0x0f)) {
1438                 BVDDB(kprintf("mss_detect - I12 (0x%02x was 0x%02x)\n", tmp1, tmp));
1439                 goto no;
1440         }
1441
1442         /*
1443         * NOTE! Last 4 bits of the reg I12 tell the chip revision.
1444         *       0x01=RevB
1445         *  0x0A=RevC. also CS4231/CS4231A and OPTi931
1446         */
1447
1448         BVDDB(kprintf("mss_detect - chip revision 0x%02x\n", tmp & 0x0f);)
1449
1450         /*
1451         * The original AD1848/CS4248 has just 16 indirect registers. This
1452         * means that I0 and I16 should return the same value (etc.). Ensure
1453         * that the Mode2 enable bit of I12 is 0. Otherwise this test fails
1454         * with new parts.
1455         */
1456
1457         ad_write(mss, 12, 0);   /* Mode2=disabled */
1458 #if 0
1459         for (i = 0; i < 16; i++) {
1460                 if ((tmp1 = ad_read(mss, i)) != (tmp2 = ad_read(mss, i + 16))) {
1461                 BVDDB(kprintf("mss_detect warning - I%d: 0x%02x/0x%02x\n",
1462                         i, tmp1, tmp2));
1463                 /*
1464                 * note - this seems to fail on the 4232 on I11. So we just break
1465                 * rather than fail.  (which makes this test pointless - cg)
1466                 */
1467                 break; /* return 0; */
1468                 }
1469         }
1470 #endif
1471         /*
1472         * Try to switch the chip to mode2 (CS4231) by setting the MODE2 bit
1473         * (0x40). The bit 0x80 is always 1 in CS4248 and CS4231.
1474         *
1475         * On the OPTi931, however, I12 is readonly and only contains the
1476         * chip revision ID (as in the CS4231A). The upper bits return 0.
1477         */
1478
1479         ad_write(mss, 12, 0x40);        /* Set mode2, clear 0x80 */
1480
1481         tmp1 = ad_read(mss, 12);
1482         if (tmp1 & 0x80) name = "CS4248"; /* Our best knowledge just now */
1483         if ((tmp1 & 0xf0) == 0x00) {
1484                 BVDDB(kprintf("this should be an OPTi931\n");)
1485         } else if ((tmp1 & 0xc0) != 0xC0) goto gotit;
1486         /*
1487         * The 4231 has bit7=1 always, and bit6 we just set to 1.
1488         * We want to check that this is really a CS4231
1489         * Verify that setting I0 doesn't change I16.
1490         */
1491         ad_write(mss, 16, 0);   /* Set I16 to known value */
1492         ad_write(mss, 0, 0x45);
1493         if ((tmp1 = ad_read(mss, 16)) == 0x45) goto gotit;
1494
1495         ad_write(mss, 0, 0xaa);
1496         if ((tmp1 = ad_read(mss, 16)) == 0xaa) {        /* Rotten bits? */
1497                 BVDDB(kprintf("mss_detect error - step H(%x)\n", tmp1));
1498                 goto no;
1499         }
1500         /* Verify that some bits of I25 are read only. */
1501         tmp1 = ad_read(mss, 25);        /* Original bits */
1502         ad_write(mss, 25, ~tmp1);       /* Invert all bits */
1503         if ((ad_read(mss, 25) & 0xe7) == (tmp1 & 0xe7)) {
1504                 int id;
1505
1506                 /* It's at least CS4231 */
1507                 name = "CS4231";
1508                 mss->bd_id = MD_CS42XX;
1509
1510                 /*
1511                 * It could be an AD1845 or CS4231A as well.
1512                 * CS4231 and AD1845 report the same revision info in I25
1513                 * while the CS4231A reports different.
1514                 */
1515
1516                 id = ad_read(mss, 25) & 0xe7;
1517                 /*
1518                 * b7-b5 = version number;
1519                 *       100 : all CS4231
1520                 *       101 : CS4231A
1521                 *
1522                 * b2-b0 = chip id;
1523                 */
1524                 switch (id) {
1525
1526                 case 0xa0:
1527                         name = "CS4231A";
1528                         mss->bd_id = MD_CS42XX;
1529                 break;
1530
1531                 case 0xa2:
1532                         name = "CS4232";
1533                         mss->bd_id = MD_CS42XX;
1534                 break;
1535
1536                 case 0xb2:
1537                 /* strange: the 4231 data sheet says b4-b3 are XX
1538                 * so this should be the same as 0xa2
1539                 */
1540                         name = "CS4232A";
1541                         mss->bd_id = MD_CS42XX;
1542                 break;
1543
1544                 case 0x80:
1545                         /*
1546                         * It must be a CS4231 or AD1845. The register I23
1547                         * of CS4231 is undefined and it appears to be read
1548                         * only. AD1845 uses I23 for setting sample rate.
1549                         * Assume the chip is AD1845 if I23 is changeable.
1550                         */
1551
1552                         tmp = ad_read(mss, 23);
1553
1554                         ad_write(mss, 23, ~tmp);
1555                         if (ad_read(mss, 23) != tmp) {  /* AD1845 ? */
1556                                 name = "AD1845";
1557                                 mss->bd_id = MD_AD1845;
1558                         }
1559                         ad_write(mss, 23, tmp); /* Restore */
1560
1561                         yamaha = ymf_test(dev, mss);
1562                         if (yamaha) {
1563                                 mss->bd_id = MD_YM0020;
1564                                 name = yamaha;
1565                         }
1566                         break;
1567
1568                 case 0x83:      /* CS4236 */
1569                 case 0x03:      /* CS4236 on Intel PR440FX motherboard XXX */
1570                         name = "CS4236";
1571                         mss->bd_id = MD_CS42XX;
1572                         break;
1573
1574                 default:        /* Assume CS4231 */
1575                         BVDDB(kprintf("unknown id 0x%02x, assuming CS4231\n", id);)
1576                         mss->bd_id = MD_CS42XX;
1577                 }
1578         }
1579         ad_write(mss, 25, tmp1);        /* Restore bits */
1580 gotit:
1581         BVDDB(kprintf("mss_detect() - Detected %s\n", name));
1582         device_set_desc(dev, name);
1583         device_set_flags(dev,
1584                          ((device_get_flags(dev) & ~DV_F_DEV_MASK) |
1585                           ((mss->bd_id << DV_F_DEV_SHIFT) & DV_F_DEV_MASK)));
1586         return 0;
1587 no:
1588         return ENXIO;
1589 }
1590
1591 static int
1592 opti_detect(device_t dev, struct mss_info *mss)
1593 {
1594         int c;
1595         static const struct opticard {
1596                 int boardid;
1597                 int passwdreg;
1598                 int password;
1599                 int base;
1600                 int indir_reg;
1601         } cards[] = {
1602                 { MD_OPTI930, 0, 0xe4, 0xf8f, 0xe0e },  /* 930 */
1603                 { MD_OPTI924, 3, 0xe5, 0xf8c, 0,    },  /* 924 */
1604                 { 0 },
1605         };
1606         mss->conf_rid = 3;
1607         mss->indir_rid = 4;
1608         for (c = 0; cards[c].base; c++) {
1609                 mss->optibase = cards[c].base;
1610                 mss->password = cards[c].password;
1611                 mss->passwdreg = cards[c].passwdreg;
1612                 mss->bd_id = cards[c].boardid;
1613
1614                 if (cards[c].indir_reg)
1615                         mss->indir = bus_alloc_resource(dev, SYS_RES_IOPORT,
1616                                 &mss->indir_rid, cards[c].indir_reg,
1617                                 cards[c].indir_reg+1, 1, RF_ACTIVE);
1618
1619                 mss->conf_base = bus_alloc_resource(dev, SYS_RES_IOPORT,
1620                         &mss->conf_rid, mss->optibase, mss->optibase+9,
1621                         9, RF_ACTIVE);
1622
1623                 if (opti_read(mss, 1) != 0xff) {
1624                         return 1;
1625                 } else {
1626                         if (mss->indir)
1627                                 bus_release_resource(dev, SYS_RES_IOPORT, mss->indir_rid, mss->indir);
1628                         mss->indir = NULL;
1629                         if (mss->conf_base)
1630                                 bus_release_resource(dev, SYS_RES_IOPORT, mss->conf_rid, mss->conf_base);
1631                         mss->conf_base = NULL;
1632                 }
1633         }
1634         return 0;
1635 }
1636
1637 static char *
1638 ymf_test(device_t dev, struct mss_info *mss)
1639 {
1640         static int ports[] = {0x370, 0x310, 0x538};
1641         int p, i, j, version;
1642         static char *chipset[] = {
1643                 NULL,                   /* 0 */
1644                 "OPL3-SA2 (YMF711)",    /* 1 */
1645                 "OPL3-SA3 (YMF715)",    /* 2 */
1646                 "OPL3-SA3 (YMF715)",    /* 3 */
1647                 "OPL3-SAx (YMF719)",    /* 4 */
1648                 "OPL3-SAx (YMF719)",    /* 5 */
1649                 "OPL3-SAx (YMF719)",    /* 6 */
1650                 "OPL3-SAx (YMF719)",    /* 7 */
1651         };
1652
1653         for (p = 0; p < 3; p++) {
1654                 mss->conf_rid = 1;
1655                 mss->conf_base = bus_alloc_resource(dev,
1656                                                 SYS_RES_IOPORT,
1657                                                 &mss->conf_rid,
1658                                                 ports[p], ports[p] + 1, 2,
1659                                                 RF_ACTIVE);
1660                 if (!mss->conf_base) return 0;
1661
1662                 /* Test the index port of the config registers */
1663                 i = port_rd(mss->conf_base, 0);
1664                 port_wr(mss->conf_base, 0, OPL3SAx_DMACONF);
1665                 j = (port_rd(mss->conf_base, 0) == OPL3SAx_DMACONF)? 1 : 0;
1666                 port_wr(mss->conf_base, 0, i);
1667                 if (!j) {
1668                         bus_release_resource(dev, SYS_RES_IOPORT,
1669                                              mss->conf_rid, mss->conf_base);
1670                         mss->conf_base = NULL;
1671                         continue;
1672                 }
1673                 version = conf_rd(mss, OPL3SAx_MISC) & 0x07;
1674                 return chipset[version];
1675         }
1676         return NULL;
1677 }
1678
1679 static int
1680 mss_doattach(device_t dev, struct mss_info *mss)
1681 {
1682         int pdma, rdma, flags = device_get_flags(dev);
1683         char status[SND_STATUSLEN], status2[SND_STATUSLEN];
1684
1685         mss->lock = snd_mtxcreate(device_get_nameunit(dev), "sound softc");
1686         mss->bufsize = pcm_getbuffersize(dev, 4096, MSS_DEFAULT_BUFSZ, 65536);
1687         if (!mss_alloc_resources(mss, dev)) goto no;
1688         mss_init(mss, dev);
1689         pdma = rman_get_start(mss->drq1);
1690         rdma = rman_get_start(mss->drq2);
1691         if (flags & DV_F_TRUE_MSS) {
1692                 /* has IRQ/DMA registers, set IRQ and DMA addr */
1693                 static char     interrupt_bits[12] =
1694                 {-1, -1, -1, -1, -1, 0x28, -1, 0x08, -1, 0x10, 0x18, 0x20};
1695                 static char     pdma_bits[4] =  {1, 2, -1, 3};
1696                 static char     valid_rdma[4] = {1, 0, -1, 0};
1697                 char            bits;
1698
1699                 if (!mss->irq || (bits = interrupt_bits[rman_get_start(mss->irq)]) == -1)
1700                         goto no;
1701                 io_wr(mss, 0, bits | 0x40);     /* config port */
1702                 if ((io_rd(mss, 3) & 0x40) == 0) device_printf(dev, "IRQ Conflict?\n");
1703                 /* Write IRQ+DMA setup */
1704                 if (pdma_bits[pdma] == -1) goto no;
1705                 bits |= pdma_bits[pdma];
1706                 if (pdma != rdma) {
1707                         if (rdma == valid_rdma[pdma]) bits |= 4;
1708                         else {
1709                                 kprintf("invalid dual dma config %d:%d\n", pdma, rdma);
1710                                 goto no;
1711                         }
1712                 }
1713                 io_wr(mss, 0, bits);
1714                 kprintf("drq/irq conf %x\n", io_rd(mss, 0));
1715         }
1716         mixer_init(dev, (mss->bd_id == MD_YM0020)? &ymmix_mixer_class : &mssmix_mixer_class, mss);
1717         switch (mss->bd_id) {
1718         case MD_OPTI931:
1719                 snd_setup_intr(dev, mss->irq, 0, opti931_intr, mss, &mss->ih);
1720                 break;
1721         default:
1722                 snd_setup_intr(dev, mss->irq, 0, mss_intr, mss, &mss->ih);
1723         }
1724         if (pdma == rdma)
1725                 pcm_setflags(dev, pcm_getflags(dev) | SD_F_SIMPLEX);
1726         if (bus_dma_tag_create(/*parent*/NULL, /*alignment*/2, /*boundary*/0,
1727                         /*lowaddr*/BUS_SPACE_MAXADDR_24BIT,
1728                         /*highaddr*/BUS_SPACE_MAXADDR,
1729                         /*filter*/NULL, /*filterarg*/NULL,
1730                         /*maxsize*/mss->bufsize, /*nsegments*/1,
1731                         /*maxsegz*/0x3ffff, /*flags*/0,
1732                         &mss->parent_dmat) != 0) {
1733                 device_printf(dev, "unable to create dma tag\n");
1734                 goto no;
1735         }
1736
1737         if (pdma != rdma)
1738                 ksnprintf(status2, SND_STATUSLEN, ":%d", rdma);
1739         else
1740                 status2[0] = '\0';
1741
1742         ksnprintf(status, SND_STATUSLEN, "at io 0x%lx irq %ld drq %d%s bufsz %u",
1743                 rman_get_start(mss->io_base), rman_get_start(mss->irq), pdma, status2, mss->bufsize);
1744
1745         if (pcm_register(dev, mss, 1, 1)) goto no;
1746         pcm_addchan(dev, PCMDIR_REC, &msschan_class, mss);
1747         pcm_addchan(dev, PCMDIR_PLAY, &msschan_class, mss);
1748         pcm_setstatus(dev, status);
1749
1750         return 0;
1751 no:
1752         mss_release_resources(mss, dev);
1753         return ENXIO;
1754 }
1755
1756 static int
1757 mss_detach(device_t dev)
1758 {
1759         int r;
1760         struct mss_info *mss;
1761
1762         r = pcm_unregister(dev);
1763         if (r)
1764                 return r;
1765
1766         mss = pcm_getdevinfo(dev);
1767         mss_release_resources(mss, dev);
1768
1769         return 0;
1770 }
1771
1772 static int
1773 mss_attach(device_t dev)
1774 {
1775         struct mss_info *mss;
1776         int flags = device_get_flags(dev);
1777
1778         mss = kmalloc(sizeof *mss, M_DEVBUF, M_WAITOK | M_ZERO);
1779         mss->io_rid = 0;
1780         mss->conf_rid = -1;
1781         mss->irq_rid = 0;
1782         mss->drq1_rid = 0;
1783         mss->drq2_rid = -1;
1784         if (flags & DV_F_DUAL_DMA) {
1785                 bus_set_resource(dev, SYS_RES_DRQ, 1,
1786                                  flags & DV_F_DRQ_MASK, 1, -1);
1787                 mss->drq2_rid = 1;
1788         }
1789         mss->bd_id = (device_get_flags(dev) & DV_F_DEV_MASK) >> DV_F_DEV_SHIFT;
1790         if (mss->bd_id == MD_YM0020) ymf_test(dev, mss);
1791         return mss_doattach(dev, mss);
1792 }
1793
1794 /*
1795  * mss_resume() is the code to allow a laptop to resume using the sound
1796  * card.
1797  *
1798  * This routine re-sets the state of the board to the state before going
1799  * to sleep.  According to the yamaha docs this is the right thing to do,
1800  * but getting DMA restarted appears to be a bit of a trick, so the device
1801  * has to be closed and re-opened to be re-used, but there is no skipping
1802  * problem, and volume, bass/treble and most other things are restored
1803  * properly.
1804  *
1805  */
1806
1807 static int
1808 mss_resume(device_t dev)
1809 {
1810         /*
1811          * Restore the state taken below.
1812          */
1813         struct mss_info *mss;
1814         int i;
1815
1816         mss = pcm_getdevinfo(dev);
1817
1818         if(mss->bd_id == MD_YM0020 || mss->bd_id == MD_CS423X) {
1819                 /* This works on a Toshiba Libretto 100CT. */
1820                 for (i = 0; i < MSS_INDEXED_REGS; i++)
1821                         ad_write(mss, i, mss->mss_indexed_regs[i]);
1822                 for (i = 0; i < OPL_INDEXED_REGS; i++)
1823                         conf_wr(mss, i, mss->opl_indexed_regs[i]);
1824                 mss_intr(mss);
1825         }
1826
1827         if (mss->bd_id == MD_CS423X) {
1828                 /* Needed on IBM Thinkpad 600E */
1829                 mss_lock(mss);
1830                 mss_format(&mss->pch, mss->pch.channel->format);
1831                 mss_speed(&mss->pch, mss->pch.channel->speed);
1832                 mss_unlock(mss);
1833         }
1834
1835         return 0;
1836
1837 }
1838
1839 /*
1840  * mss_suspend() is the code that gets called right before a laptop
1841  * suspends.
1842  *
1843  * This code saves the state of the sound card right before shutdown
1844  * so it can be restored above.
1845  *
1846  */
1847
1848 static int
1849 mss_suspend(device_t dev)
1850 {
1851         int i;
1852         struct mss_info *mss;
1853
1854         mss = pcm_getdevinfo(dev);
1855
1856         if(mss->bd_id == MD_YM0020 || mss->bd_id == MD_CS423X)
1857         {
1858                 /* this stops playback. */
1859                 conf_wr(mss, 0x12, 0x0c);
1860                 for(i = 0; i < MSS_INDEXED_REGS; i++)
1861                         mss->mss_indexed_regs[i] = ad_read(mss, i);
1862                 for(i = 0; i < OPL_INDEXED_REGS; i++)
1863                         mss->opl_indexed_regs[i] = conf_rd(mss, i);
1864                 mss->opl_indexed_regs[0x12] = 0x0;
1865         }
1866         return 0;
1867 }
1868
1869 static device_method_t mss_methods[] = {
1870         /* Device interface */
1871         DEVMETHOD(device_probe,         mss_probe),
1872         DEVMETHOD(device_attach,        mss_attach),
1873         DEVMETHOD(device_detach,        mss_detach),
1874         DEVMETHOD(device_suspend,       mss_suspend),
1875         DEVMETHOD(device_resume,        mss_resume),
1876
1877         { 0, 0 }
1878 };
1879
1880 static driver_t mss_driver = {
1881         "pcm",
1882         mss_methods,
1883         PCM_SOFTC_SIZE,
1884 };
1885
1886 DRIVER_MODULE(snd_mss, isa, mss_driver, pcm_devclass, NULL, NULL);
1887 MODULE_DEPEND(snd_mss, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
1888 MODULE_VERSION(snd_mss, 1);
1889
1890 static int
1891 azt2320_mss_mode(struct mss_info *mss, device_t dev)
1892 {
1893         struct resource *sbport;
1894         int             i, ret, rid;
1895
1896         rid = 0;
1897         ret = -1;
1898         sbport = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE);
1899         if (sbport) {
1900                 for (i = 0; i < 1000; i++) {
1901                         if ((port_rd(sbport, SBDSP_STATUS) & 0x80))
1902                                 DELAY((i > 100) ? 1000 : 10);
1903                         else {
1904                                 port_wr(sbport, SBDSP_CMD, 0x09);
1905                                 break;
1906                         }
1907                 }
1908                 for (i = 0; i < 1000; i++) {
1909                         if ((port_rd(sbport, SBDSP_STATUS) & 0x80))
1910                                 DELAY((i > 100) ? 1000 : 10);
1911                         else {
1912                                 port_wr(sbport, SBDSP_CMD, 0x00);
1913                                 ret = 0;
1914                                 break;
1915                         }
1916                 }
1917                 DELAY(1000);
1918                 bus_release_resource(dev, SYS_RES_IOPORT, rid, sbport);
1919         }
1920         return ret;
1921 }
1922
1923 static struct isa_pnp_id pnpmss_ids[] = {
1924         {0x0000630e, "CS423x"},                         /* CSC0000 */
1925         {0x0001630e, "CS423x-PCI"},                     /* CSC0100 */
1926         {0x01000000, "CMI8330"},                        /* @@@0001 */
1927         {0x2100a865, "Yamaha OPL-SAx"},                 /* YMH0021 */
1928         {0x1110d315, "ENSONIQ SoundscapeVIVO"},         /* ENS1011 */
1929         {0x1093143e, "OPTi931"},                        /* OPT9310 */
1930         {0x5092143e, "OPTi925"},                        /* OPT9250 XXX guess */
1931         {0x0000143e, "OPTi924"},                        /* OPT0924 */
1932         {0x1022b839, "Neomagic 256AV (non-ac97)"},      /* NMX2210 */
1933         {0x01005407, "Aztech 2320"},                    /* AZT0001 */
1934 #if 0
1935         {0x0000561e, "GusPnP"},                         /* GRV0000 */
1936 #endif
1937         {0},
1938 };
1939
1940 static int
1941 pnpmss_probe(device_t dev)
1942 {
1943         u_int32_t lid, vid;
1944
1945         lid = isa_get_logicalid(dev);
1946         vid = isa_get_vendorid(dev);
1947         if (lid == 0x01000000 && vid != 0x0100a90d) /* CMI0001 */
1948                 return ENXIO;
1949         return ISA_PNP_PROBE(device_get_parent(dev), dev, pnpmss_ids);
1950 }
1951
1952 static int
1953 pnpmss_attach(device_t dev)
1954 {
1955         struct mss_info *mss;
1956
1957         mss = kmalloc(sizeof *mss, M_DEVBUF, M_WAITOK | M_ZERO);
1958         mss->io_rid = 0;
1959         mss->conf_rid = -1;
1960         mss->irq_rid = 0;
1961         mss->drq1_rid = 0;
1962         mss->drq2_rid = 1;
1963         mss->bd_id = MD_CS42XX;
1964
1965         switch (isa_get_logicalid(dev)) {
1966         case 0x0000630e:                        /* CSC0000 */
1967         case 0x0001630e:                        /* CSC0100 */
1968             mss->bd_flags |= BD_F_MSS_OFFSET;
1969             mss->bd_id = MD_CS423X;
1970             break;
1971
1972         case 0x2100a865:                        /* YHM0021 */
1973             mss->io_rid = 1;
1974             mss->conf_rid = 4;
1975             mss->bd_id = MD_YM0020;
1976             break;
1977
1978         case 0x1110d315:                        /* ENS1011 */
1979             mss->io_rid = 1;
1980             mss->bd_id = MD_VIVO;
1981             break;
1982
1983         case 0x1093143e:                        /* OPT9310 */
1984             mss->bd_flags |= BD_F_MSS_OFFSET;
1985             mss->conf_rid = 3;
1986             mss->bd_id = MD_OPTI931;
1987             break;
1988
1989         case 0x5092143e:                        /* OPT9250 XXX guess */
1990             mss->io_rid = 1;
1991             mss->conf_rid = 3;
1992             mss->bd_id = MD_OPTI925;
1993             break;
1994
1995         case 0x0000143e:                        /* OPT0924 */
1996             mss->password = 0xe5;
1997             mss->passwdreg = 3;
1998             mss->optibase = 0xf0c;
1999             mss->io_rid = 2;
2000             mss->conf_rid = 3;
2001             mss->bd_id = MD_OPTI924;
2002             mss->bd_flags |= BD_F_924PNP;
2003             if(opti_init(dev, mss) != 0) {
2004                     kfree(mss, M_DEVBUF);
2005                     return ENXIO;
2006             }
2007             break;
2008
2009         case 0x1022b839:                        /* NMX2210 */
2010             mss->io_rid = 1;
2011             break;
2012
2013         case 0x01005407:                        /* AZT0001 */
2014             /* put into MSS mode first (snatched from NetBSD) */
2015             if (azt2320_mss_mode(mss, dev) == -1) {
2016                     kfree(mss, M_DEVBUF);
2017                     return ENXIO;
2018             }
2019
2020             mss->bd_flags |= BD_F_MSS_OFFSET;
2021             mss->io_rid = 2;
2022             break;
2023             
2024 #if 0
2025         case 0x0000561e:                        /* GRV0000 */
2026             mss->bd_flags |= BD_F_MSS_OFFSET;
2027             mss->io_rid = 2;
2028             mss->conf_rid = 1;
2029             mss->drq1_rid = 1;
2030             mss->drq2_rid = 0;
2031             mss->bd_id = MD_GUSPNP;
2032             break;
2033 #endif
2034         case 0x01000000:                        /* @@@0001 */
2035             mss->drq2_rid = -1;
2036             break;
2037
2038         /* Unknown MSS default.  We could let the CSC0000 stuff match too */
2039         default:
2040             mss->bd_flags |= BD_F_MSS_OFFSET;
2041             break;
2042         }
2043         return mss_doattach(dev, mss);
2044 }
2045
2046 static int
2047 opti_init(device_t dev, struct mss_info *mss)
2048 {
2049         int flags = device_get_flags(dev);
2050         int basebits = 0;
2051
2052         if (!mss->conf_base) {
2053                 bus_set_resource(dev, SYS_RES_IOPORT, mss->conf_rid,
2054                         mss->optibase, 0x9, -1);
2055
2056                 mss->conf_base = bus_alloc_resource(dev, SYS_RES_IOPORT,
2057                         &mss->conf_rid, mss->optibase, mss->optibase+0x9,
2058                         0x9, RF_ACTIVE);
2059         }
2060
2061         if (!mss->conf_base)
2062                 return ENXIO;
2063
2064         if (!mss->io_base)
2065                 mss->io_base = bus_alloc_resource(dev, SYS_RES_IOPORT,
2066                         &mss->io_rid, 0, ~0, 8, RF_ACTIVE);
2067
2068         if (!mss->io_base)      /* No hint specified, use 0x530 */
2069                 mss->io_base = bus_alloc_resource(dev, SYS_RES_IOPORT,
2070                         &mss->io_rid, 0x530, 0x537, 8, RF_ACTIVE);
2071
2072         if (!mss->io_base)
2073                 return ENXIO;
2074
2075         switch (rman_get_start(mss->io_base)) {
2076                 case 0x530:
2077                         basebits = 0x0;
2078                         break;
2079                 case 0xe80:
2080                         basebits = 0x10;
2081                         break;
2082                 case 0xf40:
2083                         basebits = 0x20;
2084                         break;
2085                 case 0x604:
2086                         basebits = 0x30;
2087                         break;
2088                 default:
2089                         kprintf("opti_init: invalid MSS base address!\n");
2090                         return ENXIO;
2091         }
2092
2093
2094         switch (mss->bd_id) {
2095         case MD_OPTI924:
2096                 opti_write(mss, 1, 0x80 | basebits);    /* MSS mode */
2097                 opti_write(mss, 2, 0x00);       /* Disable CD */
2098                 opti_write(mss, 3, 0xf0);       /* Disable SB IRQ */
2099                 opti_write(mss, 4, 0xf0);
2100                 opti_write(mss, 5, 0x00);
2101                 opti_write(mss, 6, 0x02);       /* MPU stuff */
2102                 break;
2103
2104         case MD_OPTI930:
2105                 opti_write(mss, 1, 0x00 | basebits);
2106                 opti_write(mss, 3, 0x00);       /* Disable SB IRQ/DMA */
2107                 opti_write(mss, 4, 0x52);       /* Empty FIFO */
2108                 opti_write(mss, 5, 0x3c);       /* Mode 2 */
2109                 opti_write(mss, 6, 0x02);       /* Enable MSS */
2110                 break;
2111         }
2112
2113         if (mss->bd_flags & BD_F_924PNP) {
2114                 u_int32_t irq = isa_get_irq(dev);
2115                 u_int32_t drq = isa_get_drq(dev);
2116                 bus_set_resource(dev, SYS_RES_IRQ, 0, irq, 1,
2117                     machintr_legacy_intr_cpuid(irq));
2118                 bus_set_resource(dev, SYS_RES_DRQ, mss->drq1_rid, drq, 1, -1);
2119                 if (flags & DV_F_DUAL_DMA) {
2120                         bus_set_resource(dev, SYS_RES_DRQ, 1,
2121                                 flags & DV_F_DRQ_MASK, 1, -1);
2122                         mss->drq2_rid = 1;
2123                 }
2124         }
2125
2126         /* OPTixxx has I/DRQ registers */
2127
2128         device_set_flags(dev, device_get_flags(dev) | DV_F_TRUE_MSS);
2129
2130         return 0;
2131 }
2132
2133 static void
2134 opti_write(struct mss_info *mss, u_char reg, u_char val)
2135 {
2136         port_wr(mss->conf_base, mss->passwdreg, mss->password);
2137
2138         switch(mss->bd_id) {
2139         case MD_OPTI924:
2140                 if (reg > 7) {          /* Indirect register */
2141                         port_wr(mss->conf_base, mss->passwdreg, reg);
2142                         port_wr(mss->conf_base, mss->passwdreg,
2143                                 mss->password);
2144                         port_wr(mss->conf_base, 9, val);
2145                         return;
2146                 }
2147                 port_wr(mss->conf_base, reg, val);
2148                 break;
2149
2150         case MD_OPTI930:
2151                 port_wr(mss->indir, 0, reg);
2152                 port_wr(mss->conf_base, mss->passwdreg, mss->password);
2153                 port_wr(mss->indir, 1, val);
2154                 break;
2155         }
2156 }
2157
2158 u_char
2159 opti_read(struct mss_info *mss, u_char reg)
2160 {
2161         port_wr(mss->conf_base, mss->passwdreg, mss->password);
2162
2163         switch(mss->bd_id) {
2164         case MD_OPTI924:
2165                 if (reg > 7) {          /* Indirect register */
2166                         port_wr(mss->conf_base, mss->passwdreg, reg);
2167                         port_wr(mss->conf_base, mss->passwdreg, mss->password);
2168                         return(port_rd(mss->conf_base, 9));
2169                 }
2170                 return(port_rd(mss->conf_base, reg));
2171                 break;
2172
2173         case MD_OPTI930:
2174                 port_wr(mss->indir, 0, reg);
2175                 port_wr(mss->conf_base, mss->passwdreg, mss->password);
2176                 return port_rd(mss->indir, 1);
2177                 break;
2178         }
2179         return -1;
2180 }
2181
2182 static device_method_t pnpmss_methods[] = {
2183         /* Device interface */
2184         DEVMETHOD(device_probe,         pnpmss_probe),
2185         DEVMETHOD(device_attach,        pnpmss_attach),
2186         DEVMETHOD(device_detach,        mss_detach),
2187         DEVMETHOD(device_suspend,       mss_suspend),
2188         DEVMETHOD(device_resume,        mss_resume),
2189
2190         { 0, 0 }
2191 };
2192
2193 static driver_t pnpmss_driver = {
2194         "pcm",
2195         pnpmss_methods,
2196         PCM_SOFTC_SIZE,
2197 };
2198
2199 DRIVER_MODULE(snd_pnpmss, isa, pnpmss_driver, pcm_devclass, NULL, NULL);
2200 DRIVER_MODULE(snd_pnpmss, acpi, pnpmss_driver, pcm_devclass, NULL, NULL);
2201 MODULE_DEPEND(snd_pnpmss, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
2202 MODULE_VERSION(snd_pnpmss, 1);
2203
2204 static int
2205 guspcm_probe(device_t dev)
2206 {
2207         struct sndcard_func *func;
2208
2209         func = device_get_ivars(dev);
2210         if (func == NULL || func->func != SCF_PCM)
2211                 return ENXIO;
2212
2213         device_set_desc(dev, "GUS CS4231");
2214         return 0;
2215 }
2216
2217 static int
2218 guspcm_attach(device_t dev)
2219 {
2220         device_t parent = device_get_parent(dev);
2221         struct mss_info *mss;
2222         int base, flags;
2223         unsigned char ctl;
2224
2225         mss = kmalloc(sizeof *mss, M_DEVBUF, M_WAITOK | M_ZERO);
2226         mss->bd_flags = BD_F_MSS_OFFSET;
2227         mss->io_rid = 2;
2228         mss->conf_rid = 1;
2229         mss->irq_rid = 0;
2230         mss->drq1_rid = 1;
2231         mss->drq2_rid = -1;
2232
2233         if (isa_get_logicalid(parent) == 0)
2234                 mss->bd_id = MD_GUSMAX;
2235         else {
2236                 mss->bd_id = MD_GUSPNP;
2237                 mss->drq2_rid = 0;
2238                 goto skip_setup;
2239         }
2240
2241         flags = device_get_flags(parent);
2242         if (flags & DV_F_DUAL_DMA)
2243                 mss->drq2_rid = 0;
2244
2245         mss->conf_base = bus_alloc_resource(dev, SYS_RES_IOPORT, &mss->conf_rid,
2246                                             0, ~0, 8, RF_ACTIVE);
2247
2248         if (mss->conf_base == NULL) {
2249                 mss_release_resources(mss, dev);
2250                 return ENXIO;
2251         }
2252
2253         base = isa_get_port(parent);
2254
2255         ctl = 0x40;                     /* CS4231 enable */
2256         if (isa_get_drq(dev) > 3)
2257                 ctl |= 0x10;            /* 16-bit dma channel 1 */
2258         if ((flags & DV_F_DUAL_DMA) != 0 && (flags & DV_F_DRQ_MASK) > 3)
2259                 ctl |= 0x20;            /* 16-bit dma channel 2 */
2260         ctl |= (base >> 4) & 0x0f;      /* 2X0 -> 3XC */
2261         port_wr(mss->conf_base, 6, ctl);
2262
2263 skip_setup:
2264         return mss_doattach(dev, mss);
2265 }
2266
2267 static device_method_t guspcm_methods[] = {
2268         DEVMETHOD(device_probe,         guspcm_probe),
2269         DEVMETHOD(device_attach,        guspcm_attach),
2270         DEVMETHOD(device_detach,        mss_detach),
2271
2272         { 0, 0 }
2273 };
2274
2275 static driver_t guspcm_driver = {
2276         "pcm",
2277         guspcm_methods,
2278         PCM_SOFTC_SIZE,
2279 };
2280
2281 DRIVER_MODULE(snd_guspcm, gusc, guspcm_driver, pcm_devclass, NULL, NULL);
2282 MODULE_DEPEND(snd_guspcm, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
2283 MODULE_VERSION(snd_guspcm, 1);
2284
2285