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