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