sound/core/init.c

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