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