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