2 * Initialization routines
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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.
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.
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
22 #include <linux/init.h>
23 #include <linux/sched.h>
24 #include <linux/file.h>
25 #include <linux/slab.h>
26 #include <linux/time.h>
27 #include <linux/ctype.h>
30 #include <sound/core.h>
31 #include <sound/control.h>
32 #include <sound/info.h>
34 static DEFINE_SPINLOCK(shutdown_lock);
35 static LIST_HEAD(shutdown_files);
37 static const struct file_operations snd_shutdown_f_ops;
39 static unsigned int snd_cards_lock; /* locked for registering/using */
40 struct snd_card *snd_cards[SNDRV_CARDS];
41 EXPORT_SYMBOL(snd_cards);
43 static DEFINE_MUTEX(snd_card_mutex);
45 static char *slots[SNDRV_CARDS];
46 module_param_array(slots, charp, NULL, 0444);
47 MODULE_PARM_DESC(slots, "Module names assigned to the slots.");
49 /* return non-zero if the given index is reserved for the given
50 * module via slots option
52 static int module_slot_match(struct module *module, int idx)
58 if (!module || !module->name || !slots[idx])
64 match = 0; /* negative match */
67 /* compare module name strings
68 * hyphens are handled as equivalent with underscore
86 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
87 int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
88 EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
92 static void snd_card_id_read(struct snd_info_entry *entry,
93 struct snd_info_buffer *buffer)
95 snd_iprintf(buffer, "%s\n", entry->card->id);
98 static inline int init_info_for_card(struct snd_card *card)
101 struct snd_info_entry *entry;
103 if ((err = snd_info_card_register(card)) < 0) {
104 snd_printd("unable to create card info\n");
107 if ((entry = snd_info_create_card_entry(card, "id", card->proc_root)) == NULL) {
108 snd_printd("unable to create card entry\n");
111 entry->c.text.read = snd_card_id_read;
112 if (snd_info_register(entry) < 0) {
113 snd_info_free_entry(entry);
116 card->proc_id = entry;
119 #else /* !CONFIG_PROC_FS */
120 #define init_info_for_card(card)
124 * snd_card_create - create and initialize a soundcard structure
125 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
126 * @xid: card identification (ASCII string)
127 * @module: top level module for locking
128 * @extra_size: allocate this extra size after the main soundcard structure
129 * @card_ret: the pointer to store the created card instance
131 * Creates and initializes a soundcard structure.
133 * The function allocates snd_card instance via kzalloc with the given
134 * space for the driver to use freely. The allocated struct is stored
135 * in the given card_ret pointer.
137 * Returns zero if successful or a negative error code.
139 int snd_card_create(int idx, const char *xid,
140 struct module *module, int extra_size,
141 struct snd_card **card_ret)
143 struct snd_card *card;
146 if (snd_BUG_ON(!card_ret))
152 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
156 strlcpy(card->id, xid, sizeof(card->id));
158 mutex_lock(&snd_card_mutex);
160 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
161 /* idx == -1 == 0xffff means: take any free slot */
162 if (~snd_cards_lock & idx & 1<<idx2) {
163 if (module_slot_match(module, idx2)) {
170 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
171 /* idx == -1 == 0xffff means: take any free slot */
172 if (~snd_cards_lock & idx & 1<<idx2) {
173 if (!slots[idx2] || !*slots[idx2]) {
181 else if (idx < snd_ecards_limit) {
182 if (snd_cards_lock & (1 << idx))
183 err = -EBUSY; /* invalid */
184 } else if (idx >= SNDRV_CARDS)
187 mutex_unlock(&snd_card_mutex);
188 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i), error: %d\n",
189 idx, snd_ecards_limit - 1, err);
192 snd_cards_lock |= 1 << idx; /* lock it */
193 if (idx >= snd_ecards_limit)
194 snd_ecards_limit = idx + 1; /* increase the limit */
195 mutex_unlock(&snd_card_mutex);
197 card->module = module;
198 INIT_LIST_HEAD(&card->devices);
199 init_rwsem(&card->controls_rwsem);
200 rwlock_init(&card->ctl_files_rwlock);
201 INIT_LIST_HEAD(&card->controls);
202 INIT_LIST_HEAD(&card->ctl_files);
203 spin_lock_init(&card->files_lock);
204 INIT_LIST_HEAD(&card->files_list);
205 init_waitqueue_head(&card->shutdown_sleep);
207 mutex_init(&card->power_lock);
208 init_waitqueue_head(&card->power_sleep);
210 /* the control interface cannot be accessed from the user space until */
211 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
212 err = snd_ctl_create(card);
214 snd_printk(KERN_ERR "unable to register control minors\n");
217 err = snd_info_card_create(card);
219 snd_printk(KERN_ERR "unable to create card info\n");
223 card->private_data = (char *)card + sizeof(struct snd_card);
228 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
233 EXPORT_SYMBOL(snd_card_create);
235 /* return non-zero if a card is already locked */
236 int snd_card_locked(int card)
240 mutex_lock(&snd_card_mutex);
241 locked = snd_cards_lock & (1 << card);
242 mutex_unlock(&snd_card_mutex);
246 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
251 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
252 size_t count, loff_t *offset)
257 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
258 size_t count, loff_t *offset)
263 static int snd_disconnect_release(struct inode *inode, struct file *file)
265 struct snd_monitor_file *df = NULL, *_df;
267 spin_lock(&shutdown_lock);
268 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
269 if (_df->file == file) {
271 list_del_init(&df->shutdown_list);
275 spin_unlock(&shutdown_lock);
278 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
279 df->disconnected_f_op->fasync(-1, file, 0);
280 return df->disconnected_f_op->release(inode, file);
283 panic("%s(%p, %p) failed!", __func__, inode, file);
286 static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
288 return POLLERR | POLLNVAL;
291 static long snd_disconnect_ioctl(struct file *file,
292 unsigned int cmd, unsigned long arg)
297 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
302 static int snd_disconnect_fasync(int fd, struct file *file, int on)
307 static const struct file_operations snd_shutdown_f_ops =
309 .owner = THIS_MODULE,
310 .llseek = snd_disconnect_llseek,
311 .read = snd_disconnect_read,
312 .write = snd_disconnect_write,
313 .release = snd_disconnect_release,
314 .poll = snd_disconnect_poll,
315 .unlocked_ioctl = snd_disconnect_ioctl,
317 .compat_ioctl = snd_disconnect_ioctl,
319 .mmap = snd_disconnect_mmap,
320 .fasync = snd_disconnect_fasync
324 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
325 * @card: soundcard structure
327 * Disconnects all APIs from the file-operations (user space).
329 * Returns zero, otherwise a negative error code.
331 * Note: The current implementation replaces all active file->f_op with special
332 * dummy file operations (they do nothing except release).
334 int snd_card_disconnect(struct snd_card *card)
336 struct snd_monitor_file *mfile;
343 spin_lock(&card->files_lock);
344 if (card->shutdown) {
345 spin_unlock(&card->files_lock);
349 spin_unlock(&card->files_lock);
351 /* phase 1: disable fops (user space) operations for ALSA API */
352 mutex_lock(&snd_card_mutex);
353 snd_cards[card->number] = NULL;
354 snd_cards_lock &= ~(1 << card->number);
355 mutex_unlock(&snd_card_mutex);
357 /* phase 2: replace file->f_op with special dummy operations */
359 spin_lock(&card->files_lock);
360 list_for_each_entry(mfile, &card->files_list, list) {
363 /* it's critical part, use endless loop */
364 /* we have no room to fail */
365 mfile->disconnected_f_op = mfile->file->f_op;
367 spin_lock(&shutdown_lock);
368 list_add(&mfile->shutdown_list, &shutdown_files);
369 spin_unlock(&shutdown_lock);
371 mfile->file->f_op = &snd_shutdown_f_ops;
372 fops_get(mfile->file->f_op);
374 spin_unlock(&card->files_lock);
376 /* phase 3: notify all connected devices about disconnection */
377 /* at this point, they cannot respond to any calls except release() */
379 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
380 if (snd_mixer_oss_notify_callback)
381 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
384 /* notify all devices that we are disconnected */
385 err = snd_device_disconnect_all(card);
387 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
389 snd_info_card_disconnect(card);
390 #ifndef CONFIG_SYSFS_DEPRECATED
391 if (card->card_dev) {
392 device_unregister(card->card_dev);
393 card->card_dev = NULL;
397 wake_up(&card->power_sleep);
402 EXPORT_SYMBOL(snd_card_disconnect);
405 * snd_card_free - frees given soundcard structure
406 * @card: soundcard structure
408 * This function releases the soundcard structure and the all assigned
409 * devices automatically. That is, you don't have to release the devices
412 * Returns zero. Frees all associated devices and frees the control
413 * interface associated to given soundcard.
415 static int snd_card_do_free(struct snd_card *card)
417 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
418 if (snd_mixer_oss_notify_callback)
419 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
421 if (snd_device_free_all(card, SNDRV_DEV_CMD_PRE) < 0) {
422 snd_printk(KERN_ERR "unable to free all devices (pre)\n");
423 /* Fatal, but this situation should never occur */
425 if (snd_device_free_all(card, SNDRV_DEV_CMD_NORMAL) < 0) {
426 snd_printk(KERN_ERR "unable to free all devices (normal)\n");
427 /* Fatal, but this situation should never occur */
429 if (snd_device_free_all(card, SNDRV_DEV_CMD_POST) < 0) {
430 snd_printk(KERN_ERR "unable to free all devices (post)\n");
431 /* Fatal, but this situation should never occur */
433 if (card->private_free)
434 card->private_free(card);
435 snd_info_free_entry(card->proc_id);
436 if (snd_info_card_free(card) < 0) {
437 snd_printk(KERN_WARNING "unable to free card info\n");
438 /* Not fatal error */
444 int snd_card_free_when_closed(struct snd_card *card)
447 int ret = snd_card_disconnect(card);
451 spin_lock(&card->files_lock);
452 if (list_empty(&card->files_list))
455 card->free_on_last_close = 1;
456 spin_unlock(&card->files_lock);
459 snd_card_do_free(card);
463 EXPORT_SYMBOL(snd_card_free_when_closed);
465 int snd_card_free(struct snd_card *card)
467 int ret = snd_card_disconnect(card);
471 /* wait, until all devices are ready for the free operation */
472 wait_event(card->shutdown_sleep, list_empty(&card->files_list));
473 snd_card_do_free(card);
477 EXPORT_SYMBOL(snd_card_free);
479 static void snd_card_set_id_no_lock(struct snd_card *card, const char *nid)
481 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
482 const char *spos, *src;
486 id = card->shortname;
488 while (*id != '\0') {
497 while (*spos != '\0' && !isalnum(*spos))
500 *id++ = isalpha(src[0]) ? src[0] : 'D';
501 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
511 strcpy(id, "default");
515 snd_printk(KERN_ERR "unable to set card id (%s)\n", id);
516 strcpy(card->id, card->proc_root->name);
519 if (!snd_info_check_reserved_words(id))
521 for (i = 0; i < snd_ecards_limit; i++) {
522 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
530 if (id[len-1] != '9')
534 } else if ((size_t)len <= sizeof(card->id) - 3) {
539 if ((size_t)len <= sizeof(card->id) - 2)
541 *(char *)spos++ = '_';
542 *(char *)spos++ = '1';
543 *(char *)spos++ = '\0';
550 * snd_card_set_id - set card identification name
551 * @card: soundcard structure
552 * @nid: new identification string
554 * This function sets the card identification and checks for name
557 void snd_card_set_id(struct snd_card *card, const char *nid)
559 /* check if user specified own card->id */
560 if (card->id[0] != '\0')
562 mutex_lock(&snd_card_mutex);
563 snd_card_set_id_no_lock(card, nid);
564 mutex_unlock(&snd_card_mutex);
566 EXPORT_SYMBOL(snd_card_set_id);
568 #ifndef CONFIG_SYSFS_DEPRECATED
570 card_id_show_attr(struct device *dev,
571 struct device_attribute *attr, char *buf)
573 struct snd_card *card = dev_get_drvdata(dev);
574 return snprintf(buf, PAGE_SIZE, "%s\n", card ? card->id : "(null)");
578 card_id_store_attr(struct device *dev, struct device_attribute *attr,
579 const char *buf, size_t count)
581 struct snd_card *card = dev_get_drvdata(dev);
582 char buf1[sizeof(card->id)];
583 size_t copy = count > sizeof(card->id) - 1 ?
584 sizeof(card->id) - 1 : count;
588 for (idx = 0; idx < copy; idx++) {
590 if (!isalnum(c) && c != '_' && c != '-')
593 memcpy(buf1, buf, copy);
595 mutex_lock(&snd_card_mutex);
596 if (!snd_info_check_reserved_words(buf1)) {
598 mutex_unlock(&snd_card_mutex);
601 for (idx = 0; idx < snd_ecards_limit; idx++) {
602 if (snd_cards[idx] && !strcmp(snd_cards[idx]->id, buf1))
605 strcpy(card->id, buf1);
606 snd_info_card_id_change(card);
607 mutex_unlock(&snd_card_mutex);
612 static struct device_attribute card_id_attrs =
613 __ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
616 card_number_show_attr(struct device *dev,
617 struct device_attribute *attr, char *buf)
619 struct snd_card *card = dev_get_drvdata(dev);
620 return snprintf(buf, PAGE_SIZE, "%i\n", card ? card->number : -1);
623 static struct device_attribute card_number_attrs =
624 __ATTR(number, S_IRUGO, card_number_show_attr, NULL);
625 #endif /* CONFIG_SYSFS_DEPRECATED */
628 * snd_card_register - register the soundcard
629 * @card: soundcard structure
631 * This function registers all the devices assigned to the soundcard.
632 * Until calling this, the ALSA control interface is blocked from the
633 * external accesses. Thus, you should call this function at the end
634 * of the initialization of the card.
636 * Returns zero otherwise a negative error code if the registrain failed.
638 int snd_card_register(struct snd_card *card)
642 if (snd_BUG_ON(!card))
644 #ifndef CONFIG_SYSFS_DEPRECATED
645 if (!card->card_dev) {
646 card->card_dev = device_create(sound_class, card->dev,
648 "card%i", card->number);
649 if (IS_ERR(card->card_dev))
650 card->card_dev = NULL;
653 if ((err = snd_device_register_all(card)) < 0)
655 mutex_lock(&snd_card_mutex);
656 if (snd_cards[card->number]) {
657 /* already registered */
658 mutex_unlock(&snd_card_mutex);
661 snd_card_set_id_no_lock(card, card->id[0] == '\0' ? NULL : card->id);
662 snd_cards[card->number] = card;
663 mutex_unlock(&snd_card_mutex);
664 init_info_for_card(card);
665 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
666 if (snd_mixer_oss_notify_callback)
667 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
669 #ifndef CONFIG_SYSFS_DEPRECATED
670 if (card->card_dev) {
671 err = device_create_file(card->card_dev, &card_id_attrs);
674 err = device_create_file(card->card_dev, &card_number_attrs);
682 EXPORT_SYMBOL(snd_card_register);
684 #ifdef CONFIG_PROC_FS
685 static struct snd_info_entry *snd_card_info_entry;
687 static void snd_card_info_read(struct snd_info_entry *entry,
688 struct snd_info_buffer *buffer)
691 struct snd_card *card;
693 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
694 mutex_lock(&snd_card_mutex);
695 if ((card = snd_cards[idx]) != NULL) {
697 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
702 snd_iprintf(buffer, " %s\n",
705 mutex_unlock(&snd_card_mutex);
708 snd_iprintf(buffer, "--- no soundcards ---\n");
711 #ifdef CONFIG_SND_OSSEMUL
713 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
716 struct snd_card *card;
718 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
719 mutex_lock(&snd_card_mutex);
720 if ((card = snd_cards[idx]) != NULL) {
722 snd_iprintf(buffer, "%s\n", card->longname);
724 mutex_unlock(&snd_card_mutex);
727 snd_iprintf(buffer, "--- no soundcards ---\n");
734 static struct snd_info_entry *snd_card_module_info_entry;
735 static void snd_card_module_info_read(struct snd_info_entry *entry,
736 struct snd_info_buffer *buffer)
739 struct snd_card *card;
741 for (idx = 0; idx < SNDRV_CARDS; idx++) {
742 mutex_lock(&snd_card_mutex);
743 if ((card = snd_cards[idx]) != NULL)
744 snd_iprintf(buffer, "%2i %s\n",
745 idx, card->module->name);
746 mutex_unlock(&snd_card_mutex);
751 int __init snd_card_info_init(void)
753 struct snd_info_entry *entry;
755 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
758 entry->c.text.read = snd_card_info_read;
759 if (snd_info_register(entry) < 0) {
760 snd_info_free_entry(entry);
763 snd_card_info_entry = entry;
766 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
768 entry->c.text.read = snd_card_module_info_read;
769 if (snd_info_register(entry) < 0)
770 snd_info_free_entry(entry);
772 snd_card_module_info_entry = entry;
779 int __exit snd_card_info_done(void)
781 snd_info_free_entry(snd_card_info_entry);
783 snd_info_free_entry(snd_card_module_info_entry);
788 #endif /* CONFIG_PROC_FS */
791 * snd_component_add - add a component string
792 * @card: soundcard structure
793 * @component: the component id string
795 * This function adds the component id string to the supported list.
796 * The component can be referred from the alsa-lib.
798 * Returns zero otherwise a negative error code.
801 int snd_component_add(struct snd_card *card, const char *component)
804 int len = strlen(component);
806 ptr = strstr(card->components, component);
808 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
811 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
815 if (card->components[0] != '\0')
816 strcat(card->components, " ");
817 strcat(card->components, component);
821 EXPORT_SYMBOL(snd_component_add);
824 * snd_card_file_add - add the file to the file list of the card
825 * @card: soundcard structure
826 * @file: file pointer
828 * This function adds the file to the file linked-list of the card.
829 * This linked-list is used to keep tracking the connection state,
830 * and to avoid the release of busy resources by hotplug.
832 * Returns zero or a negative error code.
834 int snd_card_file_add(struct snd_card *card, struct file *file)
836 struct snd_monitor_file *mfile;
838 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
842 mfile->disconnected_f_op = NULL;
843 spin_lock(&card->files_lock);
844 if (card->shutdown) {
845 spin_unlock(&card->files_lock);
849 list_add(&mfile->list, &card->files_list);
850 spin_unlock(&card->files_lock);
854 EXPORT_SYMBOL(snd_card_file_add);
857 * snd_card_file_remove - remove the file from the file list
858 * @card: soundcard structure
859 * @file: file pointer
861 * This function removes the file formerly added to the card via
862 * snd_card_file_add() function.
863 * If all files are removed and snd_card_free_when_closed() was
864 * called beforehand, it processes the pending release of
867 * Returns zero or a negative error code.
869 int snd_card_file_remove(struct snd_card *card, struct file *file)
871 struct snd_monitor_file *mfile, *found = NULL;
874 spin_lock(&card->files_lock);
875 list_for_each_entry(mfile, &card->files_list, list) {
876 if (mfile->file == file) {
877 list_del(&mfile->list);
878 if (mfile->disconnected_f_op)
879 fops_put(mfile->disconnected_f_op);
884 if (list_empty(&card->files_list))
886 spin_unlock(&card->files_lock);
888 wake_up(&card->shutdown_sleep);
889 if (card->free_on_last_close)
890 snd_card_do_free(card);
893 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
900 EXPORT_SYMBOL(snd_card_file_remove);
904 * snd_power_wait - wait until the power-state is changed.
905 * @card: soundcard structure
906 * @power_state: expected power state
908 * Waits until the power-state is changed.
910 * Note: the power lock must be active before call.
912 int snd_power_wait(struct snd_card *card, unsigned int power_state)
918 if (snd_power_get_state(card) == power_state)
920 init_waitqueue_entry(&wait, current);
921 add_wait_queue(&card->power_sleep, &wait);
923 if (card->shutdown) {
927 if (snd_power_get_state(card) == power_state)
929 set_current_state(TASK_UNINTERRUPTIBLE);
930 snd_power_unlock(card);
931 schedule_timeout(30 * HZ);
932 snd_power_lock(card);
934 remove_wait_queue(&card->power_sleep, &wait);
938 EXPORT_SYMBOL(snd_power_wait);
939 #endif /* CONFIG_PM */