Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
1da177e4 LT |
2 | /* |
3 | * Driver for generic ESS AudioDrive ESx688 soundcards | |
c1017a4c | 4 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4 LT |
5 | */ |
6 | ||
1da177e4 | 7 | #include <linux/init.h> |
2a571ed1 | 8 | #include <linux/err.h> |
ae596186 | 9 | #include <linux/isa.h> |
a20971b2 | 10 | #include <linux/isapnp.h> |
1da177e4 LT |
11 | #include <linux/time.h> |
12 | #include <linux/wait.h> | |
65a77217 | 13 | #include <linux/module.h> |
2a571ed1 | 14 | #include <asm/dma.h> |
1da177e4 LT |
15 | #include <sound/core.h> |
16 | #include <sound/es1688.h> | |
17 | #include <sound/mpu401.h> | |
18 | #include <sound/opl3.h> | |
1da177e4 LT |
19 | #define SNDRV_LEGACY_FIND_FREE_IRQ |
20 | #define SNDRV_LEGACY_FIND_FREE_DMA | |
21 | #include <sound/initval.h> | |
22 | ||
ae596186 RH |
23 | #define CRD_NAME "Generic ESS ES1688/ES688 AudioDrive" |
24 | #define DEV_NAME "es1688" | |
25 | ||
26 | MODULE_DESCRIPTION(CRD_NAME); | |
c1017a4c | 27 | MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>"); |
1da177e4 LT |
28 | MODULE_LICENSE("GPL"); |
29 | MODULE_SUPPORTED_DEVICE("{{ESS,ES688 PnP AudioDrive,pnp:ESS0100}," | |
30 | "{ESS,ES1688 PnP AudioDrive,pnp:ESS0102}," | |
31 | "{ESS,ES688 AudioDrive,pnp:ESS6881}," | |
32 | "{ESS,ES1688 AudioDrive,pnp:ESS1681}}"); | |
33 | ||
a20971b2 KH |
34 | MODULE_ALIAS("snd_es968"); |
35 | ||
1da177e4 LT |
36 | static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */ |
37 | static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */ | |
a20971b2 | 38 | #ifdef CONFIG_PNP |
a67ff6a5 | 39 | static bool isapnp[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; |
a20971b2 | 40 | #endif |
a67ff6a5 | 41 | static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */ |
1da177e4 | 42 | static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x240,0x260 */ |
880abd42 | 43 | static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* Usually 0x388 */ |
1da177e4 LT |
44 | static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -1}; |
45 | static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */ | |
46 | static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */ | |
47 | static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3 */ | |
48 | ||
49 | module_param_array(index, int, NULL, 0444); | |
ae596186 | 50 | MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard."); |
1da177e4 | 51 | module_param_array(id, charp, NULL, 0444); |
ae596186 | 52 | MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard."); |
1da177e4 | 53 | module_param_array(enable, bool, NULL, 0444); |
a20971b2 KH |
54 | #ifdef CONFIG_PNP |
55 | module_param_array(isapnp, bool, NULL, 0444); | |
56 | MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard."); | |
57 | #endif | |
ae596186 | 58 | MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard."); |
e992ef57 | 59 | module_param_hw_array(port, long, ioport, NULL, 0444); |
ae596186 | 60 | MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver."); |
e992ef57 | 61 | module_param_hw_array(mpu_port, long, ioport, NULL, 0444); |
ae596186 | 62 | MODULE_PARM_DESC(mpu_port, "MPU-401 port # for " CRD_NAME " driver."); |
e992ef57 DH |
63 | module_param_hw_array(irq, int, irq, NULL, 0444); |
64 | module_param_hw_array(fm_port, long, ioport, NULL, 0444); | |
880abd42 | 65 | MODULE_PARM_DESC(fm_port, "FM port # for ES1688 driver."); |
ae596186 | 66 | MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver."); |
e992ef57 | 67 | module_param_hw_array(mpu_irq, int, irq, NULL, 0444); |
ae596186 | 68 | MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for " CRD_NAME " driver."); |
e992ef57 | 69 | module_param_hw_array(dma8, int, dma, NULL, 0444); |
ae596186 | 70 | MODULE_PARM_DESC(dma8, "8-bit DMA # for " CRD_NAME " driver."); |
f7a9275d | 71 | |
a20971b2 KH |
72 | #ifdef CONFIG_PNP |
73 | #define is_isapnp_selected(dev) isapnp[dev] | |
74 | #else | |
75 | #define is_isapnp_selected(dev) 0 | |
76 | #endif | |
77 | ||
1bff292e | 78 | static int snd_es1688_match(struct device *dev, unsigned int n) |
ae596186 | 79 | { |
a20971b2 | 80 | return enable[n] && !is_isapnp_selected(n); |
ae596186 | 81 | } |
1da177e4 | 82 | |
1bff292e BP |
83 | static int snd_es1688_legacy_create(struct snd_card *card, |
84 | struct device *dev, unsigned int n) | |
1da177e4 | 85 | { |
a20971b2 | 86 | struct snd_es1688 *chip = card->private_data; |
019608b6 | 87 | static long possible_ports[] = {0x220, 0x240, 0x260}; |
1da177e4 LT |
88 | static int possible_irqs[] = {5, 9, 10, 7, -1}; |
89 | static int possible_dmas[] = {1, 3, 0, -1}; | |
ae596186 | 90 | |
019608b6 RH |
91 | int i, error; |
92 | ||
93 | if (irq[n] == SNDRV_AUTO_IRQ) { | |
94 | irq[n] = snd_legacy_find_free_irq(possible_irqs); | |
95 | if (irq[n] < 0) { | |
0418ff0c | 96 | dev_err(dev, "unable to find a free IRQ\n"); |
019608b6 RH |
97 | return -EBUSY; |
98 | } | |
99 | } | |
100 | if (dma8[n] == SNDRV_AUTO_DMA) { | |
101 | dma8[n] = snd_legacy_find_free_dma(possible_dmas); | |
102 | if (dma8[n] < 0) { | |
0418ff0c | 103 | dev_err(dev, "unable to find a free DMA\n"); |
019608b6 RH |
104 | return -EBUSY; |
105 | } | |
106 | } | |
107 | ||
108 | if (port[n] != SNDRV_AUTO_PORT) | |
396fa827 KH |
109 | return snd_es1688_create(card, chip, port[n], mpu_port[n], |
110 | irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO); | |
019608b6 RH |
111 | |
112 | i = 0; | |
113 | do { | |
114 | port[n] = possible_ports[i]; | |
396fa827 KH |
115 | error = snd_es1688_create(card, chip, port[n], mpu_port[n], |
116 | irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO); | |
019608b6 RH |
117 | } while (error < 0 && ++i < ARRAY_SIZE(possible_ports)); |
118 | ||
119 | return error; | |
120 | } | |
121 | ||
1bff292e | 122 | static int snd_es1688_probe(struct snd_card *card, unsigned int n) |
019608b6 | 123 | { |
a20971b2 | 124 | struct snd_es1688 *chip = card->private_data; |
d3a7e476 | 125 | struct snd_opl3 *opl3; |
ae596186 RH |
126 | int error; |
127 | ||
4b8ab885 | 128 | error = snd_es1688_pcm(card, chip, 0); |
ae596186 | 129 | if (error < 0) |
a20971b2 | 130 | return error; |
43bcd973 | 131 | |
396fa827 | 132 | error = snd_es1688_mixer(card, chip); |
ae596186 | 133 | if (error < 0) |
a20971b2 | 134 | return error; |
1da177e4 | 135 | |
b0fb75ad | 136 | strlcpy(card->driver, "ES1688", sizeof(card->driver)); |
4b8ab885 | 137 | strlcpy(card->shortname, chip->pcm->name, sizeof(card->shortname)); |
b0fb75ad | 138 | snprintf(card->longname, sizeof(card->longname), |
4b8ab885 | 139 | "%s at 0x%lx, irq %i, dma %i", chip->pcm->name, chip->port, |
b0fb75ad | 140 | chip->irq, chip->dma8); |
1da177e4 | 141 | |
880abd42 KH |
142 | if (fm_port[n] == SNDRV_AUTO_PORT) |
143 | fm_port[n] = port[n]; /* share the same port */ | |
144 | ||
145 | if (fm_port[n] > 0) { | |
146 | if (snd_opl3_create(card, fm_port[n], fm_port[n] + 2, | |
147 | OPL3_HW_OPL3, 0, &opl3) < 0) | |
a20971b2 | 148 | dev_warn(card->dev, |
880abd42 KH |
149 | "opl3 not detected at 0x%lx\n", fm_port[n]); |
150 | else { | |
151 | error = snd_opl3_hwdep_new(opl3, 0, 1, NULL); | |
152 | if (error < 0) | |
a20971b2 | 153 | return error; |
880abd42 | 154 | } |
1da177e4 LT |
155 | } |
156 | ||
019608b6 RH |
157 | if (mpu_irq[n] >= 0 && mpu_irq[n] != SNDRV_AUTO_IRQ && |
158 | chip->mpu_port > 0) { | |
159 | error = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688, | |
160 | chip->mpu_port, 0, | |
dba8b469 | 161 | mpu_irq[n], NULL); |
ae596186 | 162 | if (error < 0) |
a20971b2 | 163 | return error; |
1da177e4 | 164 | } |
43bcd973 | 165 | |
a20971b2 KH |
166 | return snd_card_register(card); |
167 | } | |
168 | ||
1bff292e | 169 | static int snd_es1688_isa_probe(struct device *dev, unsigned int n) |
a20971b2 KH |
170 | { |
171 | struct snd_card *card; | |
172 | int error; | |
173 | ||
4323cc4d TI |
174 | error = snd_card_new(dev, index[n], id[n], THIS_MODULE, |
175 | sizeof(struct snd_es1688), &card); | |
a20971b2 KH |
176 | if (error < 0) |
177 | return error; | |
178 | ||
179 | error = snd_es1688_legacy_create(card, dev, n); | |
180 | if (error < 0) | |
181 | goto out; | |
182 | ||
a20971b2 | 183 | error = snd_es1688_probe(card, n); |
ae596186 RH |
184 | if (error < 0) |
185 | goto out; | |
43bcd973 | 186 | |
ae596186 | 187 | dev_set_drvdata(dev, card); |
1da177e4 | 188 | |
a20971b2 KH |
189 | return 0; |
190 | out: | |
191 | snd_card_free(card); | |
ae596186 | 192 | return error; |
1da177e4 LT |
193 | } |
194 | ||
1bff292e | 195 | static int snd_es1688_isa_remove(struct device *dev, unsigned int n) |
1da177e4 | 196 | { |
ae596186 | 197 | snd_card_free(dev_get_drvdata(dev)); |
2a571ed1 | 198 | return 0; |
1da177e4 LT |
199 | } |
200 | ||
ae596186 RH |
201 | static struct isa_driver snd_es1688_driver = { |
202 | .match = snd_es1688_match, | |
a20971b2 | 203 | .probe = snd_es1688_isa_probe, |
1bff292e | 204 | .remove = snd_es1688_isa_remove, |
ae596186 RH |
205 | #if 0 /* FIXME */ |
206 | .suspend = snd_es1688_suspend, | |
207 | .resume = snd_es1688_resume, | |
208 | #endif | |
2a571ed1 | 209 | .driver = { |
ae596186 RH |
210 | .name = DEV_NAME |
211 | } | |
2a571ed1 TI |
212 | }; |
213 | ||
a20971b2 KH |
214 | static int snd_es968_pnp_is_probed; |
215 | ||
216 | #ifdef CONFIG_PNP | |
1bff292e BP |
217 | static int snd_card_es968_pnp(struct snd_card *card, unsigned int n, |
218 | struct pnp_card_link *pcard, | |
219 | const struct pnp_card_device_id *pid) | |
a20971b2 KH |
220 | { |
221 | struct snd_es1688 *chip = card->private_data; | |
222 | struct pnp_dev *pdev; | |
223 | int error; | |
224 | ||
225 | pdev = pnp_request_card_device(pcard, pid->devs[0].id, NULL); | |
226 | if (pdev == NULL) | |
227 | return -ENODEV; | |
228 | ||
229 | error = pnp_activate_dev(pdev); | |
230 | if (error < 0) { | |
231 | snd_printk(KERN_ERR "ES968 pnp configure failure\n"); | |
232 | return error; | |
233 | } | |
234 | port[n] = pnp_port_start(pdev, 0); | |
235 | dma8[n] = pnp_dma(pdev, 0); | |
236 | irq[n] = pnp_irq(pdev, 0); | |
237 | ||
238 | return snd_es1688_create(card, chip, port[n], mpu_port[n], irq[n], | |
239 | mpu_irq[n], dma8[n], ES1688_HW_AUTO); | |
240 | } | |
241 | ||
1bff292e BP |
242 | static int snd_es968_pnp_detect(struct pnp_card_link *pcard, |
243 | const struct pnp_card_device_id *pid) | |
a20971b2 KH |
244 | { |
245 | struct snd_card *card; | |
246 | static unsigned int dev; | |
247 | int error; | |
a20971b2 KH |
248 | |
249 | if (snd_es968_pnp_is_probed) | |
250 | return -EBUSY; | |
251 | for ( ; dev < SNDRV_CARDS; dev++) { | |
252 | if (enable[dev] && isapnp[dev]) | |
253 | break; | |
254 | } | |
b0fb75ad DC |
255 | if (dev == SNDRV_CARDS) |
256 | return -ENODEV; | |
a20971b2 | 257 | |
4323cc4d TI |
258 | error = snd_card_new(&pcard->card->dev, |
259 | index[dev], id[dev], THIS_MODULE, | |
260 | sizeof(struct snd_es1688), &card); | |
a20971b2 KH |
261 | if (error < 0) |
262 | return error; | |
a20971b2 KH |
263 | |
264 | error = snd_card_es968_pnp(card, dev, pcard, pid); | |
265 | if (error < 0) { | |
266 | snd_card_free(card); | |
267 | return error; | |
268 | } | |
a20971b2 KH |
269 | error = snd_es1688_probe(card, dev); |
270 | if (error < 0) | |
271 | return error; | |
272 | pnp_set_card_drvdata(pcard, card); | |
273 | snd_es968_pnp_is_probed = 1; | |
274 | return 0; | |
275 | } | |
276 | ||
1bff292e | 277 | static void snd_es968_pnp_remove(struct pnp_card_link *pcard) |
a20971b2 KH |
278 | { |
279 | snd_card_free(pnp_get_card_drvdata(pcard)); | |
280 | pnp_set_card_drvdata(pcard, NULL); | |
281 | snd_es968_pnp_is_probed = 0; | |
282 | } | |
283 | ||
284 | #ifdef CONFIG_PM | |
285 | static int snd_es968_pnp_suspend(struct pnp_card_link *pcard, | |
286 | pm_message_t state) | |
287 | { | |
288 | struct snd_card *card = pnp_get_card_drvdata(pcard); | |
a20971b2 KH |
289 | |
290 | snd_power_change_state(card, SNDRV_CTL_POWER_D3hot); | |
a20971b2 KH |
291 | return 0; |
292 | } | |
293 | ||
294 | static int snd_es968_pnp_resume(struct pnp_card_link *pcard) | |
295 | { | |
296 | struct snd_card *card = pnp_get_card_drvdata(pcard); | |
297 | struct snd_es1688 *chip = card->private_data; | |
298 | ||
299 | snd_es1688_reset(chip); | |
300 | snd_power_change_state(card, SNDRV_CTL_POWER_D0); | |
301 | return 0; | |
302 | } | |
303 | #endif | |
304 | ||
4f624a1c | 305 | static const struct pnp_card_device_id snd_es968_pnpids[] = { |
a20971b2 KH |
306 | { .id = "ESS0968", .devs = { { "@@@0968" }, } }, |
307 | { .id = "ESS0968", .devs = { { "ESS0968" }, } }, | |
308 | { .id = "", } /* end */ | |
309 | }; | |
310 | ||
311 | MODULE_DEVICE_TABLE(pnp_card, snd_es968_pnpids); | |
312 | ||
313 | static struct pnp_card_driver es968_pnpc_driver = { | |
314 | .flags = PNP_DRIVER_RES_DISABLE, | |
315 | .name = DEV_NAME " PnP", | |
316 | .id_table = snd_es968_pnpids, | |
317 | .probe = snd_es968_pnp_detect, | |
1bff292e | 318 | .remove = snd_es968_pnp_remove, |
a20971b2 KH |
319 | #ifdef CONFIG_PM |
320 | .suspend = snd_es968_pnp_suspend, | |
321 | .resume = snd_es968_pnp_resume, | |
322 | #endif | |
323 | }; | |
324 | #endif | |
325 | ||
1da177e4 LT |
326 | static int __init alsa_card_es1688_init(void) |
327 | { | |
a20971b2 KH |
328 | #ifdef CONFIG_PNP |
329 | pnp_register_card_driver(&es968_pnpc_driver); | |
330 | if (snd_es968_pnp_is_probed) | |
331 | return 0; | |
332 | pnp_unregister_card_driver(&es968_pnpc_driver); | |
333 | #endif | |
ae596186 | 334 | return isa_register_driver(&snd_es1688_driver, SNDRV_CARDS); |
1da177e4 LT |
335 | } |
336 | ||
337 | static void __exit alsa_card_es1688_exit(void) | |
338 | { | |
a20971b2 KH |
339 | if (!snd_es968_pnp_is_probed) { |
340 | isa_unregister_driver(&snd_es1688_driver); | |
341 | return; | |
342 | } | |
343 | #ifdef CONFIG_PNP | |
344 | pnp_unregister_card_driver(&es968_pnpc_driver); | |
345 | #endif | |
1da177e4 LT |
346 | } |
347 | ||
ae596186 RH |
348 | module_init(alsa_card_es1688_init); |
349 | module_exit(alsa_card_es1688_exit); |