sound/core/init.c

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