git.oblomov.eu Git - linux-2.6/blob - 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
  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
  46 /* device allocation stuff */
  47
  48 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
  49
  50 typedef 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_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
  64
  65 typedef int __bitwise snd_device_state_t;
  66 #define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
  67 #define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
  68 #define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
  69
  70 typedef int __bitwise snd_device_cmd_t;
  71 #define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
  72 #define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)
  73 #define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
  74
  75 struct snd_device;
  76
  77 struct snd_device_ops {
  78         int (*dev_free)(struct snd_device *dev);
  79         int (*dev_register)(struct snd_device *dev);
  80         int (*dev_disconnect)(struct snd_device *dev);
  81 };
  82
  83 struct snd_device {
  84         struct list_head list;          /* list of registered devices */
  85         struct snd_card *card;          /* card which holds this device */
  86         snd_device_state_t state;       /* state of the device */
  87         snd_device_type_t type;         /* device type */
  88         void *device_data;              /* device structure */
  89         struct snd_device_ops *ops;     /* operations */
  90 };
  91
  92 #define snd_device(n) list_entry(n, struct snd_device, list)
  93
  94 /* monitor files for graceful shutdown (hotplug) */
  95
  96 struct snd_monitor_file {
  97         struct file *file;
  98         struct snd_monitor_file *next;
  99         const struct file_operations *disconnected_f_op;
 100         struct list_head shutdown_list;
 101 };
 102
 103 /* main structure for soundcard */
 104
 105 struct snd_card {
 106         int number;                     /* number of soundcard (index to
 107                                                                 snd_cards) */
 108
 109         char id[16];                    /* id string of this card */
 110         char driver[16];                /* driver name */
 111         char shortname[32];             /* short name of this soundcard */
 112         char longname[80];              /* name of this soundcard */
 113         char mixername[80];             /* mixer name */
 114         char components[80];            /* card components delimited with
 115                                                                 space */
 116         struct module *module;          /* top-level module */
 117
 118         void *private_data;             /* private data for soundcard */
 119         void (*private_free) (struct snd_card *card); /* callback for freeing of
 120                                                                 private data */
 121         struct list_head devices;       /* devices */
 122
 123         unsigned int last_numid;        /* last used numeric ID */
 124         struct rw_semaphore controls_rwsem;     /* controls list lock */
 125         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
 126         int controls_count;             /* count of all controls */
 127         int user_ctl_count;             /* count of all user controls */
 128         struct list_head controls;      /* all controls for this card */
 129         struct list_head ctl_files;     /* active control files */
 130
 131         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
 132         struct snd_info_entry *proc_id; /* the card id */
 133         struct proc_dir_entry *proc_root_link;  /* number link to real id */
 134
 135         struct snd_monitor_file *files; /* all files associated to this card */
 136         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
 137                                                                 state */
 138         spinlock_t files_lock;          /* lock the files for this card */
 139         int shutdown;                   /* this card is going down */
 140         int free_on_last_close;         /* free in context of file_release */
 141         wait_queue_head_t shutdown_sleep;
 142         struct device *dev;             /* device assigned to this card */
 143 #ifndef CONFIG_SYSFS_DEPRECATED
 144         struct device *card_dev;        /* cardX object for sysfs */
 145 #endif
 146
 147 #ifdef CONFIG_PM
 148         unsigned int power_state;       /* power state */
 149         struct mutex power_lock;        /* power lock */
 150         wait_queue_head_t power_sleep;
 151 #endif
 152
 153 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 154         struct snd_mixer_oss *mixer_oss;
 155         int mixer_oss_change_count;
 156 #endif
 157 };
 158
 159 #ifdef CONFIG_PM
 160 static inline void snd_power_lock(struct snd_card *card)
 161 {
 162         mutex_lock(&card->power_lock);
 163 }
 164
 165 static inline void snd_power_unlock(struct snd_card *card)
 166 {
 167         mutex_unlock(&card->power_lock);
 168 }
 169
 170 static inline unsigned int snd_power_get_state(struct snd_card *card)
 171 {
 172         return card->power_state;
 173 }
 174
 175 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 176 {
 177         card->power_state = state;
 178         wake_up(&card->power_sleep);
 179 }
 180
 181 /* init.c */
 182 int snd_power_wait(struct snd_card *card, unsigned int power_state);
 183
 184 #else /* ! CONFIG_PM */
 185
 186 #define snd_power_lock(card)            do { (void)(card); } while (0)
 187 #define snd_power_unlock(card)          do { (void)(card); } while (0)
 188 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
 189 #define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
 190 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 191
 192 #endif /* CONFIG_PM */
 193
 194 struct snd_minor {
 195         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 196         int card;                       /* card number */
 197         int device;                     /* device number */
 198         const struct file_operations *f_ops;    /* file operations */
 199         void *private_data;             /* private data for f_ops->open */
 200         struct device *dev;             /* device for sysfs */
 201 };
 202
 203 /* return a device pointer linked to each sound device as a parent */
 204 static inline struct device *snd_card_get_device_link(struct snd_card *card)
 205 {
 206 #ifdef CONFIG_SYSFS_DEPRECATED
 207         return card ? card->dev : NULL;
 208 #else
 209         return card ? card->card_dev : NULL;
 210 #endif
 211 }
 212
 213 /* sound.c */
 214
 215 extern int snd_major;
 216 extern int snd_ecards_limit;
 217 extern struct class *sound_class;
 218
 219 void snd_request_card(int card);
 220
 221 int snd_register_device_for_dev(int type, struct snd_card *card,
 222                                 int dev,
 223                                 const struct file_operations *f_ops,
 224                                 void *private_data,
 225                                 const char *name,
 226                                 struct device *device);
 227
 228 /**
 229  * snd_register_device - Register the ALSA device file for the card
 230  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 231  * @card: the card instance
 232  * @dev: the device index
 233  * @f_ops: the file operations
 234  * @private_data: user pointer for f_ops->open()
 235  * @name: the device file name
 236  *
 237  * Registers an ALSA device file for the given card.
 238  * The operators have to be set in reg parameter.
 239  *
 240  * This function uses the card's device pointer to link to the
 241  * correct &struct device.
 242  *
 243  * Returns zero if successful, or a negative error code on failure.
 244  */
 245 static inline int snd_register_device(int type, struct snd_card *card, int dev,
 246                                       const struct file_operations *f_ops,
 247                                       void *private_data,
 248                                       const char *name)
 249 {
 250         return snd_register_device_for_dev(type, card, dev, f_ops,
 251                                            private_data, name,
 252                                            snd_card_get_device_link(card));
 253 }
 254
 255 int snd_unregister_device(int type, struct snd_card *card, int dev);
 256 void *snd_lookup_minor_data(unsigned int minor, int type);
 257 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
 258                               struct device_attribute *attr);
 259
 260 #ifdef CONFIG_SND_OSSEMUL
 261 int snd_register_oss_device(int type, struct snd_card *card, int dev,
 262                             const struct file_operations *f_ops, void *private_data,
 263                             const char *name);
 264 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 265 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 266 #endif
 267
 268 int snd_minor_info_init(void);
 269 int snd_minor_info_done(void);
 270
 271 /* sound_oss.c */
 272
 273 #ifdef CONFIG_SND_OSSEMUL
 274 int snd_minor_info_oss_init(void);
 275 int snd_minor_info_oss_done(void);
 276 #else
 277 static inline int snd_minor_info_oss_init(void) { return 0; }
 278 static inline int snd_minor_info_oss_done(void) { return 0; }
 279 #endif
 280
 281 /* memory.c */
 282
 283 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 284 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 285
 286 /* init.c */
 287
 288 extern struct snd_card *snd_cards[SNDRV_CARDS];
 289 int snd_card_locked(int card);
 290 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 291 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
 292 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 293 #define SND_MIXER_OSS_NOTIFY_FREE       2
 294 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 295 #endif
 296
 297 struct snd_card *snd_card_new(int idx, const char *id,
 298                          struct module *module, int extra_size);
 299 int snd_card_disconnect(struct snd_card *card);
 300 int snd_card_free(struct snd_card *card);
 301 int snd_card_free_when_closed(struct snd_card *card);
 302 int snd_card_register(struct snd_card *card);
 303 int snd_card_info_init(void);
 304 int snd_card_info_done(void);
 305 int snd_component_add(struct snd_card *card, const char *component);
 306 int snd_card_file_add(struct snd_card *card, struct file *file);
 307 int snd_card_file_remove(struct snd_card *card, struct file *file);
 308
 309 #ifndef snd_card_set_dev
 310 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
 311 #endif
 312
 313 /* device.c */
 314
 315 int snd_device_new(struct snd_card *card, snd_device_type_t type,
 316                    void *device_data, struct snd_device_ops *ops);
 317 int snd_device_register(struct snd_card *card, void *device_data);
 318 int snd_device_register_all(struct snd_card *card);
 319 int snd_device_disconnect(struct snd_card *card, void *device_data);
 320 int snd_device_disconnect_all(struct snd_card *card);
 321 int snd_device_free(struct snd_card *card, void *device_data);
 322 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
 323
 324 /* isadma.c */
 325
 326 #ifdef CONFIG_ISA_DMA_API
 327 #define DMA_MODE_NO_ENABLE      0x0100
 328
 329 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 330 void snd_dma_disable(unsigned long dma);
 331 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 332 #endif
 333
 334 /* misc.c */
 335 struct resource;
 336 void release_and_free_resource(struct resource *res);
 337
 338 #ifdef CONFIG_SND_VERBOSE_PRINTK
 339 void snd_verbose_printk(const char *file, int line, const char *format, ...)
 340      __attribute__ ((format (printf, 3, 4)));
 341 #endif
 342 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
 343 void snd_verbose_printd(const char *file, int line, const char *format, ...)
 344      __attribute__ ((format (printf, 3, 4)));
 345 #endif
 346
 347 /* --- */
 348
 349 #ifdef CONFIG_SND_VERBOSE_PRINTK
 350 /**
 351  * snd_printk - printk wrapper
 352  * @fmt: format string
 353  *
 354  * Works like print() but prints the file and the line of the caller
 355  * when configured with CONFIG_SND_VERBOSE_PRINTK.
 356  */
 357 #define snd_printk(fmt, args...) \
 358         snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
 359 #else
 360 #define snd_printk(fmt, args...) \
 361         printk(fmt ,##args)
 362 #endif
 363
 364 #ifdef CONFIG_SND_DEBUG
 365
 366 #define __ASTRING__(x) #x
 367
 368 #ifdef CONFIG_SND_VERBOSE_PRINTK
 369 /**
 370  * snd_printd - debug printk
 371  * @fmt: format string
 372  *
 373  * Works like snd_printk() for debugging purposes.
 374  * Ignored when CONFIG_SND_DEBUG is not set.
 375  */
 376 #define snd_printd(fmt, args...) \
 377         snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
 378 #else
 379 #define snd_printd(fmt, args...) \
 380         printk(fmt ,##args)
 381 #endif
 382 /**
 383  * snd_assert - run-time assertion macro
 384  * @expr: expression
 385  *
 386  * This macro checks the expression in run-time and invokes the commands
 387  * given in the rest arguments if the assertion is failed.
 388  * When CONFIG_SND_DEBUG is not set, the expression is executed but
 389  * not checked.
 390  */
 391 #define snd_assert(expr, args...) do {                                  \
 392         if (unlikely(!(expr))) {                                        \
 393                 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr));  \
 394                 dump_stack();                                           \
 395                 args;                                                   \
 396         }                                                               \
 397 } while (0)
 398
 399 #define snd_BUG() do {                          \
 400         snd_printk(KERN_ERR "BUG?\n");          \
 401         dump_stack();                           \
 402 } while (0)
 403
 404 #else /* !CONFIG_SND_DEBUG */
 405
 406 #define snd_printd(fmt, args...)        /* nothing */
 407 #define snd_assert(expr, args...)       (void)(expr)
 408 #define snd_BUG()                       /* nothing */
 409
 410 #endif /* CONFIG_SND_DEBUG */
 411
 412 #ifdef CONFIG_SND_DEBUG_VERBOSE
 413 /**
 414  * snd_printdd - debug printk
 415  * @format: format string
 416  *
 417  * Works like snd_printk() for debugging purposes.
 418  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 419  */
 420 #define snd_printdd(format, args...) snd_printk(format, ##args)
 421 #else
 422 #define snd_printdd(format, args...) /* nothing */
 423 #endif
 424
 425
 426 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 427
 428 /* for easier backward-porting */
 429 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
 430 #ifndef gameport_set_dev_parent
 431 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 432 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 433 #define gameport_get_port_data(gp) (gp)->port_data
 434 #endif
 435 #endif
 436
 437 /* PCI quirk list helper */
 438 struct snd_pci_quirk {
 439         unsigned short subvendor;       /* PCI subvendor ID */
 440         unsigned short subdevice;       /* PCI subdevice ID */
 441         int value;                      /* value */
 442 #ifdef CONFIG_SND_DEBUG_VERBOSE
 443         const char *name;               /* name of the device (optional) */
 444 #endif
 445 };
 446
 447 #define _SND_PCI_QUIRK_ID(vend,dev) \
 448         .subvendor = (vend), .subdevice = (dev)
 449 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
 450 #ifdef CONFIG_SND_DEBUG_VERBOSE
 451 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 452         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
 453 #else
 454 #define SND_PCI_QUIRK(vend,dev,xname,val) \
 455         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
 456 #endif
 457
 458 const struct snd_pci_quirk *
 459 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
 460
 461
 462 #endif /* __SOUND_CORE_H */