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