ALSA: support module on-demand loading for seq and timer
[linux-2.6.git] / sound / core / sound.c
1 /*
2  *  Advanced Linux Sound Architecture
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.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 <linux/init.h>
23 #include <linux/slab.h>
24 #include <linux/smp_lock.h>
25 #include <linux/time.h>
26 #include <linux/device.h>
27 #include <linux/moduleparam.h>
28 #include <sound/core.h>
29 #include <sound/minors.h>
30 #include <sound/info.h>
31 #include <sound/version.h>
32 #include <sound/control.h>
33 #include <sound/initval.h>
34 #include <linux/kmod.h>
35 #include <linux/mutex.h>
36
37 static int major = CONFIG_SND_MAJOR;
38 int snd_major;
39 EXPORT_SYMBOL(snd_major);
40
41 static int cards_limit = 1;
42
43 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
44 MODULE_DESCRIPTION("Advanced Linux Sound Architecture driver for soundcards.");
45 MODULE_LICENSE("GPL");
46 module_param(major, int, 0444);
47 MODULE_PARM_DESC(major, "Major # for sound driver.");
48 module_param(cards_limit, int, 0444);
49 MODULE_PARM_DESC(cards_limit, "Count of auto-loadable soundcards.");
50 MODULE_ALIAS_CHARDEV_MAJOR(CONFIG_SND_MAJOR);
51
52 /* this one holds the actual max. card number currently available.
53  * as default, it's identical with cards_limit option.  when more
54  * modules are loaded manually, this limit number increases, too.
55  */
56 int snd_ecards_limit;
57 EXPORT_SYMBOL(snd_ecards_limit);
58
59 static struct snd_minor *snd_minors[SNDRV_OS_MINORS];
60 static DEFINE_MUTEX(sound_mutex);
61
62 #ifdef CONFIG_MODULES
63
64 /**
65  * snd_request_card - try to load the card module
66  * @card: the card number
67  *
68  * Tries to load the module "snd-card-X" for the given card number
69  * via request_module.  Returns immediately if already loaded.
70  */
71 void snd_request_card(int card)
72 {
73         if (snd_card_locked(card))
74                 return;
75         if (card < 0 || card >= cards_limit)
76                 return;
77         request_module("snd-card-%i", card);
78 }
79
80 EXPORT_SYMBOL(snd_request_card);
81
82 static void snd_request_other(int minor)
83 {
84         char *str;
85
86         switch (minor) {
87         case SNDRV_MINOR_SEQUENCER:     str = "snd-seq";        break;
88         case SNDRV_MINOR_TIMER:         str = "snd-timer";      break;
89         default:                        return;
90         }
91         request_module(str);
92 }
93
94 #endif  /* modular kernel */
95
96 /**
97  * snd_lookup_minor_data - get user data of a registered device
98  * @minor: the minor number
99  * @type: device type (SNDRV_DEVICE_TYPE_XXX)
100  *
101  * Checks that a minor device with the specified type is registered, and returns
102  * its user data pointer.
103  */
104 void *snd_lookup_minor_data(unsigned int minor, int type)
105 {
106         struct snd_minor *mreg;
107         void *private_data;
108
109         if (minor >= ARRAY_SIZE(snd_minors))
110                 return NULL;
111         mutex_lock(&sound_mutex);
112         mreg = snd_minors[minor];
113         if (mreg && mreg->type == type)
114                 private_data = mreg->private_data;
115         else
116                 private_data = NULL;
117         mutex_unlock(&sound_mutex);
118         return private_data;
119 }
120
121 EXPORT_SYMBOL(snd_lookup_minor_data);
122
123 #ifdef CONFIG_MODULES
124 static struct snd_minor *autoload_device(unsigned int minor)
125 {
126         int dev;
127         mutex_unlock(&sound_mutex); /* release lock temporarily */
128         dev = SNDRV_MINOR_DEVICE(minor);
129         if (dev == SNDRV_MINOR_CONTROL) {
130                 /* /dev/aloadC? */
131                 int card = SNDRV_MINOR_CARD(minor);
132                 if (snd_cards[card] == NULL)
133                         snd_request_card(card);
134         } else if (dev == SNDRV_MINOR_GLOBAL) {
135                 /* /dev/aloadSEQ */
136                 snd_request_other(minor);
137         }
138         mutex_lock(&sound_mutex); /* reacuire lock */
139         return snd_minors[minor];
140 }
141 #else /* !CONFIG_MODULES */
142 #define autoload_device(minor)  NULL
143 #endif /* CONFIG_MODULES */
144
145 static int snd_open(struct inode *inode, struct file *file)
146 {
147         unsigned int minor = iminor(inode);
148         struct snd_minor *mptr = NULL;
149         const struct file_operations *old_fops;
150         int err = 0;
151
152         if (minor >= ARRAY_SIZE(snd_minors))
153                 return -ENODEV;
154         mutex_lock(&sound_mutex);
155         mptr = snd_minors[minor];
156         if (mptr == NULL) {
157                 mptr = autoload_device(minor);
158                 if (!mptr) {
159                         mutex_unlock(&sound_mutex);
160                         return -ENODEV;
161                 }
162         }
163         old_fops = file->f_op;
164         file->f_op = fops_get(mptr->f_ops);
165         if (file->f_op == NULL) {
166                 file->f_op = old_fops;
167                 err = -ENODEV;
168         }
169         mutex_unlock(&sound_mutex);
170         if (err < 0)
171                 return err;
172
173         if (file->f_op->open) {
174                 err = file->f_op->open(inode, file);
175                 if (err) {
176                         fops_put(file->f_op);
177                         file->f_op = fops_get(old_fops);
178                 }
179         }
180         fops_put(old_fops);
181         return err;
182 }
183
184 static const struct file_operations snd_fops =
185 {
186         .owner =        THIS_MODULE,
187         .open =         snd_open,
188         .llseek =       noop_llseek,
189 };
190
191 #ifdef CONFIG_SND_DYNAMIC_MINORS
192 static int snd_find_free_minor(int type)
193 {
194         int minor;
195
196         /* static minors for module auto loading */
197         if (type == SNDRV_DEVICE_TYPE_SEQUENCER)
198                 return SNDRV_MINOR_SEQUENCER;
199         if (type == SNDRV_DEVICE_TYPE_TIMER)
200                 return SNDRV_MINOR_TIMER;
201
202         for (minor = 0; minor < ARRAY_SIZE(snd_minors); ++minor) {
203                 /* skip static minors still used for module auto loading */
204                 if (SNDRV_MINOR_DEVICE(minor) == SNDRV_MINOR_CONTROL)
205                         continue;
206                 if (minor == SNDRV_MINOR_SEQUENCER ||
207                     minor == SNDRV_MINOR_TIMER)
208                         continue;
209                 if (!snd_minors[minor])
210                         return minor;
211         }
212         return -EBUSY;
213 }
214 #else
215 static int snd_kernel_minor(int type, struct snd_card *card, int dev)
216 {
217         int minor;
218
219         switch (type) {
220         case SNDRV_DEVICE_TYPE_SEQUENCER:
221         case SNDRV_DEVICE_TYPE_TIMER:
222                 minor = type;
223                 break;
224         case SNDRV_DEVICE_TYPE_CONTROL:
225                 if (snd_BUG_ON(!card))
226                         return -EINVAL;
227                 minor = SNDRV_MINOR(card->number, type);
228                 break;
229         case SNDRV_DEVICE_TYPE_HWDEP:
230         case SNDRV_DEVICE_TYPE_RAWMIDI:
231         case SNDRV_DEVICE_TYPE_PCM_PLAYBACK:
232         case SNDRV_DEVICE_TYPE_PCM_CAPTURE:
233                 if (snd_BUG_ON(!card))
234                         return -EINVAL;
235                 minor = SNDRV_MINOR(card->number, type + dev);
236                 break;
237         default:
238                 return -EINVAL;
239         }
240         if (snd_BUG_ON(minor < 0 || minor >= SNDRV_OS_MINORS))
241                 return -EINVAL;
242         return minor;
243 }
244 #endif
245
246 /**
247  * snd_register_device_for_dev - Register the ALSA device file for the card
248  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
249  * @card: the card instance
250  * @dev: the device index
251  * @f_ops: the file operations
252  * @private_data: user pointer for f_ops->open()
253  * @name: the device file name
254  * @device: the &struct device to link this new device to
255  *
256  * Registers an ALSA device file for the given card.
257  * The operators have to be set in reg parameter.
258  *
259  * Returns zero if successful, or a negative error code on failure.
260  */
261 int snd_register_device_for_dev(int type, struct snd_card *card, int dev,
262                                 const struct file_operations *f_ops,
263                                 void *private_data,
264                                 const char *name, struct device *device)
265 {
266         int minor;
267         struct snd_minor *preg;
268
269         if (snd_BUG_ON(!name))
270                 return -EINVAL;
271         preg = kmalloc(sizeof *preg, GFP_KERNEL);
272         if (preg == NULL)
273                 return -ENOMEM;
274         preg->type = type;
275         preg->card = card ? card->number : -1;
276         preg->device = dev;
277         preg->f_ops = f_ops;
278         preg->private_data = private_data;
279         mutex_lock(&sound_mutex);
280 #ifdef CONFIG_SND_DYNAMIC_MINORS
281         minor = snd_find_free_minor(type);
282 #else
283         minor = snd_kernel_minor(type, card, dev);
284         if (minor >= 0 && snd_minors[minor])
285                 minor = -EBUSY;
286 #endif
287         if (minor < 0) {
288                 mutex_unlock(&sound_mutex);
289                 kfree(preg);
290                 return minor;
291         }
292         snd_minors[minor] = preg;
293         preg->dev = device_create(sound_class, device, MKDEV(major, minor),
294                                   private_data, "%s", name);
295         if (IS_ERR(preg->dev)) {
296                 snd_minors[minor] = NULL;
297                 mutex_unlock(&sound_mutex);
298                 minor = PTR_ERR(preg->dev);
299                 kfree(preg);
300                 return minor;
301         }
302
303         mutex_unlock(&sound_mutex);
304         return 0;
305 }
306
307 EXPORT_SYMBOL(snd_register_device_for_dev);
308
309 /* find the matching minor record
310  * return the index of snd_minor, or -1 if not found
311  */
312 static int find_snd_minor(int type, struct snd_card *card, int dev)
313 {
314         int cardnum, minor;
315         struct snd_minor *mptr;
316
317         cardnum = card ? card->number : -1;
318         for (minor = 0; minor < ARRAY_SIZE(snd_minors); ++minor)
319                 if ((mptr = snd_minors[minor]) != NULL &&
320                     mptr->type == type &&
321                     mptr->card == cardnum &&
322                     mptr->device == dev)
323                         return minor;
324         return -1;
325 }
326
327 /**
328  * snd_unregister_device - unregister the device on the given card
329  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
330  * @card: the card instance
331  * @dev: the device index
332  *
333  * Unregisters the device file already registered via
334  * snd_register_device().
335  *
336  * Returns zero if sucecessful, or a negative error code on failure
337  */
338 int snd_unregister_device(int type, struct snd_card *card, int dev)
339 {
340         int minor;
341
342         mutex_lock(&sound_mutex);
343         minor = find_snd_minor(type, card, dev);
344         if (minor < 0) {
345                 mutex_unlock(&sound_mutex);
346                 return -EINVAL;
347         }
348
349         device_destroy(sound_class, MKDEV(major, minor));
350
351         kfree(snd_minors[minor]);
352         snd_minors[minor] = NULL;
353         mutex_unlock(&sound_mutex);
354         return 0;
355 }
356
357 EXPORT_SYMBOL(snd_unregister_device);
358
359 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
360                               struct device_attribute *attr)
361 {
362         int minor, ret = -EINVAL;
363         struct device *d;
364
365         mutex_lock(&sound_mutex);
366         minor = find_snd_minor(type, card, dev);
367         if (minor >= 0 && (d = snd_minors[minor]->dev) != NULL)
368                 ret = device_create_file(d, attr);
369         mutex_unlock(&sound_mutex);
370         return ret;
371
372 }
373
374 EXPORT_SYMBOL(snd_add_device_sysfs_file);
375
376 #ifdef CONFIG_PROC_FS
377 /*
378  *  INFO PART
379  */
380
381 static struct snd_info_entry *snd_minor_info_entry;
382
383 static const char *snd_device_type_name(int type)
384 {
385         switch (type) {
386         case SNDRV_DEVICE_TYPE_CONTROL:
387                 return "control";
388         case SNDRV_DEVICE_TYPE_HWDEP:
389                 return "hardware dependent";
390         case SNDRV_DEVICE_TYPE_RAWMIDI:
391                 return "raw midi";
392         case SNDRV_DEVICE_TYPE_PCM_PLAYBACK:
393                 return "digital audio playback";
394         case SNDRV_DEVICE_TYPE_PCM_CAPTURE:
395                 return "digital audio capture";
396         case SNDRV_DEVICE_TYPE_SEQUENCER:
397                 return "sequencer";
398         case SNDRV_DEVICE_TYPE_TIMER:
399                 return "timer";
400         default:
401                 return "?";
402         }
403 }
404
405 static void snd_minor_info_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
406 {
407         int minor;
408         struct snd_minor *mptr;
409
410         mutex_lock(&sound_mutex);
411         for (minor = 0; minor < SNDRV_OS_MINORS; ++minor) {
412                 if (!(mptr = snd_minors[minor]))
413                         continue;
414                 if (mptr->card >= 0) {
415                         if (mptr->device >= 0)
416                                 snd_iprintf(buffer, "%3i: [%2i-%2i]: %s\n",
417                                             minor, mptr->card, mptr->device,
418                                             snd_device_type_name(mptr->type));
419                         else
420                                 snd_iprintf(buffer, "%3i: [%2i]   : %s\n",
421                                             minor, mptr->card,
422                                             snd_device_type_name(mptr->type));
423                 } else
424                         snd_iprintf(buffer, "%3i:        : %s\n", minor,
425                                     snd_device_type_name(mptr->type));
426         }
427         mutex_unlock(&sound_mutex);
428 }
429
430 int __init snd_minor_info_init(void)
431 {
432         struct snd_info_entry *entry;
433
434         entry = snd_info_create_module_entry(THIS_MODULE, "devices", NULL);
435         if (entry) {
436                 entry->c.text.read = snd_minor_info_read;
437                 if (snd_info_register(entry) < 0) {
438                         snd_info_free_entry(entry);
439                         entry = NULL;
440                 }
441         }
442         snd_minor_info_entry = entry;
443         return 0;
444 }
445
446 int __exit snd_minor_info_done(void)
447 {
448         snd_info_free_entry(snd_minor_info_entry);
449         return 0;
450 }
451 #endif /* CONFIG_PROC_FS */
452
453 /*
454  *  INIT PART
455  */
456
457 static int __init alsa_sound_init(void)
458 {
459         snd_major = major;
460         snd_ecards_limit = cards_limit;
461         if (register_chrdev(major, "alsa", &snd_fops)) {
462                 snd_printk(KERN_ERR "unable to register native major device number %d\n", major);
463                 return -EIO;
464         }
465         if (snd_info_init() < 0) {
466                 unregister_chrdev(major, "alsa");
467                 return -ENOMEM;
468         }
469         snd_info_minor_register();
470 #ifndef MODULE
471         printk(KERN_INFO "Advanced Linux Sound Architecture Driver Version " CONFIG_SND_VERSION CONFIG_SND_DATE ".\n");
472 #endif
473         return 0;
474 }
475
476 static void __exit alsa_sound_exit(void)
477 {
478         snd_info_minor_unregister();
479         snd_info_done();
480         unregister_chrdev(major, "alsa");
481 }
482
483 subsys_initcall(alsa_sound_init);
484 module_exit(alsa_sound_exit);