sound/core/init.c

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