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/sched.h>                /* wake_up() */
  26#include <linux/mutex.h>                /* struct mutex */
  27#include <linux/rwsem.h>                /* struct rw_semaphore */
  28#include <linux/pm.h>                   /* pm_message_t */
  29#include <linux/stringify.h>
  30
  31/* number of supported soundcards */
  32#ifdef CONFIG_SND_DYNAMIC_MINORS
  33#define SNDRV_CARDS 32
  34#else
  35#define SNDRV_CARDS 8           /* don't change - minor numbers */
  36#endif
  37
  38#define CONFIG_SND_MAJOR        116     /* standard configuration */
  39
  40/* forward declarations */
  41struct pci_dev;
  42struct module;
  43struct device;
  44struct device_attribute;
  45
  46/* device allocation stuff */
  47
  48#define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
  49
  50typedef int __bitwise snd_device_type_t;
  51#define SNDRV_DEV_TOPLEVEL      ((__force snd_device_type_t) 0)
  52#define SNDRV_DEV_CONTROL       ((__force snd_device_type_t) 1)
  53#define SNDRV_DEV_LOWLEVEL_PRE  ((__force snd_device_type_t) 2)
  54#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
  55#define SNDRV_DEV_PCM           ((__force snd_device_type_t) 0x1001)
  56#define SNDRV_DEV_RAWMIDI       ((__force snd_device_type_t) 0x1002)
  57#define SNDRV_DEV_TIMER         ((__force snd_device_type_t) 0x1003)
  58#define SNDRV_DEV_SEQUENCER     ((__force snd_device_type_t) 0x1004)
  59#define SNDRV_DEV_HWDEP         ((__force snd_device_type_t) 0x1005)
  60#define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
  61#define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
  62#define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
  63#define SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
  64#define SNDRV_DEV_COMPRESS      ((__force snd_device_type_t) 0x100A)
  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        struct device *card_dev;        /* cardX object for sysfs */
 137
 138#ifdef CONFIG_PM
 139        unsigned int power_state;       /* power state */
 140        struct mutex power_lock;        /* power lock */
 141        wait_queue_head_t power_sleep;
 142#endif
 143
 144#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 145        struct snd_mixer_oss *mixer_oss;
 146        int mixer_oss_change_count;
 147#endif
 148};
 149
 150#ifdef CONFIG_PM
 151static inline void snd_power_lock(struct snd_card *card)
 152{
 153        mutex_lock(&card->power_lock);
 154}
 155
 156static inline void snd_power_unlock(struct snd_card *card)
 157{
 158        mutex_unlock(&card->power_lock);
 159}
 160
 161static inline unsigned int snd_power_get_state(struct snd_card *card)
 162{
 163        return card->power_state;
 164}
 165
 166static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 167{
 168        card->power_state = state;
 169        wake_up(&card->power_sleep);
 170}
 171
 172/* init.c */
 173int snd_power_wait(struct snd_card *card, unsigned int power_state);
 174
 175#else /* ! CONFIG_PM */
 176
 177#define snd_power_lock(card)            do { (void)(card); } while (0)
 178#define snd_power_unlock(card)          do { (void)(card); } while (0)
 179static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 180#define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
 181#define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 182
 183#endif /* CONFIG_PM */
 184
 185struct snd_minor {
 186        int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 187        int card;                       /* card number */
 188        int device;                     /* device number */
 189        const struct file_operations *f_ops;    /* file operations */
 190        void *private_data;             /* private data for f_ops->open */
 191        struct device *dev;             /* device for sysfs */
 192};
 193
 194/* return a device pointer linked to each sound device as a parent */
 195static inline struct device *snd_card_get_device_link(struct snd_card *card)
 196{
 197        return card ? card->card_dev : NULL;
 198}
 199
 200/* sound.c */
 201
 202extern int snd_major;
 203extern int snd_ecards_limit;
 204extern struct class *sound_class;
 205
 206void snd_request_card(int card);
 207
 208int snd_register_device_for_dev(int type, struct snd_card *card,
 209                                int dev,
 210                                const struct file_operations *f_ops,
 211                                void *private_data,
 212                                const char *name,
 213                                struct device *device);
 214
 215/**
 216 * snd_register_device - Register the ALSA device file for the card
 217 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 218 * @card: the card instance
 219 * @dev: the device index
 220 * @f_ops: the file operations
 221 * @private_data: user pointer for f_ops->open()
 222 * @name: the device file name
 223 *
 224 * Registers an ALSA device file for the given card.
 225 * The operators have to be set in reg parameter.
 226 *
 227 * This function uses the card's device pointer to link to the
 228 * correct &struct device.
 229 *
 230 * Returns zero if successful, or a negative error code on failure.
 231 */
 232static inline int snd_register_device(int type, struct snd_card *card, int dev,
 233                                      const struct file_operations *f_ops,
 234                                      void *private_data,
 235                                      const char *name)
 236{
 237        return snd_register_device_for_dev(type, card, dev, f_ops,
 238                                           private_data, name,
 239                                           snd_card_get_device_link(card));
 240}
 241
 242int snd_unregister_device(int type, struct snd_card *card, int dev);
 243void *snd_lookup_minor_data(unsigned int minor, int type);
 244int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
 245                              struct device_attribute *attr);
 246
 247#ifdef CONFIG_SND_OSSEMUL
 248int snd_register_oss_device(int type, struct snd_card *card, int dev,
 249                            const struct file_operations *f_ops, void *private_data,
 250                            const char *name);
 251int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 252void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 253#endif
 254
 255int snd_minor_info_init(void);
 256int snd_minor_info_done(void);
 257
 258/* sound_oss.c */
 259
 260#ifdef CONFIG_SND_OSSEMUL
 261int snd_minor_info_oss_init(void);
 262int snd_minor_info_oss_done(void);
 263#else
 264static inline int snd_minor_info_oss_init(void) { return 0; }
 265static inline int snd_minor_info_oss_done(void) { return 0; }
 266#endif
 267
 268/* memory.c */
 269
 270int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 271int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 272
 273/* init.c */
 274
 275extern struct snd_card *snd_cards[SNDRV_CARDS];
 276int snd_card_locked(int card);
 277#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 278#define SND_MIXER_OSS_NOTIFY_REGISTER   0
 279#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 280#define SND_MIXER_OSS_NOTIFY_FREE       2
 281extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 282#endif
 283
 284int snd_card_create(int idx, const char *id,
 285                    struct module *module, int extra_size,
 286                    struct snd_card **card_ret);
 287
 288int snd_card_disconnect(struct snd_card *card);
 289int snd_card_free(struct snd_card *card);
 290int snd_card_free_when_closed(struct snd_card *card);
 291void snd_card_set_id(struct snd_card *card, const char *id);
 292int snd_card_register(struct snd_card *card);
 293int snd_card_info_init(void);
 294int snd_card_info_done(void);
 295int snd_component_add(struct snd_card *card, const char *component);
 296int snd_card_file_add(struct snd_card *card, struct file *file);
 297int snd_card_file_remove(struct snd_card *card, struct file *file);
 298
 299#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 300
 301/* device.c */
 302
 303int snd_device_new(struct snd_card *card, snd_device_type_t type,
 304                   void *device_data, struct snd_device_ops *ops);
 305int snd_device_register(struct snd_card *card, void *device_data);
 306int snd_device_register_all(struct snd_card *card);
 307int snd_device_disconnect(struct snd_card *card, void *device_data);
 308int snd_device_disconnect_all(struct snd_card *card);
 309int snd_device_free(struct snd_card *card, void *device_data);
 310int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
 311
 312/* isadma.c */
 313
 314#ifdef CONFIG_ISA_DMA_API
 315#define DMA_MODE_NO_ENABLE      0x0100
 316
 317void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 318void snd_dma_disable(unsigned long dma);
 319unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 320#endif
 321
 322/* misc.c */
 323struct resource;
 324void release_and_free_resource(struct resource *res);
 325
 326/* --- */
 327
 328/* sound printk debug levels */
 329enum {
 330        SND_PR_ALWAYS,
 331        SND_PR_DEBUG,
 332        SND_PR_VERBOSE,
 333};
 334
 335#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
 336__printf(4, 5)
 337void __snd_printk(unsigned int level, const char *file, int line,
 338                  const char *format, ...);
 339#else
 340#define __snd_printk(level, file, line, format, args...) \
 341        printk(format, ##args)
 342#endif
 343
 344/**
 345 * snd_printk - printk wrapper
 346 * @fmt: format string
 347 *
 348 * Works like printk() but prints the file and the line of the caller
 349 * when configured with CONFIG_SND_VERBOSE_PRINTK.
 350 */
 351#define snd_printk(fmt, args...) \
 352        __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
 353
 354#ifdef CONFIG_SND_DEBUG
 355/**
 356 * snd_printd - debug printk
 357 * @fmt: format string
 358 *
 359 * Works like snd_printk() for debugging purposes.
 360 * Ignored when CONFIG_SND_DEBUG is not set.
 361 */
 362#define snd_printd(fmt, args...) \
 363        __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
 364#define _snd_printd(level, fmt, args...) \
 365        __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
 366
 367/**
 368 * snd_BUG - give a BUG warning message and stack trace
 369 *
 370 * Calls WARN() if CONFIG_SND_DEBUG is set.
 371 * Ignored when CONFIG_SND_DEBUG is not set.
 372 */
 373#define snd_BUG()               WARN(1, "BUG?\n")
 374
 375/**
 376 * snd_BUG_ON - debugging check macro
 377 * @cond: condition to evaluate
 378 *
 379 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
 380 * and call WARN() and returns the value if it's non-zero.
 381 * 
 382 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
 383 * condition is ignored.
 384 *
 385 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
 386 * Thus, don't put any statement that influences on the code behavior,
 387 * such as pre/post increment, to the argument of this macro.
 388 * If you want to evaluate and give a warning, use standard WARN_ON().
 389 */
 390#define snd_BUG_ON(cond)        WARN((cond), "BUG? (%s)\n", __stringify(cond))
 391
 392#else /* !CONFIG_SND_DEBUG */
 393
 394#define snd_printd(fmt, args...)        do { } while (0)
 395#define _snd_printd(level, fmt, args...) do { } while (0)
 396#define snd_BUG()                       do { } while (0)
 397static inline int __snd_bug_on(int cond)
 398{
 399        return 0;
 400}
 401#define snd_BUG_ON(cond)        __snd_bug_on(0 && (cond))  /* always false */
 402
 403#endif /* CONFIG_SND_DEBUG */
 404
 405#ifdef CONFIG_SND_DEBUG_VERBOSE
 406/**
 407 * snd_printdd - debug printk
 408 * @format: format string
 409 *
 410 * Works like snd_printk() for debugging purposes.
 411 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 412 */
 413#define snd_printdd(format, args...) \
 414        __snd_printk(2, __FILE__, __LINE__, format, ##args)
 415#else
 416#define snd_printdd(format, args...)    do { } while (0)
 417#endif
 418
 419
 420#define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 421
 422/* for easier backward-porting */
 423#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
 424#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 425#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 426#define gameport_get_port_data(gp) (gp)->port_data
 427#endif
 428
 429#ifdef CONFIG_PCI
 430/* PCI quirk list helper */
 431struct snd_pci_quirk {
 432        unsigned short subvendor;       /* PCI subvendor ID */
 433        unsigned short subdevice;       /* PCI subdevice ID */
 434        unsigned short subdevice_mask;  /* bitmask to match */
 435        int value;                      /* value */
 436#ifdef CONFIG_SND_DEBUG_VERBOSE
 437        const char *name;               /* name of the device (optional) */
 438#endif
 439};
 440
 441#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
 442        .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
 443#define _SND_PCI_QUIRK_ID(vend, dev) \
 444        _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
 445#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 446#ifdef CONFIG_SND_DEBUG_VERBOSE
 447#define SND_PCI_QUIRK(vend,dev,xname,val) \
 448        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 449#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 450        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
 451#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 452        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
 453                        .value = (val), .name = (xname)}
 454#else
 455#define SND_PCI_QUIRK(vend,dev,xname,val) \
 456        {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 457#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
 458        {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
 459#define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
 460        {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
 461#endif
 462
 463const struct snd_pci_quirk *
 464snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 465
 466const struct snd_pci_quirk *
 467snd_pci_quirk_lookup_id(u16 vendor, u16 device,
 468                        const struct snd_pci_quirk *list);
 469#endif
 470
 471#endif /* __SOUND_CORE_H */
 472