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_alloc() */
 115 static void default_release_alloc(struct device *dev)
 116 {
 117         kfree(dev);
 118 }
 119
 120 /**
 121  * snd_device_alloc - Allocate and initialize struct device for sound devices
 122  * @dev_p: pointer to store the allocated device
 123  * @card: card to assign, optional
 124  *
 125  * For releasing the allocated device, call put_device().
 126  */
 127 int snd_device_alloc(struct device **dev_p, struct snd_card *card)
 128 {
 129         struct device *dev;
 130
 131         *dev_p = NULL;
 132         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 133         if (!dev)
 134                 return -ENOMEM;
 135         device_initialize(dev);
 136         if (card)
 137                 dev->parent = &card->card_dev;
 138         dev->class = &sound_class;
 139         dev->release = default_release_alloc;
 140         *dev_p = dev;
 141         return 0;
 142 }
 143 EXPORT_SYMBOL_GPL(snd_device_alloc);
 144
 145 static int snd_card_init(struct snd_card *card, struct device *parent,
 146                          int idx, const char *xid, struct module *module,
 147                          size_t extra_size);
 148 static int snd_card_do_free(struct snd_card *card);
 149 static const struct attribute_group card_dev_attr_group;
 150
 151 static void release_card_device(struct device *dev)
 152 {
 153         snd_card_do_free(dev_to_snd_card(dev));
 154 }
 155
 156 /**
 157  *  snd_card_new - create and initialize a soundcard structure
 158  *  @parent: the parent device object
 159  *  @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
 160  *  @xid: card identification (ASCII string)
 161  *  @module: top level module for locking
 162  *  @extra_size: allocate this extra size after the main soundcard structure
 163  *  @card_ret: the pointer to store the created card instance
 164  *
 165  *  The function allocates snd_card instance via kzalloc with the given
 166  *  space for the driver to use freely.  The allocated struct is stored
 167  *  in the given card_ret pointer.
 168  *
 169  *  Return: Zero if successful or a negative error code.
 170  */
 171 int snd_card_new(struct device *parent, int idx, const char *xid,
 172                     struct module *module, int extra_size,
 173                     struct snd_card **card_ret)
 174 {
 175         struct snd_card *card;
 176         int err;
 177
 178         if (snd_BUG_ON(!card_ret))
 179                 return -EINVAL;
 180         *card_ret = NULL;
 181
 182         if (extra_size < 0)
 183                 extra_size = 0;
 184         card = kzalloc(sizeof(*card) + extra_size, GFP_KERNEL);
 185         if (!card)
 186                 return -ENOMEM;
 187
 188         err = snd_card_init(card, parent, idx, xid, module, extra_size);
 189         if (err < 0)
 190                 return err; /* card is freed by error handler */
 191
 192         *card_ret = card;
 193         return 0;
 194 }
 195 EXPORT_SYMBOL(snd_card_new);
 196
 197 static void __snd_card_release(struct device *dev, void *data)
 198 {
 199         snd_card_free(data);
 200 }
 201
 202 /**
 203  * snd_devm_card_new - managed snd_card object creation
 204  * @parent: the parent device object
 205  * @idx: card index (address) [0 ... (SNDRV_CARDS-1)]
 206  * @xid: card identification (ASCII string)
 207  * @module: top level module for locking
 208  * @extra_size: allocate this extra size after the main soundcard structure
 209  * @card_ret: the pointer to store the created card instance
 210  *
 211  * This function works like snd_card_new() but manages the allocated resource
 212  * via devres, i.e. you don't need to free explicitly.
 213  *
 214  * When a snd_card object is created with this function and registered via
 215  * snd_card_register(), the very first devres action to call snd_card_free()
 216  * is added automatically.  In that way, the resource disconnection is assured
 217  * at first, then released in the expected order.
 218  *
 219  * If an error happens at the probe before snd_card_register() is called and
 220  * there have been other devres resources, you'd need to free the card manually
 221  * via snd_card_free() call in the error; otherwise it may lead to UAF due to
 222  * devres call orders.  You can use snd_card_free_on_error() helper for
 223  * handling it more easily.
 224  *
 225  * Return: zero if successful, or a negative error code
 226  */
 227 int snd_devm_card_new(struct device *parent, int idx, const char *xid,
 228                       struct module *module, size_t extra_size,
 229                       struct snd_card **card_ret)
 230 {
 231         struct snd_card *card;
 232         int err;
 233
 234         *card_ret = NULL;
 235         card = devres_alloc(__snd_card_release, sizeof(*card) + extra_size,
 236                             GFP_KERNEL);
 237         if (!card)
 238                 return -ENOMEM;
 239         card->managed = true;
 240         err = snd_card_init(card, parent, idx, xid, module, extra_size);
 241         if (err < 0) {
 242                 devres_free(card); /* in managed mode, we need to free manually */
 243                 return err;
 244         }
 245
 246         devres_add(parent, card);
 247         *card_ret = card;
 248         return 0;
 249 }
 250 EXPORT_SYMBOL_GPL(snd_devm_card_new);
 251
 252 /**
 253  * snd_card_free_on_error - a small helper for handling devm probe errors
 254  * @dev: the managed device object
 255  * @ret: the return code from the probe callback
 256  *
 257  * This function handles the explicit snd_card_free() call at the error from
 258  * the probe callback.  It's just a small helper for simplifying the error
 259  * handling with the managed devices.
 260  *
 261  * Return: zero if successful, or a negative error code
 262  */
 263 int snd_card_free_on_error(struct device *dev, int ret)
 264 {
 265         struct snd_card *card;
 266
 267         if (!ret)
 268                 return 0;
 269         card = devres_find(dev, __snd_card_release, NULL, NULL);
 270         if (card)
 271                 snd_card_free(card);
 272         return ret;
 273 }
 274 EXPORT_SYMBOL_GPL(snd_card_free_on_error);
 275
 276 static int snd_card_init(struct snd_card *card, struct device *parent,
 277                          int idx, const char *xid, struct module *module,
 278                          size_t extra_size)
 279 {
 280         int err;
 281
 282         if (extra_size > 0)
 283                 card->private_data = (char *)card + sizeof(struct snd_card);
 284         if (xid)
 285                 strscpy(card->id, xid, sizeof(card->id));
 286         err = 0;
 287         scoped_guard(mutex, &snd_card_mutex) {
 288                 if (idx < 0) /* first check the matching module-name slot */
 289                         idx = get_slot_from_bitmask(idx, module_slot_match, module);
 290                 if (idx < 0) /* if not matched, assign an empty slot */
 291                         idx = get_slot_from_bitmask(idx, check_empty_slot, module);
 292                 if (idx < 0)
 293                         err = -ENODEV;
 294                 else if (idx < snd_ecards_limit) {
 295                         if (test_bit(idx, snd_cards_lock))
 296                                 err = -EBUSY;   /* invalid */
 297                 } else if (idx >= SNDRV_CARDS)
 298                         err = -ENODEV;
 299                 if (!err) {
 300                         set_bit(idx, snd_cards_lock);           /* lock it */
 301                         if (idx >= snd_ecards_limit)
 302                                 snd_ecards_limit = idx + 1; /* increase the limit */
 303                 }
 304         }
 305         if (err < 0) {
 306                 dev_err(parent, "cannot find the slot for index %d (range 0-%i), error: %d\n",
 307                         idx, snd_ecards_limit - 1, err);
 308                 if (!card->managed)
 309                         kfree(card); /* manually free here, as no destructor called */
 310                 return err;
 311         }
 312         card->dev = parent;
 313         card->number = idx;
 314 #ifdef MODULE
 315         WARN_ON(!module);
 316         card->module = module;
 317 #endif
 318         INIT_LIST_HEAD(&card->devices);
 319         init_rwsem(&card->controls_rwsem);
 320         rwlock_init(&card->ctl_files_rwlock);
 321         INIT_LIST_HEAD(&card->controls);
 322         INIT_LIST_HEAD(&card->ctl_files);
 323 #ifdef CONFIG_SND_CTL_FAST_LOOKUP
 324         xa_init(&card->ctl_numids);
 325         xa_init(&card->ctl_hash);
 326 #endif
 327         spin_lock_init(&card->files_lock);
 328         INIT_LIST_HEAD(&card->files_list);
 329         mutex_init(&card->memory_mutex);
 330 #ifdef CONFIG_PM
 331         init_waitqueue_head(&card->power_sleep);
 332         init_waitqueue_head(&card->power_ref_sleep);
 333         atomic_set(&card->power_ref, 0);
 334 #endif
 335         init_waitqueue_head(&card->remove_sleep);
 336         card->sync_irq = -1;
 337
 338         device_initialize(&card->card_dev);
 339         card->card_dev.parent = parent;
 340         card->card_dev.class = &sound_class;
 341         card->card_dev.release = release_card_device;
 342         card->card_dev.groups = card->dev_groups;
 343         card->dev_groups[0] = &card_dev_attr_group;
 344         err = kobject_set_name(&card->card_dev.kobj, "card%d", idx);
 345         if (err < 0)
 346                 goto __error;
 347
 348         snprintf(card->irq_descr, sizeof(card->irq_descr), "%s:%s",
 349                  dev_driver_string(card->dev), dev_name(&card->card_dev));
 350
 351         /* the control interface cannot be accessed from the user space until */
 352         /* snd_cards_bitmask and snd_cards are set with snd_card_register */
 353         err = snd_ctl_create(card);
 354         if (err < 0) {
 355                 dev_err(parent, "unable to register control minors\n");
 356                 goto __error;
 357         }
 358         err = snd_info_card_create(card);
 359         if (err < 0) {
 360                 dev_err(parent, "unable to create card info\n");
 361                 goto __error_ctl;
 362         }
 363
 364 #ifdef CONFIG_SND_DEBUG
 365         card->debugfs_root = debugfs_create_dir(dev_name(&card->card_dev),
 366                                                 sound_debugfs_root);
 367 #endif
 368         return 0;
 369
 370       __error_ctl:
 371         snd_device_free_all(card);
 372       __error:
 373         put_device(&card->card_dev);
 374         return err;
 375 }
 376
 377 /**
 378  * snd_card_ref - Get the card object from the index
 379  * @idx: the card index
 380  *
 381  * Returns a card object corresponding to the given index or NULL if not found.
 382  * Release the object via snd_card_unref().
 383  *
 384  * Return: a card object or NULL
 385  */
 386 struct snd_card *snd_card_ref(int idx)
 387 {
 388         struct snd_card *card;
 389
 390         guard(mutex)(&snd_card_mutex);
 391         card = snd_cards[idx];
 392         if (card)
 393                 get_device(&card->card_dev);
 394         return card;
 395 }
 396 EXPORT_SYMBOL_GPL(snd_card_ref);
 397
 398 /* return non-zero if a card is already locked */
 399 int snd_card_locked(int card)
 400 {
 401         guard(mutex)(&snd_card_mutex);
 402         return test_bit(card, snd_cards_lock);
 403 }
 404
 405 static loff_t snd_disconnect_llseek(struct file *file, loff_t offset, int orig)
 406 {
 407         return -ENODEV;
 408 }
 409
 410 static ssize_t snd_disconnect_read(struct file *file, char __user *buf,
 411                                    size_t count, loff_t *offset)
 412 {
 413         return -ENODEV;
 414 }
 415
 416 static ssize_t snd_disconnect_write(struct file *file, const char __user *buf,
 417                                     size_t count, loff_t *offset)
 418 {
 419         return -ENODEV;
 420 }
 421
 422 static int snd_disconnect_release(struct inode *inode, struct file *file)
 423 {
 424         struct snd_monitor_file *df = NULL, *_df;
 425
 426         scoped_guard(spinlock, &shutdown_lock) {
 427                 list_for_each_entry(_df, &shutdown_files, shutdown_list) {
 428                         if (_df->file == file) {
 429                                 df = _df;
 430                                 list_del_init(&df->shutdown_list);
 431                                 break;
 432                         }
 433                 }
 434         }
 435
 436         if (likely(df)) {
 437                 if ((file->f_flags & FASYNC) && df->disconnected_f_op->fasync)
 438                         df->disconnected_f_op->fasync(-1, file, 0);
 439                 return df->disconnected_f_op->release(inode, file);
 440         }
 441
 442         panic("%s(%p, %p) failed!", __func__, inode, file);
 443 }
 444
 445 static __poll_t snd_disconnect_poll(struct file * file, poll_table * wait)
 446 {
 447         return EPOLLERR | EPOLLNVAL;
 448 }
 449
 450 static long snd_disconnect_ioctl(struct file *file,
 451                                  unsigned int cmd, unsigned long arg)
 452 {
 453         return -ENODEV;
 454 }
 455
 456 static int snd_disconnect_mmap(struct file *file, struct vm_area_struct *vma)
 457 {
 458         return -ENODEV;
 459 }
 460
 461 static int snd_disconnect_fasync(int fd, struct file *file, int on)
 462 {
 463         return -ENODEV;
 464 }
 465
 466 static const struct file_operations snd_shutdown_f_ops =
 467 {
 468         .owner =        THIS_MODULE,
 469         .llseek =       snd_disconnect_llseek,
 470         .read =         snd_disconnect_read,
 471         .write =        snd_disconnect_write,
 472         .release =      snd_disconnect_release,
 473         .poll =         snd_disconnect_poll,
 474         .unlocked_ioctl = snd_disconnect_ioctl,
 475 #ifdef CONFIG_COMPAT
 476         .compat_ioctl = snd_disconnect_ioctl,
 477 #endif
 478         .mmap =         snd_disconnect_mmap,
 479         .fasync =       snd_disconnect_fasync
 480 };
 481
 482 /**
 483  *  snd_card_disconnect - disconnect all APIs from the file-operations (user space)
 484  *  @card: soundcard structure
 485  *
 486  *  Disconnects all APIs from the file-operations (user space).
 487  *
 488  *  Return: Zero, otherwise a negative error code.
 489  *
 490  *  Note: The current implementation replaces all active file->f_op with special
 491  *        dummy file operations (they do nothing except release).
 492  */
 493 void snd_card_disconnect(struct snd_card *card)
 494 {
 495         struct snd_monitor_file *mfile;
 496
 497         if (!card)
 498                 return;
 499
 500         scoped_guard(spinlock, &card->files_lock) {
 501                 if (card->shutdown)
 502                         return;
 503                 card->shutdown = 1;
 504
 505                 /* replace file->f_op with special dummy operations */
 506                 list_for_each_entry(mfile, &card->files_list, list) {
 507                         /* it's critical part, use endless loop */
 508                         /* we have no room to fail */
 509                         mfile->disconnected_f_op = mfile->file->f_op;
 510
 511                         scoped_guard(spinlock, &shutdown_lock)
 512                                 list_add(&mfile->shutdown_list, &shutdown_files);
 513
 514                         mfile->file->f_op = &snd_shutdown_f_ops;
 515                         fops_get(mfile->file->f_op);
 516                 }
 517         }
 518
 519 #ifdef CONFIG_PM
 520         /* wake up sleepers here before other callbacks for avoiding potential
 521          * deadlocks with other locks (e.g. in kctls);
 522          * then this notifies the shutdown and sleepers would abort immediately
 523          */
 524         wake_up_all(&card->power_sleep);
 525 #endif
 526
 527         /* notify all connected devices about disconnection */
 528         /* at this point, they cannot respond to any calls except release() */
 529
 530 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 531         if (snd_mixer_oss_notify_callback)
 532                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
 533 #endif
 534
 535         /* notify all devices that we are disconnected */
 536         snd_device_disconnect_all(card);
 537
 538         if (card->sync_irq > 0)
 539                 synchronize_irq(card->sync_irq);
 540
 541         snd_info_card_disconnect(card);
 542         if (card->registered) {
 543                 device_del(&card->card_dev);
 544                 card->registered = false;
 545         }
 546
 547         /* disable fops (user space) operations for ALSA API */
 548         scoped_guard(mutex, &snd_card_mutex) {
 549                 snd_cards[card->number] = NULL;
 550                 clear_bit(card->number, snd_cards_lock);
 551         }
 552
 553         snd_power_sync_ref(card);
 554 }
 555 EXPORT_SYMBOL(snd_card_disconnect);
 556
 557 /**
 558  * snd_card_disconnect_sync - disconnect card and wait until files get closed
 559  * @card: card object to disconnect
 560  *
 561  * This calls snd_card_disconnect() for disconnecting all belonging components
 562  * and waits until all pending files get closed.
 563  * It assures that all accesses from user-space finished so that the driver
 564  * can release its resources gracefully.
 565  */
 566 void snd_card_disconnect_sync(struct snd_card *card)
 567 {
 568         snd_card_disconnect(card);
 569
 570         guard(spinlock_irq)(&card->files_lock);
 571         wait_event_lock_irq(card->remove_sleep,
 572                             list_empty(&card->files_list),
 573                             card->files_lock);
 574 }
 575 EXPORT_SYMBOL_GPL(snd_card_disconnect_sync);
 576
 577 static int snd_card_do_free(struct snd_card *card)
 578 {
 579         card->releasing = true;
 580 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 581         if (snd_mixer_oss_notify_callback)
 582                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
 583 #endif
 584         snd_device_free_all(card);
 585         if (card->private_free)
 586                 card->private_free(card);
 587         if (snd_info_card_free(card) < 0) {
 588                 dev_warn(card->dev, "unable to free card info\n");
 589                 /* Not fatal error */
 590         }
 591 #ifdef CONFIG_SND_DEBUG
 592         debugfs_remove(card->debugfs_root);
 593         card->debugfs_root = NULL;
 594 #endif
 595         if (card->release_completion)
 596                 complete(card->release_completion);
 597         if (!card->managed)
 598                 kfree(card);
 599         return 0;
 600 }
 601
 602 /**
 603  * snd_card_free_when_closed - Disconnect the card, free it later eventually
 604  * @card: soundcard structure
 605  *
 606  * Unlike snd_card_free(), this function doesn't try to release the card
 607  * resource immediately, but tries to disconnect at first.  When the card
 608  * is still in use, the function returns before freeing the resources.
 609  * The card resources will be freed when the refcount gets to zero.
 610  *
 611  * Return: zero if successful, or a negative error code
 612  */
 613 void snd_card_free_when_closed(struct snd_card *card)
 614 {
 615         if (!card)
 616                 return;
 617
 618         snd_card_disconnect(card);
 619         put_device(&card->card_dev);
 620         return;
 621 }
 622 EXPORT_SYMBOL(snd_card_free_when_closed);
 623
 624 /**
 625  * snd_card_free - frees given soundcard structure
 626  * @card: soundcard structure
 627  *
 628  * This function releases the soundcard structure and the all assigned
 629  * devices automatically.  That is, you don't have to release the devices
 630  * by yourself.
 631  *
 632  * This function waits until the all resources are properly released.
 633  *
 634  * Return: Zero. Frees all associated devices and frees the control
 635  * interface associated to given soundcard.
 636  */
 637 void snd_card_free(struct snd_card *card)
 638 {
 639         DECLARE_COMPLETION_ONSTACK(released);
 640
 641         /* The call of snd_card_free() is allowed from various code paths;
 642          * a manual call from the driver and the call via devres_free, and
 643          * we need to avoid double-free. Moreover, the release via devres
 644          * may call snd_card_free() twice due to its nature, we need to have
 645          * the check here at the beginning.
 646          */
 647         if (card->releasing)
 648                 return;
 649
 650         card->release_completion = &released;
 651         snd_card_free_when_closed(card);
 652
 653         /* wait, until all devices are ready for the free operation */
 654         wait_for_completion(&released);
 655 }
 656 EXPORT_SYMBOL(snd_card_free);
 657
 658 /* retrieve the last word of shortname or longname */
 659 static const char *retrieve_id_from_card_name(const char *name)
 660 {
 661         const char *spos = name;
 662
 663         while (*name) {
 664                 if (isspace(*name) && isalnum(name[1]))
 665                         spos = name + 1;
 666                 name++;
 667         }
 668         return spos;
 669 }
 670
 671 /* return true if the given id string doesn't conflict any other card ids */
 672 static bool card_id_ok(struct snd_card *card, const char *id)
 673 {
 674         int i;
 675         if (!snd_info_check_reserved_words(id))
 676                 return false;
 677         for (i = 0; i < snd_ecards_limit; i++) {
 678                 if (snd_cards[i] && snd_cards[i] != card &&
 679                     !strcmp(snd_cards[i]->id, id))
 680                         return false;
 681         }
 682         return true;
 683 }
 684
 685 /* copy to card->id only with valid letters from nid */
 686 static void copy_valid_id_string(struct snd_card *card, const char *src,
 687                                  const char *nid)
 688 {
 689         char *id = card->id;
 690
 691         while (*nid && !isalnum(*nid))
 692                 nid++;
 693         if (isdigit(*nid))
 694                 *id++ = isalpha(*src) ? *src : 'D';
 695         while (*nid && (size_t)(id - card->id) < sizeof(card->id) - 1) {
 696                 if (isalnum(*nid))
 697                         *id++ = *nid;
 698                 nid++;
 699         }
 700         *id = 0;
 701 }
 702
 703 /* Set card->id from the given string
 704  * If the string conflicts with other ids, add a suffix to make it unique.
 705  */
 706 static void snd_card_set_id_no_lock(struct snd_card *card, const char *src,
 707                                     const char *nid)
 708 {
 709         int len, loops;
 710         bool is_default = false;
 711         char *id;
 712
 713         copy_valid_id_string(card, src, nid);
 714         id = card->id;
 715
 716  again:
 717         /* use "Default" for obviously invalid strings
 718          * ("card" conflicts with proc directories)
 719          */
 720         if (!*id || !strncmp(id, "card", 4)) {
 721                 strcpy(id, "Default");
 722                 is_default = true;
 723         }
 724
 725         len = strlen(id);
 726         for (loops = 0; loops < SNDRV_CARDS; loops++) {
 727                 char *spos;
 728                 char sfxstr[5]; /* "_012" */
 729                 int sfxlen;
 730
 731                 if (card_id_ok(card, id))
 732                         return; /* OK */
 733
 734                 /* Add _XYZ suffix */
 735                 sprintf(sfxstr, "_%X", loops + 1);
 736                 sfxlen = strlen(sfxstr);
 737                 if (len + sfxlen >= sizeof(card->id))
 738                         spos = id + sizeof(card->id) - sfxlen - 1;
 739                 else
 740                         spos = id + len;
 741                 strcpy(spos, sfxstr);
 742         }
 743         /* fallback to the default id */
 744         if (!is_default) {
 745                 *id = 0;
 746                 goto again;
 747         }
 748         /* last resort... */
 749         dev_err(card->dev, "unable to set card id (%s)\n", id);
 750         if (card->proc_root->name)
 751                 strscpy(card->id, card->proc_root->name, sizeof(card->id));
 752 }
 753
 754 /**
 755  *  snd_card_set_id - set card identification name
 756  *  @card: soundcard structure
 757  *  @nid: new identification string
 758  *
 759  *  This function sets the card identification and checks for name
 760  *  collisions.
 761  */
 762 void snd_card_set_id(struct snd_card *card, const char *nid)
 763 {
 764         /* check if user specified own card->id */
 765         if (card->id[0] != '\0')
 766                 return;
 767         guard(mutex)(&snd_card_mutex);
 768         snd_card_set_id_no_lock(card, nid, nid);
 769 }
 770 EXPORT_SYMBOL(snd_card_set_id);
 771
 772 static ssize_t id_show(struct device *dev,
 773                        struct device_attribute *attr, char *buf)
 774 {
 775         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 776         return sysfs_emit(buf, "%s\n", card->id);
 777 }
 778
 779 static ssize_t id_store(struct device *dev, struct device_attribute *attr,
 780                         const char *buf, size_t count)
 781 {
 782         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 783         char buf1[sizeof(card->id)];
 784         size_t copy = count > sizeof(card->id) - 1 ?
 785                                         sizeof(card->id) - 1 : count;
 786         size_t idx;
 787         int c;
 788
 789         for (idx = 0; idx < copy; idx++) {
 790                 c = buf[idx];
 791                 if (!isalnum(c) && c != '_' && c != '-')
 792                         return -EINVAL;
 793         }
 794         memcpy(buf1, buf, copy);
 795         buf1[copy] = '\0';
 796         guard(mutex)(&snd_card_mutex);
 797         if (!card_id_ok(NULL, buf1))
 798                 return -EEXIST;
 799         strcpy(card->id, buf1);
 800         snd_info_card_id_change(card);
 801
 802         return count;
 803 }
 804
 805 static DEVICE_ATTR_RW(id);
 806
 807 static ssize_t number_show(struct device *dev,
 808                            struct device_attribute *attr, char *buf)
 809 {
 810         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 811         return sysfs_emit(buf, "%i\n", card->number);
 812 }
 813
 814 static DEVICE_ATTR_RO(number);
 815
 816 static struct attribute *card_dev_attrs[] = {
 817         &dev_attr_id.attr,
 818         &dev_attr_number.attr,
 819         NULL
 820 };
 821
 822 static const struct attribute_group card_dev_attr_group = {
 823         .attrs  = card_dev_attrs,
 824 };
 825
 826 /**
 827  * snd_card_add_dev_attr - Append a new sysfs attribute group to card
 828  * @card: card instance
 829  * @group: attribute group to append
 830  *
 831  * Return: zero if successful, or a negative error code
 832  */
 833 int snd_card_add_dev_attr(struct snd_card *card,
 834                           const struct attribute_group *group)
 835 {
 836         int i;
 837
 838         /* loop for (arraysize-1) here to keep NULL at the last entry */
 839         for (i = 0; i < ARRAY_SIZE(card->dev_groups) - 1; i++) {
 840                 if (!card->dev_groups[i]) {
 841                         card->dev_groups[i] = group;
 842                         return 0;
 843                 }
 844         }
 845
 846         dev_err(card->dev, "Too many groups assigned\n");
 847         return -ENOSPC;
 848 }
 849 EXPORT_SYMBOL_GPL(snd_card_add_dev_attr);
 850
 851 static void trigger_card_free(void *data)
 852 {
 853         snd_card_free(data);
 854 }
 855
 856 /**
 857  *  snd_card_register - register the soundcard
 858  *  @card: soundcard structure
 859  *
 860  *  This function registers all the devices assigned to the soundcard.
 861  *  Until calling this, the ALSA control interface is blocked from the
 862  *  external accesses.  Thus, you should call this function at the end
 863  *  of the initialization of the card.
 864  *
 865  *  Return: Zero otherwise a negative error code if the registration failed.
 866  */
 867 int snd_card_register(struct snd_card *card)
 868 {
 869         int err;
 870
 871         if (snd_BUG_ON(!card))
 872                 return -EINVAL;
 873
 874         if (!card->registered) {
 875                 err = device_add(&card->card_dev);
 876                 if (err < 0)
 877                         return err;
 878                 card->registered = true;
 879         } else {
 880                 if (card->managed)
 881                         devm_remove_action(card->dev, trigger_card_free, card);
 882         }
 883
 884         if (card->managed) {
 885                 err = devm_add_action(card->dev, trigger_card_free, card);
 886                 if (err < 0)
 887                         return err;
 888         }
 889
 890         err = snd_device_register_all(card);
 891         if (err < 0)
 892                 return err;
 893         scoped_guard(mutex, &snd_card_mutex) {
 894                 if (snd_cards[card->number]) {
 895                         /* already registered */
 896                         return snd_info_card_register(card); /* register pending info */
 897                 }
 898                 if (*card->id) {
 899                         /* make a unique id name from the given string */
 900                         char tmpid[sizeof(card->id)];
 901
 902                         memcpy(tmpid, card->id, sizeof(card->id));
 903                         snd_card_set_id_no_lock(card, tmpid, tmpid);
 904                 } else {
 905                         /* create an id from either shortname or longname */
 906                         const char *src;
 907
 908                         src = *card->shortname ? card->shortname : card->longname;
 909                         snd_card_set_id_no_lock(card, src,
 910                                                 retrieve_id_from_card_name(src));
 911                 }
 912                 snd_cards[card->number] = card;
 913         }
 914         err = snd_info_card_register(card);
 915         if (err < 0)
 916                 return err;
 917
 918 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 919         if (snd_mixer_oss_notify_callback)
 920                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
 921 #endif
 922         return 0;
 923 }
 924 EXPORT_SYMBOL(snd_card_register);
 925
 926 #ifdef CONFIG_SND_PROC_FS
 927 static void snd_card_info_read(struct snd_info_entry *entry,
 928                                struct snd_info_buffer *buffer)
 929 {
 930         int idx, count;
 931         struct snd_card *card;
 932
 933         for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
 934                 guard(mutex)(&snd_card_mutex);
 935                 card = snd_cards[idx];
 936                 if (card) {
 937                         count++;
 938                         snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
 939                                         idx,
 940                                         card->id,
 941                                         card->driver,
 942                                         card->shortname);
 943                         snd_iprintf(buffer, "                      %s\n",
 944                                         card->longname);
 945                 }
 946         }
 947         if (!count)
 948                 snd_iprintf(buffer, "--- no soundcards ---\n");
 949 }
 950
 951 #ifdef CONFIG_SND_OSSEMUL
 952 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
 953 {
 954         int idx, count;
 955         struct snd_card *card;
 956
 957         for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
 958                 guard(mutex)(&snd_card_mutex);
 959                 card = snd_cards[idx];
 960                 if (card) {
 961                         count++;
 962                         snd_iprintf(buffer, "%s\n", card->longname);
 963                 }
 964         }
 965         if (!count) {
 966                 snd_iprintf(buffer, "--- no soundcards ---\n");
 967         }
 968 }
 969
 970 #endif
 971
 972 #ifdef MODULE
 973 static void snd_card_module_info_read(struct snd_info_entry *entry,
 974                                       struct snd_info_buffer *buffer)
 975 {
 976         int idx;
 977         struct snd_card *card;
 978
 979         for (idx = 0; idx < SNDRV_CARDS; idx++) {
 980                 guard(mutex)(&snd_card_mutex);
 981                 card = snd_cards[idx];
 982                 if (card)
 983                         snd_iprintf(buffer, "%2i %s\n",
 984                                     idx, card->module->name);
 985         }
 986 }
 987 #endif
 988
 989 int __init snd_card_info_init(void)
 990 {
 991         struct snd_info_entry *entry;
 992
 993         entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
 994         if (! entry)
 995                 return -ENOMEM;
 996         entry->c.text.read = snd_card_info_read;
 997         if (snd_info_register(entry) < 0)
 998                 return -ENOMEM; /* freed in error path */
 999
1000 #ifdef MODULE
1001         entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
1002         if (!entry)
1003                 return -ENOMEM;
1004         entry->c.text.read = snd_card_module_info_read;
1005         if (snd_info_register(entry) < 0)
1006                 return -ENOMEM; /* freed in error path */
1007 #endif
1008
1009         return 0;
1010 }
1011 #endif /* CONFIG_SND_PROC_FS */
1012
1013 /**
1014  *  snd_component_add - add a component string
1015  *  @card: soundcard structure
1016  *  @component: the component id string
1017  *
1018  *  This function adds the component id string to the supported list.
1019  *  The component can be referred from the alsa-lib.
1020  *
1021  *  Return: Zero otherwise a negative error code.
1022  */
1023
1024 int snd_component_add(struct snd_card *card, const char *component)
1025 {
1026         char *ptr;
1027         int len = strlen(component);
1028
1029         ptr = strstr(card->components, component);
1030         if (ptr != NULL) {
1031                 if (ptr[len] == '\0' || ptr[len] == ' ')        /* already there */
1032                         return 1;
1033         }
1034         if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
1035                 snd_BUG();
1036                 return -ENOMEM;
1037         }
1038         if (card->components[0] != '\0')
1039                 strcat(card->components, " ");
1040         strcat(card->components, component);
1041         return 0;
1042 }
1043 EXPORT_SYMBOL(snd_component_add);
1044
1045 /**
1046  *  snd_card_file_add - add the file to the file list of the card
1047  *  @card: soundcard structure
1048  *  @file: file pointer
1049  *
1050  *  This function adds the file to the file linked-list of the card.
1051  *  This linked-list is used to keep tracking the connection state,
1052  *  and to avoid the release of busy resources by hotplug.
1053  *
1054  *  Return: zero or a negative error code.
1055  */
1056 int snd_card_file_add(struct snd_card *card, struct file *file)
1057 {
1058         struct snd_monitor_file *mfile;
1059
1060         mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
1061         if (mfile == NULL)
1062                 return -ENOMEM;
1063         mfile->file = file;
1064         mfile->disconnected_f_op = NULL;
1065         INIT_LIST_HEAD(&mfile->shutdown_list);
1066         guard(spinlock)(&card->files_lock);
1067         if (card->shutdown) {
1068                 kfree(mfile);
1069                 return -ENODEV;
1070         }
1071         list_add(&mfile->list, &card->files_list);
1072         get_device(&card->card_dev);
1073         return 0;
1074 }
1075 EXPORT_SYMBOL(snd_card_file_add);
1076
1077 /**
1078  *  snd_card_file_remove - remove the file from the file list
1079  *  @card: soundcard structure
1080  *  @file: file pointer
1081  *
1082  *  This function removes the file formerly added to the card via
1083  *  snd_card_file_add() function.
1084  *  If all files are removed and snd_card_free_when_closed() was
1085  *  called beforehand, it processes the pending release of
1086  *  resources.
1087  *
1088  *  Return: Zero or a negative error code.
1089  */
1090 int snd_card_file_remove(struct snd_card *card, struct file *file)
1091 {
1092         struct snd_monitor_file *mfile, *found = NULL;
1093
1094         scoped_guard(spinlock, &card->files_lock) {
1095                 list_for_each_entry(mfile, &card->files_list, list) {
1096                         if (mfile->file == file) {
1097                                 list_del(&mfile->list);
1098                                 scoped_guard(spinlock, &shutdown_lock)
1099                                         list_del(&mfile->shutdown_list);
1100                                 if (mfile->disconnected_f_op)
1101                                         fops_put(mfile->disconnected_f_op);
1102                                 found = mfile;
1103                                 break;
1104                         }
1105                 }
1106                 if (list_empty(&card->files_list))
1107                         wake_up_all(&card->remove_sleep);
1108         }
1109         if (!found) {
1110                 dev_err(card->dev, "card file remove problem (%p)\n", file);
1111                 return -ENOENT;
1112         }
1113         kfree(found);
1114         put_device(&card->card_dev);
1115         return 0;
1116 }
1117 EXPORT_SYMBOL(snd_card_file_remove);
1118
1119 #ifdef CONFIG_PM
1120 /**
1121  * snd_power_ref_and_wait - wait until the card gets powered up
1122  * @card: soundcard structure
1123  *
1124  * Take the power_ref reference count of the given card, and
1125  * wait until the card gets powered up to SNDRV_CTL_POWER_D0 state.
1126  * The refcount is down again while sleeping until power-up, hence this
1127  * function can be used for syncing the floating control ops accesses,
1128  * typically around calling control ops.
1129  *
1130  * The caller needs to pull down the refcount via snd_power_unref() later
1131  * no matter whether the error is returned from this function or not.
1132  *
1133  * Return: Zero if successful, or a negative error code.
1134  */
1135 int snd_power_ref_and_wait(struct snd_card *card)
1136 {
1137         snd_power_ref(card);
1138         if (snd_power_get_state(card) == SNDRV_CTL_POWER_D0)
1139                 return 0;
1140         wait_event_cmd(card->power_sleep,
1141                        card->shutdown ||
1142                        snd_power_get_state(card) == SNDRV_CTL_POWER_D0,
1143                        snd_power_unref(card), snd_power_ref(card));
1144         return card->shutdown ? -ENODEV : 0;
1145 }
1146 EXPORT_SYMBOL_GPL(snd_power_ref_and_wait);
1147
1148 /**
1149  * snd_power_wait - wait until the card gets powered up (old form)
1150  * @card: soundcard structure
1151  *
1152  * Wait until the card gets powered up to SNDRV_CTL_POWER_D0 state.
1153  *
1154  * Return: Zero if successful, or a negative error code.
1155  */
1156 int snd_power_wait(struct snd_card *card)
1157 {
1158         int ret;
1159
1160         ret = snd_power_ref_and_wait(card);
1161         snd_power_unref(card);
1162         return ret;
1163 }
1164 EXPORT_SYMBOL(snd_power_wait);
1165 #endif /* CONFIG_PM */