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@suse.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 <asm/semaphore.h>              /* struct semaphore */
  27 #include <linux/rwsem.h>                /* struct rw_semaphore */
  28 #include <linux/workqueue.h>            /* struct workqueue_struct */
  29 #include <linux/pm.h>                   /* pm_message_t */
  30
  31 /* forward declarations */
  32 #ifdef CONFIG_PCI
  33 struct pci_dev;
  34 #endif
  35 #ifdef CONFIG_SBUS
  36 struct sbus_dev;
  37 #endif
  38
  39 /* device allocation stuff */
  40
  41 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
  42
  43 typedef int __bitwise snd_device_type_t;
  44 #define SNDRV_DEV_TOPLEVEL      ((__force snd_device_type_t) 0)
  45 #define SNDRV_DEV_CONTROL       ((__force snd_device_type_t) 1)
  46 #define SNDRV_DEV_LOWLEVEL_PRE  ((__force snd_device_type_t) 2)
  47 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
  48 #define SNDRV_DEV_PCM           ((__force snd_device_type_t) 0x1001)
  49 #define SNDRV_DEV_RAWMIDI       ((__force snd_device_type_t) 0x1002)
  50 #define SNDRV_DEV_TIMER         ((__force snd_device_type_t) 0x1003)
  51 #define SNDRV_DEV_SEQUENCER     ((__force snd_device_type_t) 0x1004)
  52 #define SNDRV_DEV_HWDEP         ((__force snd_device_type_t) 0x1005)
  53 #define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
  54 #define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
  55 #define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
  56 #define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
  57
  58 typedef int __bitwise snd_device_state_t;
  59 #define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
  60 #define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
  61 #define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
  62
  63 typedef int __bitwise snd_device_cmd_t;
  64 #define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
  65 #define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)
  66 #define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
  67
  68 struct snd_device;
  69
  70 struct snd_device_ops {
  71         int (*dev_free)(struct snd_device *dev);
  72         int (*dev_register)(struct snd_device *dev);
  73         int (*dev_disconnect)(struct snd_device *dev);
  74         int (*dev_unregister)(struct snd_device *dev);
  75 };
  76
  77 struct snd_device {
  78         struct list_head list;          /* list of registered devices */
  79         struct snd_card *card;          /* card which holds this device */
  80         snd_device_state_t state;       /* state of the device */
  81         snd_device_type_t type;         /* device type */
  82         void *device_data;              /* device structure */
  83         struct snd_device_ops *ops;     /* operations */
  84 };
  85
  86 #define snd_device(n) list_entry(n, struct snd_device, list)
  87
  88 /* monitor files for graceful shutdown (hotplug) */
  89
  90 struct snd_monitor_file {
  91         struct file *file;
  92         struct snd_monitor_file *next;
  93 };
  94
  95 struct snd_shutdown_f_ops;      /* define it later in init.c */
  96
  97 /* main structure for soundcard */
  98
  99 struct snd_card {
 100         int number;                     /* number of soundcard (index to
 101                                                                 snd_cards) */
 102
 103         char id[16];                    /* id string of this card */
 104         char driver[16];                /* driver name */
 105         char shortname[32];             /* short name of this soundcard */
 106         char longname[80];              /* name of this soundcard */
 107         char mixername[80];             /* mixer name */
 108         char components[80];            /* card components delimited with
 109                                                                 space */
 110         struct module *module;          /* top-level module */
 111
 112         void *private_data;             /* private data for soundcard */
 113         void (*private_free) (struct snd_card *card); /* callback for freeing of
 114                                                                 private data */
 115         struct list_head devices;       /* devices */
 116
 117         unsigned int last_numid;        /* last used numeric ID */
 118         struct rw_semaphore controls_rwsem;     /* controls list lock */
 119         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
 120         int controls_count;             /* count of all controls */
 121         int user_ctl_count;             /* count of all user controls */
 122         struct list_head controls;      /* all controls for this card */
 123         struct list_head ctl_files;     /* active control files */
 124
 125         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
 126         struct snd_info_entry *proc_id; /* the card id */
 127         struct proc_dir_entry *proc_root_link;  /* number link to real id */
 128
 129         struct snd_monitor_file *files; /* all files associated to this card */
 130         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
 131                                                                 state */
 132         spinlock_t files_lock;          /* lock the files for this card */
 133         int shutdown;                   /* this card is going down */
 134         wait_queue_head_t shutdown_sleep;
 135         struct work_struct free_workq;  /* for free in workqueue */
 136         struct device *dev;
 137         struct class_device *parent_device;
 138
 139 #ifdef CONFIG_PM
 140         unsigned int power_state;       /* power state */
 141         struct semaphore power_lock;    /* power lock */
 142         wait_queue_head_t power_sleep;
 143 #endif
 144
 145 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 146         struct snd_mixer_oss *mixer_oss;
 147         int mixer_oss_change_count;
 148 #endif
 149 };
 150
 151 #ifdef CONFIG_PM
 152 static inline void snd_power_lock(struct snd_card *card)
 153 {
 154         down(&card->power_lock);
 155 }
 156
 157 static inline void snd_power_unlock(struct snd_card *card)
 158 {
 159         up(&card->power_lock);
 160 }
 161
 162 static inline unsigned int snd_power_get_state(struct snd_card *card)
 163 {
 164         return card->power_state;
 165 }
 166
 167 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
 168 {
 169         card->power_state = state;
 170         wake_up(&card->power_sleep);
 171 }
 172
 173 /* init.c */
 174 int snd_power_wait(struct snd_card *card, unsigned int power_state, struct file *file);
 175
 176 #else /* ! CONFIG_PM */
 177
 178 #define snd_power_lock(card)            do { (void)(card); } while (0)
 179 #define snd_power_unlock(card)          do { (void)(card); } while (0)
 180 static inline int snd_power_wait(struct snd_card *card, unsigned int state, struct file *file) { return 0; }
 181 #define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
 182 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
 183
 184 #endif /* CONFIG_PM */
 185
 186 struct snd_minor {
 187         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
 188         int card;                       /* card number */
 189         int device;                     /* device number */
 190         struct file_operations *f_ops;  /* file operations */
 191         void *private_data;             /* private data for f_ops->open */
 192         char name[0];                   /* device name (keep at the end of
 193                                                                 structure) */
 194 };
 195
 196 /* sound.c */
 197
 198 extern int snd_major;
 199 extern int snd_ecards_limit;
 200
 201 void snd_request_card(int card);
 202
 203 int snd_register_device(int type, struct snd_card *card, int dev,
 204                         struct file_operations *f_ops, void *private_data,
 205                         const char *name);
 206 int snd_unregister_device(int type, struct snd_card *card, int dev);
 207 void *snd_lookup_minor_data(unsigned int minor, int type);
 208
 209 #ifdef CONFIG_SND_OSSEMUL
 210 int snd_register_oss_device(int type, struct snd_card *card, int dev,
 211                             struct file_operations *f_ops, void *private_data,
 212                             const char *name);
 213 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
 214 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
 215 #endif
 216
 217 int snd_minor_info_init(void);
 218 int snd_minor_info_done(void);
 219
 220 /* sound_oss.c */
 221
 222 #ifdef CONFIG_SND_OSSEMUL
 223 int snd_minor_info_oss_init(void);
 224 int snd_minor_info_oss_done(void);
 225 #else
 226 #define snd_minor_info_oss_init() /*NOP*/
 227 #define snd_minor_info_oss_done() /*NOP*/
 228 #endif
 229
 230 /* memory.c */
 231
 232 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
 233 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
 234
 235 /* init.c */
 236
 237 extern unsigned int snd_cards_lock;
 238 extern struct snd_card *snd_cards[SNDRV_CARDS];
 239 extern rwlock_t snd_card_rwlock;
 240 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
 241 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
 242 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
 243 #define SND_MIXER_OSS_NOTIFY_FREE       2
 244 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
 245 #endif
 246
 247 struct snd_card *snd_card_new(int idx, const char *id,
 248                          struct module *module, int extra_size);
 249 int snd_card_disconnect(struct snd_card *card);
 250 int snd_card_free(struct snd_card *card);
 251 int snd_card_free_in_thread(struct snd_card *card);
 252 int snd_card_register(struct snd_card *card);
 253 int snd_card_info_init(void);
 254 int snd_card_info_done(void);
 255 int snd_component_add(struct snd_card *card, const char *component);
 256 int snd_card_file_add(struct snd_card *card, struct file *file);
 257 int snd_card_file_remove(struct snd_card *card, struct file *file);
 258
 259 #ifndef snd_card_set_dev
 260 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
 261 #endif
 262
 263 /* device.c */
 264
 265 int snd_device_new(struct snd_card *card, snd_device_type_t type,
 266                    void *device_data, struct snd_device_ops *ops);
 267 int snd_device_register(struct snd_card *card, void *device_data);
 268 int snd_device_register_all(struct snd_card *card);
 269 int snd_device_disconnect(struct snd_card *card, void *device_data);
 270 int snd_device_disconnect_all(struct snd_card *card);
 271 int snd_device_free(struct snd_card *card, void *device_data);
 272 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
 273
 274 /* isadma.c */
 275
 276 #ifdef CONFIG_ISA_DMA_API
 277 #define DMA_MODE_NO_ENABLE      0x0100
 278
 279 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
 280 void snd_dma_disable(unsigned long dma);
 281 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
 282 #endif
 283
 284 /* misc.c */
 285 struct resource;
 286 void release_and_free_resource(struct resource *res);
 287
 288 #ifdef CONFIG_SND_VERBOSE_PRINTK
 289 void snd_verbose_printk(const char *file, int line, const char *format, ...)
 290      __attribute__ ((format (printf, 3, 4)));
 291 #endif
 292 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
 293 void snd_verbose_printd(const char *file, int line, const char *format, ...)
 294      __attribute__ ((format (printf, 3, 4)));
 295 #endif
 296
 297 /* --- */
 298
 299 #ifdef CONFIG_SND_VERBOSE_PRINTK
 300 /**
 301  * snd_printk - printk wrapper
 302  * @fmt: format string
 303  *
 304  * Works like print() but prints the file and the line of the caller
 305  * when configured with CONFIG_SND_VERBOSE_PRINTK.
 306  */
 307 #define snd_printk(fmt, args...) \
 308         snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
 309 #else
 310 #define snd_printk(fmt, args...) \
 311         printk(fmt ,##args)
 312 #endif
 313
 314 #ifdef CONFIG_SND_DEBUG
 315
 316 #define __ASTRING__(x) #x
 317
 318 #ifdef CONFIG_SND_VERBOSE_PRINTK
 319 /**
 320  * snd_printd - debug printk
 321  * @format: format string
 322  *
 323  * Compiled only when Works like snd_printk() for debugging purpose.
 324  * Ignored when CONFIG_SND_DEBUG is not set.
 325  */
 326 #define snd_printd(fmt, args...) \
 327         snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
 328 #else
 329 #define snd_printd(fmt, args...) \
 330         printk(fmt ,##args)
 331 #endif
 332 /**
 333  * snd_assert - run-time assertion macro
 334  * @expr: expression
 335  * @args...: the action
 336  *
 337  * This macro checks the expression in run-time and invokes the commands
 338  * given in the rest arguments if the assertion is failed.
 339  * When CONFIG_SND_DEBUG is not set, the expression is executed but
 340  * not checked.
 341  */
 342 #define snd_assert(expr, args...) do {                                  \
 343         if (unlikely(!(expr))) {                                        \
 344                 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr));  \
 345                 dump_stack();                                           \
 346                 args;                                                   \
 347         }                                                               \
 348 } while (0)
 349
 350 #define snd_BUG() do {                          \
 351         snd_printk(KERN_ERR "BUG?\n");          \
 352         dump_stack();                           \
 353 } while (0)
 354
 355 #else /* !CONFIG_SND_DEBUG */
 356
 357 #define snd_printd(fmt, args...)        /* nothing */
 358 #define snd_assert(expr, args...)       (void)(expr)
 359 #define snd_BUG()                       /* nothing */
 360
 361 #endif /* CONFIG_SND_DEBUG */
 362
 363 #ifdef CONFIG_SND_DEBUG_DETECT
 364 /**
 365  * snd_printdd - debug printk
 366  * @format: format string
 367  *
 368  * Compiled only when Works like snd_printk() for debugging purpose.
 369  * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
 370  */
 371 #define snd_printdd(format, args...) snd_printk(format, ##args)
 372 #else
 373 #define snd_printdd(format, args...) /* nothing */
 374 #endif
 375
 376
 377 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
 378
 379 /* for easier backward-porting */
 380 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
 381 #ifndef gameport_set_dev_parent
 382 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
 383 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
 384 #define gameport_get_port_data(gp) (gp)->port_data
 385 #endif
 386 #endif
 387
 388 #include "typedefs.h"
 389
 390 #endif /* __SOUND_CORE_H */