1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Initialization routines
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 #include <linux/init.h>
8 #include <linux/sched.h>
9 #include <linux/module.h>
10 #include <linux/device.h>
11 #include <linux/file.h>
12 #include <linux/slab.h>
13 #include <linux/time.h>
14 #include <linux/ctype.h>
16 #include <linux/debugfs.h>
17 #include <linux/completion.h>
18 #include <linux/interrupt.h>
20 #include <sound/core.h>
21 #include <sound/control.h>
22 #include <sound/info.h>
24 /* monitor files for graceful shutdown (hotplug) */
25 struct snd_monitor_file {
27 const struct file_operations *disconnected_f_op;
28 struct list_head shutdown_list; /* still need to shutdown */
29 struct list_head list; /* link of monitor files */
32 static DEFINE_SPINLOCK(shutdown_lock);
33 static LIST_HEAD(shutdown_files);
35 static const struct file_operations snd_shutdown_f_ops;
37 /* locked for registering/using */
38 static DECLARE_BITMAP(snd_cards_lock, SNDRV_CARDS);
39 static struct snd_card *snd_cards[SNDRV_CARDS];
41 static DEFINE_MUTEX(snd_card_mutex);
43 static char *slots[SNDRV_CARDS];
44 module_param_array(slots, charp, NULL, 0444);
45 MODULE_PARM_DESC(slots, "Module names assigned to the slots.");
47 /* return non-zero if the given index is reserved for the given
48 * module via slots option
50 static int module_slot_match(struct module *module, int idx)
56 if (!module || !*module->name || !slots[idx])
62 match = 0; /* negative match */
65 /* compare module name strings
66 * hyphens are handled as equivalent with underscore
84 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
85 int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
86 EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
89 static int check_empty_slot(struct module *module, int slot)
91 return !slots[slot] || !*slots[slot];
94 /* return an empty slot number (>= 0) found in the given bitmask @mask.
95 * @mask == -1 == 0xffffffff means: take any free slot up to 32
96 * when no slot is available, return the original @mask as is.
98 static int get_slot_from_bitmask(int mask, int (*check)(struct module *, int),
99 struct module *module)
103 for (slot = 0; slot < SNDRV_CARDS; slot++) {
104 if (slot < 32 && !(mask & (1U << slot)))
106 if (!test_bit(slot, snd_cards_lock)) {
107 if (check(module, slot))
108 return slot; /* found */
111 return mask; /* unchanged */
114 /* the default release callback set in snd_device_alloc() */
115 static void default_release_alloc(struct device *dev)
121 * snd_device_alloc - Allocate and initialize struct device for sound devices
122 * @dev_p: pointer to store the allocated device
123 * @card: card to assign, optional
125 * For releasing the allocated device, call put_device().
127 int snd_device_alloc(struct device **dev_p, struct snd_card *card)
132 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
135 device_initialize(dev);
137 dev->parent = &card->card_dev;
138 dev->class = &sound_class;
139 dev->release = default_release_alloc;
143 EXPORT_SYMBOL_GPL(snd_device_alloc);
145 static int snd_card_init(struct snd_card *card, struct device *parent,
146 int idx, const char *xid, struct module *module,
148 static int snd_card_do_free(struct snd_card *card);
149 static const struct attribute_group card_dev_attr_group;
151 static void release_card_device(struct device *dev)
153 snd_card_do_free(dev_to_snd_card(dev));
157 * snd_card_new - create and initialize a soundcard structure
158 * @parent: the parent device object
159 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
160 * @xid: card identification (ASCII string)
161 * @module: top level module for locking
162 * @extra_size: allocate this extra size after the main soundcard structure
163 * @card_ret: the pointer to store the created card instance
165 * The function allocates snd_card instance via kzalloc with the given
166 * space for the driver to use freely. The allocated struct is stored
167 * in the given card_ret pointer.
169 * Return: Zero if successful or a negative error code.
171 int snd_card_new(struct device *parent, int idx, const char *xid,
172 struct module *module, int extra_size,
173 struct snd_card **card_ret)
175 struct snd_card *card;
178 if (snd_BUG_ON(!card_ret))
184 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
188 err = snd_card_init(card, parent, idx, xid, module, extra_size);
190 return err; /* card is freed by error handler */
195 EXPORT_SYMBOL(snd_card_new);
197 static void __snd_card_release(struct device *dev, void *data)
203 * snd_devm_card_new - managed snd_card object creation
204 * @parent: the parent device object
205 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
206 * @xid: card identification (ASCII string)
207 * @module: top level module for locking
208 * @extra_size: allocate this extra size after the main soundcard structure
209 * @card_ret: the pointer to store the created card instance
211 * This function works like snd_card_new() but manages the allocated resource
212 * via devres, i.e. you don't need to free explicitly.
214 * When a snd_card object is created with this function and registered via
215 * snd_card_register(), the very first devres action to call snd_card_free()
216 * is added automatically. In that way, the resource disconnection is assured
217 * at first, then released in the expected order.
219 * If an error happens at the probe before snd_card_register() is called and
220 * there have been other devres resources, you'd need to free the card manually
221 * via snd_card_free() call in the error; otherwise it may lead to UAF due to
222 * devres call orders. You can use snd_card_free_on_error() helper for
223 * handling it more easily.
225 * Return: zero if successful, or a negative error code
227 int snd_devm_card_new(struct device *parent, int idx, const char *xid,
228 struct module *module, size_t extra_size,
229 struct snd_card **card_ret)
231 struct snd_card *card;
235 card = devres_alloc(__snd_card_release, sizeof(*card) + extra_size,
239 card->managed = true;
240 err = snd_card_init(card, parent, idx, xid, module, extra_size);
242 devres_free(card); /* in managed mode, we need to free manually */
246 devres_add(parent, card);
250 EXPORT_SYMBOL_GPL(snd_devm_card_new);
253 * snd_card_free_on_error - a small helper for handling devm probe errors
254 * @dev: the managed device object
255 * @ret: the return code from the probe callback
257 * This function handles the explicit snd_card_free() call at the error from
258 * the probe callback. It's just a small helper for simplifying the error
259 * handling with the managed devices.
261 * Return: zero if successful, or a negative error code
263 int snd_card_free_on_error(struct device *dev, int ret)
265 struct snd_card *card;
269 card = devres_find(dev, __snd_card_release, NULL, NULL);
274 EXPORT_SYMBOL_GPL(snd_card_free_on_error);
276 static int snd_card_init(struct snd_card *card, struct device *parent,
277 int idx, const char *xid, struct module *module,
283 card->private_data = (char *)card + sizeof(struct snd_card);
285 strscpy(card->id, xid, sizeof(card->id));
287 scoped_guard(mutex, &snd_card_mutex) {
288 if (idx < 0) /* first check the matching module-name slot */
289 idx = get_slot_from_bitmask(idx, module_slot_match, module);
290 if (idx < 0) /* if not matched, assign an empty slot */
291 idx = get_slot_from_bitmask(idx, check_empty_slot, module);
294 else if (idx < snd_ecards_limit) {
295 if (test_bit(idx, snd_cards_lock))
296 err = -EBUSY; /* invalid */
297 } else if (idx >= SNDRV_CARDS)
300 set_bit(idx, snd_cards_lock); /* lock it */
301 if (idx >= snd_ecards_limit)
302 snd_ecards_limit = idx + 1; /* increase the limit */
306 dev_err(parent, "cannot find the slot for index %d (range 0-%i), error: %d\n",
307 idx, snd_ecards_limit - 1, err);
309 kfree(card); /* manually free here, as no destructor called */
316 card->module = module;
318 INIT_LIST_HEAD(&card->devices);
319 init_rwsem(&card->controls_rwsem);
320 rwlock_init(&card->ctl_files_rwlock);
321 INIT_LIST_HEAD(&card->controls);
322 INIT_LIST_HEAD(&card->ctl_files);
323 #ifdef CONFIG_SND_CTL_FAST_LOOKUP
324 xa_init(&card->ctl_numids);
325 xa_init(&card->ctl_hash);
327 spin_lock_init(&card->files_lock);
328 INIT_LIST_HEAD(&card->files_list);
329 mutex_init(&card->memory_mutex);
331 init_waitqueue_head(&card->power_sleep);
332 init_waitqueue_head(&card->power_ref_sleep);
333 atomic_set(&card->power_ref, 0);
335 init_waitqueue_head(&card->remove_sleep);
338 device_initialize(&card->card_dev);
339 card->card_dev.parent = parent;
340 card->card_dev.class = &sound_class;
341 card->card_dev.release = release_card_device;
342 card->card_dev.groups = card->dev_groups;
343 card->dev_groups[0] = &card_dev_attr_group;
344 err = kobject_set_name(&card->card_dev.kobj, "card%d", idx);
348 snprintf(card->irq_descr, sizeof(card->irq_descr), "%s:%s",
349 dev_driver_string(card->dev), dev_name(&card->card_dev));
351 /* the control interface cannot be accessed from the user space until */
352 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
353 err = snd_ctl_create(card);
355 dev_err(parent, "unable to register control minors\n");
358 err = snd_info_card_create(card);
360 dev_err(parent, "unable to create card info\n");
364 #ifdef CONFIG_SND_DEBUG
365 card->debugfs_root = debugfs_create_dir(dev_name(&card->card_dev),
371 snd_device_free_all(card);
373 put_device(&card->card_dev);
378 * snd_card_ref - Get the card object from the index
379 * @idx: the card index
381 * Returns a card object corresponding to the given index or NULL if not found.
382 * Release the object via snd_card_unref().
384 * Return: a card object or NULL
386 struct snd_card *snd_card_ref(int idx)
388 struct snd_card *card;
390 guard(mutex)(&snd_card_mutex);
391 card = snd_cards[idx];
393 get_device(&card->card_dev);
396 EXPORT_SYMBOL_GPL(snd_card_ref);
398 /* return non-zero if a card is already locked */
399 int snd_card_locked(int card)
401 guard(mutex)(&snd_card_mutex);
402 return test_bit(card, snd_cards_lock);
405 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
410 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
411 size_t count, loff_t *offset)
416 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
417 size_t count, loff_t *offset)
422 static int snd_disconnect_release(struct inode *inode, struct file *file)
424 struct snd_monitor_file *df = NULL, *_df;
426 scoped_guard(spinlock, &shutdown_lock) {
427 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
428 if (_df->file == file) {
430 list_del_init(&df->shutdown_list);
437 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
438 df->disconnected_f_op->fasync(-1, file, 0);
439 return df->disconnected_f_op->release(inode, file);
442 panic("%s(%p, %p) failed!", __func__, inode, file);
445 static __poll_t snd_disconnect_poll(struct file * file, poll_table * wait)
447 return EPOLLERR | EPOLLNVAL;
450 static long snd_disconnect_ioctl(struct file *file,
451 unsigned int cmd, unsigned long arg)
456 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
461 static int snd_disconnect_fasync(int fd, struct file *file, int on)
466 static const struct file_operations snd_shutdown_f_ops =
468 .owner = THIS_MODULE,
469 .llseek = snd_disconnect_llseek,
470 .read = snd_disconnect_read,
471 .write = snd_disconnect_write,
472 .release = snd_disconnect_release,
473 .poll = snd_disconnect_poll,
474 .unlocked_ioctl = snd_disconnect_ioctl,
476 .compat_ioctl = snd_disconnect_ioctl,
478 .mmap = snd_disconnect_mmap,
479 .fasync = snd_disconnect_fasync
483 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
484 * @card: soundcard structure
486 * Disconnects all APIs from the file-operations (user space).
488 * Return: Zero, otherwise a negative error code.
490 * Note: The current implementation replaces all active file->f_op with special
491 * dummy file operations (they do nothing except release).
493 void snd_card_disconnect(struct snd_card *card)
495 struct snd_monitor_file *mfile;
500 scoped_guard(spinlock, &card->files_lock) {
505 /* replace file->f_op with special dummy operations */
506 list_for_each_entry(mfile, &card->files_list, list) {
507 /* it's critical part, use endless loop */
508 /* we have no room to fail */
509 mfile->disconnected_f_op = mfile->file->f_op;
511 scoped_guard(spinlock, &shutdown_lock)
512 list_add(&mfile->shutdown_list, &shutdown_files);
514 mfile->file->f_op = &snd_shutdown_f_ops;
515 fops_get(mfile->file->f_op);
519 /* notify all connected devices about disconnection */
520 /* at this point, they cannot respond to any calls except release() */
522 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
523 if (snd_mixer_oss_notify_callback)
524 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
527 /* notify all devices that we are disconnected */
528 snd_device_disconnect_all(card);
530 if (card->sync_irq > 0)
531 synchronize_irq(card->sync_irq);
533 snd_info_card_disconnect(card);
534 if (card->registered) {
535 device_del(&card->card_dev);
536 card->registered = false;
539 /* disable fops (user space) operations for ALSA API */
540 scoped_guard(mutex, &snd_card_mutex) {
541 snd_cards[card->number] = NULL;
542 clear_bit(card->number, snd_cards_lock);
546 wake_up(&card->power_sleep);
547 snd_power_sync_ref(card);
550 EXPORT_SYMBOL(snd_card_disconnect);
553 * snd_card_disconnect_sync - disconnect card and wait until files get closed
554 * @card: card object to disconnect
556 * This calls snd_card_disconnect() for disconnecting all belonging components
557 * and waits until all pending files get closed.
558 * It assures that all accesses from user-space finished so that the driver
559 * can release its resources gracefully.
561 void snd_card_disconnect_sync(struct snd_card *card)
563 snd_card_disconnect(card);
565 guard(spinlock_irq)(&card->files_lock);
566 wait_event_lock_irq(card->remove_sleep,
567 list_empty(&card->files_list),
570 EXPORT_SYMBOL_GPL(snd_card_disconnect_sync);
572 static int snd_card_do_free(struct snd_card *card)
574 card->releasing = true;
575 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
576 if (snd_mixer_oss_notify_callback)
577 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
579 snd_device_free_all(card);
580 if (card->private_free)
581 card->private_free(card);
582 if (snd_info_card_free(card) < 0) {
583 dev_warn(card->dev, "unable to free card info\n");
584 /* Not fatal error */
586 #ifdef CONFIG_SND_DEBUG
587 debugfs_remove(card->debugfs_root);
588 card->debugfs_root = NULL;
590 if (card->release_completion)
591 complete(card->release_completion);
598 * snd_card_free_when_closed - Disconnect the card, free it later eventually
599 * @card: soundcard structure
601 * Unlike snd_card_free(), this function doesn't try to release the card
602 * resource immediately, but tries to disconnect at first. When the card
603 * is still in use, the function returns before freeing the resources.
604 * The card resources will be freed when the refcount gets to zero.
606 * Return: zero if successful, or a negative error code
608 void snd_card_free_when_closed(struct snd_card *card)
613 snd_card_disconnect(card);
614 put_device(&card->card_dev);
617 EXPORT_SYMBOL(snd_card_free_when_closed);
620 * snd_card_free - frees given soundcard structure
621 * @card: soundcard structure
623 * This function releases the soundcard structure and the all assigned
624 * devices automatically. That is, you don't have to release the devices
627 * This function waits until the all resources are properly released.
629 * Return: Zero. Frees all associated devices and frees the control
630 * interface associated to given soundcard.
632 void snd_card_free(struct snd_card *card)
634 DECLARE_COMPLETION_ONSTACK(released);
636 /* The call of snd_card_free() is allowed from various code paths;
637 * a manual call from the driver and the call via devres_free, and
638 * we need to avoid double-free. Moreover, the release via devres
639 * may call snd_card_free() twice due to its nature, we need to have
640 * the check here at the beginning.
645 card->release_completion = &released;
646 snd_card_free_when_closed(card);
648 /* wait, until all devices are ready for the free operation */
649 wait_for_completion(&released);
651 EXPORT_SYMBOL(snd_card_free);
653 /* retrieve the last word of shortname or longname */
654 static const char *retrieve_id_from_card_name(const char *name)
656 const char *spos = name;
659 if (isspace(*name) && isalnum(name[1]))
666 /* return true if the given id string doesn't conflict any other card ids */
667 static bool card_id_ok(struct snd_card *card, const char *id)
670 if (!snd_info_check_reserved_words(id))
672 for (i = 0; i < snd_ecards_limit; i++) {
673 if (snd_cards[i] && snd_cards[i] != card &&
674 !strcmp(snd_cards[i]->id, id))
680 /* copy to card->id only with valid letters from nid */
681 static void copy_valid_id_string(struct snd_card *card, const char *src,
686 while (*nid && !isalnum(*nid))
689 *id++ = isalpha(*src) ? *src : 'D';
690 while (*nid && (size_t)(id - card->id) < sizeof(card->id) - 1) {
698 /* Set card->id from the given string
699 * If the string conflicts with other ids, add a suffix to make it unique.
701 static void snd_card_set_id_no_lock(struct snd_card *card, const char *src,
705 bool is_default = false;
708 copy_valid_id_string(card, src, nid);
712 /* use "Default" for obviously invalid strings
713 * ("card" conflicts with proc directories)
715 if (!*id || !strncmp(id, "card", 4)) {
716 strcpy(id, "Default");
721 for (loops = 0; loops < SNDRV_CARDS; loops++) {
723 char sfxstr[5]; /* "_012" */
726 if (card_id_ok(card, id))
729 /* Add _XYZ suffix */
730 sprintf(sfxstr, "_%X", loops + 1);
731 sfxlen = strlen(sfxstr);
732 if (len + sfxlen >= sizeof(card->id))
733 spos = id + sizeof(card->id) - sfxlen - 1;
736 strcpy(spos, sfxstr);
738 /* fallback to the default id */
744 dev_err(card->dev, "unable to set card id (%s)\n", id);
745 if (card->proc_root->name)
746 strscpy(card->id, card->proc_root->name, sizeof(card->id));
750 * snd_card_set_id - set card identification name
751 * @card: soundcard structure
752 * @nid: new identification string
754 * This function sets the card identification and checks for name
757 void snd_card_set_id(struct snd_card *card, const char *nid)
759 /* check if user specified own card->id */
760 if (card->id[0] != '\0')
762 guard(mutex)(&snd_card_mutex);
763 snd_card_set_id_no_lock(card, nid, nid);
765 EXPORT_SYMBOL(snd_card_set_id);
767 static ssize_t id_show(struct device *dev,
768 struct device_attribute *attr, char *buf)
770 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
771 return sysfs_emit(buf, "%s\n", card->id);
774 static ssize_t id_store(struct device *dev, struct device_attribute *attr,
775 const char *buf, size_t count)
777 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
778 char buf1[sizeof(card->id)];
779 size_t copy = count > sizeof(card->id) - 1 ?
780 sizeof(card->id) - 1 : count;
784 for (idx = 0; idx < copy; idx++) {
786 if (!isalnum(c) && c != '_' && c != '-')
789 memcpy(buf1, buf, copy);
791 guard(mutex)(&snd_card_mutex);
792 if (!card_id_ok(NULL, buf1))
794 strcpy(card->id, buf1);
795 snd_info_card_id_change(card);
800 static DEVICE_ATTR_RW(id);
802 static ssize_t number_show(struct device *dev,
803 struct device_attribute *attr, char *buf)
805 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
806 return sysfs_emit(buf, "%i\n", card->number);
809 static DEVICE_ATTR_RO(number);
811 static struct attribute *card_dev_attrs[] = {
813 &dev_attr_number.attr,
817 static const struct attribute_group card_dev_attr_group = {
818 .attrs = card_dev_attrs,
822 * snd_card_add_dev_attr - Append a new sysfs attribute group to card
823 * @card: card instance
824 * @group: attribute group to append
826 * Return: zero if successful, or a negative error code
828 int snd_card_add_dev_attr(struct snd_card *card,
829 const struct attribute_group *group)
833 /* loop for (arraysize-1) here to keep NULL at the last entry */
834 for (i = 0; i < ARRAY_SIZE(card->dev_groups) - 1; i++) {
835 if (!card->dev_groups[i]) {
836 card->dev_groups[i] = group;
841 dev_err(card->dev, "Too many groups assigned\n");
844 EXPORT_SYMBOL_GPL(snd_card_add_dev_attr);
846 static void trigger_card_free(void *data)
852 * snd_card_register - register the soundcard
853 * @card: soundcard structure
855 * This function registers all the devices assigned to the soundcard.
856 * Until calling this, the ALSA control interface is blocked from the
857 * external accesses. Thus, you should call this function at the end
858 * of the initialization of the card.
860 * Return: Zero otherwise a negative error code if the registration failed.
862 int snd_card_register(struct snd_card *card)
866 if (snd_BUG_ON(!card))
869 if (!card->registered) {
870 err = device_add(&card->card_dev);
873 card->registered = true;
876 devm_remove_action(card->dev, trigger_card_free, card);
880 err = devm_add_action(card->dev, trigger_card_free, card);
885 err = snd_device_register_all(card);
888 scoped_guard(mutex, &snd_card_mutex) {
889 if (snd_cards[card->number]) {
890 /* already registered */
891 return snd_info_card_register(card); /* register pending info */
894 /* make a unique id name from the given string */
895 char tmpid[sizeof(card->id)];
897 memcpy(tmpid, card->id, sizeof(card->id));
898 snd_card_set_id_no_lock(card, tmpid, tmpid);
900 /* create an id from either shortname or longname */
903 src = *card->shortname ? card->shortname : card->longname;
904 snd_card_set_id_no_lock(card, src,
905 retrieve_id_from_card_name(src));
907 snd_cards[card->number] = card;
909 err = snd_info_card_register(card);
913 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
914 if (snd_mixer_oss_notify_callback)
915 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
919 EXPORT_SYMBOL(snd_card_register);
921 #ifdef CONFIG_SND_PROC_FS
922 static void snd_card_info_read(struct snd_info_entry *entry,
923 struct snd_info_buffer *buffer)
926 struct snd_card *card;
928 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
929 guard(mutex)(&snd_card_mutex);
930 card = snd_cards[idx];
933 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
938 snd_iprintf(buffer, " %s\n",
943 snd_iprintf(buffer, "--- no soundcards ---\n");
946 #ifdef CONFIG_SND_OSSEMUL
947 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
950 struct snd_card *card;
952 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
953 guard(mutex)(&snd_card_mutex);
954 card = snd_cards[idx];
957 snd_iprintf(buffer, "%s\n", card->longname);
961 snd_iprintf(buffer, "--- no soundcards ---\n");
968 static void snd_card_module_info_read(struct snd_info_entry *entry,
969 struct snd_info_buffer *buffer)
972 struct snd_card *card;
974 for (idx = 0; idx < SNDRV_CARDS; idx++) {
975 guard(mutex)(&snd_card_mutex);
976 card = snd_cards[idx];
978 snd_iprintf(buffer, "%2i %s\n",
979 idx, card->module->name);
984 int __init snd_card_info_init(void)
986 struct snd_info_entry *entry;
988 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
991 entry->c.text.read = snd_card_info_read;
992 if (snd_info_register(entry) < 0)
993 return -ENOMEM; /* freed in error path */
996 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
999 entry->c.text.read = snd_card_module_info_read;
1000 if (snd_info_register(entry) < 0)
1001 return -ENOMEM; /* freed in error path */
1006 #endif /* CONFIG_SND_PROC_FS */
1009 * snd_component_add - add a component string
1010 * @card: soundcard structure
1011 * @component: the component id string
1013 * This function adds the component id string to the supported list.
1014 * The component can be referred from the alsa-lib.
1016 * Return: Zero otherwise a negative error code.
1019 int snd_component_add(struct snd_card *card, const char *component)
1022 int len = strlen(component);
1024 ptr = strstr(card->components, component);
1026 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
1029 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
1033 if (card->components[0] != '\0')
1034 strcat(card->components, " ");
1035 strcat(card->components, component);
1038 EXPORT_SYMBOL(snd_component_add);
1041 * snd_card_file_add - add the file to the file list of the card
1042 * @card: soundcard structure
1043 * @file: file pointer
1045 * This function adds the file to the file linked-list of the card.
1046 * This linked-list is used to keep tracking the connection state,
1047 * and to avoid the release of busy resources by hotplug.
1049 * Return: zero or a negative error code.
1051 int snd_card_file_add(struct snd_card *card, struct file *file)
1053 struct snd_monitor_file *mfile;
1055 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
1059 mfile->disconnected_f_op = NULL;
1060 INIT_LIST_HEAD(&mfile->shutdown_list);
1061 guard(spinlock)(&card->files_lock);
1062 if (card->shutdown) {
1066 list_add(&mfile->list, &card->files_list);
1067 get_device(&card->card_dev);
1070 EXPORT_SYMBOL(snd_card_file_add);
1073 * snd_card_file_remove - remove the file from the file list
1074 * @card: soundcard structure
1075 * @file: file pointer
1077 * This function removes the file formerly added to the card via
1078 * snd_card_file_add() function.
1079 * If all files are removed and snd_card_free_when_closed() was
1080 * called beforehand, it processes the pending release of
1083 * Return: Zero or a negative error code.
1085 int snd_card_file_remove(struct snd_card *card, struct file *file)
1087 struct snd_monitor_file *mfile, *found = NULL;
1089 scoped_guard(spinlock, &card->files_lock) {
1090 list_for_each_entry(mfile, &card->files_list, list) {
1091 if (mfile->file == file) {
1092 list_del(&mfile->list);
1093 scoped_guard(spinlock, &shutdown_lock)
1094 list_del(&mfile->shutdown_list);
1095 if (mfile->disconnected_f_op)
1096 fops_put(mfile->disconnected_f_op);
1101 if (list_empty(&card->files_list))
1102 wake_up_all(&card->remove_sleep);
1105 dev_err(card->dev, "card file remove problem (%p)\n", file);
1109 put_device(&card->card_dev);
1112 EXPORT_SYMBOL(snd_card_file_remove);
1116 * snd_power_ref_and_wait - wait until the card gets powered up
1117 * @card: soundcard structure
1119 * Take the power_ref reference count of the given card, and
1120 * wait until the card gets powered up to SNDRV_CTL_POWER_D0 state.
1121 * The refcount is down again while sleeping until power-up, hence this
1122 * function can be used for syncing the floating control ops accesses,
1123 * typically around calling control ops.
1125 * The caller needs to pull down the refcount via snd_power_unref() later
1126 * no matter whether the error is returned from this function or not.
1128 * Return: Zero if successful, or a negative error code.
1130 int snd_power_ref_and_wait(struct snd_card *card)
1132 snd_power_ref(card);
1133 if (snd_power_get_state(card) == SNDRV_CTL_POWER_D0)
1135 wait_event_cmd(card->power_sleep,
1137 snd_power_get_state(card) == SNDRV_CTL_POWER_D0,
1138 snd_power_unref(card), snd_power_ref(card));
1139 return card->shutdown ? -ENODEV : 0;
1141 EXPORT_SYMBOL_GPL(snd_power_ref_and_wait);
1144 * snd_power_wait - wait until the card gets powered up (old form)
1145 * @card: soundcard structure
1147 * Wait until the card gets powered up to SNDRV_CTL_POWER_D0 state.
1149 * Return: Zero if successful, or a negative error code.
1151 int snd_power_wait(struct snd_card *card)
1155 ret = snd_power_ref_and_wait(card);
1156 snd_power_unref(card);
1159 EXPORT_SYMBOL(snd_power_wait);
1160 #endif /* CONFIG_PM */