[ALSA] Use getnstimeofday()
[linux-2.6.git] / 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 /* Typedef's */
32 typedef struct sndrv_interval snd_interval_t;
33 typedef enum sndrv_card_type snd_card_type;
34 typedef struct sndrv_xferi snd_xferi_t;
35 typedef struct sndrv_xfern snd_xfern_t;
36 typedef struct sndrv_xferv snd_xferv_t;
37
38 /* forward declarations */
39 #ifdef CONFIG_PCI
40 struct pci_dev;
41 #endif
42 #ifdef CONFIG_SBUS
43 struct sbus_dev;
44 #endif
45
46 /* device allocation stuff */
47
48 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
49
50 typedef enum {
51         SNDRV_DEV_TOPLEVEL =            (0*SNDRV_DEV_TYPE_RANGE_SIZE),
52         SNDRV_DEV_CONTROL,
53         SNDRV_DEV_LOWLEVEL_PRE,
54         SNDRV_DEV_LOWLEVEL_NORMAL =     (1*SNDRV_DEV_TYPE_RANGE_SIZE),
55         SNDRV_DEV_PCM,
56         SNDRV_DEV_RAWMIDI,
57         SNDRV_DEV_TIMER,
58         SNDRV_DEV_SEQUENCER,
59         SNDRV_DEV_HWDEP,
60         SNDRV_DEV_INFO,
61         SNDRV_DEV_BUS,
62         SNDRV_DEV_CODEC,
63         SNDRV_DEV_LOWLEVEL =            (2*SNDRV_DEV_TYPE_RANGE_SIZE)
64 } snd_device_type_t;
65
66 typedef enum {
67         SNDRV_DEV_BUILD,
68         SNDRV_DEV_REGISTERED,
69         SNDRV_DEV_DISCONNECTED
70 } snd_device_state_t;
71
72 typedef enum {
73         SNDRV_DEV_CMD_PRE = 0,
74         SNDRV_DEV_CMD_NORMAL = 1,
75         SNDRV_DEV_CMD_POST = 2
76 } snd_device_cmd_t;
77
78 typedef struct _snd_card snd_card_t;
79 typedef struct _snd_device snd_device_t;
80
81 typedef int (snd_dev_free_t)(snd_device_t *device);
82 typedef int (snd_dev_register_t)(snd_device_t *device);
83 typedef int (snd_dev_disconnect_t)(snd_device_t *device);
84 typedef int (snd_dev_unregister_t)(snd_device_t *device);
85
86 typedef struct {
87         snd_dev_free_t *dev_free;
88         snd_dev_register_t *dev_register;
89         snd_dev_disconnect_t *dev_disconnect;
90         snd_dev_unregister_t *dev_unregister;
91 } snd_device_ops_t;
92
93 struct _snd_device {
94         struct list_head list;          /* list of registered devices */
95         snd_card_t *card;               /* card which holds this device */
96         snd_device_state_t state;       /* state of the device */
97         snd_device_type_t type;         /* device type */
98         void *device_data;              /* device structure */
99         snd_device_ops_t *ops;          /* operations */
100 };
101
102 #define snd_device(n) list_entry(n, snd_device_t, list)
103
104 /* various typedefs */
105
106 typedef struct snd_info_entry snd_info_entry_t;
107 typedef struct _snd_pcm snd_pcm_t;
108 typedef struct _snd_pcm_str snd_pcm_str_t;
109 typedef struct _snd_pcm_substream snd_pcm_substream_t;
110 typedef struct _snd_mixer snd_kmixer_t;
111 typedef struct _snd_rawmidi snd_rawmidi_t;
112 typedef struct _snd_ctl_file snd_ctl_file_t;
113 typedef struct _snd_kcontrol snd_kcontrol_t;
114 typedef struct _snd_timer snd_timer_t;
115 typedef struct _snd_timer_instance snd_timer_instance_t;
116 typedef struct _snd_hwdep snd_hwdep_t;
117 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
118 typedef struct _snd_oss_mixer snd_mixer_oss_t;
119 #endif
120
121 /* monitor files for graceful shutdown (hotplug) */
122
123 struct snd_monitor_file {
124         struct file *file;
125         struct snd_monitor_file *next;
126 };
127
128 struct snd_shutdown_f_ops;      /* define it later in init.c */
129
130 /* main structure for soundcard */
131
132 struct _snd_card {
133         int number;                     /* number of soundcard (index to
134                                                                 snd_cards) */
135
136         char id[16];                    /* id string of this card */
137         char driver[16];                /* driver name */
138         char shortname[32];             /* short name of this soundcard */
139         char longname[80];              /* name of this soundcard */
140         char mixername[80];             /* mixer name */
141         char components[80];            /* card components delimited with
142                                                                 space */
143         struct module *module;          /* top-level module */
144
145         void *private_data;             /* private data for soundcard */
146         void (*private_free) (snd_card_t *card); /* callback for freeing of
147                                                                 private data */
148         struct list_head devices;       /* devices */
149
150         unsigned int last_numid;        /* last used numeric ID */
151         struct rw_semaphore controls_rwsem;     /* controls list lock */
152         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
153         int controls_count;             /* count of all controls */
154         int user_ctl_count;             /* count of all user controls */
155         struct list_head controls;      /* all controls for this card */
156         struct list_head ctl_files;     /* active control files */
157
158         snd_info_entry_t *proc_root;    /* root for soundcard specific files */
159         snd_info_entry_t *proc_id;      /* the card id */
160         struct proc_dir_entry *proc_root_link;  /* number link to real id */
161
162         struct snd_monitor_file *files; /* all files associated to this card */
163         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
164                                                                 state */
165         spinlock_t files_lock;          /* lock the files for this card */
166         int shutdown;                   /* this card is going down */
167         wait_queue_head_t shutdown_sleep;
168         struct work_struct free_workq;  /* for free in workqueue */
169         struct device *dev;
170 #ifdef CONFIG_SND_GENERIC_DRIVER
171         struct snd_generic_device *generic_dev;
172 #endif
173
174 #ifdef CONFIG_PM
175         int (*pm_suspend)(snd_card_t *card, pm_message_t state);
176         int (*pm_resume)(snd_card_t *card);
177         void *pm_private_data;
178         unsigned int power_state;       /* power state */
179         struct semaphore power_lock;    /* power lock */
180         wait_queue_head_t power_sleep;
181 #endif
182
183 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
184         snd_mixer_oss_t *mixer_oss;
185         int mixer_oss_change_count;
186 #endif
187 };
188
189 #ifdef CONFIG_PM
190 static inline void snd_power_lock(snd_card_t *card)
191 {
192         down(&card->power_lock);
193 }
194
195 static inline void snd_power_unlock(snd_card_t *card)
196 {
197         up(&card->power_lock);
198 }
199
200 static inline unsigned int snd_power_get_state(snd_card_t *card)
201 {
202         return card->power_state;
203 }
204
205 static inline void snd_power_change_state(snd_card_t *card, unsigned int state)
206 {
207         card->power_state = state;
208         wake_up(&card->power_sleep);
209 }
210
211 /* init.c */
212 int snd_power_wait(snd_card_t *card, unsigned int power_state, struct file *file);
213
214 int snd_card_set_pm_callback(snd_card_t *card,
215                              int (*suspend)(snd_card_t *, pm_message_t),
216                              int (*resume)(snd_card_t *),
217                              void *private_data);
218 int snd_card_set_generic_pm_callback(snd_card_t *card,
219                                      int (*suspend)(snd_card_t *, pm_message_t),
220                                      int (*resume)(snd_card_t *),
221                                      void *private_data);
222 #define snd_card_set_isa_pm_callback(card,suspend,resume,data) \
223         snd_card_set_generic_pm_callback(card, suspend, resume, data)
224 struct pci_dev;
225 int snd_card_pci_suspend(struct pci_dev *dev, pm_message_t state);
226 int snd_card_pci_resume(struct pci_dev *dev);
227 #define SND_PCI_PM_CALLBACKS \
228         .suspend = snd_card_pci_suspend,  .resume = snd_card_pci_resume
229
230 #else /* ! CONFIG_PM */
231
232 #define snd_power_lock(card)            do { (void)(card); } while (0)
233 #define snd_power_unlock(card)          do { (void)(card); } while (0)
234 static inline int snd_power_wait(snd_card_t *card, unsigned int state, struct file *file) { return 0; }
235 #define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
236 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
237 #define snd_card_set_pm_callback(card,suspend,resume,data)
238 #define snd_card_set_generic_pm_callback(card,suspend,resume,data)
239 #define snd_card_set_isa_pm_callback(card,suspend,resume,data)
240 #define SND_PCI_PM_CALLBACKS
241
242 #endif /* CONFIG_PM */
243
244 struct _snd_minor {
245         struct list_head list;          /* list of all minors per card */
246         int number;                     /* minor number */
247         int device;                     /* device number */
248         const char *comment;            /* for /proc/asound/devices */
249         struct file_operations *f_ops;  /* file operations */
250         char name[0];                   /* device name (keep at the end of
251                                                                 structure) */
252 };
253
254 typedef struct _snd_minor snd_minor_t;
255
256 /* sound.c */
257
258 extern int snd_ecards_limit;
259
260 void snd_request_card(int card);
261
262 int snd_register_device(int type, snd_card_t *card, int dev, snd_minor_t *reg, const char *name);
263 int snd_unregister_device(int type, snd_card_t *card, int dev);
264
265 #ifdef CONFIG_SND_OSSEMUL
266 int snd_register_oss_device(int type, snd_card_t *card, int dev, snd_minor_t *reg, const char *name);
267 int snd_unregister_oss_device(int type, snd_card_t *card, int dev);
268 #endif
269
270 int snd_minor_info_init(void);
271 int snd_minor_info_done(void);
272
273 /* sound_oss.c */
274
275 #ifdef CONFIG_SND_OSSEMUL
276 int snd_minor_info_oss_init(void);
277 int snd_minor_info_oss_done(void);
278 int snd_oss_init_module(void);
279 #else
280 #define snd_minor_info_oss_init() /*NOP*/
281 #define snd_minor_info_oss_done() /*NOP*/
282 #define snd_oss_init_module() 0
283 #endif
284
285 /* memory.c */
286
287 #ifdef CONFIG_SND_DEBUG_MEMORY
288 void snd_memory_init(void);
289 void snd_memory_done(void);
290 int snd_memory_info_init(void);
291 int snd_memory_info_done(void);
292 void *snd_hidden_kmalloc(size_t size, gfp_t flags);
293 void *snd_hidden_kzalloc(size_t size, gfp_t flags);
294 void *snd_hidden_kcalloc(size_t n, size_t size, gfp_t flags);
295 void snd_hidden_kfree(const void *obj);
296 void *snd_hidden_vmalloc(unsigned long size);
297 void snd_hidden_vfree(void *obj);
298 char *snd_hidden_kstrdup(const char *s, gfp_t flags);
299 #define kmalloc(size, flags) snd_hidden_kmalloc(size, flags)
300 #define kzalloc(size, flags) snd_hidden_kzalloc(size, flags)
301 #define kcalloc(n, size, flags) snd_hidden_kcalloc(n, size, flags)
302 #define kfree(obj) snd_hidden_kfree(obj)
303 #define vmalloc(size) snd_hidden_vmalloc(size)
304 #define vfree(obj) snd_hidden_vfree(obj)
305 #define kmalloc_nocheck(size, flags) snd_wrapper_kmalloc(size, flags)
306 #define vmalloc_nocheck(size) snd_wrapper_vmalloc(size)
307 #define kfree_nocheck(obj) snd_wrapper_kfree(obj)
308 #define vfree_nocheck(obj) snd_wrapper_vfree(obj)
309 #define kstrdup(s, flags)  snd_hidden_kstrdup(s, flags)
310 #else
311 #define snd_memory_init() /*NOP*/
312 #define snd_memory_done() /*NOP*/
313 #define snd_memory_info_init() /*NOP*/
314 #define snd_memory_info_done() /*NOP*/
315 #define kmalloc_nocheck(size, flags) kmalloc(size, flags)
316 #define vmalloc_nocheck(size) vmalloc(size)
317 #define kfree_nocheck(obj) kfree(obj)
318 #define vfree_nocheck(obj) vfree(obj)
319 #endif
320 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
321 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
322
323 /* init.c */
324
325 extern unsigned int snd_cards_lock;
326 extern snd_card_t *snd_cards[SNDRV_CARDS];
327 extern rwlock_t snd_card_rwlock;
328 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
329 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
330 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
331 #define SND_MIXER_OSS_NOTIFY_FREE       2
332 extern int (*snd_mixer_oss_notify_callback)(snd_card_t *card, int cmd);
333 #endif
334
335 snd_card_t *snd_card_new(int idx, const char *id,
336                          struct module *module, int extra_size);
337 int snd_card_disconnect(snd_card_t *card);
338 int snd_card_free(snd_card_t *card);
339 int snd_card_free_in_thread(snd_card_t *card);
340 int snd_card_register(snd_card_t *card);
341 int snd_card_info_init(void);
342 int snd_card_info_done(void);
343 int snd_component_add(snd_card_t *card, const char *component);
344 int snd_card_file_add(snd_card_t *card, struct file *file);
345 int snd_card_file_remove(snd_card_t *card, struct file *file);
346
347 #ifndef snd_card_set_dev
348 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
349 #endif
350 /* register a generic device (for ISA, etc) */
351 int snd_card_set_generic_dev(snd_card_t *card);
352
353 /* device.c */
354
355 int snd_device_new(snd_card_t *card, snd_device_type_t type,
356                    void *device_data, snd_device_ops_t *ops);
357 int snd_device_register(snd_card_t *card, void *device_data);
358 int snd_device_register_all(snd_card_t *card);
359 int snd_device_disconnect(snd_card_t *card, void *device_data);
360 int snd_device_disconnect_all(snd_card_t *card);
361 int snd_device_free(snd_card_t *card, void *device_data);
362 int snd_device_free_all(snd_card_t *card, snd_device_cmd_t cmd);
363
364 /* isadma.c */
365
366 #ifdef CONFIG_ISA_DMA_API
367 #define DMA_MODE_NO_ENABLE      0x0100
368
369 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
370 void snd_dma_disable(unsigned long dma);
371 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
372 #endif
373
374 /* misc.c */
375
376 int snd_task_name(struct task_struct *task, char *name, size_t size);
377 #ifdef CONFIG_SND_VERBOSE_PRINTK
378 void snd_verbose_printk(const char *file, int line, const char *format, ...)
379      __attribute__ ((format (printf, 3, 4)));
380 #endif
381 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
382 void snd_verbose_printd(const char *file, int line, const char *format, ...)
383      __attribute__ ((format (printf, 3, 4)));
384 #endif
385
386 /* --- */
387
388 #ifdef CONFIG_SND_VERBOSE_PRINTK
389 /**
390  * snd_printk - printk wrapper
391  * @fmt: format string
392  *
393  * Works like print() but prints the file and the line of the caller
394  * when configured with CONFIG_SND_VERBOSE_PRINTK.
395  */
396 #define snd_printk(fmt, args...) \
397         snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
398 #else
399 #define snd_printk(fmt, args...) \
400         printk(fmt ,##args)
401 #endif
402
403 #ifdef CONFIG_SND_DEBUG
404
405 #define __ASTRING__(x) #x
406
407 #ifdef CONFIG_SND_VERBOSE_PRINTK
408 /**
409  * snd_printd - debug printk
410  * @format: format string
411  *
412  * Compiled only when Works like snd_printk() for debugging purpose.
413  * Ignored when CONFIG_SND_DEBUG is not set.
414  */
415 #define snd_printd(fmt, args...) \
416         snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
417 #else
418 #define snd_printd(fmt, args...) \
419         printk(fmt ,##args)
420 #endif
421 /**
422  * snd_assert - run-time assertion macro
423  * @expr: expression
424  * @args...: the action
425  *
426  * This macro checks the expression in run-time and invokes the commands
427  * given in the rest arguments if the assertion is failed.
428  * When CONFIG_SND_DEBUG is not set, the expression is executed but
429  * not checked.
430  */
431 #define snd_assert(expr, args...) do {                                  \
432         if (unlikely(!(expr))) {                                        \
433                 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr));  \
434                 dump_stack();                                           \
435                 args;                                                   \
436         }                                                               \
437 } while (0)
438
439 #define snd_BUG() do {                          \
440         snd_printk(KERN_ERR "BUG?\n");          \
441         dump_stack();                           \
442 } while (0)
443
444 #else /* !CONFIG_SND_DEBUG */
445
446 #define snd_printd(fmt, args...)        /* nothing */
447 #define snd_assert(expr, args...)       (void)(expr)
448 #define snd_BUG()                       /* nothing */
449
450 #endif /* CONFIG_SND_DEBUG */
451
452 #ifdef CONFIG_SND_DEBUG_DETECT
453 /**
454  * snd_printdd - debug printk
455  * @format: format string
456  *
457  * Compiled only when Works like snd_printk() for debugging purpose.
458  * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
459  */
460 #define snd_printdd(format, args...) snd_printk(format, ##args)
461 #else
462 #define snd_printdd(format, args...) /* nothing */
463 #endif
464
465
466 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
467
468 /* for easier backward-porting */
469 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
470 #ifndef gameport_set_dev_parent
471 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
472 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
473 #define gameport_get_port_data(gp) (gp)->port_data
474 #endif
475 #endif
476
477 #endif /* __SOUND_CORE_H */