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