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