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