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