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