sound/core/init.c

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