Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
1da177e4 LT |
2 | /* |
3 | * Initialization routines | |
c1017a4c | 4 | * Copyright (c) by Jaroslav Kysela <perex@perex.cz> |
1da177e4 LT |
5 | */ |
6 | ||
1da177e4 LT |
7 | #include <linux/init.h> |
8 | #include <linux/sched.h> | |
da155d5b | 9 | #include <linux/module.h> |
51990e82 | 10 | #include <linux/device.h> |
1da177e4 LT |
11 | #include <linux/file.h> |
12 | #include <linux/slab.h> | |
13 | #include <linux/time.h> | |
14 | #include <linux/ctype.h> | |
1da177e4 | 15 | #include <linux/pm.h> |
2d670ea2 | 16 | #include <linux/debugfs.h> |
f2464064 | 17 | #include <linux/completion.h> |
29bb274e | 18 | #include <linux/interrupt.h> |
d052d1be | 19 | |
1da177e4 LT |
20 | #include <sound/core.h> |
21 | #include <sound/control.h> | |
22 | #include <sound/info.h> | |
23 | ||
82a783f4 TI |
24 | /* monitor files for graceful shutdown (hotplug) */ |
25 | struct snd_monitor_file { | |
26 | struct file *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 */ | |
30 | }; | |
31 | ||
a9edfc60 KW |
32 | static DEFINE_SPINLOCK(shutdown_lock); |
33 | static LIST_HEAD(shutdown_files); | |
34 | ||
9c2e08c5 | 35 | static const struct file_operations snd_shutdown_f_ops; |
1da177e4 | 36 | |
7bb2491b TI |
37 | /* locked for registering/using */ |
38 | static DECLARE_BITMAP(snd_cards_lock, SNDRV_CARDS); | |
f4fa9689 | 39 | static struct snd_card *snd_cards[SNDRV_CARDS]; |
c0d3fb39 | 40 | |
746df948 | 41 | static DEFINE_MUTEX(snd_card_mutex); |
1da177e4 | 42 | |
304cd07f TI |
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."); | |
46 | ||
a93bbaa7 | 47 | /* return non-zero if the given index is reserved for the given |
304cd07f TI |
48 | * module via slots option |
49 | */ | |
a93bbaa7 | 50 | static int module_slot_match(struct module *module, int idx) |
304cd07f | 51 | { |
a93bbaa7 | 52 | int match = 1; |
304cd07f | 53 | #ifdef MODULE |
a93bbaa7 TI |
54 | const char *s1, *s2; |
55 | ||
60f6fef8 | 56 | if (!module || !*module->name || !slots[idx]) |
304cd07f | 57 | return 0; |
a93bbaa7 TI |
58 | |
59 | s1 = module->name; | |
60 | s2 = slots[idx]; | |
61 | if (*s2 == '!') { | |
62 | match = 0; /* negative match */ | |
63 | s2++; | |
64 | } | |
304cd07f TI |
65 | /* compare module name strings |
66 | * hyphens are handled as equivalent with underscore | |
67 | */ | |
68 | for (;;) { | |
69 | char c1 = *s1++; | |
70 | char c2 = *s2++; | |
71 | if (c1 == '-') | |
72 | c1 = '_'; | |
73 | if (c2 == '-') | |
74 | c2 = '_'; | |
75 | if (c1 != c2) | |
a93bbaa7 | 76 | return !match; |
304cd07f TI |
77 | if (!c1) |
78 | break; | |
79 | } | |
a93bbaa7 TI |
80 | #endif /* MODULE */ |
81 | return match; | |
304cd07f TI |
82 | } |
83 | ||
8eeaa2f9 | 84 | #if IS_ENABLED(CONFIG_SND_MIXER_OSS) |
512bbd6a | 85 | int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int free_flag); |
c0d3fb39 | 86 | EXPORT_SYMBOL(snd_mixer_oss_notify_callback); |
1da177e4 LT |
87 | #endif |
88 | ||
deb6596f TI |
89 | static int check_empty_slot(struct module *module, int slot) |
90 | { | |
91 | return !slots[slot] || !*slots[slot]; | |
92 | } | |
93 | ||
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. | |
97 | */ | |
98 | static int get_slot_from_bitmask(int mask, int (*check)(struct module *, int), | |
99 | struct module *module) | |
100 | { | |
101 | int slot; | |
102 | ||
103 | for (slot = 0; slot < SNDRV_CARDS; slot++) { | |
104 | if (slot < 32 && !(mask & (1U << slot))) | |
105 | continue; | |
106 | if (!test_bit(slot, snd_cards_lock)) { | |
107 | if (check(module, slot)) | |
108 | return slot; /* found */ | |
109 | } | |
110 | } | |
111 | return mask; /* unchanged */ | |
112 | } | |
113 | ||
4b440be6 TI |
114 | /* the default release callback set in snd_device_initialize() below; |
115 | * this is just NOP for now, as almost all jobs are already done in | |
116 | * dev_free callback of snd_device chain instead. | |
117 | */ | |
118 | static void default_release(struct device *dev) | |
119 | { | |
120 | } | |
121 | ||
122 | /** | |
123 | * snd_device_initialize - Initialize struct device for sound devices | |
124 | * @dev: device to initialize | |
125 | * @card: card to assign, optional | |
126 | */ | |
127 | void snd_device_initialize(struct device *dev, struct snd_card *card) | |
128 | { | |
129 | device_initialize(dev); | |
130 | if (card) | |
131 | dev->parent = &card->card_dev; | |
132 | dev->class = sound_class; | |
133 | dev->release = default_release; | |
134 | } | |
135 | EXPORT_SYMBOL_GPL(snd_device_initialize); | |
136 | ||
e8ad415b TI |
137 | static int snd_card_init(struct snd_card *card, struct device *parent, |
138 | int idx, const char *xid, struct module *module, | |
139 | size_t extra_size); | |
8bfb181c | 140 | static int snd_card_do_free(struct snd_card *card); |
6bbc7fed | 141 | static const struct attribute_group card_dev_attr_group; |
8bfb181c TI |
142 | |
143 | static void release_card_device(struct device *dev) | |
144 | { | |
145 | snd_card_do_free(dev_to_snd_card(dev)); | |
146 | } | |
147 | ||
1da177e4 | 148 | /** |
393aa9c1 TI |
149 | * snd_card_new - create and initialize a soundcard structure |
150 | * @parent: the parent device object | |
1da177e4 LT |
151 | * @idx: card index (address) [0 ... (SNDRV_CARDS-1)] |
152 | * @xid: card identification (ASCII string) | |
153 | * @module: top level module for locking | |
154 | * @extra_size: allocate this extra size after the main soundcard structure | |
53fb1e63 | 155 | * @card_ret: the pointer to store the created card instance |
1da177e4 | 156 | * |
53fb1e63 TI |
157 | * The function allocates snd_card instance via kzalloc with the given |
158 | * space for the driver to use freely. The allocated struct is stored | |
159 | * in the given card_ret pointer. | |
160 | * | |
eb7c06e8 | 161 | * Return: Zero if successful or a negative error code. |
1da177e4 | 162 | */ |
393aa9c1 | 163 | int snd_card_new(struct device *parent, int idx, const char *xid, |
53fb1e63 TI |
164 | struct module *module, int extra_size, |
165 | struct snd_card **card_ret) | |
1da177e4 | 166 | { |
512bbd6a | 167 | struct snd_card *card; |
deb6596f | 168 | int err; |
1da177e4 | 169 | |
53fb1e63 TI |
170 | if (snd_BUG_ON(!card_ret)) |
171 | return -EINVAL; | |
172 | *card_ret = NULL; | |
173 | ||
1da177e4 LT |
174 | if (extra_size < 0) |
175 | extra_size = 0; | |
ca2c0966 | 176 | card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL); |
53fb1e63 TI |
177 | if (!card) |
178 | return -ENOMEM; | |
e8ad415b TI |
179 | |
180 | err = snd_card_init(card, parent, idx, xid, module, extra_size); | |
181 | if (err < 0) { | |
182 | kfree(card); | |
183 | return err; | |
184 | } | |
185 | ||
186 | *card_ret = card; | |
187 | return 0; | |
188 | } | |
189 | EXPORT_SYMBOL(snd_card_new); | |
190 | ||
191 | static void __snd_card_release(struct device *dev, void *data) | |
192 | { | |
193 | snd_card_free(data); | |
194 | } | |
195 | ||
196 | /** | |
197 | * snd_devm_card_new - managed snd_card object creation | |
198 | * @parent: the parent device object | |
199 | * @idx: card index (address) [0 ... (SNDRV_CARDS-1)] | |
200 | * @xid: card identification (ASCII string) | |
201 | * @module: top level module for locking | |
202 | * @extra_size: allocate this extra size after the main soundcard structure | |
203 | * @card_ret: the pointer to store the created card instance | |
204 | * | |
205 | * This function works like snd_card_new() but manages the allocated resource | |
206 | * via devres, i.e. you don't need to free explicitly. | |
207 | * | |
208 | * When a snd_card object is created with this function and registered via | |
209 | * snd_card_register(), the very first devres action to call snd_card_free() | |
210 | * is added automatically. In that way, the resource disconnection is assured | |
211 | * at first, then released in the expected order. | |
fee2b871 TI |
212 | * |
213 | * If an error happens at the probe before snd_card_register() is called and | |
214 | * there have been other devres resources, you'd need to free the card manually | |
215 | * via snd_card_free() call in the error; otherwise it may lead to UAF due to | |
216 | * devres call orders. You can use snd_card_free_on_error() helper for | |
217 | * handling it more easily. | |
e8ad415b TI |
218 | */ |
219 | int snd_devm_card_new(struct device *parent, int idx, const char *xid, | |
220 | struct module *module, size_t extra_size, | |
221 | struct snd_card **card_ret) | |
222 | { | |
223 | struct snd_card *card; | |
224 | int err; | |
225 | ||
226 | *card_ret = NULL; | |
227 | card = devres_alloc(__snd_card_release, sizeof(*card) + extra_size, | |
228 | GFP_KERNEL); | |
229 | if (!card) | |
230 | return -ENOMEM; | |
231 | card->managed = true; | |
232 | err = snd_card_init(card, parent, idx, xid, module, extra_size); | |
233 | if (err < 0) { | |
234 | devres_free(card); | |
235 | return err; | |
236 | } | |
237 | ||
238 | devres_add(parent, card); | |
239 | *card_ret = card; | |
240 | return 0; | |
241 | } | |
242 | EXPORT_SYMBOL_GPL(snd_devm_card_new); | |
243 | ||
fee2b871 TI |
244 | /** |
245 | * snd_card_free_on_error - a small helper for handling devm probe errors | |
246 | * @dev: the managed device object | |
247 | * @ret: the return code from the probe callback | |
248 | * | |
249 | * This function handles the explicit snd_card_free() call at the error from | |
250 | * the probe callback. It's just a small helper for simplifying the error | |
251 | * handling with the managed devices. | |
252 | */ | |
253 | int snd_card_free_on_error(struct device *dev, int ret) | |
254 | { | |
255 | struct snd_card *card; | |
256 | ||
257 | if (!ret) | |
258 | return 0; | |
259 | card = devres_find(dev, __snd_card_release, NULL, NULL); | |
260 | if (card) | |
261 | snd_card_free(card); | |
262 | return ret; | |
263 | } | |
264 | EXPORT_SYMBOL_GPL(snd_card_free_on_error); | |
265 | ||
e8ad415b TI |
266 | static int snd_card_init(struct snd_card *card, struct device *parent, |
267 | int idx, const char *xid, struct module *module, | |
268 | size_t extra_size) | |
269 | { | |
270 | int err; | |
271 | #ifdef CONFIG_SND_DEBUG | |
272 | char name[8]; | |
273 | #endif | |
274 | ||
8bfb181c TI |
275 | if (extra_size > 0) |
276 | card->private_data = (char *)card + sizeof(struct snd_card); | |
10a8ebbb | 277 | if (xid) |
75b1a8f9 | 278 | strscpy(card->id, xid, sizeof(card->id)); |
1da177e4 | 279 | err = 0; |
746df948 | 280 | mutex_lock(&snd_card_mutex); |
deb6596f TI |
281 | if (idx < 0) /* first check the matching module-name slot */ |
282 | idx = get_slot_from_bitmask(idx, module_slot_match, module); | |
283 | if (idx < 0) /* if not matched, assign an empty slot */ | |
284 | idx = get_slot_from_bitmask(idx, check_empty_slot, module); | |
a93bbaa7 TI |
285 | if (idx < 0) |
286 | err = -ENODEV; | |
287 | else if (idx < snd_ecards_limit) { | |
7bb2491b | 288 | if (test_bit(idx, snd_cards_lock)) |
a93bbaa7 TI |
289 | err = -EBUSY; /* invalid */ |
290 | } else if (idx >= SNDRV_CARDS) | |
291 | err = -ENODEV; | |
292 | if (err < 0) { | |
746df948 | 293 | mutex_unlock(&snd_card_mutex); |
f2f9307a | 294 | dev_err(parent, "cannot find the slot for index %d (range 0-%i), error: %d\n", |
5c33dd70 | 295 | idx, snd_ecards_limit - 1, err); |
8bfb181c | 296 | return err; |
1da177e4 | 297 | } |
7bb2491b | 298 | set_bit(idx, snd_cards_lock); /* lock it */ |
a93bbaa7 TI |
299 | if (idx >= snd_ecards_limit) |
300 | snd_ecards_limit = idx + 1; /* increase the limit */ | |
746df948 | 301 | mutex_unlock(&snd_card_mutex); |
393aa9c1 | 302 | card->dev = parent; |
1da177e4 | 303 | card->number = idx; |
81033c6b TI |
304 | #ifdef MODULE |
305 | WARN_ON(!module); | |
1da177e4 | 306 | card->module = module; |
81033c6b | 307 | #endif |
1da177e4 LT |
308 | INIT_LIST_HEAD(&card->devices); |
309 | init_rwsem(&card->controls_rwsem); | |
310 | rwlock_init(&card->ctl_files_rwlock); | |
311 | INIT_LIST_HEAD(&card->controls); | |
312 | INIT_LIST_HEAD(&card->ctl_files); | |
313 | spin_lock_init(&card->files_lock); | |
118dd6bf | 314 | INIT_LIST_HEAD(&card->files_list); |
d4cfb30f | 315 | mutex_init(&card->memory_mutex); |
1da177e4 | 316 | #ifdef CONFIG_PM |
1da177e4 | 317 | init_waitqueue_head(&card->power_sleep); |
e94fdbd7 TI |
318 | init_waitqueue_head(&card->power_ref_sleep); |
319 | atomic_set(&card->power_ref, 0); | |
1da177e4 | 320 | #endif |
c44027c8 | 321 | init_waitqueue_head(&card->remove_sleep); |
fabb26dc | 322 | card->sync_irq = -1; |
8bfb181c TI |
323 | |
324 | device_initialize(&card->card_dev); | |
325 | card->card_dev.parent = parent; | |
326 | card->card_dev.class = sound_class; | |
327 | card->card_dev.release = release_card_device; | |
6bbc7fed TI |
328 | card->card_dev.groups = card->dev_groups; |
329 | card->dev_groups[0] = &card_dev_attr_group; | |
8bfb181c TI |
330 | err = kobject_set_name(&card->card_dev.kobj, "card%d", idx); |
331 | if (err < 0) | |
332 | goto __error; | |
333 | ||
de65360b HK |
334 | snprintf(card->irq_descr, sizeof(card->irq_descr), "%s:%s", |
335 | dev_driver_string(card->dev), dev_name(&card->card_dev)); | |
336 | ||
1da177e4 LT |
337 | /* the control interface cannot be accessed from the user space until */ |
338 | /* snd_cards_bitmask and snd_cards are set with snd_card_register */ | |
53fb1e63 TI |
339 | err = snd_ctl_create(card); |
340 | if (err < 0) { | |
f2f9307a | 341 | dev_err(parent, "unable to register control minors\n"); |
1da177e4 LT |
342 | goto __error; |
343 | } | |
53fb1e63 TI |
344 | err = snd_info_card_create(card); |
345 | if (err < 0) { | |
f2f9307a | 346 | dev_err(parent, "unable to create card info\n"); |
1da177e4 LT |
347 | goto __error_ctl; |
348 | } | |
2d670ea2 HW |
349 | |
350 | #ifdef CONFIG_SND_DEBUG | |
351 | sprintf(name, "card%d", idx); | |
352 | card->debugfs_root = debugfs_create_dir(name, sound_debugfs_root); | |
353 | #endif | |
53fb1e63 | 354 | return 0; |
1da177e4 LT |
355 | |
356 | __error_ctl: | |
289ca025 | 357 | snd_device_free_all(card); |
1da177e4 | 358 | __error: |
8bfb181c | 359 | put_device(&card->card_dev); |
53fb1e63 | 360 | return err; |
1da177e4 | 361 | } |
c0d3fb39 | 362 | |
f4fa9689 TI |
363 | /** |
364 | * snd_card_ref - Get the card object from the index | |
365 | * @idx: the card index | |
366 | * | |
367 | * Returns a card object corresponding to the given index or NULL if not found. | |
368 | * Release the object via snd_card_unref(). | |
369 | */ | |
370 | struct snd_card *snd_card_ref(int idx) | |
371 | { | |
372 | struct snd_card *card; | |
373 | ||
374 | mutex_lock(&snd_card_mutex); | |
375 | card = snd_cards[idx]; | |
376 | if (card) | |
377 | get_device(&card->card_dev); | |
378 | mutex_unlock(&snd_card_mutex); | |
379 | return card; | |
380 | } | |
381 | EXPORT_SYMBOL_GPL(snd_card_ref); | |
382 | ||
746df948 TI |
383 | /* return non-zero if a card is already locked */ |
384 | int snd_card_locked(int card) | |
385 | { | |
386 | int locked; | |
387 | ||
388 | mutex_lock(&snd_card_mutex); | |
7bb2491b | 389 | locked = test_bit(card, snd_cards_lock); |
746df948 TI |
390 | mutex_unlock(&snd_card_mutex); |
391 | return locked; | |
392 | } | |
393 | ||
b3b0abe1 CL |
394 | static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig) |
395 | { | |
396 | return -ENODEV; | |
397 | } | |
398 | ||
399 | static ssize_t snd_disconnect_read(struct file *file, char __user *buf, | |
400 | size_t count, loff_t *offset) | |
401 | { | |
402 | return -ENODEV; | |
403 | } | |
404 | ||
405 | static ssize_t snd_disconnect_write(struct file *file, const char __user *buf, | |
406 | size_t count, loff_t *offset) | |
407 | { | |
408 | return -ENODEV; | |
409 | } | |
410 | ||
a9edfc60 KW |
411 | static int snd_disconnect_release(struct inode *inode, struct file *file) |
412 | { | |
413 | struct snd_monitor_file *df = NULL, *_df; | |
414 | ||
415 | spin_lock(&shutdown_lock); | |
416 | list_for_each_entry(_df, &shutdown_files, shutdown_list) { | |
417 | if (_df->file == file) { | |
418 | df = _df; | |
118dd6bf | 419 | list_del_init(&df->shutdown_list); |
a9edfc60 KW |
420 | break; |
421 | } | |
422 | } | |
423 | spin_unlock(&shutdown_lock); | |
424 | ||
233e70f4 AV |
425 | if (likely(df)) { |
426 | if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync) | |
427 | df->disconnected_f_op->fasync(-1, file, 0); | |
a9edfc60 | 428 | return df->disconnected_f_op->release(inode, file); |
233e70f4 | 429 | } |
a9edfc60 | 430 | |
9bf8e7dd | 431 | panic("%s(%p, %p) failed!", __func__, inode, file); |
a9edfc60 KW |
432 | } |
433 | ||
680ef72a | 434 | static __poll_t snd_disconnect_poll(struct file * file, poll_table * wait) |
1da177e4 | 435 | { |
a9a08845 | 436 | return EPOLLERR | EPOLLNVAL; |
1da177e4 LT |
437 | } |
438 | ||
b3b0abe1 CL |
439 | static long snd_disconnect_ioctl(struct file *file, |
440 | unsigned int cmd, unsigned long arg) | |
441 | { | |
442 | return -ENODEV; | |
443 | } | |
444 | ||
445 | static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma) | |
446 | { | |
447 | return -ENODEV; | |
448 | } | |
449 | ||
450 | static int snd_disconnect_fasync(int fd, struct file *file, int on) | |
451 | { | |
452 | return -ENODEV; | |
453 | } | |
454 | ||
9c2e08c5 | 455 | static const struct file_operations snd_shutdown_f_ops = |
a9edfc60 KW |
456 | { |
457 | .owner = THIS_MODULE, | |
458 | .llseek = snd_disconnect_llseek, | |
459 | .read = snd_disconnect_read, | |
460 | .write = snd_disconnect_write, | |
461 | .release = snd_disconnect_release, | |
462 | .poll = snd_disconnect_poll, | |
463 | .unlocked_ioctl = snd_disconnect_ioctl, | |
464 | #ifdef CONFIG_COMPAT | |
465 | .compat_ioctl = snd_disconnect_ioctl, | |
466 | #endif | |
467 | .mmap = snd_disconnect_mmap, | |
468 | .fasync = snd_disconnect_fasync | |
469 | }; | |
470 | ||
1da177e4 LT |
471 | /** |
472 | * snd_card_disconnect - disconnect all APIs from the file-operations (user space) | |
473 | * @card: soundcard structure | |
474 | * | |
475 | * Disconnects all APIs from the file-operations (user space). | |
476 | * | |
eb7c06e8 | 477 | * Return: Zero, otherwise a negative error code. |
1da177e4 LT |
478 | * |
479 | * Note: The current implementation replaces all active file->f_op with special | |
480 | * dummy file operations (they do nothing except release). | |
481 | */ | |
512bbd6a | 482 | int snd_card_disconnect(struct snd_card *card) |
1da177e4 LT |
483 | { |
484 | struct snd_monitor_file *mfile; | |
1da177e4 | 485 | |
f18638dc TI |
486 | if (!card) |
487 | return -EINVAL; | |
488 | ||
1da177e4 LT |
489 | spin_lock(&card->files_lock); |
490 | if (card->shutdown) { | |
491 | spin_unlock(&card->files_lock); | |
492 | return 0; | |
493 | } | |
494 | card->shutdown = 1; | |
1da177e4 | 495 | |
2a3f7221 | 496 | /* replace file->f_op with special dummy operations */ |
118dd6bf | 497 | list_for_each_entry(mfile, &card->files_list, list) { |
1da177e4 LT |
498 | /* it's critical part, use endless loop */ |
499 | /* we have no room to fail */ | |
a9edfc60 | 500 | mfile->disconnected_f_op = mfile->file->f_op; |
1da177e4 | 501 | |
a9edfc60 KW |
502 | spin_lock(&shutdown_lock); |
503 | list_add(&mfile->shutdown_list, &shutdown_files); | |
504 | spin_unlock(&shutdown_lock); | |
1da177e4 | 505 | |
a9edfc60 | 506 | mfile->file->f_op = &snd_shutdown_f_ops; |
bc9abce0 | 507 | fops_get(mfile->file->f_op); |
1da177e4 LT |
508 | } |
509 | spin_unlock(&card->files_lock); | |
510 | ||
2a3f7221 | 511 | /* notify all connected devices about disconnection */ |
1da177e4 LT |
512 | /* at this point, they cannot respond to any calls except release() */ |
513 | ||
8eeaa2f9 | 514 | #if IS_ENABLED(CONFIG_SND_MIXER_OSS) |
1da177e4 LT |
515 | if (snd_mixer_oss_notify_callback) |
516 | snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT); | |
517 | #endif | |
518 | ||
519 | /* notify all devices that we are disconnected */ | |
e086e303 | 520 | snd_device_disconnect_all(card); |
1da177e4 | 521 | |
29bb274e TI |
522 | if (card->sync_irq > 0) |
523 | synchronize_irq(card->sync_irq); | |
524 | ||
746d4a02 | 525 | snd_info_card_disconnect(card); |
8bfb181c TI |
526 | if (card->registered) { |
527 | device_del(&card->card_dev); | |
528 | card->registered = false; | |
73d38b13 | 529 | } |
2a3f7221 TI |
530 | |
531 | /* disable fops (user space) operations for ALSA API */ | |
532 | mutex_lock(&snd_card_mutex); | |
533 | snd_cards[card->number] = NULL; | |
534 | clear_bit(card->number, snd_cards_lock); | |
535 | mutex_unlock(&snd_card_mutex); | |
536 | ||
f18638dc TI |
537 | #ifdef CONFIG_PM |
538 | wake_up(&card->power_sleep); | |
e94fdbd7 | 539 | snd_power_sync_ref(card); |
73d38b13 | 540 | #endif |
1da177e4 LT |
541 | return 0; |
542 | } | |
c0d3fb39 TI |
543 | EXPORT_SYMBOL(snd_card_disconnect); |
544 | ||
c44027c8 TI |
545 | /** |
546 | * snd_card_disconnect_sync - disconnect card and wait until files get closed | |
547 | * @card: card object to disconnect | |
548 | * | |
549 | * This calls snd_card_disconnect() for disconnecting all belonging components | |
550 | * and waits until all pending files get closed. | |
551 | * It assures that all accesses from user-space finished so that the driver | |
552 | * can release its resources gracefully. | |
553 | */ | |
554 | void snd_card_disconnect_sync(struct snd_card *card) | |
555 | { | |
556 | int err; | |
557 | ||
558 | err = snd_card_disconnect(card); | |
559 | if (err < 0) { | |
560 | dev_err(card->dev, | |
561 | "snd_card_disconnect error (%d), skipping sync\n", | |
562 | err); | |
563 | return; | |
564 | } | |
565 | ||
566 | spin_lock_irq(&card->files_lock); | |
567 | wait_event_lock_irq(card->remove_sleep, | |
568 | list_empty(&card->files_list), | |
569 | card->files_lock); | |
570 | spin_unlock_irq(&card->files_lock); | |
571 | } | |
572 | EXPORT_SYMBOL_GPL(snd_card_disconnect_sync); | |
573 | ||
c461482c | 574 | static int snd_card_do_free(struct snd_card *card) |
1da177e4 | 575 | { |
e8ad415b | 576 | card->releasing = true; |
8eeaa2f9 | 577 | #if IS_ENABLED(CONFIG_SND_MIXER_OSS) |
1da177e4 LT |
578 | if (snd_mixer_oss_notify_callback) |
579 | snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE); | |
580 | #endif | |
72620d60 | 581 | snd_device_free_all(card); |
1da177e4 LT |
582 | if (card->private_free) |
583 | card->private_free(card); | |
1da177e4 | 584 | if (snd_info_card_free(card) < 0) { |
f2f9307a | 585 | dev_warn(card->dev, "unable to free card info\n"); |
1da177e4 LT |
586 | /* Not fatal error */ |
587 | } | |
3c4ab49e TI |
588 | #ifdef CONFIG_SND_DEBUG |
589 | debugfs_remove(card->debugfs_root); | |
590 | card->debugfs_root = NULL; | |
591 | #endif | |
f2464064 TI |
592 | if (card->release_completion) |
593 | complete(card->release_completion); | |
e8ad415b TI |
594 | if (!card->managed) |
595 | kfree(card); | |
c461482c TI |
596 | return 0; |
597 | } | |
598 | ||
eb9c38d5 TI |
599 | /** |
600 | * snd_card_free_when_closed - Disconnect the card, free it later eventually | |
601 | * @card: soundcard structure | |
602 | * | |
603 | * Unlike snd_card_free(), this function doesn't try to release the card | |
604 | * resource immediately, but tries to disconnect at first. When the card | |
605 | * is still in use, the function returns before freeing the resources. | |
606 | * The card resources will be freed when the refcount gets to zero. | |
607 | */ | |
c461482c TI |
608 | int snd_card_free_when_closed(struct snd_card *card) |
609 | { | |
f2464064 TI |
610 | int ret = snd_card_disconnect(card); |
611 | if (ret) | |
a0830dbd | 612 | return ret; |
f2464064 | 613 | put_device(&card->card_dev); |
c461482c TI |
614 | return 0; |
615 | } | |
c461482c TI |
616 | EXPORT_SYMBOL(snd_card_free_when_closed); |
617 | ||
eb9c38d5 TI |
618 | /** |
619 | * snd_card_free - frees given soundcard structure | |
620 | * @card: soundcard structure | |
621 | * | |
622 | * This function releases the soundcard structure and the all assigned | |
623 | * devices automatically. That is, you don't have to release the devices | |
624 | * by yourself. | |
625 | * | |
626 | * This function waits until the all resources are properly released. | |
627 | * | |
628 | * Return: Zero. Frees all associated devices and frees the control | |
629 | * interface associated to given soundcard. | |
630 | */ | |
c461482c TI |
631 | int snd_card_free(struct snd_card *card) |
632 | { | |
bec206db | 633 | DECLARE_COMPLETION_ONSTACK(released); |
f2464064 TI |
634 | int ret; |
635 | ||
825a5248 TI |
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. | |
641 | */ | |
642 | if (card->releasing) | |
643 | return 0; | |
644 | ||
f2464064 TI |
645 | card->release_completion = &released; |
646 | ret = snd_card_free_when_closed(card); | |
c461482c TI |
647 | if (ret) |
648 | return ret; | |
c461482c | 649 | /* wait, until all devices are ready for the free operation */ |
f2464064 | 650 | wait_for_completion(&released); |
2d670ea2 | 651 | |
1da177e4 LT |
652 | return 0; |
653 | } | |
c0d3fb39 TI |
654 | EXPORT_SYMBOL(snd_card_free); |
655 | ||
e7df2a3a TI |
656 | /* retrieve the last word of shortname or longname */ |
657 | static const char *retrieve_id_from_card_name(const char *name) | |
1da177e4 | 658 | { |
e7df2a3a TI |
659 | const char *spos = name; |
660 | ||
661 | while (*name) { | |
662 | if (isspace(*name) && isalnum(name[1])) | |
663 | spos = name + 1; | |
664 | name++; | |
1da177e4 | 665 | } |
e7df2a3a TI |
666 | return spos; |
667 | } | |
668 | ||
669 | /* return true if the given id string doesn't conflict any other card ids */ | |
670 | static bool card_id_ok(struct snd_card *card, const char *id) | |
671 | { | |
672 | int i; | |
673 | if (!snd_info_check_reserved_words(id)) | |
674 | return false; | |
675 | for (i = 0; i < snd_ecards_limit; i++) { | |
676 | if (snd_cards[i] && snd_cards[i] != card && | |
677 | !strcmp(snd_cards[i]->id, id)) | |
678 | return false; | |
1da177e4 | 679 | } |
e7df2a3a TI |
680 | return true; |
681 | } | |
1da177e4 | 682 | |
e7df2a3a TI |
683 | /* copy to card->id only with valid letters from nid */ |
684 | static void copy_valid_id_string(struct snd_card *card, const char *src, | |
685 | const char *nid) | |
686 | { | |
687 | char *id = card->id; | |
688 | ||
689 | while (*nid && !isalnum(*nid)) | |
690 | nid++; | |
691 | if (isdigit(*nid)) | |
692 | *id++ = isalpha(*src) ? *src : 'D'; | |
693 | while (*nid && (size_t)(id - card->id) < sizeof(card->id) - 1) { | |
694 | if (isalnum(*nid)) | |
695 | *id++ = *nid; | |
696 | nid++; | |
697 | } | |
698 | *id = 0; | |
699 | } | |
700 | ||
701 | /* Set card->id from the given string | |
702 | * If the string conflicts with other ids, add a suffix to make it unique. | |
703 | */ | |
704 | static void snd_card_set_id_no_lock(struct snd_card *card, const char *src, | |
705 | const char *nid) | |
706 | { | |
707 | int len, loops; | |
e7df2a3a TI |
708 | bool is_default = false; |
709 | char *id; | |
1da177e4 | 710 | |
e7df2a3a TI |
711 | copy_valid_id_string(card, src, nid); |
712 | id = card->id; | |
713 | ||
714 | again: | |
715 | /* use "Default" for obviously invalid strings | |
716 | * ("card" conflicts with proc directories) | |
717 | */ | |
718 | if (!*id || !strncmp(id, "card", 4)) { | |
d8e4f9ae | 719 | strcpy(id, "Default"); |
e7df2a3a TI |
720 | is_default = true; |
721 | } | |
1da177e4 | 722 | |
8edbb198 | 723 | len = strlen(id); |
e7df2a3a | 724 | for (loops = 0; loops < SNDRV_CARDS; loops++) { |
8edbb198 TI |
725 | char *spos; |
726 | char sfxstr[5]; /* "_012" */ | |
727 | int sfxlen; | |
728 | ||
e7df2a3a TI |
729 | if (card_id_ok(card, id)) |
730 | return; /* OK */ | |
1da177e4 | 731 | |
8edbb198 TI |
732 | /* Add _XYZ suffix */ |
733 | sprintf(sfxstr, "_%X", loops + 1); | |
734 | sfxlen = strlen(sfxstr); | |
735 | if (len + sfxlen >= sizeof(card->id)) | |
736 | spos = id + sizeof(card->id) - sfxlen - 1; | |
737 | else | |
738 | spos = id + len; | |
739 | strcpy(spos, sfxstr); | |
1da177e4 | 740 | } |
e7df2a3a TI |
741 | /* fallback to the default id */ |
742 | if (!is_default) { | |
743 | *id = 0; | |
744 | goto again; | |
745 | } | |
746 | /* last resort... */ | |
f2f9307a | 747 | dev_err(card->dev, "unable to set card id (%s)\n", id); |
e7df2a3a | 748 | if (card->proc_root->name) |
75b1a8f9 | 749 | strscpy(card->id, card->proc_root->name, sizeof(card->id)); |
1da177e4 LT |
750 | } |
751 | ||
872c7820 MB |
752 | /** |
753 | * snd_card_set_id - set card identification name | |
754 | * @card: soundcard structure | |
755 | * @nid: new identification string | |
756 | * | |
757 | * This function sets the card identification and checks for name | |
758 | * collisions. | |
759 | */ | |
760 | void snd_card_set_id(struct snd_card *card, const char *nid) | |
761 | { | |
5fdc18d9 JK |
762 | /* check if user specified own card->id */ |
763 | if (card->id[0] != '\0') | |
764 | return; | |
765 | mutex_lock(&snd_card_mutex); | |
e7df2a3a | 766 | snd_card_set_id_no_lock(card, nid, nid); |
5fdc18d9 | 767 | mutex_unlock(&snd_card_mutex); |
872c7820 | 768 | } |
10a8ebbb JK |
769 | EXPORT_SYMBOL(snd_card_set_id); |
770 | ||
873fd813 Y |
771 | static ssize_t id_show(struct device *dev, |
772 | struct device_attribute *attr, char *buf) | |
9fb6198e | 773 | { |
b203dbab | 774 | struct snd_card *card = container_of(dev, struct snd_card, card_dev); |
ef21e175 | 775 | return scnprintf(buf, PAGE_SIZE, "%s\n", card->id); |
9fb6198e JK |
776 | } |
777 | ||
873fd813 Y |
778 | static ssize_t id_store(struct device *dev, struct device_attribute *attr, |
779 | const char *buf, size_t count) | |
9fb6198e | 780 | { |
b203dbab | 781 | struct snd_card *card = container_of(dev, struct snd_card, card_dev); |
9fb6198e JK |
782 | char buf1[sizeof(card->id)]; |
783 | size_t copy = count > sizeof(card->id) - 1 ? | |
784 | sizeof(card->id) - 1 : count; | |
785 | size_t idx; | |
786 | int c; | |
787 | ||
788 | for (idx = 0; idx < copy; idx++) { | |
789 | c = buf[idx]; | |
790 | if (!isalnum(c) && c != '_' && c != '-') | |
791 | return -EINVAL; | |
792 | } | |
793 | memcpy(buf1, buf, copy); | |
794 | buf1[copy] = '\0'; | |
795 | mutex_lock(&snd_card_mutex); | |
e7df2a3a | 796 | if (!card_id_ok(NULL, buf1)) { |
9fb6198e JK |
797 | mutex_unlock(&snd_card_mutex); |
798 | return -EEXIST; | |
799 | } | |
9fb6198e | 800 | strcpy(card->id, buf1); |
c2eb9c4e | 801 | snd_info_card_id_change(card); |
9fb6198e JK |
802 | mutex_unlock(&snd_card_mutex); |
803 | ||
804 | return count; | |
805 | } | |
806 | ||
873fd813 | 807 | static DEVICE_ATTR_RW(id); |
9fb6198e | 808 | |
873fd813 Y |
809 | static ssize_t number_show(struct device *dev, |
810 | struct device_attribute *attr, char *buf) | |
9fb6198e | 811 | { |
b203dbab | 812 | struct snd_card *card = container_of(dev, struct snd_card, card_dev); |
ef21e175 | 813 | return scnprintf(buf, PAGE_SIZE, "%i\n", card->number); |
9fb6198e JK |
814 | } |
815 | ||
873fd813 | 816 | static DEVICE_ATTR_RO(number); |
34356dbd TI |
817 | |
818 | static struct attribute *card_dev_attrs[] = { | |
819 | &dev_attr_id.attr, | |
820 | &dev_attr_number.attr, | |
821 | NULL | |
822 | }; | |
823 | ||
6bbc7fed | 824 | static const struct attribute_group card_dev_attr_group = { |
34356dbd TI |
825 | .attrs = card_dev_attrs, |
826 | }; | |
827 | ||
6bbc7fed TI |
828 | /** |
829 | * snd_card_add_dev_attr - Append a new sysfs attribute group to card | |
830 | * @card: card instance | |
831 | * @group: attribute group to append | |
832 | */ | |
833 | int snd_card_add_dev_attr(struct snd_card *card, | |
834 | const struct attribute_group *group) | |
835 | { | |
836 | int i; | |
837 | ||
838 | /* loop for (arraysize-1) here to keep NULL at the last entry */ | |
839 | for (i = 0; i < ARRAY_SIZE(card->dev_groups) - 1; i++) { | |
840 | if (!card->dev_groups[i]) { | |
841 | card->dev_groups[i] = group; | |
842 | return 0; | |
843 | } | |
844 | } | |
845 | ||
846 | dev_err(card->dev, "Too many groups assigned\n"); | |
847 | return -ENOSPC; | |
35f80014 | 848 | } |
6bbc7fed | 849 | EXPORT_SYMBOL_GPL(snd_card_add_dev_attr); |
9fb6198e | 850 | |
e8ad415b TI |
851 | static void trigger_card_free(void *data) |
852 | { | |
825a5248 | 853 | snd_card_free(data); |
e8ad415b TI |
854 | } |
855 | ||
1da177e4 LT |
856 | /** |
857 | * snd_card_register - register the soundcard | |
858 | * @card: soundcard structure | |
859 | * | |
860 | * This function registers all the devices assigned to the soundcard. | |
861 | * Until calling this, the ALSA control interface is blocked from the | |
862 | * external accesses. Thus, you should call this function at the end | |
863 | * of the initialization of the card. | |
864 | * | |
eb7c06e8 | 865 | * Return: Zero otherwise a negative error code if the registration failed. |
1da177e4 | 866 | */ |
512bbd6a | 867 | int snd_card_register(struct snd_card *card) |
1da177e4 LT |
868 | { |
869 | int err; | |
1da177e4 | 870 | |
7eaa943c TI |
871 | if (snd_BUG_ON(!card)) |
872 | return -EINVAL; | |
39aba963 | 873 | |
8bfb181c TI |
874 | if (!card->registered) { |
875 | err = device_add(&card->card_dev); | |
876 | if (err < 0) | |
877 | return err; | |
878 | card->registered = true; | |
e8ad415b TI |
879 | } else { |
880 | if (card->managed) | |
881 | devm_remove_action(card->dev, trigger_card_free, card); | |
882 | } | |
883 | ||
884 | if (card->managed) { | |
885 | err = devm_add_action(card->dev, trigger_card_free, card); | |
886 | if (err < 0) | |
887 | return err; | |
d80f19fa | 888 | } |
39aba963 | 889 | |
e3ded899 TI |
890 | err = snd_device_register_all(card); |
891 | if (err < 0) | |
1da177e4 | 892 | return err; |
746df948 | 893 | mutex_lock(&snd_card_mutex); |
1da177e4 LT |
894 | if (snd_cards[card->number]) { |
895 | /* already registered */ | |
746df948 | 896 | mutex_unlock(&snd_card_mutex); |
2471b6c8 | 897 | return snd_info_card_register(card); /* register pending info */ |
1da177e4 | 898 | } |
e7df2a3a TI |
899 | if (*card->id) { |
900 | /* make a unique id name from the given string */ | |
901 | char tmpid[sizeof(card->id)]; | |
902 | memcpy(tmpid, card->id, sizeof(card->id)); | |
903 | snd_card_set_id_no_lock(card, tmpid, tmpid); | |
904 | } else { | |
905 | /* create an id from either shortname or longname */ | |
906 | const char *src; | |
907 | src = *card->shortname ? card->shortname : card->longname; | |
908 | snd_card_set_id_no_lock(card, src, | |
909 | retrieve_id_from_card_name(src)); | |
910 | } | |
1da177e4 | 911 | snd_cards[card->number] = card; |
746df948 | 912 | mutex_unlock(&snd_card_mutex); |
29b2625f TI |
913 | err = snd_info_card_register(card); |
914 | if (err < 0) | |
915 | return err; | |
916 | ||
8eeaa2f9 | 917 | #if IS_ENABLED(CONFIG_SND_MIXER_OSS) |
1da177e4 LT |
918 | if (snd_mixer_oss_notify_callback) |
919 | snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER); | |
9fb6198e | 920 | #endif |
1da177e4 LT |
921 | return 0; |
922 | } | |
c0d3fb39 TI |
923 | EXPORT_SYMBOL(snd_card_register); |
924 | ||
cd6a6503 | 925 | #ifdef CONFIG_SND_PROC_FS |
a381a7a6 TI |
926 | static void snd_card_info_read(struct snd_info_entry *entry, |
927 | struct snd_info_buffer *buffer) | |
1da177e4 LT |
928 | { |
929 | int idx, count; | |
512bbd6a | 930 | struct snd_card *card; |
1da177e4 LT |
931 | |
932 | for (idx = count = 0; idx < SNDRV_CARDS; idx++) { | |
746df948 | 933 | mutex_lock(&snd_card_mutex); |
e3ded899 TI |
934 | card = snd_cards[idx]; |
935 | if (card) { | |
1da177e4 | 936 | count++; |
d001544d | 937 | snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n", |
1da177e4 LT |
938 | idx, |
939 | card->id, | |
940 | card->driver, | |
941 | card->shortname); | |
d001544d | 942 | snd_iprintf(buffer, " %s\n", |
1da177e4 LT |
943 | card->longname); |
944 | } | |
746df948 | 945 | mutex_unlock(&snd_card_mutex); |
1da177e4 LT |
946 | } |
947 | if (!count) | |
948 | snd_iprintf(buffer, "--- no soundcards ---\n"); | |
949 | } | |
950 | ||
e28563cc | 951 | #ifdef CONFIG_SND_OSSEMUL |
512bbd6a | 952 | void snd_card_info_read_oss(struct snd_info_buffer *buffer) |
1da177e4 LT |
953 | { |
954 | int idx, count; | |
512bbd6a | 955 | struct snd_card *card; |
1da177e4 LT |
956 | |
957 | for (idx = count = 0; idx < SNDRV_CARDS; idx++) { | |
746df948 | 958 | mutex_lock(&snd_card_mutex); |
e3ded899 TI |
959 | card = snd_cards[idx]; |
960 | if (card) { | |
1da177e4 LT |
961 | count++; |
962 | snd_iprintf(buffer, "%s\n", card->longname); | |
963 | } | |
746df948 | 964 | mutex_unlock(&snd_card_mutex); |
1da177e4 LT |
965 | } |
966 | if (!count) { | |
967 | snd_iprintf(buffer, "--- no soundcards ---\n"); | |
968 | } | |
969 | } | |
970 | ||
971 | #endif | |
972 | ||
973 | #ifdef MODULE | |
512bbd6a TI |
974 | static void snd_card_module_info_read(struct snd_info_entry *entry, |
975 | struct snd_info_buffer *buffer) | |
1da177e4 LT |
976 | { |
977 | int idx; | |
512bbd6a | 978 | struct snd_card *card; |
1da177e4 LT |
979 | |
980 | for (idx = 0; idx < SNDRV_CARDS; idx++) { | |
746df948 | 981 | mutex_lock(&snd_card_mutex); |
e3ded899 TI |
982 | card = snd_cards[idx]; |
983 | if (card) | |
d001544d CL |
984 | snd_iprintf(buffer, "%2i %s\n", |
985 | idx, card->module->name); | |
746df948 | 986 | mutex_unlock(&snd_card_mutex); |
1da177e4 LT |
987 | } |
988 | } | |
989 | #endif | |
990 | ||
991 | int __init snd_card_info_init(void) | |
992 | { | |
512bbd6a | 993 | struct snd_info_entry *entry; |
1da177e4 LT |
994 | |
995 | entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL); | |
7c22f1aa TI |
996 | if (! entry) |
997 | return -ENOMEM; | |
1da177e4 | 998 | entry->c.text.read = snd_card_info_read; |
b591b6e9 TI |
999 | if (snd_info_register(entry) < 0) |
1000 | return -ENOMEM; /* freed in error path */ | |
1da177e4 LT |
1001 | |
1002 | #ifdef MODULE | |
1003 | entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL); | |
b591b6e9 TI |
1004 | if (!entry) |
1005 | return -ENOMEM; | |
1006 | entry->c.text.read = snd_card_module_info_read; | |
1007 | if (snd_info_register(entry) < 0) | |
1008 | return -ENOMEM; /* freed in error path */ | |
1da177e4 LT |
1009 | #endif |
1010 | ||
1011 | return 0; | |
1012 | } | |
cd6a6503 | 1013 | #endif /* CONFIG_SND_PROC_FS */ |
e28563cc | 1014 | |
1da177e4 LT |
1015 | /** |
1016 | * snd_component_add - add a component string | |
1017 | * @card: soundcard structure | |
1018 | * @component: the component id string | |
1019 | * | |
1020 | * This function adds the component id string to the supported list. | |
1021 | * The component can be referred from the alsa-lib. | |
1022 | * | |
eb7c06e8 | 1023 | * Return: Zero otherwise a negative error code. |
1da177e4 LT |
1024 | */ |
1025 | ||
512bbd6a | 1026 | int snd_component_add(struct snd_card *card, const char *component) |
1da177e4 LT |
1027 | { |
1028 | char *ptr; | |
1029 | int len = strlen(component); | |
1030 | ||
1031 | ptr = strstr(card->components, component); | |
1032 | if (ptr != NULL) { | |
1033 | if (ptr[len] == '\0' || ptr[len] == ' ') /* already there */ | |
1034 | return 1; | |
1035 | } | |
1036 | if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) { | |
1037 | snd_BUG(); | |
1038 | return -ENOMEM; | |
1039 | } | |
1040 | if (card->components[0] != '\0') | |
1041 | strcat(card->components, " "); | |
1042 | strcat(card->components, component); | |
1043 | return 0; | |
1044 | } | |
c0d3fb39 TI |
1045 | EXPORT_SYMBOL(snd_component_add); |
1046 | ||
1da177e4 LT |
1047 | /** |
1048 | * snd_card_file_add - add the file to the file list of the card | |
1049 | * @card: soundcard structure | |
1050 | * @file: file pointer | |
1051 | * | |
1052 | * This function adds the file to the file linked-list of the card. | |
1053 | * This linked-list is used to keep tracking the connection state, | |
1054 | * and to avoid the release of busy resources by hotplug. | |
1055 | * | |
eb7c06e8 | 1056 | * Return: zero or a negative error code. |
1da177e4 | 1057 | */ |
512bbd6a | 1058 | int snd_card_file_add(struct snd_card *card, struct file *file) |
1da177e4 LT |
1059 | { |
1060 | struct snd_monitor_file *mfile; | |
1061 | ||
1062 | mfile = kmalloc(sizeof(*mfile), GFP_KERNEL); | |
1063 | if (mfile == NULL) | |
1064 | return -ENOMEM; | |
1065 | mfile->file = file; | |
a9edfc60 | 1066 | mfile->disconnected_f_op = NULL; |
a45e3d6b | 1067 | INIT_LIST_HEAD(&mfile->shutdown_list); |
1da177e4 LT |
1068 | spin_lock(&card->files_lock); |
1069 | if (card->shutdown) { | |
1070 | spin_unlock(&card->files_lock); | |
1071 | kfree(mfile); | |
1072 | return -ENODEV; | |
1073 | } | |
118dd6bf | 1074 | list_add(&mfile->list, &card->files_list); |
f2464064 | 1075 | get_device(&card->card_dev); |
1da177e4 LT |
1076 | spin_unlock(&card->files_lock); |
1077 | return 0; | |
1078 | } | |
c0d3fb39 TI |
1079 | EXPORT_SYMBOL(snd_card_file_add); |
1080 | ||
1da177e4 LT |
1081 | /** |
1082 | * snd_card_file_remove - remove the file from the file list | |
1083 | * @card: soundcard structure | |
1084 | * @file: file pointer | |
1085 | * | |
1086 | * This function removes the file formerly added to the card via | |
1087 | * snd_card_file_add() function. | |
2b29b13c TI |
1088 | * If all files are removed and snd_card_free_when_closed() was |
1089 | * called beforehand, it processes the pending release of | |
1090 | * resources. | |
1da177e4 | 1091 | * |
eb7c06e8 | 1092 | * Return: Zero or a negative error code. |
1da177e4 | 1093 | */ |
512bbd6a | 1094 | int snd_card_file_remove(struct snd_card *card, struct file *file) |
1da177e4 | 1095 | { |
118dd6bf | 1096 | struct snd_monitor_file *mfile, *found = NULL; |
1da177e4 LT |
1097 | |
1098 | spin_lock(&card->files_lock); | |
118dd6bf | 1099 | list_for_each_entry(mfile, &card->files_list, list) { |
1da177e4 | 1100 | if (mfile->file == file) { |
118dd6bf | 1101 | list_del(&mfile->list); |
a45e3d6b TI |
1102 | spin_lock(&shutdown_lock); |
1103 | list_del(&mfile->shutdown_list); | |
1104 | spin_unlock(&shutdown_lock); | |
118dd6bf TI |
1105 | if (mfile->disconnected_f_op) |
1106 | fops_put(mfile->disconnected_f_op); | |
1107 | found = mfile; | |
1da177e4 LT |
1108 | break; |
1109 | } | |
a9edfc60 | 1110 | } |
c44027c8 TI |
1111 | if (list_empty(&card->files_list)) |
1112 | wake_up_all(&card->remove_sleep); | |
c461482c | 1113 | spin_unlock(&card->files_lock); |
118dd6bf | 1114 | if (!found) { |
f2f9307a | 1115 | dev_err(card->dev, "card file remove problem (%p)\n", file); |
1da177e4 LT |
1116 | return -ENOENT; |
1117 | } | |
118dd6bf | 1118 | kfree(found); |
f2464064 | 1119 | put_device(&card->card_dev); |
1da177e4 LT |
1120 | return 0; |
1121 | } | |
c0d3fb39 TI |
1122 | EXPORT_SYMBOL(snd_card_file_remove); |
1123 | ||
1da177e4 LT |
1124 | #ifdef CONFIG_PM |
1125 | /** | |
e94fdbd7 TI |
1126 | * snd_power_ref_and_wait - wait until the card gets powered up |
1127 | * @card: soundcard structure | |
1da177e4 | 1128 | * |
e94fdbd7 TI |
1129 | * Take the power_ref reference count of the given card, and |
1130 | * wait until the card gets powered up to SNDRV_CTL_POWER_D0 state. | |
1131 | * The refcount is down again while sleeping until power-up, hence this | |
1132 | * function can be used for syncing the floating control ops accesses, | |
1133 | * typically around calling control ops. | |
1da177e4 | 1134 | * |
e94fdbd7 TI |
1135 | * The caller needs to pull down the refcount via snd_power_unref() later |
1136 | * no matter whether the error is returned from this function or not. | |
1137 | * | |
1138 | * Return: Zero if successful, or a negative error code. | |
1da177e4 | 1139 | */ |
e94fdbd7 | 1140 | int snd_power_ref_and_wait(struct snd_card *card) |
1da177e4 | 1141 | { |
e94fdbd7 | 1142 | snd_power_ref(card); |
e94fdbd7 | 1143 | if (snd_power_get_state(card) == SNDRV_CTL_POWER_D0) |
1da177e4 | 1144 | return 0; |
8c0ae778 TI |
1145 | wait_event_cmd(card->power_sleep, |
1146 | card->shutdown || | |
1147 | snd_power_get_state(card) == SNDRV_CTL_POWER_D0, | |
1148 | snd_power_unref(card), snd_power_ref(card)); | |
1149 | return card->shutdown ? -ENODEV : 0; | |
1da177e4 | 1150 | } |
e94fdbd7 TI |
1151 | EXPORT_SYMBOL_GPL(snd_power_ref_and_wait); |
1152 | ||
1153 | /** | |
1154 | * snd_power_wait - wait until the card gets powered up (old form) | |
1155 | * @card: soundcard structure | |
e94fdbd7 TI |
1156 | * |
1157 | * Wait until the card gets powered up to SNDRV_CTL_POWER_D0 state. | |
e94fdbd7 TI |
1158 | * |
1159 | * Return: Zero if successful, or a negative error code. | |
1160 | */ | |
b6cc78da | 1161 | int snd_power_wait(struct snd_card *card) |
e94fdbd7 TI |
1162 | { |
1163 | int ret; | |
1164 | ||
e94fdbd7 TI |
1165 | ret = snd_power_ref_and_wait(card); |
1166 | snd_power_unref(card); | |
1167 | return ret; | |
1168 | } | |
c0d3fb39 | 1169 | EXPORT_SYMBOL(snd_power_wait); |
1da177e4 | 1170 | #endif /* CONFIG_PM */ |