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