Merge tag 'arm-drivers-5.8' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[platform/kernel/linux-starfive.git] / sound / isa / als100.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2
3 /*
4     card-als100.c - driver for Avance Logic ALS100 based soundcards.
5     Copyright (C) 1999-2000 by Massimo Piccioni <dafastidio@libero.it>
6     Copyright (C) 1999-2002 by Massimo Piccioni <dafastidio@libero.it>
7
8     Thanks to Pierfrancesco 'qM2' Passerini.
9
10     Generalised for soundcards based on DT-0196 and ALS-007 chips
11     by Jonathan Woithe <jwoithe@just42.net>: June 2002.
12
13 */
14
15 #include <linux/init.h>
16 #include <linux/wait.h>
17 #include <linux/time.h>
18 #include <linux/pnp.h>
19 #include <linux/module.h>
20 #include <sound/core.h>
21 #include <sound/initval.h>
22 #include <sound/mpu401.h>
23 #include <sound/opl3.h>
24 #include <sound/sb.h>
25
26 #define PFX "als100: "
27
28 MODULE_DESCRIPTION("Avance Logic ALS007/ALS1X0");
29 MODULE_SUPPORTED_DEVICE("{{Diamond Technologies DT-019X},"
30                 "{Avance Logic ALS-007}}"
31                 "{{Avance Logic,ALS100 - PRO16PNP},"
32                 "{Avance Logic,ALS110},"
33                 "{Avance Logic,ALS120},"
34                 "{Avance Logic,ALS200},"
35                 "{3D Melody,MF1000},"
36                 "{Digimate,3D Sound},"
37                 "{Avance Logic,ALS120},"
38                 "{RTL,RTL3000}}");
39
40 MODULE_AUTHOR("Massimo Piccioni <dafastidio@libero.it>");
41 MODULE_LICENSE("GPL");
42
43 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
44 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
45 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
46 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* PnP setup */
47 static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
48 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* PnP setup */
49 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* PnP setup */
50 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* PnP setup */
51 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* PnP setup */
52 static int dma16[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;      /* PnP setup */
53
54 module_param_array(index, int, NULL, 0444);
55 MODULE_PARM_DESC(index, "Index value for Avance Logic based soundcard.");
56 module_param_array(id, charp, NULL, 0444);
57 MODULE_PARM_DESC(id, "ID string for Avance Logic based soundcard.");
58 module_param_array(enable, bool, NULL, 0444);
59 MODULE_PARM_DESC(enable, "Enable Avance Logic based soundcard.");
60
61 MODULE_ALIAS("snd-dt019x");
62
63 struct snd_card_als100 {
64         struct pnp_dev *dev;
65         struct pnp_dev *devmpu;
66         struct pnp_dev *devopl;
67         struct snd_sb *chip;
68 };
69
70 static const struct pnp_card_device_id snd_als100_pnpids[] = {
71         /* DT197A30 */
72         { .id = "RWB1688",
73           .devs = { { "@@@0001" }, { "@X@0001" }, { "@H@0001" } },
74           .driver_data = SB_HW_DT019X },
75         /* DT0196 / ALS-007 */
76         { .id = "ALS0007",
77           .devs = { { "@@@0001" }, { "@X@0001" }, { "@H@0001" } },
78           .driver_data = SB_HW_DT019X },
79         /* ALS100 - PRO16PNP */
80         { .id = "ALS0001",
81           .devs = { { "@@@0001" }, { "@X@0001" }, { "@H@0001" } },
82           .driver_data = SB_HW_ALS100 },
83         /* ALS110 - MF1000 - Digimate 3D Sound */
84         { .id = "ALS0110",
85           .devs = { { "@@@1001" }, { "@X@1001" }, { "@H@1001" } },
86           .driver_data = SB_HW_ALS100 },
87         /* ALS120 */
88         { .id = "ALS0120",
89           .devs = { { "@@@2001" }, { "@X@2001" }, { "@H@2001" } },
90           .driver_data = SB_HW_ALS100 },
91         /* ALS200 */
92         { .id = "ALS0200",
93           .devs = { { "@@@0020" }, { "@X@0020" }, { "@H@0001" } },
94           .driver_data = SB_HW_ALS100 },
95         /* ALS200 OEM */
96         { .id = "ALS0200",
97           .devs = { { "@@@0020" }, { "@X@0020" }, { "@H@0020" } },
98           .driver_data = SB_HW_ALS100 },
99         /* RTL3000 */
100         { .id = "RTL3000",
101           .devs = { { "@@@2001" }, { "@X@2001" }, { "@H@2001" } },
102           .driver_data = SB_HW_ALS100 },
103         { .id = "" } /* end */
104 };
105
106 MODULE_DEVICE_TABLE(pnp_card, snd_als100_pnpids);
107
108 static int snd_card_als100_pnp(int dev, struct snd_card_als100 *acard,
109                                struct pnp_card_link *card,
110                                const struct pnp_card_device_id *id)
111 {
112         struct pnp_dev *pdev;
113         int err;
114
115         acard->dev = pnp_request_card_device(card, id->devs[0].id, NULL);
116         if (acard->dev == NULL)
117                 return -ENODEV;
118
119         acard->devmpu = pnp_request_card_device(card, id->devs[1].id, acard->dev);
120         acard->devopl = pnp_request_card_device(card, id->devs[2].id, acard->dev);
121
122         pdev = acard->dev;
123
124         err = pnp_activate_dev(pdev);
125         if (err < 0) {
126                 snd_printk(KERN_ERR PFX "AUDIO pnp configure failure\n");
127                 return err;
128         }
129         port[dev] = pnp_port_start(pdev, 0);
130         if (id->driver_data == SB_HW_DT019X)
131                 dma8[dev] = pnp_dma(pdev, 0);
132         else {
133                 dma8[dev] = pnp_dma(pdev, 1);
134                 dma16[dev] = pnp_dma(pdev, 0);
135         }
136         irq[dev] = pnp_irq(pdev, 0);
137
138         pdev = acard->devmpu;
139         if (pdev != NULL) {
140                 err = pnp_activate_dev(pdev);
141                 if (err < 0)
142                         goto __mpu_error;
143                 mpu_port[dev] = pnp_port_start(pdev, 0);
144                 mpu_irq[dev] = pnp_irq(pdev, 0);
145         } else {
146              __mpu_error:
147                 if (pdev) {
148                         pnp_release_card_device(pdev);
149                         snd_printk(KERN_ERR PFX "MPU401 pnp configure failure, skipping\n");
150                 }
151                 acard->devmpu = NULL;
152                 mpu_port[dev] = -1;
153         }
154
155         pdev = acard->devopl;
156         if (pdev != NULL) {
157                 err = pnp_activate_dev(pdev);
158                 if (err < 0)
159                         goto __fm_error;
160                 fm_port[dev] = pnp_port_start(pdev, 0);
161         } else {
162               __fm_error:
163                 if (pdev) {
164                         pnp_release_card_device(pdev);
165                         snd_printk(KERN_ERR PFX "OPL3 pnp configure failure, skipping\n");
166                 }
167                 acard->devopl = NULL;
168                 fm_port[dev] = -1;
169         }
170
171         return 0;
172 }
173
174 static int snd_card_als100_probe(int dev,
175                                  struct pnp_card_link *pcard,
176                                  const struct pnp_card_device_id *pid)
177 {
178         int error;
179         struct snd_sb *chip;
180         struct snd_card *card;
181         struct snd_card_als100 *acard;
182         struct snd_opl3 *opl3;
183
184         error = snd_card_new(&pcard->card->dev,
185                              index[dev], id[dev], THIS_MODULE,
186                              sizeof(struct snd_card_als100), &card);
187         if (error < 0)
188                 return error;
189         acard = card->private_data;
190
191         if ((error = snd_card_als100_pnp(dev, acard, pcard, pid))) {
192                 snd_card_free(card);
193                 return error;
194         }
195
196         if (pid->driver_data == SB_HW_DT019X)
197                 dma16[dev] = -1;
198
199         error = snd_sbdsp_create(card, port[dev], irq[dev],
200                                   snd_sb16dsp_interrupt,
201                                   dma8[dev], dma16[dev],
202                                   pid->driver_data,
203                                   &chip);
204         if (error < 0) {
205                 snd_card_free(card);
206                 return error;
207         }
208         acard->chip = chip;
209
210         if (pid->driver_data == SB_HW_DT019X) {
211                 strcpy(card->driver, "DT-019X");
212                 strcpy(card->shortname, "Diamond Tech. DT-019X");
213                 snprintf(card->longname, sizeof(card->longname),
214                          "Diamond Tech. DT-019X, %s at 0x%lx, irq %d, dma %d",
215                          chip->name, chip->port, irq[dev], dma8[dev]);
216         } else {
217                 strcpy(card->driver, "ALS100");
218                 strcpy(card->shortname, "Avance Logic ALS100");
219                 snprintf(card->longname, sizeof(card->longname),
220                          "Avance Logic ALS100, %s at 0x%lx, irq %d, dma %d&%d",
221                          chip->name, chip->port, irq[dev], dma8[dev],
222                          dma16[dev]);
223         }
224
225         if ((error = snd_sb16dsp_pcm(chip, 0)) < 0) {
226                 snd_card_free(card);
227                 return error;
228         }
229
230         if ((error = snd_sbmixer_new(chip)) < 0) {
231                 snd_card_free(card);
232                 return error;
233         }
234
235         if (mpu_port[dev] > 0 && mpu_port[dev] != SNDRV_AUTO_PORT) {
236                 int mpu_type = MPU401_HW_ALS100;
237
238                 if (mpu_irq[dev] == SNDRV_AUTO_IRQ)
239                         mpu_irq[dev] = -1;
240
241                 if (pid->driver_data == SB_HW_DT019X)
242                         mpu_type = MPU401_HW_MPU401;
243
244                 if (snd_mpu401_uart_new(card, 0,
245                                         mpu_type,
246                                         mpu_port[dev], 0, 
247                                         mpu_irq[dev],
248                                         NULL) < 0)
249                         snd_printk(KERN_ERR PFX "no MPU-401 device at 0x%lx\n", mpu_port[dev]);
250         }
251
252         if (fm_port[dev] > 0 && fm_port[dev] != SNDRV_AUTO_PORT) {
253                 if (snd_opl3_create(card,
254                                     fm_port[dev], fm_port[dev] + 2,
255                                     OPL3_HW_AUTO, 0, &opl3) < 0) {
256                         snd_printk(KERN_ERR PFX "no OPL device at 0x%lx-0x%lx\n",
257                                    fm_port[dev], fm_port[dev] + 2);
258                 } else {
259                         if ((error = snd_opl3_timer_new(opl3, 0, 1)) < 0) {
260                                 snd_card_free(card);
261                                 return error;
262                         }
263                         if ((error = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
264                                 snd_card_free(card);
265                                 return error;
266                         }
267                 }
268         }
269
270         if ((error = snd_card_register(card)) < 0) {
271                 snd_card_free(card);
272                 return error;
273         }
274         pnp_set_card_drvdata(pcard, card);
275         return 0;
276 }
277
278 static unsigned int als100_devices;
279
280 static int snd_als100_pnp_detect(struct pnp_card_link *card,
281                                  const struct pnp_card_device_id *id)
282 {
283         static int dev;
284         int res;
285
286         for ( ; dev < SNDRV_CARDS; dev++) {
287                 if (!enable[dev])
288                         continue;
289                 res = snd_card_als100_probe(dev, card, id);
290                 if (res < 0)
291                         return res;
292                 dev++;
293                 als100_devices++;
294                 return 0;
295         }
296         return -ENODEV;
297 }
298
299 static void snd_als100_pnp_remove(struct pnp_card_link *pcard)
300 {
301         snd_card_free(pnp_get_card_drvdata(pcard));
302         pnp_set_card_drvdata(pcard, NULL);
303 }
304
305 #ifdef CONFIG_PM
306 static int snd_als100_pnp_suspend(struct pnp_card_link *pcard, pm_message_t state)
307 {
308         struct snd_card *card = pnp_get_card_drvdata(pcard);
309         struct snd_card_als100 *acard = card->private_data;
310         struct snd_sb *chip = acard->chip;
311
312         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
313         snd_sbmixer_suspend(chip);
314         return 0;
315 }
316
317 static int snd_als100_pnp_resume(struct pnp_card_link *pcard)
318 {
319         struct snd_card *card = pnp_get_card_drvdata(pcard);
320         struct snd_card_als100 *acard = card->private_data;
321         struct snd_sb *chip = acard->chip;
322
323         snd_sbdsp_reset(chip);
324         snd_sbmixer_resume(chip);
325         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
326         return 0;
327 }
328 #endif
329
330 static struct pnp_card_driver als100_pnpc_driver = {
331         .flags          = PNP_DRIVER_RES_DISABLE,
332         .name           = "als100",
333         .id_table       = snd_als100_pnpids,
334         .probe          = snd_als100_pnp_detect,
335         .remove         = snd_als100_pnp_remove,
336 #ifdef CONFIG_PM
337         .suspend        = snd_als100_pnp_suspend,
338         .resume         = snd_als100_pnp_resume,
339 #endif
340 };
341
342 static int __init alsa_card_als100_init(void)
343 {
344         int err;
345
346         err = pnp_register_card_driver(&als100_pnpc_driver);
347         if (err)
348                 return err;
349
350         if (!als100_devices) {
351                 pnp_unregister_card_driver(&als100_pnpc_driver);
352 #ifdef MODULE
353                 snd_printk(KERN_ERR "no Avance Logic based soundcards found\n");
354 #endif
355                 return -ENODEV;
356         }
357         return 0;
358 }
359
360 static void __exit alsa_card_als100_exit(void)
361 {
362         pnp_unregister_card_driver(&als100_pnpc_driver);
363 }
364
365 module_init(alsa_card_als100_init)
366 module_exit(alsa_card_als100_exit)