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