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/module.h>
29#include <linux/io.h>
30#include <sound/core.h>
31#include <sound/wss.h>
32#include <sound/mpu401.h>
33#include <sound/opl3.h>
34#include <sound/initval.h>
35#include <sound/tlv.h>
36
37MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
38MODULE_DESCRIPTION("Yamaha OPL3SA2+");
39MODULE_LICENSE("GPL");
40MODULE_SUPPORTED_DEVICE("{{Yamaha,YMF719E-S},"
41		"{Genius,Sound Maker 3DX},"
42		"{Yamaha,OPL3SA3},"
43		"{Intel,AL440LX sound},"
44	        "{NeoMagic,MagicWave 3DX}}");
45
46static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
47static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
48static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
49#ifdef CONFIG_PNP
50static bool isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
51#endif
52static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0xf86,0x370,0x100 */
53static long sb_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0x220,0x240,0x260 */
54static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x530,0xe80,0xf40,0x604 */
55static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0x388 */
56static long midi_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x330,0x300 */
57static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 0,1,3,5,9,11,12,15 */
58static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
59static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
60static int opl3sa3_ymode[SNDRV_CARDS];   /* 0,1,2,3 */ /*SL Added*/
61
62module_param_array(index, int, NULL, 0444);
63MODULE_PARM_DESC(index, "Index value for OPL3-SA soundcard.");
64module_param_array(id, charp, NULL, 0444);
65MODULE_PARM_DESC(id, "ID string for OPL3-SA soundcard.");
66module_param_array(enable, bool, NULL, 0444);
67MODULE_PARM_DESC(enable, "Enable OPL3-SA soundcard.");
68#ifdef CONFIG_PNP
69module_param_array(isapnp, bool, NULL, 0444);
70MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
71#endif
72module_param_array(port, long, NULL, 0444);
73MODULE_PARM_DESC(port, "Port # for OPL3-SA driver.");
74module_param_array(sb_port, long, NULL, 0444);
75MODULE_PARM_DESC(sb_port, "SB port # for OPL3-SA driver.");
76module_param_array(wss_port, long, NULL, 0444);
77MODULE_PARM_DESC(wss_port, "WSS port # for OPL3-SA driver.");
78module_param_array(fm_port, long, NULL, 0444);
79MODULE_PARM_DESC(fm_port, "FM port # for OPL3-SA driver.");
80module_param_array(midi_port, long, NULL, 0444);
81MODULE_PARM_DESC(midi_port, "MIDI port # for OPL3-SA driver.");
82module_param_array(irq, int, NULL, 0444);
83MODULE_PARM_DESC(irq, "IRQ # for OPL3-SA driver.");
84module_param_array(dma1, int, NULL, 0444);
85MODULE_PARM_DESC(dma1, "DMA1 # for OPL3-SA driver.");
86module_param_array(dma2, int, NULL, 0444);
87MODULE_PARM_DESC(dma2, "DMA2 # for OPL3-SA driver.");
88module_param_array(opl3sa3_ymode, int, NULL, 0444);
89MODULE_PARM_DESC(opl3sa3_ymode, "Speaker size selection for 3D Enhancement mode: Desktop/Large Notebook/Small Notebook/HiFi.");
90
91#ifdef CONFIG_PNP
92static int isa_registered;
93static int pnp_registered;
94static int pnpc_registered;
95#endif
96
97/* control ports */
98#define OPL3SA2_PM_CTRL		0x01
99#define OPL3SA2_SYS_CTRL		0x02
100#define OPL3SA2_IRQ_CONFIG	0x03
101#define OPL3SA2_IRQ_STATUS	0x04
102#define OPL3SA2_DMA_CONFIG	0x06
103#define OPL3SA2_MASTER_LEFT	0x07
104#define OPL3SA2_MASTER_RIGHT	0x08
105#define OPL3SA2_MIC		0x09
106#define OPL3SA2_MISC		0x0A
107
108/* opl3sa3 only */
109#define OPL3SA3_DGTL_DOWN	0x12
110#define OPL3SA3_ANLG_DOWN	0x13
111#define OPL3SA3_WIDE		0x14
112#define OPL3SA3_BASS		0x15
113#define OPL3SA3_TREBLE		0x16
114
115/* power management bits */
116#define OPL3SA2_PM_ADOWN		0x20
117#define OPL3SA2_PM_PSV		0x04
118#define OPL3SA2_PM_PDN		0x02
119#define OPL3SA2_PM_PDX		0x01
120
121#define OPL3SA2_PM_D0	0x00
122#define OPL3SA2_PM_D3	(OPL3SA2_PM_ADOWN|OPL3SA2_PM_PSV|OPL3SA2_PM_PDN|OPL3SA2_PM_PDX)
123
124struct snd_opl3sa2 {
125	int version;		/* 2 or 3 */
126	unsigned long port;	/* control port */
127	struct resource *res_port; /* control port resource */
128	int irq;
129	int single_dma;
130	spinlock_t reg_lock;
131	struct snd_hwdep *synth;
132	struct snd_rawmidi *rmidi;
133	struct snd_wss *wss;
134	unsigned char ctlregs[0x20];
135	int ymode;		/* SL added */
136	struct snd_kcontrol *master_switch;
137	struct snd_kcontrol *master_volume;
138};
139
140#define PFX	"opl3sa2: "
141
142#ifdef CONFIG_PNP
143
144static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
145	{ .id = "YMH0021" },
146	{ .id = "NMX2210" },	/* Gateway Solo 2500 */
147	{ .id = "" }		/* end */
148};
149
150MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
151
152static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
153	/* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
154	{ .id = "YMH0020", .devs = { { "YMH0021" } } },
155	/* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
156	{ .id = "YMH0030", .devs = { { "YMH0021" } } },
157	/* Yamaha OPL3-SA2 */
158	{ .id = "YMH0800", .devs = { { "YMH0021" } } },
159	/* Yamaha OPL3-SA2 */
160	{ .id = "YMH0801", .devs = { { "YMH0021" } } },
161	/* NeoMagic MagicWave 3DX */
162	{ .id = "NMX2200", .devs = { { "YMH2210" } } },
163	/* NeoMagic MagicWave 3D */
164	{ .id = "NMX2200", .devs = { { "NMX2210" } } },
165	/* --- */
166	{ .id = "" }	/* end */
167};
168
169MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);
170
171#endif /* CONFIG_PNP */
172
173
174/* read control port (w/o spinlock) */
175static unsigned char __snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
176{
177	unsigned char result;
178#if 0
179	outb(0x1d, port);	/* password */
180	printk(KERN_DEBUG "read [0x%lx] = 0x%x\n", port, inb(port));
181#endif
182	outb(reg, chip->port);	/* register */
183	result = inb(chip->port + 1);
184#if 0
185	printk(KERN_DEBUG "read [0x%lx] = 0x%x [0x%x]\n",
186	       port, result, inb(port));
187#endif
188	return result;
189}
190
191/* read control port (with spinlock) */
192static 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) */
204static 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) */
215static 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
223static int snd_opl3sa2_detect(struct snd_card *card)
224{
225	struct snd_opl3sa2 *chip = card->private_data;
226	unsigned long port;
227	unsigned char tmp, tmp1;
228	char str[2];
229
230	port = chip->port;
231	if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
232		snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
233		return -EBUSY;
234	}
235	/*
236	snd_printk(KERN_DEBUG "REG 0A = 0x%x\n",
237		   snd_opl3sa2_read(chip, 0x0a));
238	*/
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;
244	}
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		/* 0x07 - unknown - Neomagic MagicWave 3D */
256		break;
257	}
258	str[0] = chip->version + '0';
259	str[1] = 0;
260	strcat(card->shortname, str);
261	snd_opl3sa2_write(chip, OPL3SA2_MISC, tmp ^ 7);
262	if ((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MISC)) != tmp) {
263		snd_printd("OPL3-SA [0x%lx] detect (1) = 0x%x (0x%x)\n", port, tmp, tmp1);
264		return -ENODEV;
265	}
266	/* try if the MIC register is accessible */
267	tmp = snd_opl3sa2_read(chip, OPL3SA2_MIC);
268	snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x8a);
269	if (((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MIC)) & 0x9f) != 0x8a) {
270		snd_printd("OPL3-SA [0x%lx] detect (2) = 0x%x (0x%x)\n", port, tmp, tmp1);
271		return -ENODEV;
272	}
273	snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x9f);
274	/* initialization */
275	/* Power Management - full on */
276	snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
277	if (chip->version > 2) {
278		/* ymode is bits 4&5 (of 0 to 7) on all but opl3sa2 versions */
279		snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, (chip->ymode << 4));
280	} else {
281		/* default for opl3sa2 versions */
282		snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, 0x00);
283	}
284	snd_opl3sa2_write(chip, OPL3SA2_IRQ_CONFIG, 0x0d);	/* Interrupt Channel Configuration - IRQ A = OPL3 + MPU + WSS */
285	if (chip->single_dma) {
286		snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x03);	/* DMA Configuration - DMA A = WSS-R + WSS-P */
287	} else {
288		snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x21);	/* DMA Configuration - DMA B = WSS-R, DMA A = WSS-P */
289	}
290	snd_opl3sa2_write(chip, OPL3SA2_MISC, 0x80 | (tmp & 7));	/* Miscellaneous - default */
291	if (chip->version > 2) {
292		snd_opl3sa2_write(chip, OPL3SA3_DGTL_DOWN, 0x00);	/* Digital Block Partial Power Down - default */
293		snd_opl3sa2_write(chip, OPL3SA3_ANLG_DOWN, 0x00);	/* Analog Block Partial Power Down - default */
294	}
295	return 0;
296}
297
298static irqreturn_t snd_opl3sa2_interrupt(int irq, void *dev_id)
299{
300	unsigned short status;
301	struct snd_card *card = dev_id;
302	struct snd_opl3sa2 *chip;
303	int handled = 0;
304
305	if (card == NULL)
306		return IRQ_NONE;
307
308	chip = card->private_data;
309	status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);
310
311	if (status & 0x20) {
312		handled = 1;
313		snd_opl3_interrupt(chip->synth);
314	}
315
316	if ((status & 0x10) && chip->rmidi != NULL) {
317		handled = 1;
318		snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
319	}
320
321	if (status & 0x07) {	/* TI,CI,PI */
322		handled = 1;
323		snd_wss_interrupt(irq, chip->wss);
324	}
325
326	if (status & 0x40) { /* hardware volume change */
327		handled = 1;
328		/* reading from Master Lch register at 0x07 clears this bit */
329		snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
330		snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
331		if (chip->master_switch && chip->master_volume) {
332			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
333					&chip->master_switch->id);
334			snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
335					&chip->master_volume->id);
336		}
337	}
338	return IRQ_RETVAL(handled);
339}
340
341#define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
342{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
343  .info = snd_wss_info_single, \
344  .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
345  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
346#define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
347{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
348  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
349  .name = xname, .index = xindex, \
350  .info = snd_wss_info_single, \
351  .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
352  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
353  .tlv = { .p = (xtlv) } }
354
355static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
356{
357	struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
358	unsigned long flags;
359	int reg = kcontrol->private_value & 0xff;
360	int shift = (kcontrol->private_value >> 8) & 0xff;
361	int mask = (kcontrol->private_value >> 16) & 0xff;
362	int invert = (kcontrol->private_value >> 24) & 0xff;
363
364	spin_lock_irqsave(&chip->reg_lock, flags);
365	ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
366	spin_unlock_irqrestore(&chip->reg_lock, flags);
367	if (invert)
368		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
369	return 0;
370}
371
372static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
373{
374	struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
375	unsigned long flags;
376	int reg = kcontrol->private_value & 0xff;
377	int shift = (kcontrol->private_value >> 8) & 0xff;
378	int mask = (kcontrol->private_value >> 16) & 0xff;
379	int invert = (kcontrol->private_value >> 24) & 0xff;
380	int change;
381	unsigned short val, oval;
382
383	val = (ucontrol->value.integer.value[0] & mask);
384	if (invert)
385		val = mask - val;
386	val <<= shift;
387	spin_lock_irqsave(&chip->reg_lock, flags);
388	oval = chip->ctlregs[reg];
389	val = (oval & ~(mask << shift)) | val;
390	change = val != oval;
391	__snd_opl3sa2_write(chip, reg, val);
392	spin_unlock_irqrestore(&chip->reg_lock, flags);
393	return change;
394}
395
396#define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
397{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
398  .info = snd_wss_info_double, \
399  .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
400  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
401#define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
402{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
403  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
404  .name = xname, .index = xindex, \
405  .info = snd_wss_info_double, \
406  .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
407  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
408  .tlv = { .p = (xtlv) } }
409
410static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
411{
412	struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
413	unsigned long flags;
414	int left_reg = kcontrol->private_value & 0xff;
415	int right_reg = (kcontrol->private_value >> 8) & 0xff;
416	int shift_left = (kcontrol->private_value >> 16) & 0x07;
417	int shift_right = (kcontrol->private_value >> 19) & 0x07;
418	int mask = (kcontrol->private_value >> 24) & 0xff;
419	int invert = (kcontrol->private_value >> 22) & 1;
420
421	spin_lock_irqsave(&chip->reg_lock, flags);
422	ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
423	ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
424	spin_unlock_irqrestore(&chip->reg_lock, flags);
425	if (invert) {
426		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
427		ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
428	}
429	return 0;
430}
431
432static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
433{
434	struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
435	unsigned long flags;
436	int left_reg = kcontrol->private_value & 0xff;
437	int right_reg = (kcontrol->private_value >> 8) & 0xff;
438	int shift_left = (kcontrol->private_value >> 16) & 0x07;
439	int shift_right = (kcontrol->private_value >> 19) & 0x07;
440	int mask = (kcontrol->private_value >> 24) & 0xff;
441	int invert = (kcontrol->private_value >> 22) & 1;
442	int change;
443	unsigned short val1, val2, oval1, oval2;
444
445	val1 = ucontrol->value.integer.value[0] & mask;
446	val2 = ucontrol->value.integer.value[1] & mask;
447	if (invert) {
448		val1 = mask - val1;
449		val2 = mask - val2;
450	}
451	val1 <<= shift_left;
452	val2 <<= shift_right;
453	spin_lock_irqsave(&chip->reg_lock, flags);
454	if (left_reg != right_reg) {
455		oval1 = chip->ctlregs[left_reg];
456		oval2 = chip->ctlregs[right_reg];
457		val1 = (oval1 & ~(mask << shift_left)) | val1;
458		val2 = (oval2 & ~(mask << shift_right)) | val2;
459		change = val1 != oval1 || val2 != oval2;
460		__snd_opl3sa2_write(chip, left_reg, val1);
461		__snd_opl3sa2_write(chip, right_reg, val2);
462	} else {
463		oval1 = chip->ctlregs[left_reg];
464		val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
465		change = val1 != oval1;
466		__snd_opl3sa2_write(chip, left_reg, val1);
467	}
468	spin_unlock_irqrestore(&chip->reg_lock, flags);
469	return change;
470}
471
472static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
473static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);
474
475static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
476OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
477OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
478		   db_scale_master),
479OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
480OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
481		   db_scale_5bit_12db_max),
482OPL3SA2_SINGLE("ZV Port Switch", 0, 0x02, 0, 1, 0),
483};
484
485static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
486OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
487OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
488OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
489};
490
491static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
492{
493	struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
494	chip->master_switch = NULL;
495	chip->master_volume = NULL;
496}
497
498static int snd_opl3sa2_mixer(struct snd_card *card)
499{
500	struct snd_opl3sa2 *chip = card->private_data;
501	struct snd_ctl_elem_id id1, id2;
502	struct snd_kcontrol *kctl;
503	unsigned int idx;
504	int err;
505
506	memset(&id1, 0, sizeof(id1));
507	memset(&id2, 0, sizeof(id2));
508	id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
509	/* reassign AUX0 to CD */
510        strcpy(id1.name, "Aux Playback Switch");
511        strcpy(id2.name, "CD Playback Switch");
512        if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
513		snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
514                return err;
515	}
516        strcpy(id1.name, "Aux Playback Volume");
517        strcpy(id2.name, "CD Playback Volume");
518        if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
519		snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
520                return err;
521	}
522	/* reassign AUX1 to FM */
523        strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
524        strcpy(id2.name, "FM Playback Switch");
525        if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
526		snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
527                return err;
528	}
529        strcpy(id1.name, "Aux Playback Volume");
530        strcpy(id2.name, "FM Playback Volume");
531        if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
532		snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
533                return err;
534	}
535	/* add OPL3SA2 controls */
536	for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
537		if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
538			return err;
539		switch (idx) {
540		case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
541		case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
542		}
543	}
544	if (chip->version > 2) {
545		for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
546			if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
547				return err;
548	}
549	return 0;
550}
551
552/* Power Management support functions */
553#ifdef CONFIG_PM
554static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
555{
556	if (card) {
557		struct snd_opl3sa2 *chip = card->private_data;
558
559		snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
560		chip->wss->suspend(chip->wss);
561		/* power down */
562		snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
563	}
564
565	return 0;
566}
567
568static int snd_opl3sa2_resume(struct snd_card *card)
569{
570	struct snd_opl3sa2 *chip;
571	int i;
572
573	if (!card)
574		return 0;
575
576	chip = card->private_data;
577	/* power up */
578	snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
579
580	/* restore registers */
581	for (i = 2; i <= 0x0a; i++) {
582		if (i != OPL3SA2_IRQ_STATUS)
583			snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
584	}
585	if (chip->version > 2) {
586		for (i = 0x12; i <= 0x16; i++)
587			snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
588	}
589	/* restore wss */
590	chip->wss->resume(chip->wss);
591
592	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
593	return 0;
594}
595#endif /* CONFIG_PM */
596
597#ifdef CONFIG_PNP
598static int snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
599			   struct pnp_dev *pdev)
600{
601	if (pnp_activate_dev(pdev) < 0) {
602		snd_printk(KERN_ERR "PnP configure failure (out of resources?)\n");
603		return -EBUSY;
604	}
605	sb_port[dev] = pnp_port_start(pdev, 0);
606	wss_port[dev] = pnp_port_start(pdev, 1);
607	fm_port[dev] = pnp_port_start(pdev, 2);
608	midi_port[dev] = pnp_port_start(pdev, 3);
609	port[dev] = pnp_port_start(pdev, 4);
610	dma1[dev] = pnp_dma(pdev, 0);
611	dma2[dev] = pnp_dma(pdev, 1);
612	irq[dev] = pnp_irq(pdev, 0);
613	snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
614		pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
615	snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
616		pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
617	return 0;
618}
619#endif /* CONFIG_PNP */
620
621static void snd_opl3sa2_free(struct snd_card *card)
622{
623	struct snd_opl3sa2 *chip = card->private_data;
624	if (chip->irq >= 0)
625		free_irq(chip->irq, card);
626	release_and_free_resource(chip->res_port);
627}
628
629static int snd_opl3sa2_card_new(struct device *pdev, int dev,
630				struct snd_card **cardp)
631{
632	struct snd_card *card;
633	struct snd_opl3sa2 *chip;
634	int err;
635
636	err = snd_card_new(pdev, 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
650static int 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, 0,
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);
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);
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
724static int 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(&pdev->dev, 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	if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
748		snd_card_free(card);
749		return err;
750	}
751	pnp_set_drvdata(pdev, card);
752	dev++;
753	return 0;
754}
755
756static void snd_opl3sa2_pnp_remove(struct pnp_dev *pdev)
757{
758	snd_card_free(pnp_get_drvdata(pdev));
759}
760
761#ifdef CONFIG_PM
762static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
763{
764	return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
765}
766static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
767{
768	return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
769}
770#endif
771
772static struct pnp_driver opl3sa2_pnp_driver = {
773	.name = "snd-opl3sa2-pnpbios",
774	.id_table = snd_opl3sa2_pnpbiosids,
775	.probe = snd_opl3sa2_pnp_detect,
776	.remove = snd_opl3sa2_pnp_remove,
777#ifdef CONFIG_PM
778	.suspend = snd_opl3sa2_pnp_suspend,
779	.resume = snd_opl3sa2_pnp_resume,
780#endif
781};
782
783static int snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
784				   const struct pnp_card_device_id *id)
785{
786	static int dev;
787	struct pnp_dev *pdev;
788	int err;
789	struct snd_card *card;
790
791	pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
792	if (pdev == NULL) {
793		snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
794			   id->devs[0].id);
795		return -EBUSY;
796	}
797	for (; dev < SNDRV_CARDS; dev++) {
798		if (enable[dev] && isapnp[dev])
799			break;
800	}
801	if (dev >= SNDRV_CARDS)
802		return -ENODEV;
803
804	err = snd_opl3sa2_card_new(&pdev->dev, dev, &card);
805	if (err < 0)
806		return err;
807	if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
808		snd_card_free(card);
809		return err;
810	}
811	if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
812		snd_card_free(card);
813		return err;
814	}
815	pnp_set_card_drvdata(pcard, card);
816	dev++;
817	return 0;
818}
819
820static void snd_opl3sa2_pnp_cremove(struct pnp_card_link *pcard)
821{
822	snd_card_free(pnp_get_card_drvdata(pcard));
823	pnp_set_card_drvdata(pcard, NULL);
824}
825
826#ifdef CONFIG_PM
827static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
828{
829	return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
830}
831static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
832{
833	return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
834}
835#endif
836
837static struct pnp_card_driver opl3sa2_pnpc_driver = {
838	.flags = PNP_DRIVER_RES_DISABLE,
839	.name = "snd-opl3sa2-cpnp",
840	.id_table = snd_opl3sa2_pnpids,
841	.probe = snd_opl3sa2_pnp_cdetect,
842	.remove = snd_opl3sa2_pnp_cremove,
843#ifdef CONFIG_PM
844	.suspend = snd_opl3sa2_pnp_csuspend,
845	.resume = snd_opl3sa2_pnp_cresume,
846#endif
847};
848#endif /* CONFIG_PNP */
849
850static int snd_opl3sa2_isa_match(struct device *pdev,
851				 unsigned int dev)
852{
853	if (!enable[dev])
854		return 0;
855#ifdef CONFIG_PNP
856	if (isapnp[dev])
857		return 0;
858#endif
859	if (port[dev] == SNDRV_AUTO_PORT) {
860		snd_printk(KERN_ERR PFX "specify port\n");
861		return 0;
862	}
863	if (wss_port[dev] == SNDRV_AUTO_PORT) {
864		snd_printk(KERN_ERR PFX "specify wss_port\n");
865		return 0;
866	}
867	if (fm_port[dev] == SNDRV_AUTO_PORT) {
868		snd_printk(KERN_ERR PFX "specify fm_port\n");
869		return 0;
870	}
871	if (midi_port[dev] == SNDRV_AUTO_PORT) {
872		snd_printk(KERN_ERR PFX "specify midi_port\n");
873		return 0;
874	}
875	return 1;
876}
877
878static int snd_opl3sa2_isa_probe(struct device *pdev,
879				 unsigned int dev)
880{
881	struct snd_card *card;
882	int err;
883
884	err = snd_opl3sa2_card_new(pdev, dev, &card);
885	if (err < 0)
886		return err;
887	if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
888		snd_card_free(card);
889		return err;
890	}
891	dev_set_drvdata(pdev, card);
892	return 0;
893}
894
895static int snd_opl3sa2_isa_remove(struct device *devptr,
896				  unsigned int dev)
897{
898	snd_card_free(dev_get_drvdata(devptr));
899	return 0;
900}
901
902#ifdef CONFIG_PM
903static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
904				   pm_message_t state)
905{
906	return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
907}
908
909static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
910{
911	return snd_opl3sa2_resume(dev_get_drvdata(dev));
912}
913#endif
914
915#define DEV_NAME "opl3sa2"
916
917static struct isa_driver snd_opl3sa2_isa_driver = {
918	.match		= snd_opl3sa2_isa_match,
919	.probe		= snd_opl3sa2_isa_probe,
920	.remove		= snd_opl3sa2_isa_remove,
921#ifdef CONFIG_PM
922	.suspend	= snd_opl3sa2_isa_suspend,
923	.resume		= snd_opl3sa2_isa_resume,
924#endif
925	.driver		= {
926		.name	= DEV_NAME
927	},
928};
929
930static int __init alsa_card_opl3sa2_init(void)
931{
932	int err;
933
934	err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
935#ifdef CONFIG_PNP
936	if (!err)
937		isa_registered = 1;
938
939	err = pnp_register_driver(&opl3sa2_pnp_driver);
940	if (!err)
941		pnp_registered = 1;
942
943	err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
944	if (!err)
945		pnpc_registered = 1;
946
947	if (isa_registered || pnp_registered)
948		err = 0;
949#endif
950	return err;
951}
952
953static void __exit alsa_card_opl3sa2_exit(void)
954{
955#ifdef CONFIG_PNP
956	if (pnpc_registered)
957		pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
958	if (pnp_registered)
959		pnp_unregister_driver(&opl3sa2_pnp_driver);
960	if (isa_registered)
961#endif
962		isa_unregister_driver(&snd_opl3sa2_isa_driver);
963}
964
965module_init(alsa_card_opl3sa2_init)
966module_exit(alsa_card_opl3sa2_exit)
967