ALSA: opl3sa2: drop snd_card pointer from the snd_opl3sa2 structure
[linux-2.6] / 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("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_card *card)
225 {
226         struct snd_opl3sa2 *chip = card->private_data;
227         unsigned long port;
228         unsigned char tmp, tmp1;
229         char str[2];
230
231         port = chip->port;
232         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
233                 snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
234                 return -EBUSY;
235         }
236         // snd_printk("REG 0A = 0x%x\n", snd_opl3sa2_read(chip, 0x0a));
237         chip->version = 0;
238         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
239         if (tmp == 0xff) {
240                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
241                 return -ENODEV;
242         }
243         switch (tmp & 0x07) {
244         case 0x01:
245                 chip->version = 2; /* YMF711 */
246                 break;
247         default:
248                 chip->version = 3;
249                 /* 0x02 - standard */
250                 /* 0x03 - YM715B */
251                 /* 0x04 - YM719 - OPL-SA4? */
252                 /* 0x05 - OPL3-SA3 - Libretto 100 */
253                 /* 0x07 - unknown - Neomagic MagicWave 3D */
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_card *card = dev_id;
300         struct snd_opl3sa2 *chip;
301         int handled = 0;
302
303         if (card == NULL || card->private_data == NULL)
304                 return IRQ_NONE;
305
306         chip = card->private_data;
307         status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);
308
309         if (status & 0x20) {
310                 handled = 1;
311                 snd_opl3_interrupt(chip->synth);
312         }
313
314         if ((status & 0x10) && chip->rmidi != NULL) {
315                 handled = 1;
316                 snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
317         }
318
319         if (status & 0x07) {    /* TI,CI,PI */
320                 handled = 1;
321                 snd_wss_interrupt(irq, chip->wss);
322         }
323
324         if (status & 0x40) { /* hardware volume change */
325                 handled = 1;
326                 /* reading from Master Lch register at 0x07 clears this bit */
327                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
328                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
329                 if (chip->master_switch && chip->master_volume) {
330                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
331                                         &chip->master_switch->id);
332                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
333                                         &chip->master_volume->id);
334                 }
335         }
336         return IRQ_RETVAL(handled);
337 }
338
339 #define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
340 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
341   .info = snd_opl3sa2_info_single, \
342   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
343   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
344 #define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
345 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
346   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
347   .name = xname, .index = xindex, \
348   .info = snd_opl3sa2_info_single, \
349   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
350   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
351   .tlv = { .p = (xtlv) } }
352
353 static int snd_opl3sa2_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
354 {
355         int mask = (kcontrol->private_value >> 16) & 0xff;
356
357         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
358         uinfo->count = 1;
359         uinfo->value.integer.min = 0;
360         uinfo->value.integer.max = mask;
361         return 0;
362 }
363
364 static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
365 {
366         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
367         unsigned long flags;
368         int reg = kcontrol->private_value & 0xff;
369         int shift = (kcontrol->private_value >> 8) & 0xff;
370         int mask = (kcontrol->private_value >> 16) & 0xff;
371         int invert = (kcontrol->private_value >> 24) & 0xff;
372
373         spin_lock_irqsave(&chip->reg_lock, flags);
374         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
375         spin_unlock_irqrestore(&chip->reg_lock, flags);
376         if (invert)
377                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
378         return 0;
379 }
380
381 static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
382 {
383         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
384         unsigned long flags;
385         int reg = kcontrol->private_value & 0xff;
386         int shift = (kcontrol->private_value >> 8) & 0xff;
387         int mask = (kcontrol->private_value >> 16) & 0xff;
388         int invert = (kcontrol->private_value >> 24) & 0xff;
389         int change;
390         unsigned short val, oval;
391         
392         val = (ucontrol->value.integer.value[0] & mask);
393         if (invert)
394                 val = mask - val;
395         val <<= shift;
396         spin_lock_irqsave(&chip->reg_lock, flags);
397         oval = chip->ctlregs[reg];
398         val = (oval & ~(mask << shift)) | val;
399         change = val != oval;
400         __snd_opl3sa2_write(chip, reg, val);
401         spin_unlock_irqrestore(&chip->reg_lock, flags);
402         return change;
403 }
404
405 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
406 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
407   .info = snd_opl3sa2_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 #define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
411 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
412   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
413   .name = xname, .index = xindex, \
414   .info = snd_opl3sa2_info_double, \
415   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
416   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
417   .tlv = { .p = (xtlv) } }
418
419 static int snd_opl3sa2_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
420 {
421         int mask = (kcontrol->private_value >> 24) & 0xff;
422
423         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
424         uinfo->count = 2;
425         uinfo->value.integer.min = 0;
426         uinfo->value.integer.max = mask;
427         return 0;
428 }
429
430 static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
431 {
432         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
433         unsigned long flags;
434         int left_reg = kcontrol->private_value & 0xff;
435         int right_reg = (kcontrol->private_value >> 8) & 0xff;
436         int shift_left = (kcontrol->private_value >> 16) & 0x07;
437         int shift_right = (kcontrol->private_value >> 19) & 0x07;
438         int mask = (kcontrol->private_value >> 24) & 0xff;
439         int invert = (kcontrol->private_value >> 22) & 1;
440         
441         spin_lock_irqsave(&chip->reg_lock, flags);
442         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
443         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
444         spin_unlock_irqrestore(&chip->reg_lock, flags);
445         if (invert) {
446                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
447                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
448         }
449         return 0;
450 }
451
452 static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
453 {
454         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
455         unsigned long flags;
456         int left_reg = kcontrol->private_value & 0xff;
457         int right_reg = (kcontrol->private_value >> 8) & 0xff;
458         int shift_left = (kcontrol->private_value >> 16) & 0x07;
459         int shift_right = (kcontrol->private_value >> 19) & 0x07;
460         int mask = (kcontrol->private_value >> 24) & 0xff;
461         int invert = (kcontrol->private_value >> 22) & 1;
462         int change;
463         unsigned short val1, val2, oval1, oval2;
464         
465         val1 = ucontrol->value.integer.value[0] & mask;
466         val2 = ucontrol->value.integer.value[1] & mask;
467         if (invert) {
468                 val1 = mask - val1;
469                 val2 = mask - val2;
470         }
471         val1 <<= shift_left;
472         val2 <<= shift_right;
473         spin_lock_irqsave(&chip->reg_lock, flags);
474         if (left_reg != right_reg) {
475                 oval1 = chip->ctlregs[left_reg];
476                 oval2 = chip->ctlregs[right_reg];
477                 val1 = (oval1 & ~(mask << shift_left)) | val1;
478                 val2 = (oval2 & ~(mask << shift_right)) | val2;
479                 change = val1 != oval1 || val2 != oval2;
480                 __snd_opl3sa2_write(chip, left_reg, val1);
481                 __snd_opl3sa2_write(chip, right_reg, val2);
482         } else {
483                 oval1 = chip->ctlregs[left_reg];
484                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
485                 change = val1 != oval1;
486                 __snd_opl3sa2_write(chip, left_reg, val1);
487         }
488         spin_unlock_irqrestore(&chip->reg_lock, flags);
489         return change;
490 }
491
492 static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
493 static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);
494
495 static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
496 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
497 OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
498                    db_scale_master),
499 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
500 OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
501                    db_scale_5bit_12db_max),
502 };
503
504 static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
505 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
506 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
507 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
508 };
509
510 static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
511 {
512         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
513         chip->master_switch = NULL;
514         chip->master_volume = NULL;
515 }
516
517 static int __devinit snd_opl3sa2_mixer(struct snd_card *card)
518 {
519         struct snd_opl3sa2 *chip = card->private_data;
520         struct snd_ctl_elem_id id1, id2;
521         struct snd_kcontrol *kctl;
522         unsigned int idx;
523         int err;
524
525         memset(&id1, 0, sizeof(id1));
526         memset(&id2, 0, sizeof(id2));
527         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
528         /* reassign AUX0 to CD */
529         strcpy(id1.name, "Aux Playback Switch");
530         strcpy(id2.name, "CD Playback Switch");
531         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
532                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
533                 return err;
534         }
535         strcpy(id1.name, "Aux Playback Volume");
536         strcpy(id2.name, "CD Playback Volume");
537         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
538                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
539                 return err;
540         }
541         /* reassign AUX1 to FM */
542         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
543         strcpy(id2.name, "FM Playback Switch");
544         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
545                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
546                 return err;
547         }
548         strcpy(id1.name, "Aux Playback Volume");
549         strcpy(id2.name, "FM Playback Volume");
550         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
551                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
552                 return err;
553         }
554         /* add OPL3SA2 controls */
555         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
556                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
557                         return err;
558                 switch (idx) {
559                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
560                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
561                 }
562         }
563         if (chip->version > 2) {
564                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
565                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
566                                 return err;
567         }
568         return 0;
569 }
570
571 /* Power Management support functions */
572 #ifdef CONFIG_PM
573 static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
574 {
575         struct snd_opl3sa2 *chip = card->private_data;
576
577         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
578         chip->wss->suspend(chip->wss);
579         /* power down */
580         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
581
582         return 0;
583 }
584
585 static int snd_opl3sa2_resume(struct snd_card *card)
586 {
587         struct snd_opl3sa2 *chip = card->private_data;
588         int i;
589
590         /* power up */
591         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
592
593         /* restore registers */
594         for (i = 2; i <= 0x0a; i++) {
595                 if (i != OPL3SA2_IRQ_STATUS)
596                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
597         }
598         if (chip->version > 2) {
599                 for (i = 0x12; i <= 0x16; i++)
600                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
601         }
602         /* restore wss */
603         chip->wss->resume(chip->wss);
604
605         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
606         return 0;
607 }
608 #endif /* CONFIG_PM */
609
610 #ifdef CONFIG_PNP
611 static int __devinit snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
612                                      struct pnp_dev *pdev)
613 {
614         if (pnp_activate_dev(pdev) < 0) {
615                 snd_printk(KERN_ERR "PnP configure failure (out of resources?)\n");
616                 return -EBUSY;
617         }
618         sb_port[dev] = pnp_port_start(pdev, 0);
619         wss_port[dev] = pnp_port_start(pdev, 1);
620         fm_port[dev] = pnp_port_start(pdev, 2);
621         midi_port[dev] = pnp_port_start(pdev, 3);
622         port[dev] = pnp_port_start(pdev, 4);
623         dma1[dev] = pnp_dma(pdev, 0);
624         dma2[dev] = pnp_dma(pdev, 1);
625         irq[dev] = pnp_irq(pdev, 0);
626         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
627                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
628         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
629                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
630         return 0;
631 }
632 #endif /* CONFIG_PNP */
633
634 static void snd_opl3sa2_free(struct snd_card *card)
635 {
636         struct snd_opl3sa2 *chip = card->private_data;
637         if (chip->irq >= 0)
638                 free_irq(chip->irq, (void *)chip);
639         release_and_free_resource(chip->res_port);
640 }
641
642 static struct snd_card *snd_opl3sa2_card_new(int dev)
643 {
644         struct snd_card *card;
645         struct snd_opl3sa2 *chip;
646
647         card = snd_card_new(index[dev], id[dev], THIS_MODULE, sizeof(struct snd_opl3sa2));
648         if (card == NULL)
649                 return NULL;
650         strcpy(card->driver, "OPL3SA2");
651         strcpy(card->shortname, "Yamaha OPL3-SA2");
652         chip = card->private_data;
653         spin_lock_init(&chip->reg_lock);
654         chip->irq = -1;
655         card->private_free = snd_opl3sa2_free;
656         return card;
657 }
658
659 static int __devinit snd_opl3sa2_probe(struct snd_card *card, int dev)
660 {
661         int xirq, xdma1, xdma2;
662         struct snd_opl3sa2 *chip;
663         struct snd_wss *wss;
664         struct snd_opl3 *opl3;
665         int err;
666
667         /* initialise this card from supplied (or default) parameter*/ 
668         chip = card->private_data;
669         chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
670         chip->port = port[dev];
671         xirq = irq[dev];
672         xdma1 = dma1[dev];
673         xdma2 = dma2[dev];
674         if (xdma2 < 0)
675                 chip->single_dma = 1;
676         err = snd_opl3sa2_detect(card);
677         if (err < 0)
678                 return err;
679         err = request_irq(xirq, snd_opl3sa2_interrupt, IRQF_DISABLED,
680                           "OPL3-SA2", card);
681         if (err) {
682                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
683                 return -ENODEV;
684         }
685         chip->irq = xirq;
686         err = snd_wss_create(card,
687                              wss_port[dev] + 4, -1,
688                              xirq, xdma1, xdma2,
689                              WSS_HW_OPL3SA2, WSS_HWSHARE_IRQ, &wss);
690         if (err < 0) {
691                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
692                 return err;
693         }
694         chip->wss = wss;
695         err = snd_wss_pcm(wss, 0, NULL);
696         if (err < 0)
697                 return err;
698         err = snd_wss_mixer(wss);
699         if (err < 0)
700                 return err;
701         err = snd_opl3sa2_mixer(card);
702         if (err < 0)
703                 return err;
704         err = snd_wss_timer(wss, 0, NULL);
705         if (err < 0)
706                 return err;
707         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
708                 if ((err = snd_opl3_create(card, fm_port[dev],
709                                            fm_port[dev] + 2,
710                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
711                         return err;
712                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
713                         return err;
714                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
715                         return err;
716         }
717         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
718                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
719                                                midi_port[dev], 0,
720                                                xirq, 0, &chip->rmidi)) < 0)
721                         return err;
722         }
723         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
724                 card->shortname, chip->port, xirq, xdma1);
725         if (xdma2 >= 0)
726                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
727
728         return snd_card_register(card);
729 }
730
731 #ifdef CONFIG_PNP
732 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
733                                             const struct pnp_device_id *id)
734 {
735         static int dev;
736         int err;
737         struct snd_card *card;
738
739         if (pnp_device_is_isapnp(pdev))
740                 return -ENOENT; /* we have another procedure - card */
741         for (; dev < SNDRV_CARDS; dev++) {
742                 if (enable[dev] && isapnp[dev])
743                         break;
744         }
745         if (dev >= SNDRV_CARDS)
746                 return -ENODEV;
747
748         card = snd_opl3sa2_card_new(dev);
749         if (! card)
750                 return -ENOMEM;
751         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
752                 snd_card_free(card);
753                 return err;
754         }
755         snd_card_set_dev(card, &pdev->dev);
756         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
757                 snd_card_free(card);
758                 return err;
759         }
760         pnp_set_drvdata(pdev, card);
761         dev++;
762         return 0;
763 }
764
765 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
766 {
767         snd_card_free(pnp_get_drvdata(pdev));
768         pnp_set_drvdata(pdev, NULL);
769 }
770
771 #ifdef CONFIG_PM
772 static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
773 {
774         return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
775 }
776 static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
777 {
778         return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
779 }
780 #endif
781
782 static struct pnp_driver opl3sa2_pnp_driver = {
783         .name = "snd-opl3sa2-pnpbios",
784         .id_table = snd_opl3sa2_pnpbiosids,
785         .probe = snd_opl3sa2_pnp_detect,
786         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
787 #ifdef CONFIG_PM
788         .suspend = snd_opl3sa2_pnp_suspend,
789         .resume = snd_opl3sa2_pnp_resume,
790 #endif
791 };
792
793 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
794                                              const struct pnp_card_device_id *id)
795 {
796         static int dev;
797         struct pnp_dev *pdev;
798         int err;
799         struct snd_card *card;
800
801         pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
802         if (pdev == NULL) {
803                 snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
804                            id->devs[0].id);
805                 return -EBUSY;
806         }
807         for (; dev < SNDRV_CARDS; dev++) {
808                 if (enable[dev] && isapnp[dev])
809                         break;
810         }
811         if (dev >= SNDRV_CARDS)
812                 return -ENODEV;
813
814         card = snd_opl3sa2_card_new(dev);
815         if (! card)
816                 return -ENOMEM;
817         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
818                 snd_card_free(card);
819                 return err;
820         }
821         snd_card_set_dev(card, &pdev->dev);
822         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
823                 snd_card_free(card);
824                 return err;
825         }
826         pnp_set_card_drvdata(pcard, card);
827         dev++;
828         return 0;
829 }
830
831 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
832 {
833         snd_card_free(pnp_get_card_drvdata(pcard));
834         pnp_set_card_drvdata(pcard, NULL);
835 }
836
837 #ifdef CONFIG_PM
838 static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
839 {
840         return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
841 }
842 static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
843 {
844         return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
845 }
846 #endif
847
848 static struct pnp_card_driver opl3sa2_pnpc_driver = {
849         .flags = PNP_DRIVER_RES_DISABLE,
850         .name = "snd-opl3sa2-cpnp",
851         .id_table = snd_opl3sa2_pnpids,
852         .probe = snd_opl3sa2_pnp_cdetect,
853         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
854 #ifdef CONFIG_PM
855         .suspend = snd_opl3sa2_pnp_csuspend,
856         .resume = snd_opl3sa2_pnp_cresume,
857 #endif
858 };
859 #endif /* CONFIG_PNP */
860
861 static int __devinit snd_opl3sa2_isa_match(struct device *pdev,
862                                            unsigned int dev)
863 {
864         if (!enable[dev])
865                 return 0;
866 #ifdef CONFIG_PNP
867         if (isapnp[dev])
868                 return 0;
869 #endif
870         if (port[dev] == SNDRV_AUTO_PORT) {
871                 snd_printk(KERN_ERR PFX "specify port\n");
872                 return 0;
873         }
874         if (wss_port[dev] == SNDRV_AUTO_PORT) {
875                 snd_printk(KERN_ERR PFX "specify wss_port\n");
876                 return 0;
877         }
878         if (fm_port[dev] == SNDRV_AUTO_PORT) {
879                 snd_printk(KERN_ERR PFX "specify fm_port\n");
880                 return 0;
881         }
882         if (midi_port[dev] == SNDRV_AUTO_PORT) {
883                 snd_printk(KERN_ERR PFX "specify midi_port\n");
884                 return 0;
885         }
886         return 1;
887 }
888
889 static int __devinit snd_opl3sa2_isa_probe(struct device *pdev,
890                                            unsigned int dev)
891 {
892         struct snd_card *card;
893         int err;
894
895         card = snd_opl3sa2_card_new(dev);
896         if (! card)
897                 return -ENOMEM;
898         snd_card_set_dev(card, pdev);
899         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
900                 snd_card_free(card);
901                 return err;
902         }
903         dev_set_drvdata(pdev, card);
904         return 0;
905 }
906
907 static int __devexit snd_opl3sa2_isa_remove(struct device *devptr,
908                                             unsigned int dev)
909 {
910         snd_card_free(dev_get_drvdata(devptr));
911         dev_set_drvdata(devptr, NULL);
912         return 0;
913 }
914
915 #ifdef CONFIG_PM
916 static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
917                                    pm_message_t state)
918 {
919         return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
920 }
921
922 static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
923 {
924         return snd_opl3sa2_resume(dev_get_drvdata(dev));
925 }
926 #endif
927
928 #define DEV_NAME "opl3sa2"
929
930 static struct isa_driver snd_opl3sa2_isa_driver = {
931         .match          = snd_opl3sa2_isa_match,
932         .probe          = snd_opl3sa2_isa_probe,
933         .remove         = __devexit_p(snd_opl3sa2_isa_remove),
934 #ifdef CONFIG_PM
935         .suspend        = snd_opl3sa2_isa_suspend,
936         .resume         = snd_opl3sa2_isa_resume,
937 #endif
938         .driver         = {
939                 .name   = DEV_NAME
940         },
941 };
942
943 static int __init alsa_card_opl3sa2_init(void)
944 {
945         int err;
946
947         err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
948 #ifdef CONFIG_PNP
949         if (!err)
950                 isa_registered = 1;
951
952         err = pnp_register_driver(&opl3sa2_pnp_driver);
953         if (!err)
954                 pnp_registered = 1;
955
956         err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
957         if (!err)
958                 pnpc_registered = 1;
959
960         if (isa_registered || pnp_registered)
961                 err = 0;
962 #endif
963         return err;
964 }
965
966 static void __exit alsa_card_opl3sa2_exit(void)
967 {
968 #ifdef CONFIG_PNP
969         if (pnpc_registered)
970                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
971         if (pnp_registered)
972                 pnp_unregister_driver(&opl3sa2_pnp_driver);
973         if (isa_registered)
974 #endif
975                 isa_unregister_driver(&snd_opl3sa2_isa_driver);
976 }
977
978 module_init(alsa_card_opl3sa2_init)
979 module_exit(alsa_card_opl3sa2_exit)