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 /* monitor files for graceful shutdown (hotplug) */
35 struct snd_monitor_file {
37 const struct file_operations *disconnected_f_op;
38 struct list_head shutdown_list; /* still need to shutdown */
39 struct list_head list; /* link of monitor files */
42 static DEFINE_SPINLOCK(shutdown_lock);
43 static LIST_HEAD(shutdown_files);
45 static const struct file_operations snd_shutdown_f_ops;
47 static unsigned int snd_cards_lock; /* locked for registering/using */
48 struct snd_card *snd_cards[SNDRV_CARDS];
49 EXPORT_SYMBOL(snd_cards);
51 static DEFINE_MUTEX(snd_card_mutex);
53 static char *slots[SNDRV_CARDS];
54 module_param_array(slots, charp, NULL, 0444);
55 MODULE_PARM_DESC(slots, "Module names assigned to the slots.");
57 /* return non-zero if the given index is reserved for the given
58 * module via slots option
60 static int module_slot_match(struct module *module, int idx)
66 if (!module || !module->name || !slots[idx])
72 match = 0; /* negative match */
75 /* compare module name strings
76 * hyphens are handled as equivalent with underscore
94 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
95 int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
96 EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
100 static void snd_card_id_read(struct snd_info_entry *entry,
101 struct snd_info_buffer *buffer)
103 snd_iprintf(buffer, "%s\n", entry->card->id);
106 static inline int init_info_for_card(struct snd_card *card)
109 struct snd_info_entry *entry;
111 if ((err = snd_info_card_register(card)) < 0) {
112 snd_printd("unable to create card info\n");
115 if ((entry = snd_info_create_card_entry(card, "id", card->proc_root)) == NULL) {
116 snd_printd("unable to create card entry\n");
119 entry->c.text.read = snd_card_id_read;
120 if (snd_info_register(entry) < 0) {
121 snd_info_free_entry(entry);
124 card->proc_id = entry;
127 #else /* !CONFIG_PROC_FS */
128 #define init_info_for_card(card)
132 * snd_card_create - create and initialize a soundcard structure
133 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
134 * @xid: card identification (ASCII string)
135 * @module: top level module for locking
136 * @extra_size: allocate this extra size after the main soundcard structure
137 * @card_ret: the pointer to store the created card instance
139 * Creates and initializes a soundcard structure.
141 * The function allocates snd_card instance via kzalloc with the given
142 * space for the driver to use freely. The allocated struct is stored
143 * in the given card_ret pointer.
145 * Returns zero if successful or a negative error code.
147 int snd_card_create(int idx, const char *xid,
148 struct module *module, int extra_size,
149 struct snd_card **card_ret)
151 struct snd_card *card;
154 if (snd_BUG_ON(!card_ret))
160 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
164 strlcpy(card->id, xid, sizeof(card->id));
166 mutex_lock(&snd_card_mutex);
168 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
169 /* idx == -1 == 0xffff means: take any free slot */
170 if (~snd_cards_lock & idx & 1<<idx2) {
171 if (module_slot_match(module, idx2)) {
178 for (idx2 = 0; idx2 < SNDRV_CARDS; idx2++)
179 /* idx == -1 == 0xffff means: take any free slot */
180 if (~snd_cards_lock & idx & 1<<idx2) {
181 if (!slots[idx2] || !*slots[idx2]) {
189 else if (idx < snd_ecards_limit) {
190 if (snd_cards_lock & (1 << idx))
191 err = -EBUSY; /* invalid */
192 } else if (idx >= SNDRV_CARDS)
195 mutex_unlock(&snd_card_mutex);
196 snd_printk(KERN_ERR "cannot find the slot for index %d (range 0-%i), error: %d\n",
197 idx, snd_ecards_limit - 1, err);
200 snd_cards_lock |= 1 << idx; /* lock it */
201 if (idx >= snd_ecards_limit)
202 snd_ecards_limit = idx + 1; /* increase the limit */
203 mutex_unlock(&snd_card_mutex);
205 card->module = module;
206 INIT_LIST_HEAD(&card->devices);
207 init_rwsem(&card->controls_rwsem);
208 rwlock_init(&card->ctl_files_rwlock);
209 INIT_LIST_HEAD(&card->controls);
210 INIT_LIST_HEAD(&card->ctl_files);
211 spin_lock_init(&card->files_lock);
212 INIT_LIST_HEAD(&card->files_list);
213 init_waitqueue_head(&card->shutdown_sleep);
215 mutex_init(&card->power_lock);
216 init_waitqueue_head(&card->power_sleep);
218 /* the control interface cannot be accessed from the user space until */
219 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
220 err = snd_ctl_create(card);
222 snd_printk(KERN_ERR "unable to register control minors\n");
225 err = snd_info_card_create(card);
227 snd_printk(KERN_ERR "unable to create card info\n");
231 card->private_data = (char *)card + sizeof(struct snd_card);
236 snd_device_free_all(card, SNDRV_DEV_CMD_PRE);
241 EXPORT_SYMBOL(snd_card_create);
243 /* return non-zero if a card is already locked */
244 int snd_card_locked(int card)
248 mutex_lock(&snd_card_mutex);
249 locked = snd_cards_lock & (1 << card);
250 mutex_unlock(&snd_card_mutex);
254 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
259 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
260 size_t count, loff_t *offset)
265 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
266 size_t count, loff_t *offset)
271 static int snd_disconnect_release(struct inode *inode, struct file *file)
273 struct snd_monitor_file *df = NULL, *_df;
275 spin_lock(&shutdown_lock);
276 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
277 if (_df->file == file) {
279 list_del_init(&df->shutdown_list);
283 spin_unlock(&shutdown_lock);
286 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
287 df->disconnected_f_op->fasync(-1, file, 0);
288 return df->disconnected_f_op->release(inode, file);
291 panic("%s(%p, %p) failed!", __func__, inode, file);
294 static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
296 return POLLERR | POLLNVAL;
299 static long snd_disconnect_ioctl(struct file *file,
300 unsigned int cmd, unsigned long arg)
305 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
310 static int snd_disconnect_fasync(int fd, struct file *file, int on)
315 static const struct file_operations snd_shutdown_f_ops =
317 .owner = THIS_MODULE,
318 .llseek = snd_disconnect_llseek,
319 .read = snd_disconnect_read,
320 .write = snd_disconnect_write,
321 .release = snd_disconnect_release,
322 .poll = snd_disconnect_poll,
323 .unlocked_ioctl = snd_disconnect_ioctl,
325 .compat_ioctl = snd_disconnect_ioctl,
327 .mmap = snd_disconnect_mmap,
328 .fasync = snd_disconnect_fasync
332 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
333 * @card: soundcard structure
335 * Disconnects all APIs from the file-operations (user space).
337 * Returns zero, otherwise a negative error code.
339 * Note: The current implementation replaces all active file->f_op with special
340 * dummy file operations (they do nothing except release).
342 int snd_card_disconnect(struct snd_card *card)
344 struct snd_monitor_file *mfile;
350 spin_lock(&card->files_lock);
351 if (card->shutdown) {
352 spin_unlock(&card->files_lock);
356 spin_unlock(&card->files_lock);
358 /* phase 1: disable fops (user space) operations for ALSA API */
359 mutex_lock(&snd_card_mutex);
360 snd_cards[card->number] = NULL;
361 snd_cards_lock &= ~(1 << card->number);
362 mutex_unlock(&snd_card_mutex);
364 /* phase 2: replace file->f_op with special dummy operations */
366 spin_lock(&card->files_lock);
367 list_for_each_entry(mfile, &card->files_list, list) {
368 /* it's critical part, use endless loop */
369 /* we have no room to fail */
370 mfile->disconnected_f_op = mfile->file->f_op;
372 spin_lock(&shutdown_lock);
373 list_add(&mfile->shutdown_list, &shutdown_files);
374 spin_unlock(&shutdown_lock);
376 mfile->file->f_op = &snd_shutdown_f_ops;
377 fops_get(mfile->file->f_op);
379 spin_unlock(&card->files_lock);
381 /* phase 3: notify all connected devices about disconnection */
382 /* at this point, they cannot respond to any calls except release() */
384 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
385 if (snd_mixer_oss_notify_callback)
386 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
389 /* notify all devices that we are disconnected */
390 err = snd_device_disconnect_all(card);
392 snd_printk(KERN_ERR "not all devices for card %i can be disconnected\n", card->number);
394 snd_info_card_disconnect(card);
395 if (card->card_dev) {
396 device_unregister(card->card_dev);
397 card->card_dev = NULL;
400 wake_up(&card->power_sleep);
405 EXPORT_SYMBOL(snd_card_disconnect);
408 * snd_card_free - frees given soundcard structure
409 * @card: soundcard structure
411 * This function releases the soundcard structure and the all assigned
412 * devices automatically. That is, you don't have to release the devices
415 * Returns zero. Frees all associated devices and frees the control
416 * interface associated to given soundcard.
418 static int snd_card_do_free(struct snd_card *card)
420 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
421 if (snd_mixer_oss_notify_callback)
422 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
424 if (snd_device_free_all(card, SNDRV_DEV_CMD_PRE) < 0) {
425 snd_printk(KERN_ERR "unable to free all devices (pre)\n");
426 /* Fatal, but this situation should never occur */
428 if (snd_device_free_all(card, SNDRV_DEV_CMD_NORMAL) < 0) {
429 snd_printk(KERN_ERR "unable to free all devices (normal)\n");
430 /* Fatal, but this situation should never occur */
432 if (snd_device_free_all(card, SNDRV_DEV_CMD_POST) < 0) {
433 snd_printk(KERN_ERR "unable to free all devices (post)\n");
434 /* Fatal, but this situation should never occur */
436 if (card->private_free)
437 card->private_free(card);
438 snd_info_free_entry(card->proc_id);
439 if (snd_info_card_free(card) < 0) {
440 snd_printk(KERN_WARNING "unable to free card info\n");
441 /* Not fatal error */
447 int snd_card_free_when_closed(struct snd_card *card)
450 int ret = snd_card_disconnect(card);
454 spin_lock(&card->files_lock);
455 if (list_empty(&card->files_list))
458 card->free_on_last_close = 1;
459 spin_unlock(&card->files_lock);
462 snd_card_do_free(card);
466 EXPORT_SYMBOL(snd_card_free_when_closed);
468 int snd_card_free(struct snd_card *card)
470 int ret = snd_card_disconnect(card);
474 /* wait, until all devices are ready for the free operation */
475 wait_event(card->shutdown_sleep, list_empty(&card->files_list));
476 snd_card_do_free(card);
480 EXPORT_SYMBOL(snd_card_free);
482 static void snd_card_set_id_no_lock(struct snd_card *card, const char *nid)
484 int i, len, idx_flag = 0, loops = SNDRV_CARDS;
485 const char *spos, *src;
489 id = card->shortname;
491 while (*id != '\0') {
500 while (*spos != '\0' && !isalnum(*spos))
503 *id++ = isalpha(src[0]) ? src[0] : 'D';
504 while (*spos != '\0' && (size_t)(id - card->id) < sizeof(card->id) - 1) {
514 strcpy(id, "Default");
518 snd_printk(KERN_ERR "unable to set card id (%s)\n", id);
519 strcpy(card->id, card->proc_root->name);
522 if (!snd_info_check_reserved_words(id))
524 for (i = 0; i < snd_ecards_limit; i++) {
525 if (snd_cards[i] && !strcmp(snd_cards[i]->id, id))
533 if (id[len-1] != '9')
537 } else if ((size_t)len <= sizeof(card->id) - 3) {
542 if ((size_t)len <= sizeof(card->id) - 2)
544 *(char *)spos++ = '_';
545 *(char *)spos++ = '1';
546 *(char *)spos++ = '\0';
553 * snd_card_set_id - set card identification name
554 * @card: soundcard structure
555 * @nid: new identification string
557 * This function sets the card identification and checks for name
560 void snd_card_set_id(struct snd_card *card, const char *nid)
562 /* check if user specified own card->id */
563 if (card->id[0] != '\0')
565 mutex_lock(&snd_card_mutex);
566 snd_card_set_id_no_lock(card, nid);
567 mutex_unlock(&snd_card_mutex);
569 EXPORT_SYMBOL(snd_card_set_id);
572 card_id_show_attr(struct device *dev,
573 struct device_attribute *attr, char *buf)
575 struct snd_card *card = dev_get_drvdata(dev);
576 return snprintf(buf, PAGE_SIZE, "%s\n", card ? card->id : "(null)");
580 card_id_store_attr(struct device *dev, struct device_attribute *attr,
581 const char *buf, size_t count)
583 struct snd_card *card = dev_get_drvdata(dev);
584 char buf1[sizeof(card->id)];
585 size_t copy = count > sizeof(card->id) - 1 ?
586 sizeof(card->id) - 1 : count;
590 for (idx = 0; idx < copy; idx++) {
592 if (!isalnum(c) && c != '_' && c != '-')
595 memcpy(buf1, buf, copy);
597 mutex_lock(&snd_card_mutex);
598 if (!snd_info_check_reserved_words(buf1)) {
600 mutex_unlock(&snd_card_mutex);
603 for (idx = 0; idx < snd_ecards_limit; idx++) {
604 if (snd_cards[idx] && !strcmp(snd_cards[idx]->id, buf1)) {
605 if (card == snd_cards[idx])
611 strcpy(card->id, buf1);
612 snd_info_card_id_change(card);
614 mutex_unlock(&snd_card_mutex);
619 static struct device_attribute card_id_attrs =
620 __ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
623 card_number_show_attr(struct device *dev,
624 struct device_attribute *attr, char *buf)
626 struct snd_card *card = dev_get_drvdata(dev);
627 return snprintf(buf, PAGE_SIZE, "%i\n", card ? card->number : -1);
630 static struct device_attribute card_number_attrs =
631 __ATTR(number, S_IRUGO, card_number_show_attr, NULL);
634 * snd_card_register - register the soundcard
635 * @card: soundcard structure
637 * This function registers all the devices assigned to the soundcard.
638 * Until calling this, the ALSA control interface is blocked from the
639 * external accesses. Thus, you should call this function at the end
640 * of the initialization of the card.
642 * Returns zero otherwise a negative error code if the registration failed.
644 int snd_card_register(struct snd_card *card)
648 if (snd_BUG_ON(!card))
651 if (!card->card_dev) {
652 card->card_dev = device_create(sound_class, card->dev,
654 "card%i", card->number);
655 if (IS_ERR(card->card_dev))
656 card->card_dev = NULL;
659 if ((err = snd_device_register_all(card)) < 0)
661 mutex_lock(&snd_card_mutex);
662 if (snd_cards[card->number]) {
663 /* already registered */
664 mutex_unlock(&snd_card_mutex);
667 snd_card_set_id_no_lock(card, card->id[0] == '\0' ? NULL : card->id);
668 snd_cards[card->number] = card;
669 mutex_unlock(&snd_card_mutex);
670 init_info_for_card(card);
671 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
672 if (snd_mixer_oss_notify_callback)
673 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
675 if (card->card_dev) {
676 err = device_create_file(card->card_dev, &card_id_attrs);
679 err = device_create_file(card->card_dev, &card_number_attrs);
687 EXPORT_SYMBOL(snd_card_register);
689 #ifdef CONFIG_PROC_FS
690 static struct snd_info_entry *snd_card_info_entry;
692 static void snd_card_info_read(struct snd_info_entry *entry,
693 struct snd_info_buffer *buffer)
696 struct snd_card *card;
698 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
699 mutex_lock(&snd_card_mutex);
700 if ((card = snd_cards[idx]) != NULL) {
702 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
707 snd_iprintf(buffer, " %s\n",
710 mutex_unlock(&snd_card_mutex);
713 snd_iprintf(buffer, "--- no soundcards ---\n");
716 #ifdef CONFIG_SND_OSSEMUL
718 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
721 struct snd_card *card;
723 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
724 mutex_lock(&snd_card_mutex);
725 if ((card = snd_cards[idx]) != NULL) {
727 snd_iprintf(buffer, "%s\n", card->longname);
729 mutex_unlock(&snd_card_mutex);
732 snd_iprintf(buffer, "--- no soundcards ---\n");
739 static struct snd_info_entry *snd_card_module_info_entry;
740 static void snd_card_module_info_read(struct snd_info_entry *entry,
741 struct snd_info_buffer *buffer)
744 struct snd_card *card;
746 for (idx = 0; idx < SNDRV_CARDS; idx++) {
747 mutex_lock(&snd_card_mutex);
748 if ((card = snd_cards[idx]) != NULL)
749 snd_iprintf(buffer, "%2i %s\n",
750 idx, card->module->name);
751 mutex_unlock(&snd_card_mutex);
756 int __init snd_card_info_init(void)
758 struct snd_info_entry *entry;
760 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
763 entry->c.text.read = snd_card_info_read;
764 if (snd_info_register(entry) < 0) {
765 snd_info_free_entry(entry);
768 snd_card_info_entry = entry;
771 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
773 entry->c.text.read = snd_card_module_info_read;
774 if (snd_info_register(entry) < 0)
775 snd_info_free_entry(entry);
777 snd_card_module_info_entry = entry;
784 int __exit snd_card_info_done(void)
786 snd_info_free_entry(snd_card_info_entry);
788 snd_info_free_entry(snd_card_module_info_entry);
793 #endif /* CONFIG_PROC_FS */
796 * snd_component_add - add a component string
797 * @card: soundcard structure
798 * @component: the component id string
800 * This function adds the component id string to the supported list.
801 * The component can be referred from the alsa-lib.
803 * Returns zero otherwise a negative error code.
806 int snd_component_add(struct snd_card *card, const char *component)
809 int len = strlen(component);
811 ptr = strstr(card->components, component);
813 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
816 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
820 if (card->components[0] != '\0')
821 strcat(card->components, " ");
822 strcat(card->components, component);
826 EXPORT_SYMBOL(snd_component_add);
829 * snd_card_file_add - add the file to the file list of the card
830 * @card: soundcard structure
831 * @file: file pointer
833 * This function adds the file to the file linked-list of the card.
834 * This linked-list is used to keep tracking the connection state,
835 * and to avoid the release of busy resources by hotplug.
837 * Returns zero or a negative error code.
839 int snd_card_file_add(struct snd_card *card, struct file *file)
841 struct snd_monitor_file *mfile;
843 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
847 mfile->disconnected_f_op = NULL;
848 INIT_LIST_HEAD(&mfile->shutdown_list);
849 spin_lock(&card->files_lock);
850 if (card->shutdown) {
851 spin_unlock(&card->files_lock);
855 list_add(&mfile->list, &card->files_list);
856 spin_unlock(&card->files_lock);
860 EXPORT_SYMBOL(snd_card_file_add);
863 * snd_card_file_remove - remove the file from the file list
864 * @card: soundcard structure
865 * @file: file pointer
867 * This function removes the file formerly added to the card via
868 * snd_card_file_add() function.
869 * If all files are removed and snd_card_free_when_closed() was
870 * called beforehand, it processes the pending release of
873 * Returns zero or a negative error code.
875 int snd_card_file_remove(struct snd_card *card, struct file *file)
877 struct snd_monitor_file *mfile, *found = NULL;
880 spin_lock(&card->files_lock);
881 list_for_each_entry(mfile, &card->files_list, list) {
882 if (mfile->file == file) {
883 list_del(&mfile->list);
884 spin_lock(&shutdown_lock);
885 list_del(&mfile->shutdown_list);
886 spin_unlock(&shutdown_lock);
887 if (mfile->disconnected_f_op)
888 fops_put(mfile->disconnected_f_op);
893 if (list_empty(&card->files_list))
895 spin_unlock(&card->files_lock);
897 wake_up(&card->shutdown_sleep);
898 if (card->free_on_last_close)
899 snd_card_do_free(card);
902 snd_printk(KERN_ERR "ALSA card file remove problem (%p)\n", file);
909 EXPORT_SYMBOL(snd_card_file_remove);
913 * snd_power_wait - wait until the power-state is changed.
914 * @card: soundcard structure
915 * @power_state: expected power state
917 * Waits until the power-state is changed.
919 * Note: the power lock must be active before call.
921 int snd_power_wait(struct snd_card *card, unsigned int power_state)
927 if (snd_power_get_state(card) == power_state)
929 init_waitqueue_entry(&wait, current);
930 add_wait_queue(&card->power_sleep, &wait);
932 if (card->shutdown) {
936 if (snd_power_get_state(card) == power_state)
938 set_current_state(TASK_UNINTERRUPTIBLE);
939 snd_power_unlock(card);
940 schedule_timeout(30 * HZ);
941 snd_power_lock(card);
943 remove_wait_queue(&card->power_sleep, &wait);
947 EXPORT_SYMBOL(snd_power_wait);
948 #endif /* CONFIG_PM */