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_new - 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
130 * Creates and initializes a soundcard structure.
132 * Returns kmallocated snd_card structure. Creates the ALSA control interface
133 * (which is blocked until snd_card_register function is called).
135 struct snd_card *snd_card_new(int idx, const char *xid,
136 struct module *module, int extra_size)
138 struct snd_card *card;
143 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
147 if (!snd_info_check_reserved_words(xid))
149 strlcpy(card->id, xid, sizeof(card->id));
152 mutex_lock(&snd_card_mutex);
154 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
155 /* idx == -1 == 0xffff means: take any free slot */
156 if (~snd_cards_lock & idx & 1<<idx2) {
157 if (module_slot_match(module, idx2)) {
164 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
165 /* idx == -1 == 0xffff means: take any free slot */
166 if (~snd_cards_lock & idx & 1<<idx2) {
167 if (!slots[idx2] || !*slots[idx2]) {
175 else if (idx < snd_ecards_limit) {
176 if (snd_cards_lock & (1 << idx))
177 err = -EBUSY; /* invalid */
178 } else if (idx >= SNDRV_CARDS)
181 mutex_unlock(&snd_card_mutex);
182 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i), error: %d\n",
183 idx, snd_ecards_limit - 1, err);
186 snd_cards_lock |= 1 << idx; /* lock it */
187 if (idx >= snd_ecards_limit)
188 snd_ecards_limit = idx + 1; /* increase the limit */
189 mutex_unlock(&snd_card_mutex);
191 card->module = module;
192 INIT_LIST_HEAD(&card->devices);
193 init_rwsem(&card->controls_rwsem);
194 rwlock_init(&card->ctl_files_rwlock);
195 INIT_LIST_HEAD(&card->controls);
196 INIT_LIST_HEAD(&card->ctl_files);
197 spin_lock_init(&card->files_lock);
198 INIT_LIST_HEAD(&card->files_list);
199 init_waitqueue_head(&card->shutdown_sleep);
201 mutex_init(&card->power_lock);
202 init_waitqueue_head(&card->power_sleep);
204 /* the control interface cannot be accessed from the user space until */
205 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
206 if ((err = snd_ctl_create(card)) < 0) {
207 snd_printd("unable to register control minors\n");
210 if ((err = snd_info_card_create(card)) < 0) {
211 snd_printd("unable to create card info\n");
215 card->private_data = (char *)card + sizeof(struct snd_card);
219 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
225 EXPORT_SYMBOL(snd_card_new);
227 /* return non-zero if a card is already locked */
228 int snd_card_locked(int card)
232 mutex_lock(&snd_card_mutex);
233 locked = snd_cards_lock & (1 << card);
234 mutex_unlock(&snd_card_mutex);
238 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
243 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
244 size_t count, loff_t *offset)
249 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
250 size_t count, loff_t *offset)
255 static int snd_disconnect_release(struct inode *inode, struct file *file)
257 struct snd_monitor_file *df = NULL, *_df;
259 spin_lock(&shutdown_lock);
260 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
261 if (_df->file == file) {
263 list_del_init(&df->shutdown_list);
267 spin_unlock(&shutdown_lock);
270 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
271 df->disconnected_f_op->fasync(-1, file, 0);
272 return df->disconnected_f_op->release(inode, file);
275 panic("%s(%p, %p) failed!", __func__, inode, file);
278 static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
280 return POLLERR | POLLNVAL;
283 static long snd_disconnect_ioctl(struct file *file,
284 unsigned int cmd, unsigned long arg)
289 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
294 static int snd_disconnect_fasync(int fd, struct file *file, int on)
299 static const struct file_operations snd_shutdown_f_ops =
301 .owner = THIS_MODULE,
302 .llseek = snd_disconnect_llseek,
303 .read = snd_disconnect_read,
304 .write = snd_disconnect_write,
305 .release = snd_disconnect_release,
306 .poll = snd_disconnect_poll,
307 .unlocked_ioctl = snd_disconnect_ioctl,
309 .compat_ioctl = snd_disconnect_ioctl,
311 .mmap = snd_disconnect_mmap,
312 .fasync = snd_disconnect_fasync
316 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
317 * @card: soundcard structure
319 * Disconnects all APIs from the file-operations (user space).
321 * Returns zero, otherwise a negative error code.
323 * Note: The current implementation replaces all active file->f_op with special
324 * dummy file operations (they do nothing except release).
326 int snd_card_disconnect(struct snd_card *card)
328 struct snd_monitor_file *mfile;
335 spin_lock(&card->files_lock);
336 if (card->shutdown) {
337 spin_unlock(&card->files_lock);
341 spin_unlock(&card->files_lock);
343 /* phase 1: disable fops (user space) operations for ALSA API */
344 mutex_lock(&snd_card_mutex);
345 snd_cards[card->number] = NULL;
346 snd_cards_lock &= ~(1 << card->number);
347 mutex_unlock(&snd_card_mutex);
349 /* phase 2: replace file->f_op with special dummy operations */
351 spin_lock(&card->files_lock);
352 list_for_each_entry(mfile, &card->files_list, list) {
355 /* it's critical part, use endless loop */
356 /* we have no room to fail */
357 mfile->disconnected_f_op = mfile->file->f_op;
359 spin_lock(&shutdown_lock);
360 list_add(&mfile->shutdown_list, &shutdown_files);
361 spin_unlock(&shutdown_lock);
363 mfile->file->f_op = &snd_shutdown_f_ops;
364 fops_get(mfile->file->f_op);
366 spin_unlock(&card->files_lock);
368 /* phase 3: notify all connected devices about disconnection */
369 /* at this point, they cannot respond to any calls except release() */
371 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
372 if (snd_mixer_oss_notify_callback)
373 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
376 /* notify all devices that we are disconnected */
377 err = snd_device_disconnect_all(card);
379 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
381 snd_info_card_disconnect(card);
382 #ifndef CONFIG_SYSFS_DEPRECATED
383 if (card->card_dev) {
384 device_unregister(card->card_dev);
385 card->card_dev = NULL;
389 wake_up(&card->power_sleep);
394 EXPORT_SYMBOL(snd_card_disconnect);
397 * snd_card_free - frees given soundcard structure
398 * @card: soundcard structure
400 * This function releases the soundcard structure and the all assigned
401 * devices automatically. That is, you don't have to release the devices
404 * Returns zero. Frees all associated devices and frees the control
405 * interface associated to given soundcard.
407 static int snd_card_do_free(struct snd_card *card)
409 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
410 if (snd_mixer_oss_notify_callback)
411 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
413 if (snd_device_free_all(card, SNDRV_DEV_CMD_PRE) < 0) {
414 snd_printk(KERN_ERR "unable to free all devices (pre)\n");
415 /* Fatal, but this situation should never occur */
417 if (snd_device_free_all(card, SNDRV_DEV_CMD_NORMAL) < 0) {
418 snd_printk(KERN_ERR "unable to free all devices (normal)\n");
419 /* Fatal, but this situation should never occur */
421 if (snd_device_free_all(card, SNDRV_DEV_CMD_POST) < 0) {
422 snd_printk(KERN_ERR "unable to free all devices (post)\n");
423 /* Fatal, but this situation should never occur */
425 if (card->private_free)
426 card->private_free(card);
427 snd_info_free_entry(card->proc_id);
428 if (snd_info_card_free(card) < 0) {
429 snd_printk(KERN_WARNING "unable to free card info\n");
430 /* Not fatal error */
436 int snd_card_free_when_closed(struct snd_card *card)
439 int ret = snd_card_disconnect(card);
443 spin_lock(&card->files_lock);
444 if (list_empty(&card->files_list))
447 card->free_on_last_close = 1;
448 spin_unlock(&card->files_lock);
451 snd_card_do_free(card);
455 EXPORT_SYMBOL(snd_card_free_when_closed);
457 int snd_card_free(struct snd_card *card)
459 int ret = snd_card_disconnect(card);
463 /* wait, until all devices are ready for the free operation */
464 wait_event(card->shutdown_sleep, list_empty(&card->files_list));
465 snd_card_do_free(card);
469 EXPORT_SYMBOL(snd_card_free);
471 static void choose_default_id(struct snd_card *card)
473 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
476 id = spos = card->shortname;
477 while (*id != '\0') {
483 while (*spos != '\0' && !isalnum(*spos))
486 *id++ = isalpha(card->shortname[0]) ? card->shortname[0] : 'D';
487 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
497 strcpy(id, "default");
501 snd_printk(KERN_ERR "unable to choose default card id (%s)\n", id);
502 strcpy(card->id, card->proc_root->name);
505 if (!snd_info_check_reserved_words(id))
507 for (i = 0; i < snd_ecards_limit; i++) {
508 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
516 if (id[len-1] != '9')
520 } else if ((size_t)len <= sizeof(card->id) - 3) {
525 if ((size_t)len <= sizeof(card->id) - 2)
535 #ifndef CONFIG_SYSFS_DEPRECATED
537 card_id_show_attr(struct device *dev,
538 struct device_attribute *attr, char *buf)
540 struct snd_card *card = dev_get_drvdata(dev);
541 return snprintf(buf, PAGE_SIZE, "%s\n", card ? card->id : "(null)");
545 card_id_store_attr(struct device *dev, struct device_attribute *attr,
546 const char *buf, size_t count)
548 struct snd_card *card = dev_get_drvdata(dev);
549 char buf1[sizeof(card->id)];
550 size_t copy = count > sizeof(card->id) - 1 ?
551 sizeof(card->id) - 1 : count;
555 for (idx = 0; idx < copy; idx++) {
557 if (!isalnum(c) && c != '_' && c != '-')
560 memcpy(buf1, buf, copy);
562 mutex_lock(&snd_card_mutex);
563 if (!snd_info_check_reserved_words(buf1)) {
565 mutex_unlock(&snd_card_mutex);
568 for (idx = 0; idx < snd_ecards_limit; idx++) {
569 if (snd_cards[idx] && !strcmp(snd_cards[idx]->id, buf1))
572 strcpy(card->id, buf1);
573 snd_info_card_id_change(card);
574 mutex_unlock(&snd_card_mutex);
579 static struct device_attribute card_id_attrs =
580 __ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
583 card_number_show_attr(struct device *dev,
584 struct device_attribute *attr, char *buf)
586 struct snd_card *card = dev_get_drvdata(dev);
587 return snprintf(buf, PAGE_SIZE, "%i\n", card ? card->number : -1);
590 static struct device_attribute card_number_attrs =
591 __ATTR(number, S_IRUGO, card_number_show_attr, NULL);
592 #endif /* CONFIG_SYSFS_DEPRECATED */
595 * snd_card_register - register the soundcard
596 * @card: soundcard structure
598 * This function registers all the devices assigned to the soundcard.
599 * Until calling this, the ALSA control interface is blocked from the
600 * external accesses. Thus, you should call this function at the end
601 * of the initialization of the card.
603 * Returns zero otherwise a negative error code if the registrain failed.
605 int snd_card_register(struct snd_card *card)
609 if (snd_BUG_ON(!card))
611 #ifndef CONFIG_SYSFS_DEPRECATED
612 if (!card->card_dev) {
613 card->card_dev = device_create(sound_class, card->dev,
615 "card%i", card->number);
616 if (IS_ERR(card->card_dev))
617 card->card_dev = NULL;
620 if ((err = snd_device_register_all(card)) < 0)
622 mutex_lock(&snd_card_mutex);
623 if (snd_cards[card->number]) {
624 /* already registered */
625 mutex_unlock(&snd_card_mutex);
628 if (card->id[0] == '\0')
629 choose_default_id(card);
630 snd_cards[card->number] = card;
631 mutex_unlock(&snd_card_mutex);
632 init_info_for_card(card);
633 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
634 if (snd_mixer_oss_notify_callback)
635 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
637 #ifndef CONFIG_SYSFS_DEPRECATED
638 if (card->card_dev) {
639 err = device_create_file(card->card_dev, &card_id_attrs);
642 err = device_create_file(card->card_dev, &card_number_attrs);
650 EXPORT_SYMBOL(snd_card_register);
652 #ifdef CONFIG_PROC_FS
653 static struct snd_info_entry *snd_card_info_entry;
655 static void snd_card_info_read(struct snd_info_entry *entry,
656 struct snd_info_buffer *buffer)
659 struct snd_card *card;
661 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
662 mutex_lock(&snd_card_mutex);
663 if ((card = snd_cards[idx]) != NULL) {
665 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
670 snd_iprintf(buffer, " %s\n",
673 mutex_unlock(&snd_card_mutex);
676 snd_iprintf(buffer, "--- no soundcards ---\n");
679 #ifdef CONFIG_SND_OSSEMUL
681 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
684 struct snd_card *card;
686 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
687 mutex_lock(&snd_card_mutex);
688 if ((card = snd_cards[idx]) != NULL) {
690 snd_iprintf(buffer, "%s\n", card->longname);
692 mutex_unlock(&snd_card_mutex);
695 snd_iprintf(buffer, "--- no soundcards ---\n");
702 static struct snd_info_entry *snd_card_module_info_entry;
703 static void snd_card_module_info_read(struct snd_info_entry *entry,
704 struct snd_info_buffer *buffer)
707 struct snd_card *card;
709 for (idx = 0; idx < SNDRV_CARDS; idx++) {
710 mutex_lock(&snd_card_mutex);
711 if ((card = snd_cards[idx]) != NULL)
712 snd_iprintf(buffer, "%2i %s\n",
713 idx, card->module->name);
714 mutex_unlock(&snd_card_mutex);
719 int __init snd_card_info_init(void)
721 struct snd_info_entry *entry;
723 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
726 entry->c.text.read = snd_card_info_read;
727 if (snd_info_register(entry) < 0) {
728 snd_info_free_entry(entry);
731 snd_card_info_entry = entry;
734 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
736 entry->c.text.read = snd_card_module_info_read;
737 if (snd_info_register(entry) < 0)
738 snd_info_free_entry(entry);
740 snd_card_module_info_entry = entry;
747 int __exit snd_card_info_done(void)
749 snd_info_free_entry(snd_card_info_entry);
751 snd_info_free_entry(snd_card_module_info_entry);
756 #endif /* CONFIG_PROC_FS */
759 * snd_component_add - add a component string
760 * @card: soundcard structure
761 * @component: the component id string
763 * This function adds the component id string to the supported list.
764 * The component can be referred from the alsa-lib.
766 * Returns zero otherwise a negative error code.
769 int snd_component_add(struct snd_card *card, const char *component)
772 int len = strlen(component);
774 ptr = strstr(card->components, component);
776 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
779 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
783 if (card->components[0] != '\0')
784 strcat(card->components, " ");
785 strcat(card->components, component);
789 EXPORT_SYMBOL(snd_component_add);
792 * snd_card_file_add - add the file to the file list of the card
793 * @card: soundcard structure
794 * @file: file pointer
796 * This function adds the file to the file linked-list of the card.
797 * This linked-list is used to keep tracking the connection state,
798 * and to avoid the release of busy resources by hotplug.
800 * Returns zero or a negative error code.
802 int snd_card_file_add(struct snd_card *card, struct file *file)
804 struct snd_monitor_file *mfile;
806 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
810 mfile->disconnected_f_op = NULL;
811 spin_lock(&card->files_lock);
812 if (card->shutdown) {
813 spin_unlock(&card->files_lock);
817 list_add(&mfile->list, &card->files_list);
818 spin_unlock(&card->files_lock);
822 EXPORT_SYMBOL(snd_card_file_add);
825 * snd_card_file_remove - remove the file from the file list
826 * @card: soundcard structure
827 * @file: file pointer
829 * This function removes the file formerly added to the card via
830 * snd_card_file_add() function.
831 * If all files are removed and snd_card_free_when_closed() was
832 * called beforehand, it processes the pending release of
835 * Returns zero or a negative error code.
837 int snd_card_file_remove(struct snd_card *card, struct file *file)
839 struct snd_monitor_file *mfile, *found = NULL;
842 spin_lock(&card->files_lock);
843 list_for_each_entry(mfile, &card->files_list, list) {
844 if (mfile->file == file) {
845 list_del(&mfile->list);
846 if (mfile->disconnected_f_op)
847 fops_put(mfile->disconnected_f_op);
852 if (list_empty(&card->files_list))
854 spin_unlock(&card->files_lock);
856 wake_up(&card->shutdown_sleep);
857 if (card->free_on_last_close)
858 snd_card_do_free(card);
861 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
868 EXPORT_SYMBOL(snd_card_file_remove);
872 * snd_power_wait - wait until the power-state is changed.
873 * @card: soundcard structure
874 * @power_state: expected power state
876 * Waits until the power-state is changed.
878 * Note: the power lock must be active before call.
880 int snd_power_wait(struct snd_card *card, unsigned int power_state)
886 if (snd_power_get_state(card) == power_state)
888 init_waitqueue_entry(&wait, current);
889 add_wait_queue(&card->power_sleep, &wait);
891 if (card->shutdown) {
895 if (snd_power_get_state(card) == power_state)
897 set_current_state(TASK_UNINTERRUPTIBLE);
898 snd_power_unlock(card);
899 schedule_timeout(30 * HZ);
900 snd_power_lock(card);
902 remove_wait_queue(&card->power_sleep, &wait);
906 EXPORT_SYMBOL(snd_power_wait);
907 #endif /* CONFIG_PM */