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         int err;
 404
 405         if (!card)
 406                 return -EINVAL;
 407
 408         spin_lock(&card->files_lock);
 409         if (card->shutdown) {
 410                 spin_unlock(&card->files_lock);
 411                 return 0;
 412         }
 413         card->shutdown = 1;
 414         spin_unlock(&card->files_lock);
 415
 416         /* phase 1: disable fops (user space) operations for ALSA API */
 417         mutex_lock(&snd_card_mutex);
 418         snd_cards[card->number] = NULL;
 419         clear_bit(card->number, snd_cards_lock);
 420         mutex_unlock(&snd_card_mutex);
 421
 422         /* phase 2: replace file->f_op with special dummy operations */
 423
 424         spin_lock(&card->files_lock);
 425         list_for_each_entry(mfile, &card->files_list, list) {
 426                 /* it's critical part, use endless loop */
 427                 /* we have no room to fail */
 428                 mfile->disconnected_f_op = mfile->file->f_op;
 429
 430                 spin_lock(&shutdown_lock);
 431                 list_add(&mfile->shutdown_list, &shutdown_files);
 432                 spin_unlock(&shutdown_lock);
 433
 434                 mfile->file->f_op = &snd_shutdown_f_ops;
 435                 fops_get(mfile->file->f_op);
 436         }
 437         spin_unlock(&card->files_lock);
 438
 439         /* phase 3: notify all connected devices about disconnection */
 440         /* at this point, they cannot respond to any calls except release() */
 441
 442 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 443         if (snd_mixer_oss_notify_callback)
 444                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_DISCONNECT);
 445 #endif
 446
 447         /* notify all devices that we are disconnected */
 448         err = snd_device_disconnect_all(card);
 449         if (err < 0)
 450                 dev_err(card->dev, "not all devices for card %i can be disconnected\n", card->number);
 451
 452         snd_info_card_disconnect(card);
 453         if (card->registered) {
 454                 device_del(&card->card_dev);
 455                 card->registered = false;
 456         }
 457 #ifdef CONFIG_PM
 458         wake_up(&card->power_sleep);
 459 #endif
 460         return 0;
 461 }
 462
 463 EXPORT_SYMBOL(snd_card_disconnect);
 464
 465 static int snd_card_do_free(struct snd_card *card)
 466 {
 467 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 468         if (snd_mixer_oss_notify_callback)
 469                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_FREE);
 470 #endif
 471         snd_device_free_all(card);
 472         if (card->private_free)
 473                 card->private_free(card);
 474         snd_info_free_entry(card->proc_id);
 475         if (snd_info_card_free(card) < 0) {
 476                 dev_warn(card->dev, "unable to free card info\n");
 477                 /* Not fatal error */
 478         }
 479         if (card->release_completion)
 480                 complete(card->release_completion);
 481         kfree(card);
 482         return 0;
 483 }
 484
 485 /**
 486  * snd_card_free_when_closed - Disconnect the card, free it later eventually
 487  * @card: soundcard structure
 488  *
 489  * Unlike snd_card_free(), this function doesn't try to release the card
 490  * resource immediately, but tries to disconnect at first.  When the card
 491  * is still in use, the function returns before freeing the resources.
 492  * The card resources will be freed when the refcount gets to zero.
 493  */
 494 int snd_card_free_when_closed(struct snd_card *card)
 495 {
 496         int ret = snd_card_disconnect(card);
 497         if (ret)
 498                 return ret;
 499         put_device(&card->card_dev);
 500         return 0;
 501 }
 502 EXPORT_SYMBOL(snd_card_free_when_closed);
 503
 504 /**
 505  * snd_card_free - frees given soundcard structure
 506  * @card: soundcard structure
 507  *
 508  * This function releases the soundcard structure and the all assigned
 509  * devices automatically.  That is, you don't have to release the devices
 510  * by yourself.
 511  *
 512  * This function waits until the all resources are properly released.
 513  *
 514  * Return: Zero. Frees all associated devices and frees the control
 515  * interface associated to given soundcard.
 516  */
 517 int snd_card_free(struct snd_card *card)
 518 {
 519         struct completion released;
 520         int ret;
 521
 522         init_completion(&released);
 523         card->release_completion = &released;
 524         ret = snd_card_free_when_closed(card);
 525         if (ret)
 526                 return ret;
 527         /* wait, until all devices are ready for the free operation */
 528         wait_for_completion(&released);
 529         return 0;
 530 }
 531 EXPORT_SYMBOL(snd_card_free);
 532
 533 /* retrieve the last word of shortname or longname */
 534 static const char *retrieve_id_from_card_name(const char *name)
 535 {
 536         const char *spos = name;
 537
 538         while (*name) {
 539                 if (isspace(*name) && isalnum(name[1]))
 540                         spos = name + 1;
 541                 name++;
 542         }
 543         return spos;
 544 }
 545
 546 /* return true if the given id string doesn't conflict any other card ids */
 547 static bool card_id_ok(struct snd_card *card, const char *id)
 548 {
 549         int i;
 550         if (!snd_info_check_reserved_words(id))
 551                 return false;
 552         for (i = 0; i < snd_ecards_limit; i++) {
 553                 if (snd_cards[i] && snd_cards[i] != card &&
 554                     !strcmp(snd_cards[i]->id, id))
 555                         return false;
 556         }
 557         return true;
 558 }
 559
 560 /* copy to card->id only with valid letters from nid */
 561 static void copy_valid_id_string(struct snd_card *card, const char *src,
 562                                  const char *nid)
 563 {
 564         char *id = card->id;
 565
 566         while (*nid && !isalnum(*nid))
 567                 nid++;
 568         if (isdigit(*nid))
 569                 *id++ = isalpha(*src) ? *src : 'D';
 570         while (*nid && (size_t)(id - card->id) < sizeof(card->id) - 1) {
 571                 if (isalnum(*nid))
 572                         *id++ = *nid;
 573                 nid++;
 574         }
 575         *id = 0;
 576 }
 577
 578 /* Set card->id from the given string
 579  * If the string conflicts with other ids, add a suffix to make it unique.
 580  */
 581 static void snd_card_set_id_no_lock(struct snd_card *card, const char *src,
 582                                     const char *nid)
 583 {
 584         int len, loops;
 585         bool is_default = false;
 586         char *id;
 587
 588         copy_valid_id_string(card, src, nid);
 589         id = card->id;
 590
 591  again:
 592         /* use "Default" for obviously invalid strings
 593          * ("card" conflicts with proc directories)
 594          */
 595         if (!*id || !strncmp(id, "card", 4)) {
 596                 strcpy(id, "Default");
 597                 is_default = true;
 598         }
 599
 600         len = strlen(id);
 601         for (loops = 0; loops < SNDRV_CARDS; loops++) {
 602                 char *spos;
 603                 char sfxstr[5]; /* "_012" */
 604                 int sfxlen;
 605
 606                 if (card_id_ok(card, id))
 607                         return; /* OK */
 608
 609                 /* Add _XYZ suffix */
 610                 sprintf(sfxstr, "_%X", loops + 1);
 611                 sfxlen = strlen(sfxstr);
 612                 if (len + sfxlen >= sizeof(card->id))
 613                         spos = id + sizeof(card->id) - sfxlen - 1;
 614                 else
 615                         spos = id + len;
 616                 strcpy(spos, sfxstr);
 617         }
 618         /* fallback to the default id */
 619         if (!is_default) {
 620                 *id = 0;
 621                 goto again;
 622         }
 623         /* last resort... */
 624         dev_err(card->dev, "unable to set card id (%s)\n", id);
 625         if (card->proc_root->name)
 626                 strlcpy(card->id, card->proc_root->name, sizeof(card->id));
 627 }
 628
 629 /**
 630  *  snd_card_set_id - set card identification name
 631  *  @card: soundcard structure
 632  *  @nid: new identification string
 633  *
 634  *  This function sets the card identification and checks for name
 635  *  collisions.
 636  */
 637 void snd_card_set_id(struct snd_card *card, const char *nid)
 638 {
 639         /* check if user specified own card->id */
 640         if (card->id[0] != '\0')
 641                 return;
 642         mutex_lock(&snd_card_mutex);
 643         snd_card_set_id_no_lock(card, nid, nid);
 644         mutex_unlock(&snd_card_mutex);
 645 }
 646 EXPORT_SYMBOL(snd_card_set_id);
 647
 648 static ssize_t
 649 card_id_show_attr(struct device *dev,
 650                   struct device_attribute *attr, char *buf)
 651 {
 652         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 653         return snprintf(buf, PAGE_SIZE, "%s\n", card->id);
 654 }
 655
 656 static ssize_t
 657 card_id_store_attr(struct device *dev, struct device_attribute *attr,
 658                    const char *buf, size_t count)
 659 {
 660         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 661         char buf1[sizeof(card->id)];
 662         size_t copy = count > sizeof(card->id) - 1 ?
 663                                         sizeof(card->id) - 1 : count;
 664         size_t idx;
 665         int c;
 666
 667         for (idx = 0; idx < copy; idx++) {
 668                 c = buf[idx];
 669                 if (!isalnum(c) && c != '_' && c != '-')
 670                         return -EINVAL;
 671         }
 672         memcpy(buf1, buf, copy);
 673         buf1[copy] = '\0';
 674         mutex_lock(&snd_card_mutex);
 675         if (!card_id_ok(NULL, buf1)) {
 676                 mutex_unlock(&snd_card_mutex);
 677                 return -EEXIST;
 678         }
 679         strcpy(card->id, buf1);
 680         snd_info_card_id_change(card);
 681         mutex_unlock(&snd_card_mutex);
 682
 683         return count;
 684 }
 685
 686 static DEVICE_ATTR(id, S_IRUGO | S_IWUSR, card_id_show_attr, card_id_store_attr);
 687
 688 static ssize_t
 689 card_number_show_attr(struct device *dev,
 690                      struct device_attribute *attr, char *buf)
 691 {
 692         struct snd_card *card = container_of(dev, struct snd_card, card_dev);
 693         return snprintf(buf, PAGE_SIZE, "%i\n", card->number);
 694 }
 695
 696 static DEVICE_ATTR(number, S_IRUGO, card_number_show_attr, NULL);
 697
 698 static struct attribute *card_dev_attrs[] = {
 699         &dev_attr_id.attr,
 700         &dev_attr_number.attr,
 701         NULL
 702 };
 703
 704 static const struct attribute_group card_dev_attr_group = {
 705         .attrs  = card_dev_attrs,
 706 };
 707
 708 /**
 709  * snd_card_add_dev_attr - Append a new sysfs attribute group to card
 710  * @card: card instance
 711  * @group: attribute group to append
 712  */
 713 int snd_card_add_dev_attr(struct snd_card *card,
 714                           const struct attribute_group *group)
 715 {
 716         int i;
 717
 718         /* loop for (arraysize-1) here to keep NULL at the last entry */
 719         for (i = 0; i < ARRAY_SIZE(card->dev_groups) - 1; i++) {
 720                 if (!card->dev_groups[i]) {
 721                         card->dev_groups[i] = group;
 722                         return 0;
 723                 }
 724         }
 725
 726         dev_err(card->dev, "Too many groups assigned\n");
 727         return -ENOSPC;
 728 };
 729 EXPORT_SYMBOL_GPL(snd_card_add_dev_attr);
 730
 731 /**
 732  *  snd_card_register - register the soundcard
 733  *  @card: soundcard structure
 734  *
 735  *  This function registers all the devices assigned to the soundcard.
 736  *  Until calling this, the ALSA control interface is blocked from the
 737  *  external accesses.  Thus, you should call this function at the end
 738  *  of the initialization of the card.
 739  *
 740  *  Return: Zero otherwise a negative error code if the registration failed.
 741  */
 742 int snd_card_register(struct snd_card *card)
 743 {
 744         int err;
 745
 746         if (snd_BUG_ON(!card))
 747                 return -EINVAL;
 748
 749         if (!card->registered) {
 750                 err = device_add(&card->card_dev);
 751                 if (err < 0)
 752                         return err;
 753                 card->registered = true;
 754         }
 755
 756         if ((err = snd_device_register_all(card)) < 0)
 757                 return err;
 758         mutex_lock(&snd_card_mutex);
 759         if (snd_cards[card->number]) {
 760                 /* already registered */
 761                 mutex_unlock(&snd_card_mutex);
 762                 return 0;
 763         }
 764         if (*card->id) {
 765                 /* make a unique id name from the given string */
 766                 char tmpid[sizeof(card->id)];
 767                 memcpy(tmpid, card->id, sizeof(card->id));
 768                 snd_card_set_id_no_lock(card, tmpid, tmpid);
 769         } else {
 770                 /* create an id from either shortname or longname */
 771                 const char *src;
 772                 src = *card->shortname ? card->shortname : card->longname;
 773                 snd_card_set_id_no_lock(card, src,
 774                                         retrieve_id_from_card_name(src));
 775         }
 776         snd_cards[card->number] = card;
 777         mutex_unlock(&snd_card_mutex);
 778         init_info_for_card(card);
 779 #if IS_ENABLED(CONFIG_SND_MIXER_OSS)
 780         if (snd_mixer_oss_notify_callback)
 781                 snd_mixer_oss_notify_callback(card, SND_MIXER_OSS_NOTIFY_REGISTER);
 782 #endif
 783         return 0;
 784 }
 785
 786 EXPORT_SYMBOL(snd_card_register);
 787
 788 #ifdef CONFIG_PROC_FS
 789 static struct snd_info_entry *snd_card_info_entry;
 790
 791 static void snd_card_info_read(struct snd_info_entry *entry,
 792                                struct snd_info_buffer *buffer)
 793 {
 794         int idx, count;
 795         struct snd_card *card;
 796
 797         for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
 798                 mutex_lock(&snd_card_mutex);
 799                 if ((card = snd_cards[idx]) != NULL) {
 800                         count++;
 801                         snd_iprintf(buffer, "%2i [%-15s]: %s - %s\n",
 802                                         idx,
 803                                         card->id,
 804                                         card->driver,
 805                                         card->shortname);
 806                         snd_iprintf(buffer, "                      %s\n",
 807                                         card->longname);
 808                 }
 809                 mutex_unlock(&snd_card_mutex);
 810         }
 811         if (!count)
 812                 snd_iprintf(buffer, "--- no soundcards ---\n");
 813 }
 814
 815 #ifdef CONFIG_SND_OSSEMUL
 816
 817 void snd_card_info_read_oss(struct snd_info_buffer *buffer)
 818 {
 819         int idx, count;
 820         struct snd_card *card;
 821
 822         for (idx = count = 0; idx < SNDRV_CARDS; idx++) {
 823                 mutex_lock(&snd_card_mutex);
 824                 if ((card = snd_cards[idx]) != NULL) {
 825                         count++;
 826                         snd_iprintf(buffer, "%s\n", card->longname);
 827                 }
 828                 mutex_unlock(&snd_card_mutex);
 829         }
 830         if (!count) {
 831                 snd_iprintf(buffer, "--- no soundcards ---\n");
 832         }
 833 }
 834
 835 #endif
 836
 837 #ifdef MODULE
 838 static struct snd_info_entry *snd_card_module_info_entry;
 839 static void snd_card_module_info_read(struct snd_info_entry *entry,
 840                                       struct snd_info_buffer *buffer)
 841 {
 842         int idx;
 843         struct snd_card *card;
 844
 845         for (idx = 0; idx < SNDRV_CARDS; idx++) {
 846                 mutex_lock(&snd_card_mutex);
 847                 if ((card = snd_cards[idx]) != NULL)
 848                         snd_iprintf(buffer, "%2i %s\n",
 849                                     idx, card->module->name);
 850                 mutex_unlock(&snd_card_mutex);
 851         }
 852 }
 853 #endif
 854
 855 int __init snd_card_info_init(void)
 856 {
 857         struct snd_info_entry *entry;
 858
 859         entry = snd_info_create_module_entry(THIS_MODULE, "cards", NULL);
 860         if (! entry)
 861                 return -ENOMEM;
 862         entry->c.text.read = snd_card_info_read;
 863         if (snd_info_register(entry) < 0) {
 864                 snd_info_free_entry(entry);
 865                 return -ENOMEM;
 866         }
 867         snd_card_info_entry = entry;
 868
 869 #ifdef MODULE
 870         entry = snd_info_create_module_entry(THIS_MODULE, "modules", NULL);
 871         if (entry) {
 872                 entry->c.text.read = snd_card_module_info_read;
 873                 if (snd_info_register(entry) < 0)
 874                         snd_info_free_entry(entry);
 875                 else
 876                         snd_card_module_info_entry = entry;
 877         }
 878 #endif
 879
 880         return 0;
 881 }
 882
 883 int __exit snd_card_info_done(void)
 884 {
 885         snd_info_free_entry(snd_card_info_entry);
 886 #ifdef MODULE
 887         snd_info_free_entry(snd_card_module_info_entry);
 888 #endif
 889         return 0;
 890 }
 891
 892 #endif /* CONFIG_PROC_FS */
 893
 894 /**
 895  *  snd_component_add - add a component string
 896  *  @card: soundcard structure
 897  *  @component: the component id string
 898  *
 899  *  This function adds the component id string to the supported list.
 900  *  The component can be referred from the alsa-lib.
 901  *
 902  *  Return: Zero otherwise a negative error code.
 903  */
 904
 905 int snd_component_add(struct snd_card *card, const char *component)
 906 {
 907         char *ptr;
 908         int len = strlen(component);
 909
 910         ptr = strstr(card->components, component);
 911         if (ptr != NULL) {
 912                 if (ptr[len] == '\0' || ptr[len] == ' ')        /* already there */
 913                         return 1;
 914         }
 915         if (strlen(card->components) + 1 + len + 1 > sizeof(card->components)) {
 916                 snd_BUG();
 917                 return -ENOMEM;
 918         }
 919         if (card->components[0] != '\0')
 920                 strcat(card->components, " ");
 921         strcat(card->components, component);
 922         return 0;
 923 }
 924
 925 EXPORT_SYMBOL(snd_component_add);
 926
 927 /**
 928  *  snd_card_file_add - add the file to the file list of the card
 929  *  @card: soundcard structure
 930  *  @file: file pointer
 931  *
 932  *  This function adds the file to the file linked-list of the card.
 933  *  This linked-list is used to keep tracking the connection state,
 934  *  and to avoid the release of busy resources by hotplug.
 935  *
 936  *  Return: zero or a negative error code.
 937  */
 938 int snd_card_file_add(struct snd_card *card, struct file *file)
 939 {
 940         struct snd_monitor_file *mfile;
 941
 942         mfile = kmalloc(sizeof(*mfile), GFP_KERNEL);
 943         if (mfile == NULL)
 944                 return -ENOMEM;
 945         mfile->file = file;
 946         mfile->disconnected_f_op = NULL;
 947         INIT_LIST_HEAD(&mfile->shutdown_list);
 948         spin_lock(&card->files_lock);
 949         if (card->shutdown) {
 950                 spin_unlock(&card->files_lock);
 951                 kfree(mfile);
 952                 return -ENODEV;
 953         }
 954         list_add(&mfile->list, &card->files_list);
 955         get_device(&card->card_dev);
 956         spin_unlock(&card->files_lock);
 957         return 0;
 958 }
 959
 960 EXPORT_SYMBOL(snd_card_file_add);
 961
 962 /**
 963  *  snd_card_file_remove - remove the file from the file list
 964  *  @card: soundcard structure
 965  *  @file: file pointer
 966  *
 967  *  This function removes the file formerly added to the card via
 968  *  snd_card_file_add() function.
 969  *  If all files are removed and snd_card_free_when_closed() was
 970  *  called beforehand, it processes the pending release of
 971  *  resources.
 972  *
 973  *  Return: Zero or a negative error code.
 974  */
 975 int snd_card_file_remove(struct snd_card *card, struct file *file)
 976 {
 977         struct snd_monitor_file *mfile, *found = NULL;
 978
 979         spin_lock(&card->files_lock);
 980         list_for_each_entry(mfile, &card->files_list, list) {
 981                 if (mfile->file == file) {
 982                         list_del(&mfile->list);
 983                         spin_lock(&shutdown_lock);
 984                         list_del(&mfile->shutdown_list);
 985                         spin_unlock(&shutdown_lock);
 986                         if (mfile->disconnected_f_op)
 987                                 fops_put(mfile->disconnected_f_op);
 988                         found = mfile;
 989                         break;
 990                 }
 991         }
 992         spin_unlock(&card->files_lock);
 993         if (!found) {
 994                 dev_err(card->dev, "card file remove problem (%p)\n", file);
 995                 return -ENOENT;
 996         }
 997         kfree(found);
 998         put_device(&card->card_dev);
 999         return 0;
1000 }
1001
1002 EXPORT_SYMBOL(snd_card_file_remove);
1003
1004 #ifdef CONFIG_PM
1005 /**
1006  *  snd_power_wait - wait until the power-state is changed.
1007  *  @card: soundcard structure
1008  *  @power_state: expected power state
1009  *
1010  *  Waits until the power-state is changed.
1011  *
1012  *  Return: Zero if successful, or a negative error code.
1013  *
1014  *  Note: the power lock must be active before call.
1015  */
1016 int snd_power_wait(struct snd_card *card, unsigned int power_state)
1017 {
1018         wait_queue_t wait;
1019         int result = 0;
1020
1021         /* fastpath */
1022         if (snd_power_get_state(card) == power_state)
1023                 return 0;
1024         init_waitqueue_entry(&wait, current);
1025         add_wait_queue(&card->power_sleep, &wait);
1026         while (1) {
1027                 if (card->shutdown) {
1028                         result = -ENODEV;
1029                         break;
1030                 }
1031                 if (snd_power_get_state(card) == power_state)
1032                         break;
1033                 set_current_state(TASK_UNINTERRUPTIBLE);
1034                 snd_power_unlock(card);
1035                 schedule_timeout(30 * HZ);
1036                 snd_power_lock(card);
1037         }
1038         remove_wait_queue(&card->power_sleep, &wait);
1039         return result;
1040 }
1041
1042 EXPORT_SYMBOL(snd_power_wait);
1043 #endif /* CONFIG_PM */