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