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