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