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