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