xref: /openbmc/linux/sound/drivers/mpu401/mpu401.c (revision 96de0e252cedffad61b3cb5e05662c591898e69a)
1 /*
2  *  Driver for generic MPU-401 boards (UART mode only)
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4  *  Copyright (c) 2004 by Castet Matthieu <castet.matthieu@free.fr>
5  *
6  *
7  *   This program is free software; you can redistribute it and/or modify
8  *   it under the terms of the GNU General Public License as published by
9  *   the Free Software Foundation; either version 2 of the License, or
10  *   (at your option) any later version.
11  *
12  *   This program is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *   GNU General Public License for more details.
16  *
17  *   You should have received a copy of the GNU General Public License
18  *   along with this program; if not, write to the Free Software
19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
20  *
21  */
22 
23 #include <sound/driver.h>
24 #include <linux/init.h>
25 #include <linux/pnp.h>
26 #include <linux/err.h>
27 #include <linux/platform_device.h>
28 #include <linux/moduleparam.h>
29 #include <sound/core.h>
30 #include <sound/mpu401.h>
31 #include <sound/initval.h>
32 
33 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
34 MODULE_DESCRIPTION("MPU-401 UART");
35 MODULE_LICENSE("GPL");
36 
37 static int index[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -2}; /* exclude the first card */
38 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
39 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	/* Enable this card */
40 #ifdef CONFIG_PNP
41 static int pnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
42 #endif
43 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* MPU-401 port number */
44 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* MPU-401 IRQ */
45 static int uart_enter[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
46 
47 module_param_array(index, int, NULL, 0444);
48 MODULE_PARM_DESC(index, "Index value for MPU-401 device.");
49 module_param_array(id, charp, NULL, 0444);
50 MODULE_PARM_DESC(id, "ID string for MPU-401 device.");
51 module_param_array(enable, bool, NULL, 0444);
52 MODULE_PARM_DESC(enable, "Enable MPU-401 device.");
53 #ifdef CONFIG_PNP
54 module_param_array(pnp, bool, NULL, 0444);
55 MODULE_PARM_DESC(pnp, "PnP detection for MPU-401 device.");
56 #endif
57 module_param_array(port, long, NULL, 0444);
58 MODULE_PARM_DESC(port, "Port # for MPU-401 device.");
59 module_param_array(irq, int, NULL, 0444);
60 MODULE_PARM_DESC(irq, "IRQ # for MPU-401 device.");
61 module_param_array(uart_enter, bool, NULL, 0444);
62 MODULE_PARM_DESC(uart_enter, "Issue UART_ENTER command at open.");
63 
64 static struct platform_device *platform_devices[SNDRV_CARDS];
65 static int pnp_registered;
66 static unsigned int snd_mpu401_devices;
67 
68 static int snd_mpu401_create(int dev, struct snd_card **rcard)
69 {
70 	struct snd_card *card;
71 	int err;
72 
73 	if (!uart_enter[dev])
74 		snd_printk(KERN_ERR "the uart_enter option is obsolete; remove it\n");
75 
76 	*rcard = NULL;
77 	card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
78 	if (card == NULL)
79 		return -ENOMEM;
80 	strcpy(card->driver, "MPU-401 UART");
81 	strcpy(card->shortname, card->driver);
82 	sprintf(card->longname, "%s at %#lx, ", card->shortname, port[dev]);
83 	if (irq[dev] >= 0) {
84 		sprintf(card->longname + strlen(card->longname), "irq %d", irq[dev]);
85 	} else {
86 		strcat(card->longname, "polled");
87 	}
88 
89 	err = snd_mpu401_uart_new(card, 0, MPU401_HW_MPU401, port[dev], 0,
90 				  irq[dev], irq[dev] >= 0 ? IRQF_DISABLED : 0,
91 				  NULL);
92 	if (err < 0) {
93 		printk(KERN_ERR "MPU401 not detected at 0x%lx\n", port[dev]);
94 		goto _err;
95 	}
96 
97 	*rcard = card;
98 	return 0;
99 
100  _err:
101 	snd_card_free(card);
102 	return err;
103 }
104 
105 static int __devinit snd_mpu401_probe(struct platform_device *devptr)
106 {
107 	int dev = devptr->id;
108 	int err;
109 	struct snd_card *card;
110 
111 	if (port[dev] == SNDRV_AUTO_PORT) {
112 		snd_printk(KERN_ERR "specify port\n");
113 		return -EINVAL;
114 	}
115 	if (irq[dev] == SNDRV_AUTO_IRQ) {
116 		snd_printk(KERN_ERR "specify or disable IRQ\n");
117 		return -EINVAL;
118 	}
119 	err = snd_mpu401_create(dev, &card);
120 	if (err < 0)
121 		return err;
122 	snd_card_set_dev(card, &devptr->dev);
123 	if ((err = snd_card_register(card)) < 0) {
124 		snd_card_free(card);
125 		return err;
126 	}
127 	platform_set_drvdata(devptr, card);
128 	return 0;
129 }
130 
131 static int __devexit snd_mpu401_remove(struct platform_device *devptr)
132 {
133 	snd_card_free(platform_get_drvdata(devptr));
134 	platform_set_drvdata(devptr, NULL);
135 	return 0;
136 }
137 
138 #define SND_MPU401_DRIVER	"snd_mpu401"
139 
140 static struct platform_driver snd_mpu401_driver = {
141 	.probe		= snd_mpu401_probe,
142 	.remove		= __devexit_p(snd_mpu401_remove),
143 	.driver		= {
144 		.name	= SND_MPU401_DRIVER
145 	},
146 };
147 
148 
149 #ifdef CONFIG_PNP
150 
151 #define IO_EXTENT 2
152 
153 static struct pnp_device_id snd_mpu401_pnpids[] = {
154 	{ .id = "PNPb006" },
155 	{ .id = "" }
156 };
157 
158 MODULE_DEVICE_TABLE(pnp, snd_mpu401_pnpids);
159 
160 static int __devinit snd_mpu401_pnp(int dev, struct pnp_dev *device,
161 				 const struct pnp_device_id *id)
162 {
163 	if (!pnp_port_valid(device, 0) ||
164 	    pnp_port_flags(device, 0) & IORESOURCE_DISABLED) {
165 		snd_printk(KERN_ERR "no PnP port\n");
166 		return -ENODEV;
167 	}
168 	if (pnp_port_len(device, 0) < IO_EXTENT) {
169 		snd_printk(KERN_ERR "PnP port length is %llu, expected %d\n",
170 			   (unsigned long long)pnp_port_len(device, 0),
171 			   IO_EXTENT);
172 		return -ENODEV;
173 	}
174 	port[dev] = pnp_port_start(device, 0);
175 
176 	if (!pnp_irq_valid(device, 0) ||
177 	    pnp_irq_flags(device, 0) & IORESOURCE_DISABLED) {
178 		snd_printk(KERN_WARNING "no PnP irq, using polling\n");
179 		irq[dev] = -1;
180 	} else {
181 		irq[dev] = pnp_irq(device, 0);
182 	}
183 	return 0;
184 }
185 
186 static int __devinit snd_mpu401_pnp_probe(struct pnp_dev *pnp_dev,
187 					  const struct pnp_device_id *id)
188 {
189 	static int dev;
190 	struct snd_card *card;
191 	int err;
192 
193 	for ( ; dev < SNDRV_CARDS; ++dev) {
194 		if (!enable[dev] || !pnp[dev])
195 			continue;
196 		err = snd_mpu401_pnp(dev, pnp_dev, id);
197 		if (err < 0)
198 			return err;
199 		err = snd_mpu401_create(dev, &card);
200 		if (err < 0)
201 			return err;
202 		if ((err = snd_card_register(card)) < 0) {
203 			snd_card_free(card);
204 			return err;
205 		}
206 		snd_card_set_dev(card, &pnp_dev->dev);
207 		pnp_set_drvdata(pnp_dev, card);
208 		snd_mpu401_devices++;
209 		++dev;
210 		return 0;
211 	}
212 	return -ENODEV;
213 }
214 
215 static void __devexit snd_mpu401_pnp_remove(struct pnp_dev *dev)
216 {
217 	struct snd_card *card = (struct snd_card *) pnp_get_drvdata(dev);
218 
219 	snd_card_disconnect(card);
220 	snd_card_free_when_closed(card);
221 }
222 
223 static struct pnp_driver snd_mpu401_pnp_driver = {
224 	.name = "mpu401",
225 	.id_table = snd_mpu401_pnpids,
226 	.probe = snd_mpu401_pnp_probe,
227 	.remove = __devexit_p(snd_mpu401_pnp_remove),
228 };
229 #else
230 static struct pnp_driver snd_mpu401_pnp_driver;
231 #endif
232 
233 static void snd_mpu401_unregister_all(void)
234 {
235 	int i;
236 
237 	if (pnp_registered)
238 		pnp_unregister_driver(&snd_mpu401_pnp_driver);
239 	for (i = 0; i < ARRAY_SIZE(platform_devices); ++i)
240 		platform_device_unregister(platform_devices[i]);
241 	platform_driver_unregister(&snd_mpu401_driver);
242 }
243 
244 static int __init alsa_card_mpu401_init(void)
245 {
246 	int i, err;
247 
248 	if ((err = platform_driver_register(&snd_mpu401_driver)) < 0)
249 		return err;
250 
251 	for (i = 0; i < SNDRV_CARDS; i++) {
252 		struct platform_device *device;
253 		if (! enable[i])
254 			continue;
255 #ifdef CONFIG_PNP
256 		if (pnp[i])
257 			continue;
258 #endif
259 		device = platform_device_register_simple(SND_MPU401_DRIVER,
260 							 i, NULL, 0);
261 		if (IS_ERR(device))
262 			continue;
263 		if (!platform_get_drvdata(device)) {
264 			platform_device_unregister(device);
265 			continue;
266 		}
267 		platform_devices[i] = device;
268 		snd_mpu401_devices++;
269 	}
270 	err = pnp_register_driver(&snd_mpu401_pnp_driver);
271 	if (!err)
272 		pnp_registered = 1;
273 
274 	if (!snd_mpu401_devices) {
275 #ifdef MODULE
276 		printk(KERN_ERR "MPU-401 device not found or device busy\n");
277 #endif
278 		snd_mpu401_unregister_all();
279 		return -ENODEV;
280 	}
281 	return 0;
282 }
283 
284 static void __exit alsa_card_mpu401_exit(void)
285 {
286 	snd_mpu401_unregister_all();
287 }
288 
289 module_init(alsa_card_mpu401_init)
290 module_exit(alsa_card_mpu401_exit)
291