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