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