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