sound/core/init.c

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