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