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 if (!snd_info_check_reserved_words(xid)) {
158 "given id string '%s' is reserved.\n", xid);
162 strlcpy(card->id, xid, sizeof(card->id));
165 mutex_lock(&snd_card_mutex);
167 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
168 /* idx == -1 == 0xffff means: take any free slot */
169 if (~snd_cards_lock & idx & 1<<idx2) {
170 if (module_slot_match(module, idx2)) {
177 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
178 /* idx == -1 == 0xffff means: take any free slot */
179 if (~snd_cards_lock & idx & 1<<idx2) {
180 if (!slots[idx2] || !*slots[idx2]) {
188 else if (idx < snd_ecards_limit) {
189 if (snd_cards_lock & (1 << idx))
190 err = -EBUSY; /* invalid */
191 } else if (idx >= SNDRV_CARDS)
194 mutex_unlock(&snd_card_mutex);
195 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i), error: %d\n",
196 idx, snd_ecards_limit - 1, err);
199 snd_cards_lock |= 1 << idx; /* lock it */
200 if (idx >= snd_ecards_limit)
201 snd_ecards_limit = idx + 1; /* increase the limit */
202 mutex_unlock(&snd_card_mutex);
204 card->module = module;
205 INIT_LIST_HEAD(&card->devices);
206 init_rwsem(&card->controls_rwsem);
207 rwlock_init(&card->ctl_files_rwlock);
208 INIT_LIST_HEAD(&card->controls);
209 INIT_LIST_HEAD(&card->ctl_files);
210 spin_lock_init(&card->files_lock);
211 init_waitqueue_head(&card->shutdown_sleep);
213 mutex_init(&card->power_lock);
214 init_waitqueue_head(&card->power_sleep);
216 /* the control interface cannot be accessed from the user space until */
217 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
218 err = snd_ctl_create(card);
220 snd_printk(KERN_ERR "unable to register control minors\n");
223 err = snd_info_card_create(card);
225 snd_printk(KERN_ERR "unable to create card info\n");
229 card->private_data = (char *)card + sizeof(struct snd_card);
234 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
239 EXPORT_SYMBOL(snd_card_create);
241 /* return non-zero if a card is already locked */
242 int snd_card_locked(int card)
246 mutex_lock(&snd_card_mutex);
247 locked = snd_cards_lock & (1 << card);
248 mutex_unlock(&snd_card_mutex);
252 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
257 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
258 size_t count, loff_t *offset)
263 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
264 size_t count, loff_t *offset)
269 static int snd_disconnect_release(struct inode *inode, struct file *file)
271 struct snd_monitor_file *df = NULL, *_df;
273 spin_lock(&shutdown_lock);
274 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
275 if (_df->file == file) {
280 spin_unlock(&shutdown_lock);
283 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
284 df->disconnected_f_op->fasync(-1, file, 0);
285 return df->disconnected_f_op->release(inode, file);
288 panic("%s(%p, %p) failed!", __func__, inode, file);
291 static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
293 return POLLERR | POLLNVAL;
296 static long snd_disconnect_ioctl(struct file *file,
297 unsigned int cmd, unsigned long arg)
302 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
307 static int snd_disconnect_fasync(int fd, struct file *file, int on)
312 static const struct file_operations snd_shutdown_f_ops =
314 .owner = THIS_MODULE,
315 .llseek = snd_disconnect_llseek,
316 .read = snd_disconnect_read,
317 .write = snd_disconnect_write,
318 .release = snd_disconnect_release,
319 .poll = snd_disconnect_poll,
320 .unlocked_ioctl = snd_disconnect_ioctl,
322 .compat_ioctl = snd_disconnect_ioctl,
324 .mmap = snd_disconnect_mmap,
325 .fasync = snd_disconnect_fasync
329 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
330 * @card: soundcard structure
332 * Disconnects all APIs from the file-operations (user space).
334 * Returns zero, otherwise a negative error code.
336 * Note: The current implementation replaces all active file->f_op with special
337 * dummy file operations (they do nothing except release).
339 int snd_card_disconnect(struct snd_card *card)
341 struct snd_monitor_file *mfile;
348 spin_lock(&card->files_lock);
349 if (card->shutdown) {
350 spin_unlock(&card->files_lock);
354 spin_unlock(&card->files_lock);
356 /* phase 1: disable fops (user space) operations for ALSA API */
357 mutex_lock(&snd_card_mutex);
358 snd_cards[card->number] = NULL;
359 snd_cards_lock &= ~(1 << card->number);
360 mutex_unlock(&snd_card_mutex);
362 /* phase 2: replace file->f_op with special dummy operations */
364 spin_lock(&card->files_lock);
369 /* it's critical part, use endless loop */
370 /* we have no room to fail */
371 mfile->disconnected_f_op = mfile->file->f_op;
373 spin_lock(&shutdown_lock);
374 list_add(&mfile->shutdown_list, &shutdown_files);
375 spin_unlock(&shutdown_lock);
377 mfile->file->f_op = &snd_shutdown_f_ops;
378 fops_get(mfile->file->f_op);
382 spin_unlock(&card->files_lock);
384 /* phase 3: notify all connected devices about disconnection */
385 /* at this point, they cannot respond to any calls except release() */
387 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
388 if (snd_mixer_oss_notify_callback)
389 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
392 /* notify all devices that we are disconnected */
393 err = snd_device_disconnect_all(card);
395 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
397 snd_info_card_disconnect(card);
398 #ifndef CONFIG_SYSFS_DEPRECATED
399 if (card->card_dev) {
400 device_unregister(card->card_dev);
401 card->card_dev = NULL;
405 wake_up(&card->power_sleep);
410 EXPORT_SYMBOL(snd_card_disconnect);
413 * snd_card_free - frees given soundcard structure
414 * @card: soundcard structure
416 * This function releases the soundcard structure and the all assigned
417 * devices automatically. That is, you don't have to release the devices
420 * Returns zero. Frees all associated devices and frees the control
421 * interface associated to given soundcard.
423 static int snd_card_do_free(struct snd_card *card)
425 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
426 if (snd_mixer_oss_notify_callback)
427 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
429 if (snd_device_free_all(card, SNDRV_DEV_CMD_PRE) < 0) {
430 snd_printk(KERN_ERR "unable to free all devices (pre)\n");
431 /* Fatal, but this situation should never occur */
433 if (snd_device_free_all(card, SNDRV_DEV_CMD_NORMAL) < 0) {
434 snd_printk(KERN_ERR "unable to free all devices (normal)\n");
435 /* Fatal, but this situation should never occur */
437 if (snd_device_free_all(card, SNDRV_DEV_CMD_POST) < 0) {
438 snd_printk(KERN_ERR "unable to free all devices (post)\n");
439 /* Fatal, but this situation should never occur */
441 if (card->private_free)
442 card->private_free(card);
443 snd_info_free_entry(card->proc_id);
444 if (snd_info_card_free(card) < 0) {
445 snd_printk(KERN_WARNING "unable to free card info\n");
446 /* Not fatal error */
452 int snd_card_free_when_closed(struct snd_card *card)
455 int ret = snd_card_disconnect(card);
459 spin_lock(&card->files_lock);
460 if (card->files == NULL)
463 card->free_on_last_close = 1;
464 spin_unlock(&card->files_lock);
467 snd_card_do_free(card);
471 EXPORT_SYMBOL(snd_card_free_when_closed);
473 int snd_card_free(struct snd_card *card)
475 int ret = snd_card_disconnect(card);
479 /* wait, until all devices are ready for the free operation */
480 wait_event(card->shutdown_sleep, card->files == NULL);
481 snd_card_do_free(card);
485 EXPORT_SYMBOL(snd_card_free);
487 static void choose_default_id(struct snd_card *card)
489 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
492 id = spos = card->shortname;
493 while (*id != '\0') {
499 while (*spos != '\0' && !isalnum(*spos))
502 *id++ = isalpha(card->shortname[0]) ? card->shortname[0] : 'D';
503 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
513 strcpy(id, "default");
517 snd_printk(KERN_ERR "unable to choose default card id (%s)\n", id);
518 strcpy(card->id, card->proc_root->name);
521 if (!snd_info_check_reserved_words(id))
523 for (i = 0; i < snd_ecards_limit; i++) {
524 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
532 if (id[len-1] != '9')
536 } else if ((size_t)len <= sizeof(card->id) - 3) {
541 if ((size_t)len <= sizeof(card->id) - 2)
551 #ifndef CONFIG_SYSFS_DEPRECATED
553 card_id_show_attr(struct device *dev,
554 struct device_attribute *attr, char *buf)
556 struct snd_card *card = dev_get_drvdata(dev);
557 return snprintf(buf, PAGE_SIZE, "%s\n", card ? card->id : "(null)");
561 card_id_store_attr(struct device *dev, struct device_attribute *attr,
562 const char *buf, size_t count)
564 struct snd_card *card = dev_get_drvdata(dev);
565 char buf1[sizeof(card->id)];
566 size_t copy = count > sizeof(card->id) - 1 ?
567 sizeof(card->id) - 1 : count;
571 for (idx = 0; idx < copy; idx++) {
573 if (!isalnum(c) && c != '_' && c != '-')
576 memcpy(buf1, buf, copy);
578 mutex_lock(&snd_card_mutex);
579 if (!snd_info_check_reserved_words(buf1)) {
581 mutex_unlock(&snd_card_mutex);
584 for (idx = 0; idx < snd_ecards_limit; idx++) {
585 if (snd_cards[idx] && !strcmp(snd_cards[idx]->id, buf1))
588 strcpy(card->id, buf1);
589 snd_info_card_id_change(card);
590 mutex_unlock(&snd_card_mutex);
595 static struct device_attribute card_id_attrs =
596 __ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
599 card_number_show_attr(struct device *dev,
600 struct device_attribute *attr, char *buf)
602 struct snd_card *card = dev_get_drvdata(dev);
603 return snprintf(buf, PAGE_SIZE, "%i\n", card ? card->number : -1);
606 static struct device_attribute card_number_attrs =
607 __ATTR(number, S_IRUGO, card_number_show_attr, NULL);
608 #endif /* CONFIG_SYSFS_DEPRECATED */
611 * snd_card_register - register the soundcard
612 * @card: soundcard structure
614 * This function registers all the devices assigned to the soundcard.
615 * Until calling this, the ALSA control interface is blocked from the
616 * external accesses. Thus, you should call this function at the end
617 * of the initialization of the card.
619 * Returns zero otherwise a negative error code if the registrain failed.
621 int snd_card_register(struct snd_card *card)
625 if (snd_BUG_ON(!card))
627 #ifndef CONFIG_SYSFS_DEPRECATED
628 if (!card->card_dev) {
629 card->card_dev = device_create(sound_class, card->dev,
631 "card%i", card->number);
632 if (IS_ERR(card->card_dev))
633 card->card_dev = NULL;
636 if ((err = snd_device_register_all(card)) < 0)
638 mutex_lock(&snd_card_mutex);
639 if (snd_cards[card->number]) {
640 /* already registered */
641 mutex_unlock(&snd_card_mutex);
644 if (card->id[0] == '\0')
645 choose_default_id(card);
646 snd_cards[card->number] = card;
647 mutex_unlock(&snd_card_mutex);
648 init_info_for_card(card);
649 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
650 if (snd_mixer_oss_notify_callback)
651 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
653 #ifndef CONFIG_SYSFS_DEPRECATED
654 if (card->card_dev) {
655 err = device_create_file(card->card_dev, &card_id_attrs);
658 err = device_create_file(card->card_dev, &card_number_attrs);
666 EXPORT_SYMBOL(snd_card_register);
668 #ifdef CONFIG_PROC_FS
669 static struct snd_info_entry *snd_card_info_entry;
671 static void snd_card_info_read(struct snd_info_entry *entry,
672 struct snd_info_buffer *buffer)
675 struct snd_card *card;
677 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
678 mutex_lock(&snd_card_mutex);
679 if ((card = snd_cards[idx]) != NULL) {
681 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
686 snd_iprintf(buffer, " %s\n",
689 mutex_unlock(&snd_card_mutex);
692 snd_iprintf(buffer, "--- no soundcards ---\n");
695 #ifdef CONFIG_SND_OSSEMUL
697 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
700 struct snd_card *card;
702 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
703 mutex_lock(&snd_card_mutex);
704 if ((card = snd_cards[idx]) != NULL) {
706 snd_iprintf(buffer, "%s\n", card->longname);
708 mutex_unlock(&snd_card_mutex);
711 snd_iprintf(buffer, "--- no soundcards ---\n");
718 static struct snd_info_entry *snd_card_module_info_entry;
719 static void snd_card_module_info_read(struct snd_info_entry *entry,
720 struct snd_info_buffer *buffer)
723 struct snd_card *card;
725 for (idx = 0; idx < SNDRV_CARDS; idx++) {
726 mutex_lock(&snd_card_mutex);
727 if ((card = snd_cards[idx]) != NULL)
728 snd_iprintf(buffer, "%2i %s\n",
729 idx, card->module->name);
730 mutex_unlock(&snd_card_mutex);
735 int __init snd_card_info_init(void)
737 struct snd_info_entry *entry;
739 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
742 entry->c.text.read = snd_card_info_read;
743 if (snd_info_register(entry) < 0) {
744 snd_info_free_entry(entry);
747 snd_card_info_entry = entry;
750 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
752 entry->c.text.read = snd_card_module_info_read;
753 if (snd_info_register(entry) < 0)
754 snd_info_free_entry(entry);
756 snd_card_module_info_entry = entry;
763 int __exit snd_card_info_done(void)
765 snd_info_free_entry(snd_card_info_entry);
767 snd_info_free_entry(snd_card_module_info_entry);
772 #endif /* CONFIG_PROC_FS */
775 * snd_component_add - add a component string
776 * @card: soundcard structure
777 * @component: the component id string
779 * This function adds the component id string to the supported list.
780 * The component can be referred from the alsa-lib.
782 * Returns zero otherwise a negative error code.
785 int snd_component_add(struct snd_card *card, const char *component)
788 int len = strlen(component);
790 ptr = strstr(card->components, component);
792 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
795 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
799 if (card->components[0] != '\0')
800 strcat(card->components, " ");
801 strcat(card->components, component);
805 EXPORT_SYMBOL(snd_component_add);
808 * snd_card_file_add - add the file to the file list of the card
809 * @card: soundcard structure
810 * @file: file pointer
812 * This function adds the file to the file linked-list of the card.
813 * This linked-list is used to keep tracking the connection state,
814 * and to avoid the release of busy resources by hotplug.
816 * Returns zero or a negative error code.
818 int snd_card_file_add(struct snd_card *card, struct file *file)
820 struct snd_monitor_file *mfile;
822 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
826 mfile->disconnected_f_op = NULL;
828 spin_lock(&card->files_lock);
829 if (card->shutdown) {
830 spin_unlock(&card->files_lock);
834 mfile->next = card->files;
836 spin_unlock(&card->files_lock);
840 EXPORT_SYMBOL(snd_card_file_add);
843 * snd_card_file_remove - remove the file from the file list
844 * @card: soundcard structure
845 * @file: file pointer
847 * This function removes the file formerly added to the card via
848 * snd_card_file_add() function.
849 * If all files are removed and snd_card_free_when_closed() was
850 * called beforehand, it processes the pending release of
853 * Returns zero or a negative error code.
855 int snd_card_file_remove(struct snd_card *card, struct file *file)
857 struct snd_monitor_file *mfile, *pfile = NULL;
860 spin_lock(&card->files_lock);
863 if (mfile->file == file) {
865 pfile->next = mfile->next;
867 card->files = mfile->next;
873 if (mfile && mfile->disconnected_f_op) {
874 fops_put(mfile->disconnected_f_op);
875 spin_lock(&shutdown_lock);
876 list_del(&mfile->shutdown_list);
877 spin_unlock(&shutdown_lock);
879 if (card->files == NULL)
881 spin_unlock(&card->files_lock);
883 wake_up(&card->shutdown_sleep);
884 if (card->free_on_last_close)
885 snd_card_do_free(card);
888 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
895 EXPORT_SYMBOL(snd_card_file_remove);
899 * snd_power_wait - wait until the power-state is changed.
900 * @card: soundcard structure
901 * @power_state: expected power state
903 * Waits until the power-state is changed.
905 * Note: the power lock must be active before call.
907 int snd_power_wait(struct snd_card *card, unsigned int power_state)
913 if (snd_power_get_state(card) == power_state)
915 init_waitqueue_entry(&wait, current);
916 add_wait_queue(&card->power_sleep, &wait);
918 if (card->shutdown) {
922 if (snd_power_get_state(card) == power_state)
924 set_current_state(TASK_UNINTERRUPTIBLE);
925 snd_power_unlock(card);
926 schedule_timeout(30 * HZ);
927 snd_power_lock(card);
929 remove_wait_queue(&card->power_sleep, &wait);
933 EXPORT_SYMBOL(snd_power_wait);
934 #endif /* CONFIG_PM */