1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 *  The driver for the EMU10K1 (SB Live!) based soundcards
4 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 *
6 *  Copyright (c) by James Courtier-Dutton <James@superbug.demon.co.uk>
7 *      Added support for Audigy 2 Value.
8 */
9
10#include <linux/init.h>
11#include <linux/pci.h>
12#include <linux/time.h>
13#include <linux/module.h>
14#include <sound/core.h>
15#include <sound/emu10k1.h>
16#include <sound/initval.h>
17
18MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
19MODULE_DESCRIPTION("EMU10K1");
20MODULE_LICENSE("GPL");
21MODULE_SUPPORTED_DEVICE("{{Creative Labs,SB Live!/PCI512/E-mu APS},"
22	       "{Creative Labs,SB Audigy}}");
23
24#if IS_ENABLED(CONFIG_SND_SEQUENCER)
25#define ENABLE_SYNTH
26#include <sound/emu10k1_synth.h>
27#endif
28
29static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
30static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
31static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
32static int extin[SNDRV_CARDS];
33static int extout[SNDRV_CARDS];
34static int seq_ports[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 4};
35static int max_synth_voices[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 64};
36static int max_buffer_size[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 128};
37static bool enable_ir[SNDRV_CARDS];
38static uint subsystem[SNDRV_CARDS]; /* Force card subsystem model */
39static uint delay_pcm_irq[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};
40
41module_param_array(index, int, NULL, 0444);
42MODULE_PARM_DESC(index, "Index value for the EMU10K1 soundcard.");
43module_param_array(id, charp, NULL, 0444);
44MODULE_PARM_DESC(id, "ID string for the EMU10K1 soundcard.");
45module_param_array(enable, bool, NULL, 0444);
46MODULE_PARM_DESC(enable, "Enable the EMU10K1 soundcard.");
47module_param_array(extin, int, NULL, 0444);
48MODULE_PARM_DESC(extin, "Available external inputs for FX8010. Zero=default.");
49module_param_array(extout, int, NULL, 0444);
50MODULE_PARM_DESC(extout, "Available external outputs for FX8010. Zero=default.");
51module_param_array(seq_ports, int, NULL, 0444);
52MODULE_PARM_DESC(seq_ports, "Allocated sequencer ports for internal synthesizer.");
53module_param_array(max_synth_voices, int, NULL, 0444);
54MODULE_PARM_DESC(max_synth_voices, "Maximum number of voices for WaveTable.");
55module_param_array(max_buffer_size, int, NULL, 0444);
56MODULE_PARM_DESC(max_buffer_size, "Maximum sample buffer size in MB.");
57module_param_array(enable_ir, bool, NULL, 0444);
58MODULE_PARM_DESC(enable_ir, "Enable IR.");
59module_param_array(subsystem, uint, NULL, 0444);
60MODULE_PARM_DESC(subsystem, "Force card subsystem model.");
61module_param_array(delay_pcm_irq, uint, NULL, 0444);
62MODULE_PARM_DESC(delay_pcm_irq, "Delay PCM interrupt by specified number of samples (default 0).");
63/*
64 * Class 0401: 1102:0008 (rev 00) Subsystem: 1102:1001 -> Audigy2 Value  Model:SB0400
65 */
66static const struct pci_device_id snd_emu10k1_ids[] = {
67	{ PCI_VDEVICE(CREATIVE, 0x0002), 0 },	/* EMU10K1 */
68	{ PCI_VDEVICE(CREATIVE, 0x0004), 1 },	/* Audigy */
69	{ PCI_VDEVICE(CREATIVE, 0x0008), 1 },	/* Audigy 2 Value SB0400 */
70	{ 0, }
71};
72
73/*
74 * Audigy 2 Value notes:
75 * A_IOCFG Input (GPIO)
76 * 0x400  = Front analog jack plugged in. (Green socket)
77 * 0x1000 = Read analog jack plugged in. (Black socket)
78 * 0x2000 = Center/LFE analog jack plugged in. (Orange socket)
79 * A_IOCFG Output (GPIO)
80 * 0x60 = Sound out of front Left.
81 * Win sets it to 0xXX61
82 */
83
84MODULE_DEVICE_TABLE(pci, snd_emu10k1_ids);
85
86static int snd_card_emu10k1_probe(struct pci_dev *pci,
87				  const struct pci_device_id *pci_id)
88{
89	static int dev;
90	struct snd_card *card;
91	struct snd_emu10k1 *emu;
92#ifdef ENABLE_SYNTH
93	struct snd_seq_device *wave = NULL;
94#endif
95	int err;
96
97	if (dev >= SNDRV_CARDS)
98        	return -ENODEV;
99	if (!enable[dev]) {
100		dev++;
101		return -ENOENT;
102	}
103
104	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
105			   0, &card);
106	if (err < 0)
107		return err;
108	if (max_buffer_size[dev] < 32)
109		max_buffer_size[dev] = 32;
110	else if (max_buffer_size[dev] > 1024)
111		max_buffer_size[dev] = 1024;
112	if ((err = snd_emu10k1_create(card, pci, extin[dev], extout[dev],
113				      (long)max_buffer_size[dev] * 1024 * 1024,
114				      enable_ir[dev], subsystem[dev],
115				      &emu)) < 0)
116		goto error;
117	card->private_data = emu;
118	emu->delay_pcm_irq = delay_pcm_irq[dev] & 0x1f;
119	if ((err = snd_emu10k1_pcm(emu, 0)) < 0)
120		goto error;
121	if ((err = snd_emu10k1_pcm_mic(emu, 1)) < 0)
122		goto error;
123	if ((err = snd_emu10k1_pcm_efx(emu, 2)) < 0)
124		goto error;
125	/* This stores the periods table. */
126	if (emu->card_capabilities->ca0151_chip) { /* P16V */
127		err = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, &pci->dev,
128					  1024, &emu->p16v_buffer);
129		if (err < 0)
130			goto error;
131	}
132
133	if ((err = snd_emu10k1_mixer(emu, 0, 3)) < 0)
134		goto error;
135
136	if ((err = snd_emu10k1_timer(emu, 0)) < 0)
137		goto error;
138
139	if ((err = snd_emu10k1_pcm_multi(emu, 3)) < 0)
140		goto error;
141	if (emu->card_capabilities->ca0151_chip) { /* P16V */
142		if ((err = snd_p16v_pcm(emu, 4)) < 0)
143			goto error;
144	}
145	if (emu->audigy) {
146		if ((err = snd_emu10k1_audigy_midi(emu)) < 0)
147			goto error;
148	} else {
149		if ((err = snd_emu10k1_midi(emu)) < 0)
150			goto error;
151	}
152	if ((err = snd_emu10k1_fx8010_new(emu, 0)) < 0)
153		goto error;
154#ifdef ENABLE_SYNTH
155	if (snd_seq_device_new(card, 1, SNDRV_SEQ_DEV_ID_EMU10K1_SYNTH,
156			       sizeof(struct snd_emu10k1_synth_arg), &wave) < 0 ||
157	    wave == NULL) {
158		dev_warn(emu->card->dev,
159			 "can't initialize Emu10k1 wavetable synth\n");
160	} else {
161		struct snd_emu10k1_synth_arg *arg;
162		arg = SNDRV_SEQ_DEVICE_ARGPTR(wave);
163		strcpy(wave->name, "Emu-10k1 Synth");
164		arg->hwptr = emu;
165		arg->index = 1;
166		arg->seq_ports = seq_ports[dev];
167		arg->max_voices = max_synth_voices[dev];
168	}
169#endif
170
171	strlcpy(card->driver, emu->card_capabilities->driver,
172		sizeof(card->driver));
173	strlcpy(card->shortname, emu->card_capabilities->name,
174		sizeof(card->shortname));
175	snprintf(card->longname, sizeof(card->longname),
176		 "%s (rev.%d, serial:0x%x) at 0x%lx, irq %i",
177		 card->shortname, emu->revision, emu->serial, emu->port, emu->irq);
178
179	if ((err = snd_card_register(card)) < 0)
180		goto error;
181
182	if (emu->card_capabilities->emu_model)
183		schedule_delayed_work(&emu->emu1010.firmware_work, 0);
184
185	pci_set_drvdata(pci, card);
186	dev++;
187	return 0;
188
189 error:
190	snd_card_free(card);
191	return err;
192}
193
194static void snd_card_emu10k1_remove(struct pci_dev *pci)
195{
196	snd_card_free(pci_get_drvdata(pci));
197}
198
199
200#ifdef CONFIG_PM_SLEEP
201static int snd_emu10k1_suspend(struct device *dev)
202{
203	struct snd_card *card = dev_get_drvdata(dev);
204	struct snd_emu10k1 *emu = card->private_data;
205
206	snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
207
208	emu->suspend = 1;
209
210	cancel_delayed_work_sync(&emu->emu1010.firmware_work);
211
212	snd_ac97_suspend(emu->ac97);
213
214	snd_emu10k1_efx_suspend(emu);
215	snd_emu10k1_suspend_regs(emu);
216	if (emu->card_capabilities->ca0151_chip)
217		snd_p16v_suspend(emu);
218
219	snd_emu10k1_done(emu);
220	return 0;
221}
222
223static int snd_emu10k1_resume(struct device *dev)
224{
225	struct snd_card *card = dev_get_drvdata(dev);
226	struct snd_emu10k1 *emu = card->private_data;
227
228	snd_emu10k1_resume_init(emu);
229	snd_emu10k1_efx_resume(emu);
230	snd_ac97_resume(emu->ac97);
231	snd_emu10k1_resume_regs(emu);
232
233	if (emu->card_capabilities->ca0151_chip)
234		snd_p16v_resume(emu);
235
236	emu->suspend = 0;
237
238	snd_power_change_state(card, SNDRV_CTL_POWER_D0);
239
240	if (emu->card_capabilities->emu_model)
241		schedule_delayed_work(&emu->emu1010.firmware_work, 0);
242
243	return 0;
244}
245
246static SIMPLE_DEV_PM_OPS(snd_emu10k1_pm, snd_emu10k1_suspend, snd_emu10k1_resume);
247#define SND_EMU10K1_PM_OPS	&snd_emu10k1_pm
248#else
249#define SND_EMU10K1_PM_OPS	NULL
250#endif /* CONFIG_PM_SLEEP */
251
252static struct pci_driver emu10k1_driver = {
253	.name = KBUILD_MODNAME,
254	.id_table = snd_emu10k1_ids,
255	.probe = snd_card_emu10k1_probe,
256	.remove = snd_card_emu10k1_remove,
257	.driver = {
258		.pm = SND_EMU10K1_PM_OPS,
259	},
260};
261
262module_pci_driver(emu10k1_driver);
263