xref: /openbmc/linux/sound/isa/es1688/es1688.c (revision 87c2ce3b)
1 /*
2  *  Driver for generic ESS AudioDrive ESx688 soundcards
3  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
4  *
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21 
22 #include <sound/driver.h>
23 #include <linux/init.h>
24 #include <linux/err.h>
25 #include <linux/platform_device.h>
26 #include <linux/time.h>
27 #include <linux/wait.h>
28 #include <linux/moduleparam.h>
29 #include <asm/dma.h>
30 #include <sound/core.h>
31 #include <sound/es1688.h>
32 #include <sound/mpu401.h>
33 #include <sound/opl3.h>
34 #define SNDRV_LEGACY_FIND_FREE_IRQ
35 #define SNDRV_LEGACY_FIND_FREE_DMA
36 #include <sound/initval.h>
37 
38 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
39 MODULE_DESCRIPTION("ESS ESx688 AudioDrive");
40 MODULE_LICENSE("GPL");
41 MODULE_SUPPORTED_DEVICE("{{ESS,ES688 PnP AudioDrive,pnp:ESS0100},"
42 	        "{ESS,ES1688 PnP AudioDrive,pnp:ESS0102},"
43 	        "{ESS,ES688 AudioDrive,pnp:ESS6881},"
44 	        "{ESS,ES1688 AudioDrive,pnp:ESS1681}}");
45 
46 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
47 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
48 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	/* Enable this card */
49 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0x220,0x240,0x260 */
50 static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -1};
51 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 5,7,9,10 */
52 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 5,7,9,10 */
53 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 0,1,3 */
54 
55 module_param_array(index, int, NULL, 0444);
56 MODULE_PARM_DESC(index, "Index value for ESx688 soundcard.");
57 module_param_array(id, charp, NULL, 0444);
58 MODULE_PARM_DESC(id, "ID string for ESx688 soundcard.");
59 module_param_array(enable, bool, NULL, 0444);
60 MODULE_PARM_DESC(enable, "Enable ESx688 soundcard.");
61 module_param_array(port, long, NULL, 0444);
62 MODULE_PARM_DESC(port, "Port # for ESx688 driver.");
63 module_param_array(mpu_port, long, NULL, 0444);
64 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for ESx688 driver.");
65 module_param_array(irq, int, NULL, 0444);
66 MODULE_PARM_DESC(irq, "IRQ # for ESx688 driver.");
67 module_param_array(mpu_irq, int, NULL, 0444);
68 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for ESx688 driver.");
69 module_param_array(dma8, int, NULL, 0444);
70 MODULE_PARM_DESC(dma8, "8-bit DMA # for ESx688 driver.");
71 
72 static struct platform_device *devices[SNDRV_CARDS];
73 
74 #define PFX	"es1688: "
75 
76 static int __init snd_es1688_probe(struct platform_device *pdev)
77 {
78 	int dev = pdev->id;
79 	static int possible_irqs[] = {5, 9, 10, 7, -1};
80 	static int possible_dmas[] = {1, 3, 0, -1};
81 	int xirq, xdma, xmpu_irq;
82 	struct snd_card *card;
83 	struct snd_es1688 *chip;
84 	struct snd_opl3 *opl3;
85 	struct snd_pcm *pcm;
86 	int err;
87 
88 	card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
89 	if (card == NULL)
90 		return -ENOMEM;
91 
92 	xirq = irq[dev];
93 	if (xirq == SNDRV_AUTO_IRQ) {
94 		if ((xirq = snd_legacy_find_free_irq(possible_irqs)) < 0) {
95 			snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
96 			err = -EBUSY;
97 			goto _err;
98 		}
99 	}
100 	xmpu_irq = mpu_irq[dev];
101 	xdma = dma8[dev];
102 	if (xdma == SNDRV_AUTO_DMA) {
103 		if ((xdma = snd_legacy_find_free_dma(possible_dmas)) < 0) {
104 			snd_printk(KERN_ERR PFX "unable to find a free DMA\n");
105 			err = -EBUSY;
106 			goto _err;
107 		}
108 	}
109 
110 	if (port[dev] != SNDRV_AUTO_PORT) {
111 		if ((err = snd_es1688_create(card, port[dev], mpu_port[dev],
112 					     xirq, xmpu_irq, xdma,
113 					     ES1688_HW_AUTO, &chip)) < 0)
114 			goto _err;
115 	} else {
116 		/* auto-probe legacy ports */
117 		static unsigned long possible_ports[] = {
118 			0x220, 0x240, 0x260,
119 		};
120 		int i;
121 		for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
122 			err = snd_es1688_create(card, possible_ports[i],
123 						mpu_port[dev],
124 						xirq, xmpu_irq, xdma,
125 						ES1688_HW_AUTO, &chip);
126 			if (err >= 0) {
127 				port[dev] = possible_ports[i];
128 				break;
129 			}
130 		}
131 		if (i >= ARRAY_SIZE(possible_ports))
132 			goto _err;
133 	}
134 
135 	if ((err = snd_es1688_pcm(chip, 0, &pcm)) < 0)
136 		goto _err;
137 
138 	if ((err = snd_es1688_mixer(chip)) < 0)
139 		goto _err;
140 
141 	strcpy(card->driver, "ES1688");
142 	strcpy(card->shortname, pcm->name);
143 	sprintf(card->longname, "%s at 0x%lx, irq %i, dma %i", pcm->name, chip->port, xirq, xdma);
144 
145 	if ((snd_opl3_create(card, chip->port, chip->port + 2, OPL3_HW_OPL3, 0, &opl3)) < 0) {
146 		printk(KERN_WARNING PFX "opl3 not detected at 0x%lx\n", chip->port);
147 	} else {
148 		if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0)
149 			goto _err;
150 	}
151 
152 	if (xmpu_irq >= 0 && xmpu_irq != SNDRV_AUTO_IRQ && chip->mpu_port > 0) {
153 		if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
154 					       chip->mpu_port, 0,
155 					       xmpu_irq,
156 					       SA_INTERRUPT,
157 					       NULL)) < 0)
158 			goto _err;
159 	}
160 
161 	snd_card_set_dev(card, &pdev->dev);
162 
163 	if ((err = snd_card_register(card)) < 0)
164 		goto _err;
165 
166 	platform_set_drvdata(pdev, card);
167 	return 0;
168 
169  _err:
170 	snd_card_free(card);
171 	return err;
172 }
173 
174 static int snd_es1688_remove(struct platform_device *devptr)
175 {
176 	snd_card_free(platform_get_drvdata(devptr));
177 	platform_set_drvdata(devptr, NULL);
178 	return 0;
179 }
180 
181 #define ES1688_DRIVER	"snd_es1688"
182 
183 static struct platform_driver snd_es1688_driver = {
184 	.probe		= snd_es1688_probe,
185 	.remove		= snd_es1688_remove,
186 	/* FIXME: suspend/resume */
187 	.driver		= {
188 		.name	= ES1688_DRIVER
189 	},
190 };
191 
192 static void __init_or_module snd_es1688_unregister_all(void)
193 {
194 	int i;
195 
196 	for (i = 0; i < ARRAY_SIZE(devices); ++i)
197 		platform_device_unregister(devices[i]);
198 	platform_driver_unregister(&snd_es1688_driver);
199 }
200 
201 static int __init alsa_card_es1688_init(void)
202 {
203 	int i, cards, err;
204 
205 	err = platform_driver_register(&snd_es1688_driver);
206 	if (err < 0)
207 		return err;
208 
209 	cards = 0;
210 	for (i = 0; i < SNDRV_CARDS && enable[i]; i++) {
211 		struct platform_device *device;
212 		device = platform_device_register_simple(ES1688_DRIVER,
213 							 i, NULL, 0);
214 		if (IS_ERR(device)) {
215 			err = PTR_ERR(device);
216 			goto errout;
217 		}
218 		devices[i] = device;
219 		cards++;
220 	}
221 	if (!cards) {
222 #ifdef MODULE
223 		printk(KERN_ERR "ESS AudioDrive ES1688 soundcard not found or device busy\n");
224 #endif
225 		err = -ENODEV;
226 		goto errout;
227 	}
228 	return 0;
229 
230  errout:
231 	snd_es1688_unregister_all();
232 	return err;
233 }
234 
235 static void __exit alsa_card_es1688_exit(void)
236 {
237 	snd_es1688_unregister_all();
238 }
239 
240 module_init(alsa_card_es1688_init)
241 module_exit(alsa_card_es1688_exit)
242