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