LXR linux/include/sound/core.h

   1#ifndef __SOUND_CORE_H
   2#define __SOUND_CORE_H
   3
   4/*
   5 *  Main header file for the ALSA driver
   6 *  Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
   7 *
   8 *
   9 *   This program is free software; you can redistribute it and/or modify
  10 *   it under the terms of the GNU General Public License as published by
  11 *   the Free Software Foundation; either version 2 of the License, or
  12 *   (at your option) any later version.
  13 *
  14 *   This program is distributed in the hope that it will be useful,
  15 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 *   GNU General Public License for more details.
  18 *
  19 *   You should have received a copy of the GNU General Public License
  20 *   along with this program; if not, write to the Free Software
  21 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  22 *
  23 */
  24
  25#include <linux/module.h>
  26#include <linux/sched.h>                /* wake_up() */
  27#include <linux/mutex.h>                /* struct mutex */
  28#include <linux/rwsem.h>                /* struct rw_semaphore */
  29#include <linux/pm.h>                   /* pm_message_t */
  30#include <linux/device.h>
  31#include <linux/stringify.h>
  32
  33/* number of supported soundcards */
  34#ifdef CONFIG_SND_DYNAMIC_MINORS
  35#define SNDRV_CARDS 32
  36#else
  37#define SNDRV_CARDS 8           /* don't change - minor numbers */
  38#endif
  39
  40#define CONFIG_SND_MAJOR        116     /* standard configuration */
  41
  42/* forward declarations */
  43#ifdef CONFIG_PCI
  44struct pci_dev;
  45#endif
  46
  47/* device allocation stuff */
  48
  49#define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
  50
  51typedef int __bitwise snd_device_type_t;
  52#define SNDRV_DEV_TOPLEVEL      ((__force snd_device_type_t) 0)
  53#define SNDRV_DEV_CONTROL       ((__force snd_device_type_t) 1)
  54#define SNDRV_DEV_LOWLEVEL_PRE  ((__force snd_device_type_t) 2)
  55#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
  56#define SNDRV_DEV_PCM           ((__force snd_device_type_t) 0x1001)
  57#define SNDRV_DEV_RAWMIDI       ((__force snd_device_type_t) 0x1002)
  58#define SNDRV_DEV_TIMER         ((__force snd_device_type_t) 0x1003)
  59#define SNDRV_DEV_SEQUENCER     ((__force snd_device_type_t) 0x1004)
  60#define SNDRV_DEV_HWDEP         ((__force snd_device_type_t) 0x1005)
  61#define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
  62#define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
  63#define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
  64#define SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
  65#define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
  66
  67typedef int __bitwise snd_device_state_t;
  68#define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
  69#define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
  70#define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
  71
  72typedef int __bitwise snd_device_cmd_t;
  73#define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
  74#define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)  
  75#define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
  76
  77struct snd_device;
  78
  79struct snd_device_ops {
  80        int (*dev_free)(struct snd_device *dev);
  81        int (*dev_register)(struct snd_device *dev);
  82        int (*dev_disconnect)(struct snd_device *dev);
  83};
  84
  85struct snd_device {
  86        struct list_head list;          /* list of registered devices */
  87        struct snd_card *card;          /* card which holds this device */
  88        snd_device_state_t state;       /* state of the device */
  89        snd_device_type_t type;         /* device type */
  90        void *device_data;              /* device structure */
  91        struct snd_device_ops *ops;     /* operations */
  92};
  93
  94#define snd_device(n) list_entry(n, struct snd_device, list)
  95
  96/* main structure for soundcard */
  97
  98struct snd_card {
  99        int number;                     /* number of soundcard (index to
 100                                                                snd_cards) */
 101
 102        char id[16];                    /* id string of this card */
 103        char driver[16];                /* driver name */
 104        char shortname[32];             /* short name of this soundcard */
 105        char longname[80];              /* name of this soundcard */
 106        char mixername[80];             /* mixer name */
 107        char components[128];           /* card components delimited with
 108                                                                space */
 109        struct module *module;          /* top-level module */
 110
 111        void *private_data;             /* private data for soundcard */
 112        void (*private_free) (struct snd_card *card); /* callback for freeing of
 113                                                                private data */
 114        struct list_head devices;       /* devices */
 115
 116        unsigned int last_numid;        /* last used numeric ID */
 117        struct rw_semaphore controls_rwsem;     /* controls list lock */
 118        rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
 119        int controls_count;             /* count of all controls */
 120        int user_ctl_count;             /* count of all user controls */
 121        struct list_head controls;      /* all controls for this card */
 122        struct list_head ctl_files;     /* active control files */
 123
 124        struct snd_info_entry *proc_root;       /* root for soundcard specific files */
 125        struct snd_info_entry *proc_id; /* the card id */
 126        struct proc_dir_entry *proc_root_link;  /* number link to real id */
 127
 128        struct list_head files_list;    /* all files associated to this card */
 129        struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
 130                                                                state */
 131        spinlock_t files_lock;          /* lock the files for this card */
 132        int shutdown;                   /* this card is going down */
 133        int free_on_last_close;         /* free in context of file_release */
 134        wait_queue_head_t shutdown_sleep;
 135        struct device *dev;             /* device assigned to this card */
 136#ifndef CONFIG_SYSFS_DEPRECATED
 137        struct device *card_dev;        /* cardX object for sysfs */
 138#endif
 139
 140#ifdef CONFIG_PM
 141        unsigned int power_state;       /* power state */
 142        struct mutex power_lock;        /* power lock */
 143        wait_queue_head_t power_sleep;
 144#endif
 145
 146#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 147        struct snd_mixer_oss *mixer_oss;
 148        int mixer_oss_change_count;
 149#endif
 150};
 151
 152#ifdef CONFIG_PM
 153static inline void snd_power_lock(struct snd_card *card)
 154{
 155        mutex_lock(&card->power_lock);
 156}
 157
 158static inline void snd_power_unlock(struct snd_card *card)
 159{
 160        mutex_unlock(&card->power_lock);
 161}
 162
 163static inline unsigned int snd_power_get_state(struct snd_card *card)
 164{
 165        return card->power_state;
 166}
 167
 168static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 169{
 170        card->power_state = state;
 171        wake_up(&card->power_sleep);
 172}
 173
 174/* init.c */
 175int snd_power_wait(struct snd_card *card, unsigned int power_state);
 176
 177#else /* ! CONFIG_PM */
 178
 179#define snd_power_lock(card)            do { (void)(card); } while (0)
 180#define snd_power_unlock(card)          do { (void)(card); } while (0)
 181static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 182#define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
 183#define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 184
 185#endif /* CONFIG_PM */
 186
 187struct snd_minor {
 188        int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 189        int card;                       /* card number */
 190        int device;                     /* device number */
 191        const struct file_operations *f_ops;    /* file operations */
 192        void *private_data;             /* private data for f_ops->open */
 193        struct device *dev;             /* device for sysfs */
 194};
 195
 196/* return a device pointer linked to each sound device as a parent */
 197static inline struct device *snd_card_get_device_link(struct snd_card *card)
 198{
 199#ifdef CONFIG_SYSFS_DEPRECATED
 200        return card ? card->dev : NULL;
 201#else
 202        return card ? card->card_dev : NULL;
 203#endif
 204}
 205
 206/* sound.c */
 207
 208extern int snd_major;
 209extern int snd_ecards_limit;
 210extern struct class *sound_class;
 211
 212void snd_request_card(int card);
 213
 214int snd_register_device_for_dev(int type, struct snd_card *card,
 215                                int dev,
 216                                const struct file_operations *f_ops,
 217                                void *private_data,
 218                                const char *name,
 219                                struct device *device);
 220
 221/**
 222 * snd_register_device - Register the ALSA device file for the card
 223 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 224 * @card: the card instance
 225 * @dev: the device index
 226 * @f_ops: the file operations
 227 * @private_data: user pointer for f_ops->open()
 228 * @name: the device file name
 229 *
 230 * Registers an ALSA device file for the given card.
 231 * The operators have to be set in reg parameter.
 232 *
 233 * This function uses the card's device pointer to link to the
 234 * correct &struct device.
 235 *
 236 * Returns zero if successful, or a negative error code on failure.
 237 */
 238static inline int snd_register_device(int type, struct snd_card *card, int dev,
 239                                      const struct file_operations *f_ops,
 240                                      void *private_data,
 241                                      const char *name)
 242{
 243        return snd_register_device_for_dev(type, card, dev, f_ops,
 244                                           private_data, name,
 245                                           snd_card_get_device_link(card));
 246}
 247
 248int snd_unregister_device(int type, struct snd_card *card, int dev);
 249void *snd_lookup_minor_data(unsigned int minor, int type);
 250int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
 251                              struct device_attribute *attr);
 252
 253#ifdef CONFIG_SND_OSSEMUL
 254int snd_register_oss_device(int type, struct snd_card *card, int dev,
 255                            const struct file_operations *f_ops, void *private_data,
 256                            const char *name);
 257int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 258void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 259#endif
 260
 261int snd_minor_info_init(void);
 262int snd_minor_info_done(void);
 263
 264/* sound_oss.c */
 265
 266#ifdef CONFIG_SND_OSSEMUL
 267int snd_minor_info_oss_init(void);
 268int snd_minor_info_oss_done(void);
 269#else
 270static inline int snd_minor_info_oss_init(void) { return 0; }
 271static inline int snd_minor_info_oss_done(void) { return 0; }
 272#endif
 273
 274/* memory.c */
 275
 276int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 277int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 278
 279/* init.c */
 280
 281extern struct snd_card *snd_cards[SNDRV_CARDS];
 282int snd_card_locked(int card);
 283#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 284#define SND_MIXER_OSS_NOTIFY_REGISTER   0
 285#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 286#define SND_MIXER_OSS_NOTIFY_FREE       2
 287extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 288#endif
 289
 290int snd_card_create(int idx, const char *id,
 291                    struct module *module, int extra_size,
 292                    struct snd_card **card_ret);
 293
 294int snd_card_disconnect(struct snd_card *card);
 295int snd_card_free(struct snd_card *card);
 296int snd_card_free_when_closed(struct snd_card *card);
 297void snd_card_set_id(struct snd_card *card, const char *id);
 298int snd_card_register(struct snd_card *card);
 299int snd_card_info_init(void);
 300int snd_card_info_done(void);
 301int snd_component_add(struct snd_card *card, const char *component);
 302int snd_card_file_add(struct snd_card *card, struct file *file);
 303int snd_card_file_remove(struct snd_card *card, struct file *file);
 304
 305#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 306
 307/* device.c */
 308
 309int snd_device_new(struct snd_card *card, snd_device_type_t type,
 310                   void *device_data, struct snd_device_ops *ops);
 311int snd_device_register(struct snd_card *card, void *device_data);
 312int snd_device_register_all(struct snd_card *card);
 313int snd_device_disconnect(struct snd_card *card, void *device_data);
 314int snd_device_disconnect_all(struct snd_card *card);
 315int snd_device_free(struct snd_card *card, void *device_data);
 316int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
 317
 318/* isadma.c */
 319
 320#ifdef CONFIG_ISA_DMA_API
 321#define DMA_MODE_NO_ENABLE      0x0100
 322
 323void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 324void snd_dma_disable(unsigned long dma);
 325unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 326#endif
 327
 328/* misc.c */
 329struct resource;
 330void release_and_free_resource(struct resource *res);
 331
 332/* --- */
 333
 334#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 335void __snd_printk(unsigned int level, const char *file, int line,
 336                  const char *format, ...)
 337     __attribute__ ((format (printf, 4, 5)));
 338#else
 339#define __snd_printk(level, file, line, format, args...) \
 340        printk(format, ##args)
 341#endif
 342
 343/**
 344 * snd_printk - printk wrapper
 345 * @fmt: format string
 346 *
 347 * Works like printk() but prints the file and the line of the caller
 348 * when configured with CONFIG_SND_VERBOSE_PRINTK.
 349 */
 350#define snd_printk(fmt, args...) \
 351        __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
 352
 353#ifdef CONFIG_SND_DEBUG
 354/**
 355 * snd_printd - debug printk
 356 * @fmt: format string
 357 *
 358 * Works like snd_printk() for debugging purposes.
 359 * Ignored when CONFIG_SND_DEBUG is not set.
 360 */
 361#define snd_printd(fmt, args...) \
 362        __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
 363
 364/**
 365 * snd_BUG - give a BUG warning message and stack trace
 366 *
 367 * Calls WARN() if CONFIG_SND_DEBUG is set.
 368 * Ignored when CONFIG_SND_DEBUG is not set.
 369 */
 370#define snd_BUG()               WARN(1, "BUG?\n")
 371
 372/**
 373 * snd_BUG_ON - debugging check macro
 374 * @cond: condition to evaluate
 375 *
 376 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
 377 * and call WARN() and returns the value if it's non-zero.
 378 * 
 379 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
 380 * condition is ignored.
 381 *
 382 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
 383 * Thus, don't put any statement that influences on the code behavior,
 384 * such as pre/post increment, to the argument of this macro.
 385 * If you want to evaluate and give a warning, use standard WARN_ON().
 386 */
 387#define snd_BUG_ON(cond)        WARN((cond), "BUG? (%s)\n", __stringify(cond))
 388
 389#else /* !CONFIG_SND_DEBUG */
 390
 391#define snd_printd(fmt, args...)        do { } while (0)
 392#define snd_BUG()                       do { } while (0)
 393static inline int __snd_bug_on(int cond)
 394{
 395        return 0;
 396}
 397#define snd_BUG_ON(cond)        __snd_bug_on(0 && (cond))  /* always false */
 398
 399#endif /* CONFIG_SND_DEBUG */
 400
 401#ifdef CONFIG_SND_DEBUG_VERBOSE
 402/**
 403 * snd_printdd - debug printk
 404 * @format: format string
 405 *
 406 * Works like snd_printk() for debugging purposes.
 407 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 408 */
 409#define snd_printdd(format, args...) \
 410        __snd_printk(2, __FILE__, __LINE__, format, ##args)
 411#else
 412#define snd_printdd(format, args...)    do { } while (0)
 413#endif
 414
 415
 416#define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 417
 418/* for easier backward-porting */
 419#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
 420#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 421#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 422#define gameport_get_port_data(gp) (gp)->port_data
 423#endif
 424
 425/* PCI quirk list helper */
 426struct snd_pci_quirk {
 427        unsigned short subvendor;       /* PCI subvendor ID */
 428        unsigned short subdevice;       /* PCI subdevice ID */
 429        unsigned short subdevice_mask;  /* bitmask to match */
 430        int value;                      /* value */
 431#ifdef CONFIG_SND_DEBUG_VERBOSE
 432        const char *name;               /* name of the device (optional) */
 433#endif
 434};
 435
 436#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 437        .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 438#define _SND_PCI_QUIRK_ID(vend, dev) \
 439        _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 440#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 441#ifdef CONFIG_SND_DEBUG_VERBOSE
 442#define SND_PCI_QUIRK(vend,dev,xname,val) \
 443        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 444#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 445        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 446#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 447        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 448                        .value = (val), .name = (xname)}
 449#else
 450#define SND_PCI_QUIRK(vend,dev,xname,val) \
 451        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 452#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 453        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 454#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 455        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 456#endif
 457
 458const struct snd_pci_quirk *
 459snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 460
 461
 462#endif /* __SOUND_CORE_H */
 463