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