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