Merge branch 'topic/isa-misc' into for-linus
[linux-2.6.git] / sound / isa / opl3sa2.c
1 /*
2  *  Driver for Yamaha OPL3-SA[2,3] soundcards
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4  *
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21
22 #include <linux/init.h>
23 #include <linux/err.h>
24 #include <linux/isa.h>
25 #include <linux/interrupt.h>
26 #include <linux/pm.h>
27 #include <linux/slab.h>
28 #include <linux/pnp.h>
29 #include <linux/moduleparam.h>
30 #include <sound/core.h>
31 #include <sound/wss.h>
32 #include <sound/mpu401.h>
33 #include <sound/opl3.h>
34 #include <sound/initval.h>
35 #include <sound/tlv.h>
36
37 #include <asm/io.h>
38
39 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
40 MODULE_DESCRIPTION("Yamaha OPL3SA2+");
41 MODULE_LICENSE("GPL");
42 MODULE_SUPPORTED_DEVICE("{{Yamaha,YMF719E-S},"
43                 "{Genius,Sound Maker 3DX},"
44                 "{Yamaha,OPL3SA3},"
45                 "{Intel,AL440LX sound},"
46                 "{NeoMagic,MagicWave 3DX}}");
47
48 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
49 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
50 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
51 #ifdef CONFIG_PNP
52 static int isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
53 #endif
54 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0xf86,0x370,0x100 */
55 static long sb_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x220,0x240,0x260 */
56 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x530,0xe80,0xf40,0x604 */
57 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x388 */
58 static long midi_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x330,0x300 */
59 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 0,1,3,5,9,11,12,15 */
60 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
61 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
62 static int opl3sa3_ymode[SNDRV_CARDS];   /* 0,1,2,3 */ /*SL Added*/
63
64 module_param_array(index, int, NULL, 0444);
65 MODULE_PARM_DESC(index, "Index value for OPL3-SA soundcard.");
66 module_param_array(id, charp, NULL, 0444);
67 MODULE_PARM_DESC(id, "ID string for OPL3-SA soundcard.");
68 module_param_array(enable, bool, NULL, 0444);
69 MODULE_PARM_DESC(enable, "Enable OPL3-SA soundcard.");
70 #ifdef CONFIG_PNP
71 module_param_array(isapnp, bool, NULL, 0444);
72 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
73 #endif
74 module_param_array(port, long, NULL, 0444);
75 MODULE_PARM_DESC(port, "Port # for OPL3-SA driver.");
76 module_param_array(sb_port, long, NULL, 0444);
77 MODULE_PARM_DESC(sb_port, "SB port # for OPL3-SA driver.");
78 module_param_array(wss_port, long, NULL, 0444);
79 MODULE_PARM_DESC(wss_port, "WSS port # for OPL3-SA driver.");
80 module_param_array(fm_port, long, NULL, 0444);
81 MODULE_PARM_DESC(fm_port, "FM port # for OPL3-SA driver.");
82 module_param_array(midi_port, long, NULL, 0444);
83 MODULE_PARM_DESC(midi_port, "MIDI port # for OPL3-SA driver.");
84 module_param_array(irq, int, NULL, 0444);
85 MODULE_PARM_DESC(irq, "IRQ # for OPL3-SA driver.");
86 module_param_array(dma1, int, NULL, 0444);
87 MODULE_PARM_DESC(dma1, "DMA1 # for OPL3-SA driver.");
88 module_param_array(dma2, int, NULL, 0444);
89 MODULE_PARM_DESC(dma2, "DMA2 # for OPL3-SA driver.");
90 module_param_array(opl3sa3_ymode, int, NULL, 0444);
91 MODULE_PARM_DESC(opl3sa3_ymode, "Speaker size selection for 3D Enhancement mode: Desktop/Large Notebook/Small Notebook/HiFi.");
92
93 #ifdef CONFIG_PNP
94 static int isa_registered;
95 static int pnp_registered;
96 static int pnpc_registered;
97 #endif
98
99 /* control ports */
100 #define OPL3SA2_PM_CTRL         0x01
101 #define OPL3SA2_SYS_CTRL                0x02
102 #define OPL3SA2_IRQ_CONFIG      0x03
103 #define OPL3SA2_IRQ_STATUS      0x04
104 #define OPL3SA2_DMA_CONFIG      0x06
105 #define OPL3SA2_MASTER_LEFT     0x07
106 #define OPL3SA2_MASTER_RIGHT    0x08
107 #define OPL3SA2_MIC             0x09
108 #define OPL3SA2_MISC            0x0A
109
110 /* opl3sa3 only */
111 #define OPL3SA3_DGTL_DOWN       0x12
112 #define OPL3SA3_ANLG_DOWN       0x13
113 #define OPL3SA3_WIDE            0x14
114 #define OPL3SA3_BASS            0x15
115 #define OPL3SA3_TREBLE          0x16
116
117 /* power management bits */
118 #define OPL3SA2_PM_ADOWN                0x20
119 #define OPL3SA2_PM_PSV          0x04            
120 #define OPL3SA2_PM_PDN          0x02
121 #define OPL3SA2_PM_PDX          0x01
122
123 #define OPL3SA2_PM_D0   0x00
124 #define OPL3SA2_PM_D3   (OPL3SA2_PM_ADOWN|OPL3SA2_PM_PSV|OPL3SA2_PM_PDN|OPL3SA2_PM_PDX)
125
126 struct snd_opl3sa2 {
127         int version;            /* 2 or 3 */
128         unsigned long port;     /* control port */
129         struct resource *res_port; /* control port resource */
130         int irq;
131         int single_dma;
132         spinlock_t reg_lock;
133         struct snd_hwdep *synth;
134         struct snd_rawmidi *rmidi;
135         struct snd_wss *wss;
136         unsigned char ctlregs[0x20];
137         int ymode;              /* SL added */
138         struct snd_kcontrol *master_switch;
139         struct snd_kcontrol *master_volume;
140 };
141
142 #define PFX     "opl3sa2: "
143
144 #ifdef CONFIG_PNP
145
146 static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
147         { .id = "YMH0021" },
148         { .id = "NMX2210" },    /* Gateway Solo 2500 */
149         { .id = "" }            /* end */
150 };
151
152 MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
153
154 static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
155         /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
156         { .id = "YMH0020", .devs = { { "YMH0021" } } },
157         /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
158         { .id = "YMH0030", .devs = { { "YMH0021" } } },
159         /* Yamaha OPL3-SA2 */
160         { .id = "YMH0800", .devs = { { "YMH0021" } } },
161         /* Yamaha OPL3-SA2 */
162         { .id = "YMH0801", .devs = { { "YMH0021" } } },
163         /* NeoMagic MagicWave 3DX */
164         { .id = "NMX2200", .devs = { { "YMH2210" } } },
165         /* NeoMagic MagicWave 3D */
166         { .id = "NMX2200", .devs = { { "NMX2210" } } },
167         /* --- */
168         { .id = "" }    /* end */
169 };
170
171 MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);
172
173 #endif /* CONFIG_PNP */
174
175
176 /* read control port (w/o spinlock) */
177 static unsigned char __snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
178 {
179         unsigned char result;
180 #if 0
181         outb(0x1d, port);       /* password */
182         printk(KERN_DEBUG "read [0x%lx] = 0x%x\n", port, inb(port));
183 #endif
184         outb(reg, chip->port);  /* register */
185         result = inb(chip->port + 1);
186 #if 0
187         printk(KERN_DEBUG "read [0x%lx] = 0x%x [0x%x]\n",
188                port, result, inb(port));
189 #endif
190         return result;
191 }
192
193 /* read control port (with spinlock) */
194 static unsigned char snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
195 {
196         unsigned long flags;
197         unsigned char result;
198
199         spin_lock_irqsave(&chip->reg_lock, flags);
200         result = __snd_opl3sa2_read(chip, reg);
201         spin_unlock_irqrestore(&chip->reg_lock, flags);
202         return result;
203 }
204
205 /* write control port (w/o spinlock) */
206 static void __snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
207 {
208 #if 0
209         outb(0x1d, port);       /* password */
210 #endif
211         outb(reg, chip->port);  /* register */
212         outb(value, chip->port + 1);
213         chip->ctlregs[reg] = value;
214 }
215
216 /* write control port (with spinlock) */
217 static void snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
218 {
219         unsigned long flags;
220         spin_lock_irqsave(&chip->reg_lock, flags);
221         __snd_opl3sa2_write(chip, reg, value);
222         spin_unlock_irqrestore(&chip->reg_lock, flags);
223 }
224
225 static int __devinit snd_opl3sa2_detect(struct snd_card *card)
226 {
227         struct snd_opl3sa2 *chip = card->private_data;
228         unsigned long port;
229         unsigned char tmp, tmp1;
230         char str[2];
231
232         port = chip->port;
233         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
234                 snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
235                 return -EBUSY;
236         }
237         /*
238         snd_printk(KERN_DEBUG "REG 0A = 0x%x\n",
239                    snd_opl3sa2_read(chip, 0x0a));
240         */
241         chip->version = 0;
242         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
243         if (tmp == 0xff) {
244                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
245                 return -ENODEV;
246         }
247         switch (tmp & 0x07) {
248         case 0x01:
249                 chip->version = 2; /* YMF711 */
250                 break;
251         default:
252                 chip->version = 3;
253                 /* 0x02 - standard */
254                 /* 0x03 - YM715B */
255                 /* 0x04 - YM719 - OPL-SA4? */
256                 /* 0x05 - OPL3-SA3 - Libretto 100 */
257                 /* 0x07 - unknown - Neomagic MagicWave 3D */
258                 break;
259         }
260         str[0] = chip->version + '0';
261         str[1] = 0;
262         strcat(card->shortname, str);
263         snd_opl3sa2_write(chip, OPL3SA2_MISC, tmp ^ 7);
264         if ((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MISC)) != tmp) {
265                 snd_printd("OPL3-SA [0x%lx] detect (1) = 0x%x (0x%x)\n", port, tmp, tmp1);
266                 return -ENODEV;
267         }
268         /* try if the MIC register is accesible */
269         tmp = snd_opl3sa2_read(chip, OPL3SA2_MIC);
270         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x8a);
271         if (((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MIC)) & 0x9f) != 0x8a) {
272                 snd_printd("OPL3-SA [0x%lx] detect (2) = 0x%x (0x%x)\n", port, tmp, tmp1);
273                 return -ENODEV;
274         }
275         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x9f);
276         /* initialization */
277         /* Power Management - full on */
278         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
279         if (chip->version > 2) {
280                 /* ymode is bits 4&5 (of 0 to 7) on all but opl3sa2 versions */
281                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, (chip->ymode << 4));
282         } else {
283                 /* default for opl3sa2 versions */
284                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, 0x00);
285         }
286         snd_opl3sa2_write(chip, OPL3SA2_IRQ_CONFIG, 0x0d);      /* Interrupt Channel Configuration - IRQ A = OPL3 + MPU + WSS */
287         if (chip->single_dma) {
288                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x03);      /* DMA Configuration - DMA A = WSS-R + WSS-P */
289         } else {
290                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x21);      /* DMA Configuration - DMA B = WSS-R, DMA A = WSS-P */
291         }
292         snd_opl3sa2_write(chip, OPL3SA2_MISC, 0x80 | (tmp & 7));        /* Miscellaneous - default */
293         if (chip->version > 2) {
294                 snd_opl3sa2_write(chip, OPL3SA3_DGTL_DOWN, 0x00);       /* Digital Block Partial Power Down - default */
295                 snd_opl3sa2_write(chip, OPL3SA3_ANLG_DOWN, 0x00);       /* Analog Block Partial Power Down - default */
296         }
297         return 0;
298 }
299
300 static irqreturn_t snd_opl3sa2_interrupt(int irq, void *dev_id)
301 {
302         unsigned short status;
303         struct snd_card *card = dev_id;
304         struct snd_opl3sa2 *chip;
305         int handled = 0;
306
307         if (card == NULL)
308                 return IRQ_NONE;
309
310         chip = card->private_data;
311         status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);
312
313         if (status & 0x20) {
314                 handled = 1;
315                 snd_opl3_interrupt(chip->synth);
316         }
317
318         if ((status & 0x10) && chip->rmidi != NULL) {
319                 handled = 1;
320                 snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
321         }
322
323         if (status & 0x07) {    /* TI,CI,PI */
324                 handled = 1;
325                 snd_wss_interrupt(irq, chip->wss);
326         }
327
328         if (status & 0x40) { /* hardware volume change */
329                 handled = 1;
330                 /* reading from Master Lch register at 0x07 clears this bit */
331                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
332                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
333                 if (chip->master_switch && chip->master_volume) {
334                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
335                                         &chip->master_switch->id);
336                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
337                                         &chip->master_volume->id);
338                 }
339         }
340         return IRQ_RETVAL(handled);
341 }
342
343 #define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
344 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
345   .info = snd_wss_info_single, \
346   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
347   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
348 #define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
349 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
350   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
351   .name = xname, .index = xindex, \
352   .info = snd_wss_info_single, \
353   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
354   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
355   .tlv = { .p = (xtlv) } }
356
357 static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
358 {
359         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
360         unsigned long flags;
361         int reg = kcontrol->private_value & 0xff;
362         int shift = (kcontrol->private_value >> 8) & 0xff;
363         int mask = (kcontrol->private_value >> 16) & 0xff;
364         int invert = (kcontrol->private_value >> 24) & 0xff;
365
366         spin_lock_irqsave(&chip->reg_lock, flags);
367         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
368         spin_unlock_irqrestore(&chip->reg_lock, flags);
369         if (invert)
370                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
371         return 0;
372 }
373
374 static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
375 {
376         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
377         unsigned long flags;
378         int reg = kcontrol->private_value & 0xff;
379         int shift = (kcontrol->private_value >> 8) & 0xff;
380         int mask = (kcontrol->private_value >> 16) & 0xff;
381         int invert = (kcontrol->private_value >> 24) & 0xff;
382         int change;
383         unsigned short val, oval;
384         
385         val = (ucontrol->value.integer.value[0] & mask);
386         if (invert)
387                 val = mask - val;
388         val <<= shift;
389         spin_lock_irqsave(&chip->reg_lock, flags);
390         oval = chip->ctlregs[reg];
391         val = (oval & ~(mask << shift)) | val;
392         change = val != oval;
393         __snd_opl3sa2_write(chip, reg, val);
394         spin_unlock_irqrestore(&chip->reg_lock, flags);
395         return change;
396 }
397
398 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
399 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
400   .info = snd_wss_info_double, \
401   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
402   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
403 #define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
404 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
405   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
406   .name = xname, .index = xindex, \
407   .info = snd_wss_info_double, \
408   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
409   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
410   .tlv = { .p = (xtlv) } }
411
412 static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
413 {
414         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
415         unsigned long flags;
416         int left_reg = kcontrol->private_value & 0xff;
417         int right_reg = (kcontrol->private_value >> 8) & 0xff;
418         int shift_left = (kcontrol->private_value >> 16) & 0x07;
419         int shift_right = (kcontrol->private_value >> 19) & 0x07;
420         int mask = (kcontrol->private_value >> 24) & 0xff;
421         int invert = (kcontrol->private_value >> 22) & 1;
422         
423         spin_lock_irqsave(&chip->reg_lock, flags);
424         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
425         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
426         spin_unlock_irqrestore(&chip->reg_lock, flags);
427         if (invert) {
428                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
429                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
430         }
431         return 0;
432 }
433
434 static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
435 {
436         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
437         unsigned long flags;
438         int left_reg = kcontrol->private_value & 0xff;
439         int right_reg = (kcontrol->private_value >> 8) & 0xff;
440         int shift_left = (kcontrol->private_value >> 16) & 0x07;
441         int shift_right = (kcontrol->private_value >> 19) & 0x07;
442         int mask = (kcontrol->private_value >> 24) & 0xff;
443         int invert = (kcontrol->private_value >> 22) & 1;
444         int change;
445         unsigned short val1, val2, oval1, oval2;
446         
447         val1 = ucontrol->value.integer.value[0] & mask;
448         val2 = ucontrol->value.integer.value[1] & mask;
449         if (invert) {
450                 val1 = mask - val1;
451                 val2 = mask - val2;
452         }
453         val1 <<= shift_left;
454         val2 <<= shift_right;
455         spin_lock_irqsave(&chip->reg_lock, flags);
456         if (left_reg != right_reg) {
457                 oval1 = chip->ctlregs[left_reg];
458                 oval2 = chip->ctlregs[right_reg];
459                 val1 = (oval1 & ~(mask << shift_left)) | val1;
460                 val2 = (oval2 & ~(mask << shift_right)) | val2;
461                 change = val1 != oval1 || val2 != oval2;
462                 __snd_opl3sa2_write(chip, left_reg, val1);
463                 __snd_opl3sa2_write(chip, right_reg, val2);
464         } else {
465                 oval1 = chip->ctlregs[left_reg];
466                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
467                 change = val1 != oval1;
468                 __snd_opl3sa2_write(chip, left_reg, val1);
469         }
470         spin_unlock_irqrestore(&chip->reg_lock, flags);
471         return change;
472 }
473
474 static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
475 static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);
476
477 static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
478 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
479 OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
480                    db_scale_master),
481 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
482 OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
483                    db_scale_5bit_12db_max),
484 };
485
486 static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
487 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
488 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
489 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
490 };
491
492 static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
493 {
494         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
495         chip->master_switch = NULL;
496         chip->master_volume = NULL;
497 }
498
499 static int __devinit snd_opl3sa2_mixer(struct snd_card *card)
500 {
501         struct snd_opl3sa2 *chip = card->private_data;
502         struct snd_ctl_elem_id id1, id2;
503         struct snd_kcontrol *kctl;
504         unsigned int idx;
505         int err;
506
507         memset(&id1, 0, sizeof(id1));
508         memset(&id2, 0, sizeof(id2));
509         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
510         /* reassign AUX0 to CD */
511         strcpy(id1.name, "Aux Playback Switch");
512         strcpy(id2.name, "CD Playback Switch");
513         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
514                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
515                 return err;
516         }
517         strcpy(id1.name, "Aux Playback Volume");
518         strcpy(id2.name, "CD Playback Volume");
519         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
520                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
521                 return err;
522         }
523         /* reassign AUX1 to FM */
524         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
525         strcpy(id2.name, "FM Playback Switch");
526         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
527                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
528                 return err;
529         }
530         strcpy(id1.name, "Aux Playback Volume");
531         strcpy(id2.name, "FM Playback Volume");
532         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
533                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
534                 return err;
535         }
536         /* add OPL3SA2 controls */
537         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
538                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
539                         return err;
540                 switch (idx) {
541                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
542                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
543                 }
544         }
545         if (chip->version > 2) {
546                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
547                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
548                                 return err;
549         }
550         return 0;
551 }
552
553 /* Power Management support functions */
554 #ifdef CONFIG_PM
555 static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
556 {
557         if (card) {
558                 struct snd_opl3sa2 *chip = card->private_data;
559
560                 snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
561                 chip->wss->suspend(chip->wss);
562                 /* power down */
563                 snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
564         }
565
566         return 0;
567 }
568
569 static int snd_opl3sa2_resume(struct snd_card *card)
570 {
571         struct snd_opl3sa2 *chip;
572         int i;
573
574         if (!card)
575                 return 0;
576
577         chip = card->private_data;
578         /* power up */
579         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
580
581         /* restore registers */
582         for (i = 2; i <= 0x0a; i++) {
583                 if (i != OPL3SA2_IRQ_STATUS)
584                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
585         }
586         if (chip->version > 2) {
587                 for (i = 0x12; i <= 0x16; i++)
588                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
589         }
590         /* restore wss */
591         chip->wss->resume(chip->wss);
592
593         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
594         return 0;
595 }
596 #endif /* CONFIG_PM */
597
598 #ifdef CONFIG_PNP
599 static int __devinit snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
600                                      struct pnp_dev *pdev)
601 {
602         if (pnp_activate_dev(pdev) < 0) {
603                 snd_printk(KERN_ERR "PnP configure failure (out of resources?)\n");
604                 return -EBUSY;
605         }
606         sb_port[dev] = pnp_port_start(pdev, 0);
607         wss_port[dev] = pnp_port_start(pdev, 1);
608         fm_port[dev] = pnp_port_start(pdev, 2);
609         midi_port[dev] = pnp_port_start(pdev, 3);
610         port[dev] = pnp_port_start(pdev, 4);
611         dma1[dev] = pnp_dma(pdev, 0);
612         dma2[dev] = pnp_dma(pdev, 1);
613         irq[dev] = pnp_irq(pdev, 0);
614         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
615                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
616         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
617                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
618         return 0;
619 }
620 #endif /* CONFIG_PNP */
621
622 static void snd_opl3sa2_free(struct snd_card *card)
623 {
624         struct snd_opl3sa2 *chip = card->private_data;
625         if (chip->irq >= 0)
626                 free_irq(chip->irq, card);
627         release_and_free_resource(chip->res_port);
628 }
629
630 static int snd_opl3sa2_card_new(int dev, struct snd_card **cardp)
631 {
632         struct snd_card *card;
633         struct snd_opl3sa2 *chip;
634         int err;
635
636         err = snd_card_create(index[dev], id[dev], THIS_MODULE,
637                               sizeof(struct snd_opl3sa2), &card);
638         if (err < 0)
639                 return err;
640         strcpy(card->driver, "OPL3SA2");
641         strcpy(card->shortname, "Yamaha OPL3-SA");
642         chip = card->private_data;
643         spin_lock_init(&chip->reg_lock);
644         chip->irq = -1;
645         card->private_free = snd_opl3sa2_free;
646         *cardp = card;
647         return 0;
648 }
649
650 static int __devinit snd_opl3sa2_probe(struct snd_card *card, int dev)
651 {
652         int xirq, xdma1, xdma2;
653         struct snd_opl3sa2 *chip;
654         struct snd_wss *wss;
655         struct snd_opl3 *opl3;
656         int err;
657
658         /* initialise this card from supplied (or default) parameter*/ 
659         chip = card->private_data;
660         chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
661         chip->port = port[dev];
662         xirq = irq[dev];
663         xdma1 = dma1[dev];
664         xdma2 = dma2[dev];
665         if (xdma2 < 0)
666                 chip->single_dma = 1;
667         err = snd_opl3sa2_detect(card);
668         if (err < 0)
669                 return err;
670         err = request_irq(xirq, snd_opl3sa2_interrupt, IRQF_DISABLED,
671                           "OPL3-SA2", card);
672         if (err) {
673                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
674                 return -ENODEV;
675         }
676         chip->irq = xirq;
677         err = snd_wss_create(card,
678                              wss_port[dev] + 4, -1,
679                              xirq, xdma1, xdma2,
680                              WSS_HW_OPL3SA2, WSS_HWSHARE_IRQ, &wss);
681         if (err < 0) {
682                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
683                 return err;
684         }
685         chip->wss = wss;
686         err = snd_wss_pcm(wss, 0, NULL);
687         if (err < 0)
688                 return err;
689         err = snd_wss_mixer(wss);
690         if (err < 0)
691                 return err;
692         err = snd_opl3sa2_mixer(card);
693         if (err < 0)
694                 return err;
695         err = snd_wss_timer(wss, 0, NULL);
696         if (err < 0)
697                 return err;
698         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
699                 if ((err = snd_opl3_create(card, fm_port[dev],
700                                            fm_port[dev] + 2,
701                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
702                         return err;
703                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
704                         return err;
705                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
706                         return err;
707         }
708         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
709                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
710                                                midi_port[dev], 0,
711                                                xirq, 0, &chip->rmidi)) < 0)
712                         return err;
713         }
714         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
715                 card->shortname, chip->port, xirq, xdma1);
716         if (xdma2 >= 0)
717                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
718
719         return snd_card_register(card);
720 }
721
722 #ifdef CONFIG_PNP
723 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
724                                             const struct pnp_device_id *id)
725 {
726         static int dev;
727         int err;
728         struct snd_card *card;
729
730         if (pnp_device_is_isapnp(pdev))
731                 return -ENOENT; /* we have another procedure - card */
732         for (; dev < SNDRV_CARDS; dev++) {
733                 if (enable[dev] && isapnp[dev])
734                         break;
735         }
736         if (dev >= SNDRV_CARDS)
737                 return -ENODEV;
738
739         err = snd_opl3sa2_card_new(dev, &card);
740         if (err < 0)
741                 return err;
742         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
743                 snd_card_free(card);
744                 return err;
745         }
746         snd_card_set_dev(card, &pdev->dev);
747         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
748                 snd_card_free(card);
749                 return err;
750         }
751         pnp_set_drvdata(pdev, card);
752         dev++;
753         return 0;
754 }
755
756 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
757 {
758         snd_card_free(pnp_get_drvdata(pdev));
759         pnp_set_drvdata(pdev, NULL);
760 }
761
762 #ifdef CONFIG_PM
763 static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
764 {
765         return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
766 }
767 static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
768 {
769         return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
770 }
771 #endif
772
773 static struct pnp_driver opl3sa2_pnp_driver = {
774         .name = "snd-opl3sa2-pnpbios",
775         .id_table = snd_opl3sa2_pnpbiosids,
776         .probe = snd_opl3sa2_pnp_detect,
777         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
778 #ifdef CONFIG_PM
779         .suspend = snd_opl3sa2_pnp_suspend,
780         .resume = snd_opl3sa2_pnp_resume,
781 #endif
782 };
783
784 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
785                                              const struct pnp_card_device_id *id)
786 {
787         static int dev;
788         struct pnp_dev *pdev;
789         int err;
790         struct snd_card *card;
791
792         pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
793         if (pdev == NULL) {
794                 snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
795                            id->devs[0].id);
796                 return -EBUSY;
797         }
798         for (; dev < SNDRV_CARDS; dev++) {
799                 if (enable[dev] && isapnp[dev])
800                         break;
801         }
802         if (dev >= SNDRV_CARDS)
803                 return -ENODEV;
804
805         err = snd_opl3sa2_card_new(dev, &card);
806         if (err < 0)
807                 return err;
808         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
809                 snd_card_free(card);
810                 return err;
811         }
812         snd_card_set_dev(card, &pdev->dev);
813         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
814                 snd_card_free(card);
815                 return err;
816         }
817         pnp_set_card_drvdata(pcard, card);
818         dev++;
819         return 0;
820 }
821
822 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
823 {
824         snd_card_free(pnp_get_card_drvdata(pcard));
825         pnp_set_card_drvdata(pcard, NULL);
826 }
827
828 #ifdef CONFIG_PM
829 static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
830 {
831         return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
832 }
833 static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
834 {
835         return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
836 }
837 #endif
838
839 static struct pnp_card_driver opl3sa2_pnpc_driver = {
840         .flags = PNP_DRIVER_RES_DISABLE,
841         .name = "snd-opl3sa2-cpnp",
842         .id_table = snd_opl3sa2_pnpids,
843         .probe = snd_opl3sa2_pnp_cdetect,
844         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
845 #ifdef CONFIG_PM
846         .suspend = snd_opl3sa2_pnp_csuspend,
847         .resume = snd_opl3sa2_pnp_cresume,
848 #endif
849 };
850 #endif /* CONFIG_PNP */
851
852 static int __devinit snd_opl3sa2_isa_match(struct device *pdev,
853                                            unsigned int dev)
854 {
855         if (!enable[dev])
856                 return 0;
857 #ifdef CONFIG_PNP
858         if (isapnp[dev])
859                 return 0;
860 #endif
861         if (port[dev] == SNDRV_AUTO_PORT) {
862                 snd_printk(KERN_ERR PFX "specify port\n");
863                 return 0;
864         }
865         if (wss_port[dev] == SNDRV_AUTO_PORT) {
866                 snd_printk(KERN_ERR PFX "specify wss_port\n");
867                 return 0;
868         }
869         if (fm_port[dev] == SNDRV_AUTO_PORT) {
870                 snd_printk(KERN_ERR PFX "specify fm_port\n");
871                 return 0;
872         }
873         if (midi_port[dev] == SNDRV_AUTO_PORT) {
874                 snd_printk(KERN_ERR PFX "specify midi_port\n");
875                 return 0;
876         }
877         return 1;
878 }
879
880 static int __devinit snd_opl3sa2_isa_probe(struct device *pdev,
881                                            unsigned int dev)
882 {
883         struct snd_card *card;
884         int err;
885
886         err = snd_opl3sa2_card_new(dev, &card);
887         if (err < 0)
888                 return err;
889         snd_card_set_dev(card, pdev);
890         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
891                 snd_card_free(card);
892                 return err;
893         }
894         dev_set_drvdata(pdev, card);
895         return 0;
896 }
897
898 static int __devexit snd_opl3sa2_isa_remove(struct device *devptr,
899                                             unsigned int dev)
900 {
901         snd_card_free(dev_get_drvdata(devptr));
902         dev_set_drvdata(devptr, NULL);
903         return 0;
904 }
905
906 #ifdef CONFIG_PM
907 static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
908                                    pm_message_t state)
909 {
910         return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
911 }
912
913 static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
914 {
915         return snd_opl3sa2_resume(dev_get_drvdata(dev));
916 }
917 #endif
918
919 #define DEV_NAME "opl3sa2"
920
921 static struct isa_driver snd_opl3sa2_isa_driver = {
922         .match          = snd_opl3sa2_isa_match,
923         .probe          = snd_opl3sa2_isa_probe,
924         .remove         = __devexit_p(snd_opl3sa2_isa_remove),
925 #ifdef CONFIG_PM
926         .suspend        = snd_opl3sa2_isa_suspend,
927         .resume         = snd_opl3sa2_isa_resume,
928 #endif
929         .driver         = {
930                 .name   = DEV_NAME
931         },
932 };
933
934 static int __init alsa_card_opl3sa2_init(void)
935 {
936         int err;
937
938         err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
939 #ifdef CONFIG_PNP
940         if (!err)
941                 isa_registered = 1;
942
943         err = pnp_register_driver(&opl3sa2_pnp_driver);
944         if (!err)
945                 pnp_registered = 1;
946
947         err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
948         if (!err)
949                 pnpc_registered = 1;
950
951         if (isa_registered || pnp_registered)
952                 err = 0;
953 #endif
954         return err;
955 }
956
957 static void __exit alsa_card_opl3sa2_exit(void)
958 {
959 #ifdef CONFIG_PNP
960         if (pnpc_registered)
961                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
962         if (pnp_registered)
963                 pnp_unregister_driver(&opl3sa2_pnp_driver);
964         if (isa_registered)
965 #endif
966                 isa_unregister_driver(&snd_opl3sa2_isa_driver);
967 }
968
969 module_init(alsa_card_opl3sa2_init)
970 module_exit(alsa_card_opl3sa2_exit)