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