sound/core/sound.c

   1 /*
   2  *  Advanced Linux Sound Architecture
   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/slab.h>
  24 #include <linux/smp_lock.h>
  25 #include <linux/time.h>
  26 #include <linux/device.h>
  27 #include <linux/moduleparam.h>
  28 #include <sound/core.h>
  29 #include <sound/minors.h>
  30 #include <sound/info.h>
  31 #include <sound/version.h>
  32 #include <sound/control.h>
  33 #include <sound/initval.h>
  34 #include <linux/kmod.h>
  35 #include <linux/mutex.h>
  36
  37 static int major = CONFIG_SND_MAJOR;
  38 int snd_major;
  39 EXPORT_SYMBOL(snd_major);
  40
  41 static int cards_limit = 1;
  42
  43 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
  44 MODULE_DESCRIPTION("Advanced Linux Sound Architecture driver for soundcards.");
  45 MODULE_LICENSE("GPL");
  46 module_param(major, int, 0444);
  47 MODULE_PARM_DESC(major, "Major # for sound driver.");
  48 module_param(cards_limit, int, 0444);
  49 MODULE_PARM_DESC(cards_limit, "Count of auto-loadable soundcards.");
  50 MODULE_ALIAS_CHARDEV_MAJOR(CONFIG_SND_MAJOR);
  51
  52 /* this one holds the actual max. card number currently available.
  53  * as default, it's identical with cards_limit option.  when more
  54  * modules are loaded manually, this limit number increases, too.
  55  */
  56 int snd_ecards_limit;
  57 EXPORT_SYMBOL(snd_ecards_limit);
  58
  59 static struct snd_minor *snd_minors[SNDRV_OS_MINORS];
  60 static DEFINE_MUTEX(sound_mutex);
  61
  62 #ifdef CONFIG_MODULES
  63
  64 /**
  65  * snd_request_card - try to load the card module
  66  * @card: the card number
  67  *
  68  * Tries to load the module "snd-card-X" for the given card number
  69  * via request_module.  Returns immediately if already loaded.
  70  */
  71 void snd_request_card(int card)
  72 {
  73         if (snd_card_locked(card))
  74                 return;
  75         if (card < 0 || card >= cards_limit)
  76                 return;
  77         request_module("snd-card-%i", card);
  78 }
  79
  80 EXPORT_SYMBOL(snd_request_card);
  81
  82 static void snd_request_other(int minor)
  83 {
  84         char *str;
  85
  86         switch (minor) {
  87         case SNDRV_MINOR_SEQUENCER:     str = "snd-seq";        break;
  88         case SNDRV_MINOR_TIMER:         str = "snd-timer";      break;
  89         default:                        return;
  90         }
  91         request_module(str);
  92 }
  93
  94 #endif  /* modular kernel */
  95
  96 /**
  97  * snd_lookup_minor_data - get user data of a registered device
  98  * @minor: the minor number
  99  * @type: device type (SNDRV_DEVICE_TYPE_XXX)
 100  *
 101  * Checks that a minor device with the specified type is registered, and returns
 102  * its user data pointer.
 103  */
 104 void *snd_lookup_minor_data(unsigned int minor, int type)
 105 {
 106         struct snd_minor *mreg;
 107         void *private_data;
 108
 109         if (minor >= ARRAY_SIZE(snd_minors))
 110                 return NULL;
 111         mutex_lock(&sound_mutex);
 112         mreg = snd_minors[minor];
 113         if (mreg && mreg->type == type)
 114                 private_data = mreg->private_data;
 115         else
 116                 private_data = NULL;
 117         mutex_unlock(&sound_mutex);
 118         return private_data;
 119 }
 120
 121 EXPORT_SYMBOL(snd_lookup_minor_data);
 122
 123 static int __snd_open(struct inode *inode, struct file *file)
 124 {
 125         unsigned int minor = iminor(inode);
 126         struct snd_minor *mptr = NULL;
 127         const struct file_operations *old_fops;
 128         int err = 0;
 129
 130         if (minor >= ARRAY_SIZE(snd_minors))
 131                 return -ENODEV;
 132         mptr = snd_minors[minor];
 133         if (mptr == NULL) {
 134 #ifdef CONFIG_MODULES
 135                 int dev = SNDRV_MINOR_DEVICE(minor);
 136                 if (dev == SNDRV_MINOR_CONTROL) {
 137                         /* /dev/aloadC? */
 138                         int card = SNDRV_MINOR_CARD(minor);
 139                         if (snd_cards[card] == NULL)
 140                                 snd_request_card(card);
 141                 } else if (dev == SNDRV_MINOR_GLOBAL) {
 142                         /* /dev/aloadSEQ */
 143                         snd_request_other(minor);
 144                 }
 145 #ifndef CONFIG_SND_DYNAMIC_MINORS
 146                 /* /dev/snd/{controlC?,seq} */
 147                 mptr = snd_minors[minor];
 148                 if (mptr == NULL)
 149 #endif
 150 #endif
 151                         return -ENODEV;
 152         }
 153         old_fops = file->f_op;
 154         file->f_op = fops_get(mptr->f_ops);
 155         if (file->f_op->open)
 156                 err = file->f_op->open(inode, file);
 157         if (err) {
 158                 fops_put(file->f_op);
 159                 file->f_op = fops_get(old_fops);
 160         }
 161         fops_put(old_fops);
 162         return err;
 163 }
 164
 165
 166 /* BKL pushdown: nasty #ifdef avoidance wrapper */
 167 static int snd_open(struct inode *inode, struct file *file)
 168 {
 169         int ret;
 170
 171         lock_kernel();
 172         ret = __snd_open(inode, file);
 173         unlock_kernel();
 174         return ret;
 175 }
 176
 177 static const struct file_operations snd_fops =
 178 {
 179         .owner =        THIS_MODULE,
 180         .open =         snd_open
 181 };
 182
 183 #ifdef CONFIG_SND_DYNAMIC_MINORS
 184 static int snd_find_free_minor(void)
 185 {
 186         int minor;
 187
 188         for (minor = 0; minor < ARRAY_SIZE(snd_minors); ++minor) {
 189                 /* skip minors still used statically for autoloading devices */
 190                 if (SNDRV_MINOR_DEVICE(minor) == SNDRV_MINOR_CONTROL ||
 191                     minor == SNDRV_MINOR_SEQUENCER)
 192                         continue;
 193                 if (!snd_minors[minor])
 194                         return minor;
 195         }
 196         return -EBUSY;
 197 }
 198 #else
 199 static int snd_kernel_minor(int type, struct snd_card *card, int dev)
 200 {
 201         int minor;
 202
 203         switch (type) {
 204         case SNDRV_DEVICE_TYPE_SEQUENCER:
 205         case SNDRV_DEVICE_TYPE_TIMER:
 206                 minor = type;
 207                 break;
 208         case SNDRV_DEVICE_TYPE_CONTROL:
 209                 snd_assert(card != NULL, return -EINVAL);
 210                 minor = SNDRV_MINOR(card->number, type);
 211                 break;
 212         case SNDRV_DEVICE_TYPE_HWDEP:
 213         case SNDRV_DEVICE_TYPE_RAWMIDI:
 214         case SNDRV_DEVICE_TYPE_PCM_PLAYBACK:
 215         case SNDRV_DEVICE_TYPE_PCM_CAPTURE:
 216                 snd_assert(card != NULL, return -EINVAL);
 217                 minor = SNDRV_MINOR(card->number, type + dev);
 218                 break;
 219         default:
 220                 return -EINVAL;
 221         }
 222         snd_assert(minor >= 0 && minor < SNDRV_OS_MINORS, return -EINVAL);
 223         return minor;
 224 }
 225 #endif
 226
 227 /**
 228  * snd_register_device_for_dev - Register the ALSA device file for the card
 229  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 230  * @card: the card instance
 231  * @dev: the device index
 232  * @f_ops: the file operations
 233  * @private_data: user pointer for f_ops->open()
 234  * @name: the device file name
 235  * @device: the &struct device to link this new device to
 236  *
 237  * Registers an ALSA device file for the given card.
 238  * The operators have to be set in reg parameter.
 239  *
 240  * Returns zero if successful, or a negative error code on failure.
 241  */
 242 int snd_register_device_for_dev(int type, struct snd_card *card, int dev,
 243                                 const struct file_operations *f_ops,
 244                                 void *private_data,
 245                                 const char *name, struct device *device)
 246 {
 247         int minor;
 248         struct snd_minor *preg;
 249
 250         snd_assert(name, return -EINVAL);
 251         preg = kmalloc(sizeof *preg, GFP_KERNEL);
 252         if (preg == NULL)
 253                 return -ENOMEM;
 254         preg->type = type;
 255         preg->card = card ? card->number : -1;
 256         preg->device = dev;
 257         preg->f_ops = f_ops;
 258         preg->private_data = private_data;
 259         mutex_lock(&sound_mutex);
 260 #ifdef CONFIG_SND_DYNAMIC_MINORS
 261         minor = snd_find_free_minor();
 262 #else
 263         minor = snd_kernel_minor(type, card, dev);
 264         if (minor >= 0 && snd_minors[minor])
 265                 minor = -EBUSY;
 266 #endif
 267         if (minor < 0) {
 268                 mutex_unlock(&sound_mutex);
 269                 kfree(preg);
 270                 return minor;
 271         }
 272         snd_minors[minor] = preg;
 273         preg->dev = device_create_drvdata(sound_class, device,
 274                                           MKDEV(major, minor),
 275                                           private_data, "%s", name);
 276         if (IS_ERR(preg->dev)) {
 277                 snd_minors[minor] = NULL;
 278                 mutex_unlock(&sound_mutex);
 279                 minor = PTR_ERR(preg->dev);
 280                 kfree(preg);
 281                 return minor;
 282         }
 283
 284         mutex_unlock(&sound_mutex);
 285         return 0;
 286 }
 287
 288 EXPORT_SYMBOL(snd_register_device_for_dev);
 289
 290 /* find the matching minor record
 291  * return the index of snd_minor, or -1 if not found
 292  */
 293 static int find_snd_minor(int type, struct snd_card *card, int dev)
 294 {
 295         int cardnum, minor;
 296         struct snd_minor *mptr;
 297
 298         cardnum = card ? card->number : -1;
 299         for (minor = 0; minor < ARRAY_SIZE(snd_minors); ++minor)
 300                 if ((mptr = snd_minors[minor]) != NULL &&
 301                     mptr->type == type &&
 302                     mptr->card == cardnum &&
 303                     mptr->device == dev)
 304                         return minor;
 305         return -1;
 306 }
 307
 308 /**
 309  * snd_unregister_device - unregister the device on the given card
 310  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 311  * @card: the card instance
 312  * @dev: the device index
 313  *
 314  * Unregisters the device file already registered via
 315  * snd_register_device().
 316  *
 317  * Returns zero if sucecessful, or a negative error code on failure
 318  */
 319 int snd_unregister_device(int type, struct snd_card *card, int dev)
 320 {
 321         int minor;
 322
 323         mutex_lock(&sound_mutex);
 324         minor = find_snd_minor(type, card, dev);
 325         if (minor < 0) {
 326                 mutex_unlock(&sound_mutex);
 327                 return -EINVAL;
 328         }
 329
 330         device_destroy(sound_class, MKDEV(major, minor));
 331
 332         kfree(snd_minors[minor]);
 333         snd_minors[minor] = NULL;
 334         mutex_unlock(&sound_mutex);
 335         return 0;
 336 }
 337
 338 EXPORT_SYMBOL(snd_unregister_device);
 339
 340 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
 341                               struct device_attribute *attr)
 342 {
 343         int minor, ret = -EINVAL;
 344         struct device *d;
 345
 346         mutex_lock(&sound_mutex);
 347         minor = find_snd_minor(type, card, dev);
 348         if (minor >= 0 && (d = snd_minors[minor]->dev) != NULL)
 349                 ret = device_create_file(d, attr);
 350         mutex_unlock(&sound_mutex);
 351         return ret;
 352
 353 }
 354
 355 EXPORT_SYMBOL(snd_add_device_sysfs_file);
 356
 357 #ifdef CONFIG_PROC_FS
 358 /*
 359  *  INFO PART
 360  */
 361
 362 static struct snd_info_entry *snd_minor_info_entry;
 363
 364 static const char *snd_device_type_name(int type)
 365 {
 366         switch (type) {
 367         case SNDRV_DEVICE_TYPE_CONTROL:
 368                 return "control";
 369         case SNDRV_DEVICE_TYPE_HWDEP:
 370                 return "hardware dependent";
 371         case SNDRV_DEVICE_TYPE_RAWMIDI:
 372                 return "raw midi";
 373         case SNDRV_DEVICE_TYPE_PCM_PLAYBACK:
 374                 return "digital audio playback";
 375         case SNDRV_DEVICE_TYPE_PCM_CAPTURE:
 376                 return "digital audio capture";
 377         case SNDRV_DEVICE_TYPE_SEQUENCER:
 378                 return "sequencer";
 379         case SNDRV_DEVICE_TYPE_TIMER:
 380                 return "timer";
 381         default:
 382                 return "?";
 383         }
 384 }
 385
 386 static void snd_minor_info_read(struct snd_info_entry *entry, struct snd_info_buffer *buffer)
 387 {
 388         int minor;
 389         struct snd_minor *mptr;
 390
 391         mutex_lock(&sound_mutex);
 392         for (minor = 0; minor < SNDRV_OS_MINORS; ++minor) {
 393                 if (!(mptr = snd_minors[minor]))
 394                         continue;
 395                 if (mptr->card >= 0) {
 396                         if (mptr->device >= 0)
 397                                 snd_iprintf(buffer, "%3i: [%2i-%2i]: %s\n",
 398                                             minor, mptr->card, mptr->device,
 399                                             snd_device_type_name(mptr->type));
 400                         else
 401                                 snd_iprintf(buffer, "%3i: [%2i]   : %s\n",
 402                                             minor, mptr->card,
 403                                             snd_device_type_name(mptr->type));
 404                 } else
 405                         snd_iprintf(buffer, "%3i:        : %s\n", minor,
 406                                     snd_device_type_name(mptr->type));
 407         }
 408         mutex_unlock(&sound_mutex);
 409 }
 410
 411 int __init snd_minor_info_init(void)
 412 {
 413         struct snd_info_entry *entry;
 414
 415         entry = snd_info_create_module_entry(THIS_MODULE, "devices", NULL);
 416         if (entry) {
 417                 entry->c.text.read = snd_minor_info_read;
 418                 if (snd_info_register(entry) < 0) {
 419                         snd_info_free_entry(entry);
 420                         entry = NULL;
 421                 }
 422         }
 423         snd_minor_info_entry = entry;
 424         return 0;
 425 }
 426
 427 int __exit snd_minor_info_done(void)
 428 {
 429         snd_info_free_entry(snd_minor_info_entry);
 430         return 0;
 431 }
 432 #endif /* CONFIG_PROC_FS */
 433
 434 /*
 435  *  INIT PART
 436  */
 437
 438 static int __init alsa_sound_init(void)
 439 {
 440         snd_major = major;
 441         snd_ecards_limit = cards_limit;
 442         if (register_chrdev(major, "alsa", &snd_fops)) {
 443                 snd_printk(KERN_ERR "unable to register native major device number %d\n", major);
 444                 return -EIO;
 445         }
 446         if (snd_info_init() < 0) {
 447                 unregister_chrdev(major, "alsa");
 448                 return -ENOMEM;
 449         }
 450         snd_info_minor_register();
 451 #ifndef MODULE
 452         printk(KERN_INFO "Advanced Linux Sound Architecture Driver Version " CONFIG_SND_VERSION CONFIG_SND_DATE ".\n");
 453 #endif
 454         return 0;
 455 }
 456
 457 static void __exit alsa_sound_exit(void)
 458 {
 459         snd_info_minor_unregister();
 460         snd_info_done();
 461         unregister_chrdev(major, "alsa");
 462 }
 463
 464 module_init(alsa_sound_init)
 465 module_exit(alsa_sound_exit)