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