c906e205d7d52943be88e06aeb88301ddc9eeceb
[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 static struct platform_device *platform_devices[SNDRV_CARDS];
94 #ifdef CONFIG_PNP
95 static int pnp_registered;
96 static int pnpc_registered;
97 #endif
98 static unsigned int snd_opl3sa2_devices;
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 __init 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, struct pt_regs *regs)
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, regs);
315         }
316
317         if (status & 0x07) {    /* TI,CI,PI */
318                 handled = 1;
319                 snd_cs4231_interrupt(irq, chip->cs4231, regs);
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
341 static int snd_opl3sa2_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
342 {
343         int mask = (kcontrol->private_value >> 16) & 0xff;
344
345         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
346         uinfo->count = 1;
347         uinfo->value.integer.min = 0;
348         uinfo->value.integer.max = mask;
349         return 0;
350 }
351
352 static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
353 {
354         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
355         unsigned long flags;
356         int reg = kcontrol->private_value & 0xff;
357         int shift = (kcontrol->private_value >> 8) & 0xff;
358         int mask = (kcontrol->private_value >> 16) & 0xff;
359         int invert = (kcontrol->private_value >> 24) & 0xff;
360
361         spin_lock_irqsave(&chip->reg_lock, flags);
362         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
363         spin_unlock_irqrestore(&chip->reg_lock, flags);
364         if (invert)
365                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
366         return 0;
367 }
368
369 static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
370 {
371         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
372         unsigned long flags;
373         int reg = kcontrol->private_value & 0xff;
374         int shift = (kcontrol->private_value >> 8) & 0xff;
375         int mask = (kcontrol->private_value >> 16) & 0xff;
376         int invert = (kcontrol->private_value >> 24) & 0xff;
377         int change;
378         unsigned short val, oval;
379         
380         val = (ucontrol->value.integer.value[0] & mask);
381         if (invert)
382                 val = mask - val;
383         val <<= shift;
384         spin_lock_irqsave(&chip->reg_lock, flags);
385         oval = chip->ctlregs[reg];
386         val = (oval & ~(mask << shift)) | val;
387         change = val != oval;
388         __snd_opl3sa2_write(chip, reg, val);
389         spin_unlock_irqrestore(&chip->reg_lock, flags);
390         return change;
391 }
392
393 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
394 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
395   .info = snd_opl3sa2_info_double, \
396   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
397   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
398
399 static int snd_opl3sa2_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
400 {
401         int mask = (kcontrol->private_value >> 24) & 0xff;
402
403         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
404         uinfo->count = 2;
405         uinfo->value.integer.min = 0;
406         uinfo->value.integer.max = mask;
407         return 0;
408 }
409
410 static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
411 {
412         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
413         unsigned long flags;
414         int left_reg = kcontrol->private_value & 0xff;
415         int right_reg = (kcontrol->private_value >> 8) & 0xff;
416         int shift_left = (kcontrol->private_value >> 16) & 0x07;
417         int shift_right = (kcontrol->private_value >> 19) & 0x07;
418         int mask = (kcontrol->private_value >> 24) & 0xff;
419         int invert = (kcontrol->private_value >> 22) & 1;
420         
421         spin_lock_irqsave(&chip->reg_lock, flags);
422         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
423         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
424         spin_unlock_irqrestore(&chip->reg_lock, flags);
425         if (invert) {
426                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
427                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
428         }
429         return 0;
430 }
431
432 static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
433 {
434         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
435         unsigned long flags;
436         int left_reg = kcontrol->private_value & 0xff;
437         int right_reg = (kcontrol->private_value >> 8) & 0xff;
438         int shift_left = (kcontrol->private_value >> 16) & 0x07;
439         int shift_right = (kcontrol->private_value >> 19) & 0x07;
440         int mask = (kcontrol->private_value >> 24) & 0xff;
441         int invert = (kcontrol->private_value >> 22) & 1;
442         int change;
443         unsigned short val1, val2, oval1, oval2;
444         
445         val1 = ucontrol->value.integer.value[0] & mask;
446         val2 = ucontrol->value.integer.value[1] & mask;
447         if (invert) {
448                 val1 = mask - val1;
449                 val2 = mask - val2;
450         }
451         val1 <<= shift_left;
452         val2 <<= shift_right;
453         spin_lock_irqsave(&chip->reg_lock, flags);
454         if (left_reg != right_reg) {
455                 oval1 = chip->ctlregs[left_reg];
456                 oval2 = chip->ctlregs[right_reg];
457                 val1 = (oval1 & ~(mask << shift_left)) | val1;
458                 val2 = (oval2 & ~(mask << shift_right)) | val2;
459                 change = val1 != oval1 || val2 != oval2;
460                 __snd_opl3sa2_write(chip, left_reg, val1);
461                 __snd_opl3sa2_write(chip, right_reg, val2);
462         } else {
463                 oval1 = chip->ctlregs[left_reg];
464                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
465                 change = val1 != oval1;
466                 __snd_opl3sa2_write(chip, left_reg, val1);
467         }
468         spin_unlock_irqrestore(&chip->reg_lock, flags);
469         return change;
470 }
471
472 static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
473 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
474 OPL3SA2_DOUBLE("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1),
475 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
476 OPL3SA2_SINGLE("Mic Playback Volume", 0, 0x09, 0, 31, 1)
477 };
478
479 static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
480 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
481 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
482 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
483 };
484
485 static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
486 {
487         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
488         chip->master_switch = NULL;
489         chip->master_volume = NULL;
490 }
491
492 static int __init snd_opl3sa2_mixer(struct snd_opl3sa2 *chip)
493 {
494         struct snd_card *card = chip->card;
495         struct snd_ctl_elem_id id1, id2;
496         struct snd_kcontrol *kctl;
497         unsigned int idx;
498         int err;
499
500         memset(&id1, 0, sizeof(id1));
501         memset(&id2, 0, sizeof(id2));
502         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
503         /* reassign AUX0 to CD */
504         strcpy(id1.name, "Aux Playback Switch");
505         strcpy(id2.name, "CD Playback Switch");
506         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
507                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
508                 return err;
509         }
510         strcpy(id1.name, "Aux Playback Volume");
511         strcpy(id2.name, "CD Playback Volume");
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         /* reassign AUX1 to FM */
517         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
518         strcpy(id2.name, "FM Playback Switch");
519         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
520                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
521                 return err;
522         }
523         strcpy(id1.name, "Aux Playback Volume");
524         strcpy(id2.name, "FM Playback Volume");
525         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
526                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
527                 return err;
528         }
529         /* add OPL3SA2 controls */
530         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
531                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
532                         return err;
533                 switch (idx) {
534                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
535                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
536                 }
537         }
538         if (chip->version > 2) {
539                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
540                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
541                                 return err;
542         }
543         return 0;
544 }
545
546 /* Power Management support functions */
547 #ifdef CONFIG_PM
548 static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
549 {
550         struct snd_opl3sa2 *chip = card->private_data;
551
552         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
553         chip->cs4231->suspend(chip->cs4231);
554         /* power down */
555         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
556
557         return 0;
558 }
559
560 static int snd_opl3sa2_resume(struct snd_card *card)
561 {
562         struct snd_opl3sa2 *chip = card->private_data;
563         int i;
564
565         /* power up */
566         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
567
568         /* restore registers */
569         for (i = 2; i <= 0x0a; i++) {
570                 if (i != OPL3SA2_IRQ_STATUS)
571                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
572         }
573         if (chip->version > 2) {
574                 for (i = 0x12; i <= 0x16; i++)
575                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
576         }
577         /* restore cs4231 */
578         chip->cs4231->resume(chip->cs4231);
579
580         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
581         return 0;
582 }
583 #endif /* CONFIG_PM */
584
585 #ifdef CONFIG_PNP
586 static int __init snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
587                                   struct pnp_dev *pdev)
588 {
589         struct pnp_resource_table * cfg;
590         int err;
591
592         cfg = kmalloc(sizeof(struct pnp_resource_table), GFP_KERNEL);
593         if (!cfg) {
594                 snd_printk(KERN_ERR PFX "cannot allocate pnp cfg\n");
595                 return -ENOMEM;
596         }
597         /* PnP initialization */
598         pnp_init_resource_table(cfg);
599         if (sb_port[dev] != SNDRV_AUTO_PORT)
600                 pnp_resource_change(&cfg->port_resource[0], sb_port[dev], 16);
601         if (wss_port[dev] != SNDRV_AUTO_PORT)
602                 pnp_resource_change(&cfg->port_resource[1], wss_port[dev], 8);
603         if (fm_port[dev] != SNDRV_AUTO_PORT)
604                 pnp_resource_change(&cfg->port_resource[2], fm_port[dev], 4);
605         if (midi_port[dev] != SNDRV_AUTO_PORT)
606                 pnp_resource_change(&cfg->port_resource[3], midi_port[dev], 2);
607         if (port[dev] != SNDRV_AUTO_PORT)
608                 pnp_resource_change(&cfg->port_resource[4], port[dev], 2);
609         if (dma1[dev] != SNDRV_AUTO_DMA)
610                 pnp_resource_change(&cfg->dma_resource[0], dma1[dev], 1);
611         if (dma2[dev] != SNDRV_AUTO_DMA)
612                 pnp_resource_change(&cfg->dma_resource[1], dma2[dev], 1);
613         if (irq[dev] != SNDRV_AUTO_IRQ)
614                 pnp_resource_change(&cfg->irq_resource[0], irq[dev], 1);
615         err = pnp_manual_config_dev(pdev, cfg, 0);
616         if (err < 0)
617                 snd_printk(KERN_WARNING "PnP manual resources are invalid, using auto config\n");
618         err = pnp_activate_dev(pdev);
619         if (err < 0) {
620                 kfree(cfg);
621                 snd_printk(KERN_ERR "PnP configure failure (out of resources?) err = %d\n", err);
622                 return -EBUSY;
623         }
624         sb_port[dev] = pnp_port_start(pdev, 0);
625         wss_port[dev] = pnp_port_start(pdev, 1);
626         fm_port[dev] = pnp_port_start(pdev, 2);
627         midi_port[dev] = pnp_port_start(pdev, 3);
628         port[dev] = pnp_port_start(pdev, 4);
629         dma1[dev] = pnp_dma(pdev, 0);
630         dma2[dev] = pnp_dma(pdev, 1);
631         irq[dev] = pnp_irq(pdev, 0);
632         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
633                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
634         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
635                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
636         kfree(cfg);
637         return 0;
638 }
639 #endif /* CONFIG_PNP */
640
641 static void snd_opl3sa2_free(struct snd_card *card)
642 {
643         struct snd_opl3sa2 *chip = card->private_data;
644         if (chip->irq >= 0)
645                 free_irq(chip->irq, (void *)chip);
646         release_and_free_resource(chip->res_port);
647 }
648
649 static struct snd_card *snd_opl3sa2_card_new(int dev)
650 {
651         struct snd_card *card;
652         struct snd_opl3sa2 *chip;
653
654         card = snd_card_new(index[dev], id[dev], THIS_MODULE, sizeof(struct snd_opl3sa2));
655         if (card == NULL)
656                 return NULL;
657         strcpy(card->driver, "OPL3SA2");
658         strcpy(card->shortname, "Yamaha OPL3-SA2");
659         chip = card->private_data;
660         spin_lock_init(&chip->reg_lock);
661         chip->irq = -1;
662         chip->card = card;
663         card->private_free = snd_opl3sa2_free;
664         return card;
665 }
666
667 static int __devinit snd_opl3sa2_probe(struct snd_card *card, int dev)
668 {
669         int xirq, xdma1, xdma2;
670         struct snd_opl3sa2 *chip;
671         struct snd_cs4231 *cs4231;
672         struct snd_opl3 *opl3;
673         int err;
674
675         /* initialise this card from supplied (or default) parameter*/ 
676         chip = card->private_data;
677         chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
678         chip->port = port[dev];
679         xirq = irq[dev];
680         xdma1 = dma1[dev];
681         xdma2 = dma2[dev];
682         if (xdma2 < 0)
683                 chip->single_dma = 1;
684         if ((err = snd_opl3sa2_detect(chip)) < 0)
685                 return err;
686         if (request_irq(xirq, snd_opl3sa2_interrupt, SA_INTERRUPT, "OPL3-SA2", chip)) {
687                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
688                 return -ENODEV;
689         }
690         chip->irq = xirq;
691         if ((err = snd_cs4231_create(card,
692                                      wss_port[dev] + 4, -1,
693                                      xirq, xdma1, xdma2,
694                                      CS4231_HW_OPL3SA2,
695                                      CS4231_HWSHARE_IRQ,
696                                      &cs4231)) < 0) {
697                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
698                 return err;
699         }
700         chip->cs4231 = cs4231;
701         if ((err = snd_cs4231_pcm(cs4231, 0, NULL)) < 0)
702                 return err;
703         if ((err = snd_cs4231_mixer(cs4231)) < 0)
704                 return err;
705         if ((err = snd_opl3sa2_mixer(chip)) < 0)
706                 return err;
707         if ((err = snd_cs4231_timer(cs4231, 0, NULL)) < 0)
708                 return err;
709         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
710                 if ((err = snd_opl3_create(card, fm_port[dev],
711                                            fm_port[dev] + 2,
712                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
713                         return err;
714                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
715                         return err;
716                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
717                         return err;
718         }
719         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
720                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
721                                                midi_port[dev], 0,
722                                                xirq, 0, &chip->rmidi)) < 0)
723                         return err;
724         }
725         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
726                 card->shortname, chip->port, xirq, xdma1);
727         if (xdma2 >= 0)
728                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
729
730         return snd_card_register(card);
731 }
732
733 #ifdef CONFIG_PNP
734 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
735                                             const struct pnp_device_id *id)
736 {
737         static int dev;
738         int err;
739         struct snd_card *card;
740
741         if (pnp_device_is_isapnp(pdev))
742                 return -ENOENT; /* we have another procedure - card */
743         for (; dev < SNDRV_CARDS; dev++) {
744                 if (enable[dev] && isapnp[dev])
745                         break;
746         }
747         if (dev >= SNDRV_CARDS)
748                 return -ENODEV;
749
750         card = snd_opl3sa2_card_new(dev);
751         if (! card)
752                 return -ENOMEM;
753         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
754                 snd_card_free(card);
755                 return err;
756         }
757         snd_card_set_dev(card, &pdev->dev);
758         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
759                 snd_card_free(card);
760                 return err;
761         }
762         pnp_set_drvdata(pdev, card);
763         dev++;
764         snd_opl3sa2_devices++;
765         return 0;
766 }
767
768 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
769 {
770         snd_card_free(pnp_get_drvdata(pdev));
771         pnp_set_drvdata(pdev, NULL);
772 }
773
774 #ifdef CONFIG_PM
775 static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
776 {
777         return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
778 }
779 static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
780 {
781         return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
782 }
783 #endif
784
785 static struct pnp_driver opl3sa2_pnp_driver = {
786         .name = "snd-opl3sa2-pnpbios",
787         .id_table = snd_opl3sa2_pnpbiosids,
788         .probe = snd_opl3sa2_pnp_detect,
789         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
790 #ifdef CONFIG_PM
791         .suspend = snd_opl3sa2_pnp_suspend,
792         .resume = snd_opl3sa2_pnp_resume,
793 #endif
794 };
795
796 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
797                                              const struct pnp_card_device_id *id)
798 {
799         static int dev;
800         struct pnp_dev *pdev;
801         int err;
802         struct snd_card *card;
803
804         pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
805         if (pdev == NULL) {
806                 snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
807                            id->devs[0].id);
808                 return -EBUSY;
809         }
810         for (; dev < SNDRV_CARDS; dev++) {
811                 if (enable[dev] && isapnp[dev])
812                         break;
813         }
814         if (dev >= SNDRV_CARDS)
815                 return -ENODEV;
816
817         card = snd_opl3sa2_card_new(dev);
818         if (! card)
819                 return -ENOMEM;
820         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
821                 snd_card_free(card);
822                 return err;
823         }
824         snd_card_set_dev(card, &pdev->dev);
825         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
826                 snd_card_free(card);
827                 return err;
828         }
829         pnp_set_card_drvdata(pcard, card);
830         dev++;
831         snd_opl3sa2_devices++;
832         return 0;
833 }
834
835 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
836 {
837         snd_card_free(pnp_get_card_drvdata(pcard));
838         pnp_set_card_drvdata(pcard, NULL);
839 }
840
841 #ifdef CONFIG_PM
842 static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
843 {
844         return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
845 }
846 static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
847 {
848         return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
849 }
850 #endif
851
852 static struct pnp_card_driver opl3sa2_pnpc_driver = {
853         .flags = PNP_DRIVER_RES_DISABLE,
854         .name = "snd-opl3sa2-cpnp",
855         .id_table = snd_opl3sa2_pnpids,
856         .probe = snd_opl3sa2_pnp_cdetect,
857         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
858 #ifdef CONFIG_PM
859         .suspend = snd_opl3sa2_pnp_csuspend,
860         .resume = snd_opl3sa2_pnp_cresume,
861 #endif
862 };
863 #endif /* CONFIG_PNP */
864
865 static int __init snd_opl3sa2_nonpnp_probe(struct platform_device *pdev)
866 {
867         struct snd_card *card;
868         int err;
869         int dev = pdev->id;
870
871         if (port[dev] == SNDRV_AUTO_PORT) {
872                 snd_printk(KERN_ERR PFX "specify port\n");
873                 return -EINVAL;
874         }
875         if (wss_port[dev] == SNDRV_AUTO_PORT) {
876                 snd_printk(KERN_ERR PFX "specify wss_port\n");
877                 return -EINVAL;
878         }
879         if (fm_port[dev] == SNDRV_AUTO_PORT) {
880                 snd_printk(KERN_ERR PFX "specify fm_port\n");
881                 return -EINVAL;
882         }
883         if (midi_port[dev] == SNDRV_AUTO_PORT) {
884                 snd_printk(KERN_ERR PFX "specify midi_port\n");
885                 return -EINVAL;
886         }
887
888         card = snd_opl3sa2_card_new(dev);
889         if (! card)
890                 return -ENOMEM;
891         snd_card_set_dev(card, &pdev->dev);
892         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
893                 snd_card_free(card);
894                 return err;
895         }
896         platform_set_drvdata(pdev, card);
897         return 0;
898 }
899
900 static int snd_opl3sa2_nonpnp_remove(struct platform_device *devptr)
901 {
902         snd_card_free(platform_get_drvdata(devptr));
903         platform_set_drvdata(devptr, NULL);
904         return 0;
905 }
906
907 #ifdef CONFIG_PM
908 static int snd_opl3sa2_nonpnp_suspend(struct platform_device *dev, pm_message_t state)
909 {
910         return snd_opl3sa2_suspend(platform_get_drvdata(dev), state);
911 }
912
913 static int snd_opl3sa2_nonpnp_resume(struct platform_device *dev)
914 {
915         return snd_opl3sa2_resume(platform_get_drvdata(dev));
916 }
917 #endif
918
919 #define OPL3SA2_DRIVER  "snd_opl3sa2"
920
921 static struct platform_driver snd_opl3sa2_nonpnp_driver = {
922         .probe          = snd_opl3sa2_nonpnp_probe,
923         .remove         = snd_opl3sa2_nonpnp_remove,
924 #ifdef CONFIG_PM
925         .suspend        = snd_opl3sa2_nonpnp_suspend,
926         .resume         = snd_opl3sa2_nonpnp_resume,
927 #endif
928         .driver         = {
929                 .name   = OPL3SA2_DRIVER
930         },
931 };
932
933 static void __init_or_module snd_opl3sa2_unregister_all(void)
934 {
935         int i;
936
937 #ifdef CONFIG_PNP
938         if (pnpc_registered)
939                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
940         if (pnp_registered)
941                 pnp_unregister_driver(&opl3sa2_pnp_driver);
942 #endif
943         for (i = 0; i < ARRAY_SIZE(platform_devices); ++i)
944                 platform_device_unregister(platform_devices[i]);
945         platform_driver_unregister(&snd_opl3sa2_nonpnp_driver);
946 }
947
948 static int __init alsa_card_opl3sa2_init(void)
949 {
950         int i, err;
951
952         if ((err = platform_driver_register(&snd_opl3sa2_nonpnp_driver)) < 0)
953                 return err;
954
955         for (i = 0; i < SNDRV_CARDS; i++) {
956                 struct platform_device *device;
957                 if (! enable[i])
958                         continue;
959 #ifdef CONFIG_PNP
960                 if (isapnp[i])
961                         continue;
962 #endif
963                 device = platform_device_register_simple(OPL3SA2_DRIVER,
964                                                          i, NULL, 0);
965                 if (IS_ERR(device)) {
966                         err = PTR_ERR(device);
967                         goto errout;
968                 }
969                 platform_devices[i] = device;
970                 snd_opl3sa2_devices++;
971         }
972
973 #ifdef CONFIG_PNP
974         err = pnp_register_driver(&opl3sa2_pnp_driver);
975         if (!err)
976                 pnp_registered = 1;
977         err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
978         if (!err)
979                 pnpc_registered = 1;
980 #endif
981
982         if (!snd_opl3sa2_devices) {
983 #ifdef MODULE
984                 snd_printk(KERN_ERR "Yamaha OPL3-SA soundcard not found or device busy\n");
985 #endif
986                 err = -ENODEV;
987                 goto errout;
988         }
989         return 0;
990
991  errout:
992         snd_opl3sa2_unregister_all();
993         return err;
994 }
995
996 static void __exit alsa_card_opl3sa2_exit(void)
997 {
998         snd_opl3sa2_unregister_all();
999 }
1000
1001 module_init(alsa_card_opl3sa2_init)
1002 module_exit(alsa_card_opl3sa2_exit)