blob: 074875d68c156745519987f24d22058ca4c398b4 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Initialization routines
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02003 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 *
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.
10 *
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.
15 *
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
19 *
20 */
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/init.h>
23#include <linux/sched.h>
Paul Gortmakerda155d52011-07-15 12:38:28 -040024#include <linux/module.h>
Paul Gortmaker51990e82012-01-22 11:23:42 -050025#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/file.h>
27#include <linux/slab.h>
28#include <linux/time.h>
29#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/pm.h>
Takashi Iwaif2464062014-01-29 12:13:43 +010031#include <linux/completion.h>
Russell Kingd052d1b2005-10-29 19:07:23 +010032
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <sound/core.h>
34#include <sound/control.h>
35#include <sound/info.h>
36
Takashi Iwai82a783f2009-09-07 15:50:18 +020037/* monitor files for graceful shutdown (hotplug) */
38struct snd_monitor_file {
39 struct file *file;
40 const struct file_operations *disconnected_f_op;
41 struct list_head shutdown_list; /* still need to shutdown */
42 struct list_head list; /* link of monitor files */
43};
44
Karsten Wiesea9edfc62006-10-06 16:08:27 +020045static DEFINE_SPINLOCK(shutdown_lock);
46static LIST_HEAD(shutdown_files);
47
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -080048static const struct file_operations snd_shutdown_f_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Takashi Iwai7bb24912013-05-15 08:46:39 +020050/* locked for registering/using */
51static DECLARE_BITMAP(snd_cards_lock, SNDRV_CARDS);
Takashi Iwai6581f4e2006-05-17 17:14:51 +020052struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwaic0d3fb32006-04-28 15:13:39 +020053EXPORT_SYMBOL(snd_cards);
54
Takashi Iwai746df942006-05-15 19:49:05 +020055static DEFINE_MUTEX(snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Takashi Iwai304cd072007-10-26 15:10:15 +020057static char *slots[SNDRV_CARDS];
58module_param_array(slots, charp, NULL, 0444);
59MODULE_PARM_DESC(slots, "Module names assigned to the slots.");
60
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020061/* return non-zero if the given index is reserved for the given
Takashi Iwai304cd072007-10-26 15:10:15 +020062 * module via slots option
63 */
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020064static int module_slot_match(struct module *module, int idx)
Takashi Iwai304cd072007-10-26 15:10:15 +020065{
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020066 int match = 1;
Takashi Iwai304cd072007-10-26 15:10:15 +020067#ifdef MODULE
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020068 const char *s1, *s2;
69
Takashi Iwai60f6fef2013-10-28 12:54:52 +010070 if (!module || !*module->name || !slots[idx])
Takashi Iwai304cd072007-10-26 15:10:15 +020071 return 0;
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020072
73 s1 = module->name;
74 s2 = slots[idx];
75 if (*s2 == '!') {
76 match = 0; /* negative match */
77 s2++;
78 }
Takashi Iwai304cd072007-10-26 15:10:15 +020079 /* compare module name strings
80 * hyphens are handled as equivalent with underscore
81 */
82 for (;;) {
83 char c1 = *s1++;
84 char c2 = *s2++;
85 if (c1 == '-')
86 c1 = '_';
87 if (c2 == '-')
88 c2 = '_';
89 if (c1 != c2)
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020090 return !match;
Takashi Iwai304cd072007-10-26 15:10:15 +020091 if (!c1)
92 break;
93 }
Takashi Iwaia93bbaa2008-05-27 17:59:24 +020094#endif /* MODULE */
95 return match;
Takashi Iwai304cd072007-10-26 15:10:15 +020096}
97
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +010098#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Takashi Iwai512bbd62005-11-17 13:51:18 +010099int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag);
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200100EXPORT_SYMBOL(snd_mixer_oss_notify_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#endif
102
Takashi Iwaie28563c2005-12-01 10:42:42 +0100103#ifdef CONFIG_PROC_FS
Takashi Iwai512bbd62005-11-17 13:51:18 +0100104static void snd_card_id_read(struct snd_info_entry *entry,
105 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106{
107 snd_iprintf(buffer, "%s\n", entry->card->id);
108}
109
Takashi Iwaie28563c2005-12-01 10:42:42 +0100110static inline int init_info_for_card(struct snd_card *card)
111{
112 int err;
113 struct snd_info_entry *entry;
114
115 if ((err = snd_info_card_register(card)) < 0) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100116 dev_dbg(card->dev, "unable to create card info\n");
Takashi Iwaie28563c2005-12-01 10:42:42 +0100117 return err;
118 }
119 if ((entry = snd_info_create_card_entry(card, "id", card->proc_root)) == NULL) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100120 dev_dbg(card->dev, "unable to create card entry\n");
Takashi Iwaie28563c2005-12-01 10:42:42 +0100121 return err;
122 }
Takashi Iwaie28563c2005-12-01 10:42:42 +0100123 entry->c.text.read = snd_card_id_read;
124 if (snd_info_register(entry) < 0) {
125 snd_info_free_entry(entry);
126 entry = NULL;
127 }
128 card->proc_id = entry;
129 return 0;
130}
131#else /* !CONFIG_PROC_FS */
132#define init_info_for_card(card)
133#endif
134
Takashi Iwaideb65962014-01-23 11:02:15 +0100135static int check_empty_slot(struct module *module, int slot)
136{
137 return !slots[slot] || !*slots[slot];
138}
139
140/* return an empty slot number (>= 0) found in the given bitmask @mask.
141 * @mask == -1 == 0xffffffff means: take any free slot up to 32
142 * when no slot is available, return the original @mask as is.
143 */
144static int get_slot_from_bitmask(int mask, int (*check)(struct module *, int),
145 struct module *module)
146{
147 int slot;
148
149 for (slot = 0; slot < SNDRV_CARDS; slot++) {
150 if (slot < 32 && !(mask & (1U << slot)))
151 continue;
152 if (!test_bit(slot, snd_cards_lock)) {
153 if (check(module, slot))
154 return slot; /* found */
155 }
156 }
157 return mask; /* unchanged */
158}
159
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100160static int snd_card_do_free(struct snd_card *card);
Takashi Iwai34356db2014-01-29 11:54:10 +0100161static const struct attribute_group *card_dev_attr_groups[];
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100162
163static void release_card_device(struct device *dev)
164{
165 snd_card_do_free(dev_to_snd_card(dev));
166}
167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168/**
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100169 * snd_card_new - create and initialize a soundcard structure
170 * @parent: the parent device object
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
172 * @xid: card identification (ASCII string)
173 * @module: top level module for locking
174 * @extra_size: allocate this extra size after the main soundcard structure
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100175 * @card_ret: the pointer to store the created card instance
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 *
177 * Creates and initializes a soundcard structure.
178 *
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100179 * The function allocates snd_card instance via kzalloc with the given
180 * space for the driver to use freely. The allocated struct is stored
181 * in the given card_ret pointer.
182 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100183 * Return: Zero if successful or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 */
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100185int snd_card_new(struct device *parent, int idx, const char *xid,
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100186 struct module *module, int extra_size,
187 struct snd_card **card_ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100189 struct snd_card *card;
Takashi Iwaideb65962014-01-23 11:02:15 +0100190 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100192 if (snd_BUG_ON(!card_ret))
193 return -EINVAL;
194 *card_ret = NULL;
195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 if (extra_size < 0)
197 extra_size = 0;
Takashi Iwaica2c0962005-09-09 14:20:23 +0200198 card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100199 if (!card)
200 return -ENOMEM;
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100201 if (extra_size > 0)
202 card->private_data = (char *)card + sizeof(struct snd_card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200203 if (xid)
Jaroslav Kysela5fdc18d2009-06-04 00:12:18 +0200204 strlcpy(card->id, xid, sizeof(card->id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 err = 0;
Takashi Iwai746df942006-05-15 19:49:05 +0200206 mutex_lock(&snd_card_mutex);
Takashi Iwaideb65962014-01-23 11:02:15 +0100207 if (idx < 0) /* first check the matching module-name slot */
208 idx = get_slot_from_bitmask(idx, module_slot_match, module);
209 if (idx < 0) /* if not matched, assign an empty slot */
210 idx = get_slot_from_bitmask(idx, check_empty_slot, module);
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200211 if (idx < 0)
212 err = -ENODEV;
213 else if (idx < snd_ecards_limit) {
Takashi Iwai7bb24912013-05-15 08:46:39 +0200214 if (test_bit(idx, snd_cards_lock))
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200215 err = -EBUSY; /* invalid */
216 } else if (idx >= SNDRV_CARDS)
217 err = -ENODEV;
218 if (err < 0) {
Takashi Iwai746df942006-05-15 19:49:05 +0200219 mutex_unlock(&snd_card_mutex);
Takashi Iwaif2f93072014-02-04 18:21:03 +0100220 dev_err(parent, "cannot find the slot for index %d (range 0-%i), error: %d\n",
Oliver Neukum5c33dd72007-01-16 17:49:21 +0100221 idx, snd_ecards_limit - 1, err);
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100222 kfree(card);
223 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 }
Takashi Iwai7bb24912013-05-15 08:46:39 +0200225 set_bit(idx, snd_cards_lock); /* lock it */
Takashi Iwaia93bbaa2008-05-27 17:59:24 +0200226 if (idx >= snd_ecards_limit)
227 snd_ecards_limit = idx + 1; /* increase the limit */
Takashi Iwai746df942006-05-15 19:49:05 +0200228 mutex_unlock(&snd_card_mutex);
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100229 card->dev = parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 card->number = idx;
231 card->module = module;
232 INIT_LIST_HEAD(&card->devices);
233 init_rwsem(&card->controls_rwsem);
234 rwlock_init(&card->ctl_files_rwlock);
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +0200235 mutex_init(&card->user_ctl_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 INIT_LIST_HEAD(&card->controls);
237 INIT_LIST_HEAD(&card->ctl_files);
238 spin_lock_init(&card->files_lock);
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100239 INIT_LIST_HEAD(&card->files_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240#ifdef CONFIG_PM
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100241 mutex_init(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 init_waitqueue_head(&card->power_sleep);
243#endif
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100244
245 device_initialize(&card->card_dev);
246 card->card_dev.parent = parent;
247 card->card_dev.class = sound_class;
248 card->card_dev.release = release_card_device;
Takashi Iwai34356db2014-01-29 11:54:10 +0100249 card->card_dev.groups = card_dev_attr_groups;
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100250 err = kobject_set_name(&card->card_dev.kobj, "card%d", idx);
251 if (err < 0)
252 goto __error;
253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 /* the control interface cannot be accessed from the user space until */
255 /* snd_cards_bitmask and snd_cards are set with snd_card_register */
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100256 err = snd_ctl_create(card);
257 if (err < 0) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100258 dev_err(parent, "unable to register control minors\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 goto __error;
260 }
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100261 err = snd_info_card_create(card);
262 if (err < 0) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100263 dev_err(parent, "unable to create card info\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 goto __error_ctl;
265 }
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100266 *card_ret = card;
267 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269 __error_ctl:
Takashi Iwai289ca022014-01-29 15:53:35 +0100270 snd_device_free_all(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 __error:
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100272 put_device(&card->card_dev);
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100273 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100275EXPORT_SYMBOL(snd_card_new);
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200276
Takashi Iwai746df942006-05-15 19:49:05 +0200277/* return non-zero if a card is already locked */
278int snd_card_locked(int card)
279{
280 int locked;
281
282 mutex_lock(&snd_card_mutex);
Takashi Iwai7bb24912013-05-15 08:46:39 +0200283 locked = test_bit(card, snd_cards_lock);
Takashi Iwai746df942006-05-15 19:49:05 +0200284 mutex_unlock(&snd_card_mutex);
285 return locked;
286}
287
Clemens Ladischb3b0abe2006-03-03 14:08:43 +0100288static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
289{
290 return -ENODEV;
291}
292
293static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
294 size_t count, loff_t *offset)
295{
296 return -ENODEV;
297}
298
299static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
300 size_t count, loff_t *offset)
301{
302 return -ENODEV;
303}
304
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200305static int snd_disconnect_release(struct inode *inode, struct file *file)
306{
307 struct snd_monitor_file *df = NULL, *_df;
308
309 spin_lock(&shutdown_lock);
310 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
311 if (_df->file == file) {
312 df = _df;
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100313 list_del_init(&df->shutdown_list);
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200314 break;
315 }
316 }
317 spin_unlock(&shutdown_lock);
318
Al Viro233e70f2008-10-31 23:28:30 +0000319 if (likely(df)) {
320 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
321 df->disconnected_f_op->fasync(-1, file, 0);
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200322 return df->disconnected_f_op->release(inode, file);
Al Viro233e70f2008-10-31 23:28:30 +0000323 }
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200324
Harvey Harrison9bf8e7d2008-03-03 15:32:18 -0800325 panic("%s(%p, %p) failed!", __func__, inode, file);
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200326}
327
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328static unsigned int snd_disconnect_poll(struct file * file, poll_table * wait)
329{
330 return POLLERR | POLLNVAL;
331}
332
Clemens Ladischb3b0abe2006-03-03 14:08:43 +0100333static long snd_disconnect_ioctl(struct file *file,
334 unsigned int cmd, unsigned long arg)
335{
336 return -ENODEV;
337}
338
339static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
340{
341 return -ENODEV;
342}
343
344static int snd_disconnect_fasync(int fd, struct file *file, int on)
345{
346 return -ENODEV;
347}
348
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -0800349static const struct file_operations snd_shutdown_f_ops =
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200350{
351 .owner = THIS_MODULE,
352 .llseek = snd_disconnect_llseek,
353 .read = snd_disconnect_read,
354 .write = snd_disconnect_write,
355 .release = snd_disconnect_release,
356 .poll = snd_disconnect_poll,
357 .unlocked_ioctl = snd_disconnect_ioctl,
358#ifdef CONFIG_COMPAT
359 .compat_ioctl = snd_disconnect_ioctl,
360#endif
361 .mmap = snd_disconnect_mmap,
362 .fasync = snd_disconnect_fasync
363};
364
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365/**
366 * snd_card_disconnect - disconnect all APIs from the file-operations (user space)
367 * @card: soundcard structure
368 *
369 * Disconnects all APIs from the file-operations (user space).
370 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100371 * Return: Zero, otherwise a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 *
373 * Note: The current implementation replaces all active file->f_op with special
374 * dummy file operations (they do nothing except release).
375 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100376int snd_card_disconnect(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
378 struct snd_monitor_file *mfile;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 int err;
380
Takashi Iwaif18638d2008-04-17 12:52:02 +0200381 if (!card)
382 return -EINVAL;
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 spin_lock(&card->files_lock);
385 if (card->shutdown) {
386 spin_unlock(&card->files_lock);
387 return 0;
388 }
389 card->shutdown = 1;
390 spin_unlock(&card->files_lock);
391
392 /* phase 1: disable fops (user space) operations for ALSA API */
Takashi Iwai746df942006-05-15 19:49:05 +0200393 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 snd_cards[card->number] = NULL;
Takashi Iwai7bb24912013-05-15 08:46:39 +0200395 clear_bit(card->number, snd_cards_lock);
Takashi Iwai746df942006-05-15 19:49:05 +0200396 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 /* phase 2: replace file->f_op with special dummy operations */
399
400 spin_lock(&card->files_lock);
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100401 list_for_each_entry(mfile, &card->files_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 /* it's critical part, use endless loop */
403 /* we have no room to fail */
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200404 mfile->disconnected_f_op = mfile->file->f_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200406 spin_lock(&shutdown_lock);
407 list_add(&mfile->shutdown_list, &shutdown_files);
408 spin_unlock(&shutdown_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200410 mfile->file->f_op = &snd_shutdown_f_ops;
Miguel Botonbc9abce2008-01-13 12:03:53 +0100411 fops_get(mfile->file->f_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 }
413 spin_unlock(&card->files_lock);
414
415 /* phase 3: notify all connected devices about disconnection */
416 /* at this point, they cannot respond to any calls except release() */
417
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +0100418#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 if (snd_mixer_oss_notify_callback)
420 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
421#endif
422
423 /* notify all devices that we are disconnected */
424 err = snd_device_disconnect_all(card);
425 if (err < 0)
Takashi Iwaif2f93072014-02-04 18:21:03 +0100426 dev_err(card->dev, "not all devices for card %i can be disconnected\n", card->number);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Takashi Iwai746d4a02006-06-23 14:37:59 +0200428 snd_info_card_disconnect(card);
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100429 if (card->registered) {
430 device_del(&card->card_dev);
431 card->registered = false;
Takashi Iwai73d38b12008-04-17 12:50:47 +0200432 }
Takashi Iwaif18638d2008-04-17 12:52:02 +0200433#ifdef CONFIG_PM
434 wake_up(&card->power_sleep);
435#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 return 0;
437}
438
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200439EXPORT_SYMBOL(snd_card_disconnect);
440
Takashi Iwaic4614822006-06-23 14:38:23 +0200441static int snd_card_do_free(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +0100443#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 if (snd_mixer_oss_notify_callback)
445 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
446#endif
Takashi Iwai72620d62014-02-04 11:36:11 +0100447 snd_device_free_all(card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 if (card->private_free)
449 card->private_free(card);
Takashi Iwai746d4a02006-06-23 14:37:59 +0200450 snd_info_free_entry(card->proc_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 if (snd_info_card_free(card) < 0) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100452 dev_warn(card->dev, "unable to free card info\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 /* Not fatal error */
454 }
Takashi Iwaif2464062014-01-29 12:13:43 +0100455 if (card->release_completion)
456 complete(card->release_completion);
Takashi Iwaic4614822006-06-23 14:38:23 +0200457 kfree(card);
458 return 0;
459}
460
Takashi Iwaieb9c38d2014-10-30 15:19:43 +0100461/**
462 * snd_card_free_when_closed - Disconnect the card, free it later eventually
463 * @card: soundcard structure
464 *
465 * Unlike snd_card_free(), this function doesn't try to release the card
466 * resource immediately, but tries to disconnect at first. When the card
467 * is still in use, the function returns before freeing the resources.
468 * The card resources will be freed when the refcount gets to zero.
469 */
Takashi Iwaic4614822006-06-23 14:38:23 +0200470int snd_card_free_when_closed(struct snd_card *card)
471{
Takashi Iwaif18638d2008-04-17 12:52:02 +0200472 int ret = snd_card_disconnect(card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200473 if (ret)
474 return ret;
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100475 put_device(&card->card_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 return 0;
477}
Takashi Iwaif2464062014-01-29 12:13:43 +0100478EXPORT_SYMBOL(snd_card_free_when_closed);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479
Takashi Iwaieb9c38d2014-10-30 15:19:43 +0100480/**
481 * snd_card_free - frees given soundcard structure
482 * @card: soundcard structure
483 *
484 * This function releases the soundcard structure and the all assigned
485 * devices automatically. That is, you don't have to release the devices
486 * by yourself.
487 *
488 * This function waits until the all resources are properly released.
489 *
490 * Return: Zero. Frees all associated devices and frees the control
491 * interface associated to given soundcard.
492 */
Takashi Iwaif2464062014-01-29 12:13:43 +0100493int snd_card_free(struct snd_card *card)
494{
495 struct completion released;
496 int ret;
497
498 init_completion(&released);
499 card->release_completion = &released;
500 ret = snd_card_free_when_closed(card);
501 if (ret)
502 return ret;
503 /* wait, until all devices are ready for the free operation */
504 wait_for_completion(&released);
505 return 0;
506}
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200507EXPORT_SYMBOL(snd_card_free);
508
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100509/* retrieve the last word of shortname or longname */
510static const char *retrieve_id_from_card_name(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100512 const char *spos = name;
513
514 while (*name) {
515 if (isspace(*name) && isalnum(name[1]))
516 spos = name + 1;
517 name++;
518 }
519 return spos;
520}
521
522/* return true if the given id string doesn't conflict any other card ids */
523static bool card_id_ok(struct snd_card *card, const char *id)
524{
525 int i;
526 if (!snd_info_check_reserved_words(id))
527 return false;
528 for (i = 0; i < snd_ecards_limit; i++) {
529 if (snd_cards[i] && snd_cards[i] != card &&
530 !strcmp(snd_cards[i]->id, id))
531 return false;
532 }
533 return true;
534}
535
536/* copy to card->id only with valid letters from nid */
537static void copy_valid_id_string(struct snd_card *card, const char *src,
538 const char *nid)
539{
540 char *id = card->id;
541
542 while (*nid && !isalnum(*nid))
543 nid++;
544 if (isdigit(*nid))
545 *id++ = isalpha(*src) ? *src : 'D';
546 while (*nid && (size_t)(id - card->id) < sizeof(card->id) - 1) {
547 if (isalnum(*nid))
548 *id++ = *nid;
549 nid++;
550 }
551 *id = 0;
552}
553
554/* Set card->id from the given string
555 * If the string conflicts with other ids, add a suffix to make it unique.
556 */
557static void snd_card_set_id_no_lock(struct snd_card *card, const char *src,
558 const char *nid)
559{
560 int len, loops;
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100561 bool is_default = false;
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200562 char *id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100564 copy_valid_id_string(card, src, nid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 id = card->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100567 again:
568 /* use "Default" for obviously invalid strings
569 * ("card" conflicts with proc directories)
570 */
571 if (!*id || !strncmp(id, "card", 4)) {
Takashi Iwaid8e4f9a2011-04-04 12:43:23 +0200572 strcpy(id, "Default");
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100573 is_default = true;
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Takashi Iwai8edbb192013-05-24 16:30:39 +0200576 len = strlen(id);
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100577 for (loops = 0; loops < SNDRV_CARDS; loops++) {
Takashi Iwai8edbb192013-05-24 16:30:39 +0200578 char *spos;
579 char sfxstr[5]; /* "_012" */
580 int sfxlen;
581
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100582 if (card_id_ok(card, id))
583 return; /* OK */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Takashi Iwai8edbb192013-05-24 16:30:39 +0200585 /* Add _XYZ suffix */
586 sprintf(sfxstr, "_%X", loops + 1);
587 sfxlen = strlen(sfxstr);
588 if (len + sfxlen >= sizeof(card->id))
589 spos = id + sizeof(card->id) - sfxlen - 1;
590 else
591 spos = id + len;
592 strcpy(spos, sfxstr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 }
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100594 /* fallback to the default id */
595 if (!is_default) {
596 *id = 0;
597 goto again;
598 }
599 /* last resort... */
Takashi Iwaif2f93072014-02-04 18:21:03 +0100600 dev_err(card->dev, "unable to set card id (%s)\n", id);
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100601 if (card->proc_root->name)
Takashi Iwai97f44f52013-10-29 15:20:06 +0100602 strlcpy(card->id, card->proc_root->name, sizeof(card->id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603}
604
Mark Brown872c7822009-06-03 20:43:29 +0100605/**
606 * snd_card_set_id - set card identification name
607 * @card: soundcard structure
608 * @nid: new identification string
609 *
610 * This function sets the card identification and checks for name
611 * collisions.
612 */
613void snd_card_set_id(struct snd_card *card, const char *nid)
614{
Jaroslav Kysela5fdc18d2009-06-04 00:12:18 +0200615 /* check if user specified own card->id */
616 if (card->id[0] != '\0')
617 return;
618 mutex_lock(&snd_card_mutex);
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100619 snd_card_set_id_no_lock(card, nid, nid);
Jaroslav Kysela5fdc18d2009-06-04 00:12:18 +0200620 mutex_unlock(&snd_card_mutex);
Mark Brown872c7822009-06-03 20:43:29 +0100621}
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200622EXPORT_SYMBOL(snd_card_set_id);
623
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100624static ssize_t
625card_id_show_attr(struct device *dev,
626 struct device_attribute *attr, char *buf)
627{
Takashi Iwaib203dba2014-02-19 11:18:10 +0100628 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
629 return snprintf(buf, PAGE_SIZE, "%s\n", card->id);
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100630}
631
632static ssize_t
633card_id_store_attr(struct device *dev, struct device_attribute *attr,
634 const char *buf, size_t count)
635{
Takashi Iwaib203dba2014-02-19 11:18:10 +0100636 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100637 char buf1[sizeof(card->id)];
638 size_t copy = count > sizeof(card->id) - 1 ?
639 sizeof(card->id) - 1 : count;
640 size_t idx;
641 int c;
642
643 for (idx = 0; idx < copy; idx++) {
644 c = buf[idx];
645 if (!isalnum(c) && c != '_' && c != '-')
646 return -EINVAL;
647 }
648 memcpy(buf1, buf, copy);
649 buf1[copy] = '\0';
650 mutex_lock(&snd_card_mutex);
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100651 if (!card_id_ok(NULL, buf1)) {
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100652 mutex_unlock(&snd_card_mutex);
653 return -EEXIST;
654 }
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100655 strcpy(card->id, buf1);
Jaroslav Kyselac2eb9c42008-11-12 16:31:37 +0100656 snd_info_card_id_change(card);
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100657 mutex_unlock(&snd_card_mutex);
658
659 return count;
660}
661
Takashi Iwai34356db2014-01-29 11:54:10 +0100662static DEVICE_ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100663
664static ssize_t
665card_number_show_attr(struct device *dev,
666 struct device_attribute *attr, char *buf)
667{
Takashi Iwaib203dba2014-02-19 11:18:10 +0100668 struct snd_card *card = container_of(dev, struct snd_card, card_dev);
669 return snprintf(buf, PAGE_SIZE, "%i\n", card->number);
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100670}
671
Takashi Iwai34356db2014-01-29 11:54:10 +0100672static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);
673
674static struct attribute *card_dev_attrs[] = {
675 &dev_attr_id.attr,
676 &dev_attr_number.attr,
677 NULL
678};
679
680static struct attribute_group card_dev_attr_group = {
681 .attrs = card_dev_attrs,
682};
683
684static const struct attribute_group *card_dev_attr_groups[] = {
685 &card_dev_attr_group,
686 NULL
687};
Jaroslav Kysela9fb61982008-11-11 16:51:02 +0100688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689/**
690 * snd_card_register - register the soundcard
691 * @card: soundcard structure
692 *
693 * This function registers all the devices assigned to the soundcard.
694 * Until calling this, the ALSA control interface is blocked from the
695 * external accesses. Thus, you should call this function at the end
696 * of the initialization of the card.
697 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100698 * Return: Zero otherwise a negative error code if the registration failed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100700int snd_card_register(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701{
702 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200704 if (snd_BUG_ON(!card))
705 return -EINVAL;
Kay Sievers39aba962010-09-04 22:33:14 -0700706
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100707 if (!card->registered) {
708 err = device_add(&card->card_dev);
709 if (err < 0)
710 return err;
711 card->registered = true;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700712 }
Kay Sievers39aba962010-09-04 22:33:14 -0700713
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 if ((err = snd_device_register_all(card)) < 0)
715 return err;
Takashi Iwai746df942006-05-15 19:49:05 +0200716 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 if (snd_cards[card->number]) {
718 /* already registered */
Takashi Iwai746df942006-05-15 19:49:05 +0200719 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 return 0;
721 }
Takashi Iwaie7df2a32012-03-09 17:41:53 +0100722 if (*card->id) {
723 /* make a unique id name from the given string */
724 char tmpid[sizeof(card->id)];
725 memcpy(tmpid, card->id, sizeof(card->id));
726 snd_card_set_id_no_lock(card, tmpid, tmpid);
727 } else {
728 /* create an id from either shortname or longname */
729 const char *src;
730 src = *card->shortname ? card->shortname : card->longname;
731 snd_card_set_id_no_lock(card, src,
732 retrieve_id_from_card_name(src));
733 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 snd_cards[card->number] = card;
Takashi Iwai746df942006-05-15 19:49:05 +0200735 mutex_unlock(&snd_card_mutex);
Takashi Iwaie28563c2005-12-01 10:42:42 +0100736 init_info_for_card(card);
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +0100737#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 if (snd_mixer_oss_notify_callback)
739 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
740#endif
741 return 0;
742}
743
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200744EXPORT_SYMBOL(snd_card_register);
745
Takashi Iwaie28563c2005-12-01 10:42:42 +0100746#ifdef CONFIG_PROC_FS
Takashi Iwai6581f4e2006-05-17 17:14:51 +0200747static struct snd_info_entry *snd_card_info_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Takashi Iwaia381a7a2005-11-17 15:55:49 +0100749static void snd_card_info_read(struct snd_info_entry *entry,
750 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751{
752 int idx, count;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100753 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200756 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 if ((card = snd_cards[idx]) != NULL) {
758 count++;
Clemens Ladischd0015442005-11-20 14:09:05 +0100759 snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 idx,
761 card->id,
762 card->driver,
763 card->shortname);
Clemens Ladischd0015442005-11-20 14:09:05 +0100764 snd_iprintf(buffer, " %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 card->longname);
766 }
Takashi Iwai746df942006-05-15 19:49:05 +0200767 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 }
769 if (!count)
770 snd_iprintf(buffer, "--- no soundcards ---\n");
771}
772
Takashi Iwaie28563c2005-12-01 10:42:42 +0100773#ifdef CONFIG_SND_OSSEMUL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Takashi Iwai512bbd62005-11-17 13:51:18 +0100775void snd_card_info_read_oss(struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
777 int idx, count;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100778 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
780 for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200781 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 if ((card = snd_cards[idx]) != NULL) {
783 count++;
784 snd_iprintf(buffer, "%s\n", card->longname);
785 }
Takashi Iwai746df942006-05-15 19:49:05 +0200786 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 }
788 if (!count) {
789 snd_iprintf(buffer, "--- no soundcards ---\n");
790 }
791}
792
793#endif
794
795#ifdef MODULE
Takashi Iwai512bbd62005-11-17 13:51:18 +0100796static struct snd_info_entry *snd_card_module_info_entry;
797static void snd_card_module_info_read(struct snd_info_entry *entry,
798 struct snd_info_buffer *buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 int idx;
Takashi Iwai512bbd62005-11-17 13:51:18 +0100801 struct snd_card *card;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
803 for (idx = 0; idx < SNDRV_CARDS; idx++) {
Takashi Iwai746df942006-05-15 19:49:05 +0200804 mutex_lock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 if ((card = snd_cards[idx]) != NULL)
Clemens Ladischd0015442005-11-20 14:09:05 +0100806 snd_iprintf(buffer, "%2i %s\n",
807 idx, card->module->name);
Takashi Iwai746df942006-05-15 19:49:05 +0200808 mutex_unlock(&snd_card_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 }
810}
811#endif
812
813int __init snd_card_info_init(void)
814{
Takashi Iwai512bbd62005-11-17 13:51:18 +0100815 struct snd_info_entry *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
817 entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200818 if (! entry)
819 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 entry->c.text.read = snd_card_info_read;
821 if (snd_info_register(entry) < 0) {
822 snd_info_free_entry(entry);
823 return -ENOMEM;
824 }
825 snd_card_info_entry = entry;
826
827#ifdef MODULE
828 entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
829 if (entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 entry->c.text.read = snd_card_module_info_read;
831 if (snd_info_register(entry) < 0)
832 snd_info_free_entry(entry);
833 else
834 snd_card_module_info_entry = entry;
835 }
836#endif
837
838 return 0;
839}
840
841int __exit snd_card_info_done(void)
842{
Takashi Iwai746d4a02006-06-23 14:37:59 +0200843 snd_info_free_entry(snd_card_info_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844#ifdef MODULE
Takashi Iwai746d4a02006-06-23 14:37:59 +0200845 snd_info_free_entry(snd_card_module_info_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846#endif
847 return 0;
848}
849
Takashi Iwaie28563c2005-12-01 10:42:42 +0100850#endif /* CONFIG_PROC_FS */
851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852/**
853 * snd_component_add - add a component string
854 * @card: soundcard structure
855 * @component: the component id string
856 *
857 * This function adds the component id string to the supported list.
858 * The component can be referred from the alsa-lib.
859 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100860 * Return: Zero otherwise a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 */
862
Takashi Iwai512bbd62005-11-17 13:51:18 +0100863int snd_component_add(struct snd_card *card, const char *component)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864{
865 char *ptr;
866 int len = strlen(component);
867
868 ptr = strstr(card->components, component);
869 if (ptr != NULL) {
870 if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */
871 return 1;
872 }
873 if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
874 snd_BUG();
875 return -ENOMEM;
876 }
877 if (card->components[0] != '\0')
878 strcat(card->components, " ");
879 strcat(card->components, component);
880 return 0;
881}
882
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200883EXPORT_SYMBOL(snd_component_add);
884
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885/**
886 * snd_card_file_add - add the file to the file list of the card
887 * @card: soundcard structure
888 * @file: file pointer
889 *
890 * This function adds the file to the file linked-list of the card.
891 * This linked-list is used to keep tracking the connection state,
892 * and to avoid the release of busy resources by hotplug.
893 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100894 * Return: zero or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100896int snd_card_file_add(struct snd_card *card, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897{
898 struct snd_monitor_file *mfile;
899
900 mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
901 if (mfile == NULL)
902 return -ENOMEM;
903 mfile->file = file;
Karsten Wiesea9edfc62006-10-06 16:08:27 +0200904 mfile->disconnected_f_op = NULL;
Takashi Iwaia45e3d62011-03-24 09:50:15 +0100905 INIT_LIST_HEAD(&mfile->shutdown_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 spin_lock(&card->files_lock);
907 if (card->shutdown) {
908 spin_unlock(&card->files_lock);
909 kfree(mfile);
910 return -ENODEV;
911 }
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100912 list_add(&mfile->list, &card->files_list);
Takashi Iwaif2464062014-01-29 12:13:43 +0100913 get_device(&card->card_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 spin_unlock(&card->files_lock);
915 return 0;
916}
917
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200918EXPORT_SYMBOL(snd_card_file_add);
919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920/**
921 * snd_card_file_remove - remove the file from the file list
922 * @card: soundcard structure
923 * @file: file pointer
924 *
925 * This function removes the file formerly added to the card via
926 * snd_card_file_add() function.
Takashi Iwai2b29b132006-06-23 14:38:26 +0200927 * If all files are removed and snd_card_free_when_closed() was
928 * called beforehand, it processes the pending release of
929 * resources.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100931 * Return: Zero or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100933int snd_card_file_remove(struct snd_card *card, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100935 struct snd_monitor_file *mfile, *found = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
937 spin_lock(&card->files_lock);
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100938 list_for_each_entry(mfile, &card->files_list, list) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 if (mfile->file == file) {
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100940 list_del(&mfile->list);
Takashi Iwaia45e3d62011-03-24 09:50:15 +0100941 spin_lock(&shutdown_lock);
942 list_del(&mfile->shutdown_list);
943 spin_unlock(&shutdown_lock);
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100944 if (mfile->disconnected_f_op)
945 fops_put(mfile->disconnected_f_op);
946 found = mfile;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 break;
948 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 }
Takashi Iwaic4614822006-06-23 14:38:23 +0200950 spin_unlock(&card->files_lock);
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100951 if (!found) {
Takashi Iwaif2f93072014-02-04 18:21:03 +0100952 dev_err(card->dev, "card file remove problem (%p)\n", file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 return -ENOENT;
954 }
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100955 kfree(found);
Takashi Iwaif2464062014-01-29 12:13:43 +0100956 put_device(&card->card_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 return 0;
958}
959
Takashi Iwaic0d3fb32006-04-28 15:13:39 +0200960EXPORT_SYMBOL(snd_card_file_remove);
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962#ifdef CONFIG_PM
963/**
964 * snd_power_wait - wait until the power-state is changed.
965 * @card: soundcard structure
966 * @power_state: expected power state
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 *
968 * Waits until the power-state is changed.
969 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100970 * Return: Zero if successful, or a negative error code.
971 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 * Note: the power lock must be active before call.
973 */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200974int snd_power_wait(struct snd_card *card, unsigned int power_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
976 wait_queue_t wait;
977 int result = 0;
978
979 /* fastpath */
980 if (snd_power_get_state(card) == power_state)
981 return 0;
982 init_waitqueue_entry(&wait, current);
983 add_wait_queue(&card->power_sleep, &wait);
984 while (1) {
985 if (card->shutdown) {
986 result = -ENODEV;
987 break;
988 }
989 if (snd_power_get_state(card) == power_state)
990 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 set_current_state(TASK_UNINTERRUPTIBLE);
992 snd_power_unlock(card);
993 schedule_timeout(30 * HZ);
994 snd_power_lock(card);
995 }
996 remove_wait_queue(&card->power_sleep, &wait);
997 return result;
998}
999
Takashi Iwaic0d3fb32006-04-28 15:13:39 +02001000EXPORT_SYMBOL(snd_power_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001#endif /* CONFIG_PM */