5 * Main header file for the ALSA driver
6 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@suse.cz>
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.
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.
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
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 */
31 typedef struct timespec snd_timestamp_t;
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;
38 /* forward declarations */
46 /* device allocation stuff */
48 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
51 SNDRV_DEV_TOPLEVEL = (0*SNDRV_DEV_TYPE_RANGE_SIZE),
52 SNDRV_DEV_LOWLEVEL_PRE,
53 SNDRV_DEV_LOWLEVEL_NORMAL = (1*SNDRV_DEV_TYPE_RANGE_SIZE),
60 SNDRV_DEV_LOWLEVEL = (2*SNDRV_DEV_TYPE_RANGE_SIZE)
66 SNDRV_DEV_DISCONNECTED
70 SNDRV_DEV_CMD_PRE = 0,
71 SNDRV_DEV_CMD_NORMAL = 1,
72 SNDRV_DEV_CMD_POST = 2
75 typedef struct _snd_card snd_card_t;
76 typedef struct _snd_device snd_device_t;
78 typedef int (snd_dev_free_t)(snd_device_t *device);
79 typedef int (snd_dev_register_t)(snd_device_t *device);
80 typedef int (snd_dev_disconnect_t)(snd_device_t *device);
81 typedef int (snd_dev_unregister_t)(snd_device_t *device);
84 snd_dev_free_t *dev_free;
85 snd_dev_register_t *dev_register;
86 snd_dev_disconnect_t *dev_disconnect;
87 snd_dev_unregister_t *dev_unregister;
91 struct list_head list; /* list of registered devices */
92 snd_card_t *card; /* card which holds this device */
93 snd_device_state_t state; /* state of the device */
94 snd_device_type_t type; /* device type */
95 void *device_data; /* device structure */
96 snd_device_ops_t *ops; /* operations */
99 #define snd_device(n) list_entry(n, snd_device_t, list)
101 /* various typedefs */
103 typedef struct snd_info_entry snd_info_entry_t;
104 typedef struct _snd_pcm snd_pcm_t;
105 typedef struct _snd_pcm_str snd_pcm_str_t;
106 typedef struct _snd_pcm_substream snd_pcm_substream_t;
107 typedef struct _snd_mixer snd_kmixer_t;
108 typedef struct _snd_rawmidi snd_rawmidi_t;
109 typedef struct _snd_ctl_file snd_ctl_file_t;
110 typedef struct _snd_kcontrol snd_kcontrol_t;
111 typedef struct _snd_timer snd_timer_t;
112 typedef struct _snd_timer_instance snd_timer_instance_t;
113 typedef struct _snd_hwdep snd_hwdep_t;
114 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
115 typedef struct _snd_oss_mixer snd_mixer_oss_t;
118 /* monitor files for graceful shutdown (hotplug) */
120 struct snd_monitor_file {
122 struct snd_monitor_file *next;
125 struct snd_shutdown_f_ops; /* define it later */
127 /* main structure for soundcard */
130 int number; /* number of soundcard (index to snd_cards) */
132 char id[16]; /* id string of this card */
133 char driver[16]; /* driver name */
134 char shortname[32]; /* short name of this soundcard */
135 char longname[80]; /* name of this soundcard */
136 char mixername[80]; /* mixer name */
137 char components[80]; /* card components delimited with space */
139 struct module *module; /* top-level module */
141 void *private_data; /* private data for soundcard */
142 void (*private_free) (snd_card_t *card); /* callback for freeing of private data */
144 struct list_head devices; /* devices */
146 unsigned int last_numid; /* last used numeric ID */
147 struct rw_semaphore controls_rwsem; /* controls list lock */
148 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
149 int controls_count; /* count of all controls */
150 struct list_head controls; /* all controls for this card */
151 struct list_head ctl_files; /* active control files */
153 snd_info_entry_t *proc_root; /* root for soundcard specific files */
154 snd_info_entry_t *proc_id; /* the card id */
155 struct proc_dir_entry *proc_root_link; /* number link to real id */
157 struct snd_monitor_file *files; /* all files associated to this card */
158 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown state */
159 spinlock_t files_lock; /* lock the files for this card */
160 int shutdown; /* this card is going down */
161 wait_queue_head_t shutdown_sleep;
162 struct work_struct free_workq; /* for free in workqueue */
166 int (*pm_suspend)(snd_card_t *card, unsigned int state);
167 int (*pm_resume)(snd_card_t *card, unsigned int state);
168 struct pm_dev *pm_dev; /* for ISA */
169 void *pm_private_data;
170 unsigned int power_state; /* power state */
171 struct semaphore power_lock; /* power lock */
172 wait_queue_head_t power_sleep;
175 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
176 snd_mixer_oss_t *mixer_oss;
177 int mixer_oss_change_count;
182 static inline void snd_power_lock(snd_card_t *card)
184 down(&card->power_lock);
187 static inline void snd_power_unlock(snd_card_t *card)
189 up(&card->power_lock);
192 int snd_power_wait(snd_card_t *card, unsigned int power_state, struct file *file);
194 static inline unsigned int snd_power_get_state(snd_card_t *card)
196 return card->power_state;
199 static inline void snd_power_change_state(snd_card_t *card, unsigned int state)
201 card->power_state = state;
202 wake_up(&card->power_sleep);
204 int snd_card_set_pm_callback(snd_card_t *card,
205 int (*suspend)(snd_card_t *, unsigned int),
206 int (*resume)(snd_card_t *, unsigned int),
208 int snd_card_set_dev_pm_callback(snd_card_t *card, int type,
209 int (*suspend)(snd_card_t *, unsigned int),
210 int (*resume)(snd_card_t *, unsigned int),
212 #define snd_card_set_isa_pm_callback(card,suspend,resume,data) \
213 snd_card_set_dev_pm_callback(card, PM_ISA_DEV, suspend, resume, data)
215 #ifndef SND_PCI_PM_CALLBACKS
216 int snd_card_pci_suspend(struct pci_dev *dev, u32 state);
217 int snd_card_pci_resume(struct pci_dev *dev);
218 #define SND_PCI_PM_CALLBACKS \
219 .suspend = snd_card_pci_suspend, .resume = snd_card_pci_resume
223 #define snd_power_lock(card) do { (void)(card); } while (0)
224 #define snd_power_unlock(card) do { (void)(card); } while (0)
225 static inline int snd_power_wait(snd_card_t *card, unsigned int state, struct file *file) { return 0; }
226 #define snd_power_get_state(card) SNDRV_CTL_POWER_D0
227 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
228 #define snd_card_set_pm_callback(card,suspend,resume,data)
229 #define snd_card_set_dev_pm_callback(card,suspend,resume,data)
230 #define snd_card_set_isa_pm_callback(card,suspend,resume,data)
232 #define SND_PCI_PM_CALLBACKS
239 struct list_head list; /* list of all minors per card */
240 int number; /* minor number */
241 int device; /* device number */
242 const char *comment; /* for /proc/asound/devices */
243 struct file_operations *f_ops; /* file operations */
244 char name[0]; /* device name (keep at the end of structure) */
247 typedef struct _snd_minor snd_minor_t;
251 extern int snd_ecards_limit;
253 void snd_request_card(int card);
255 int snd_register_device(int type, snd_card_t *card, int dev, snd_minor_t *reg, const char *name);
256 int snd_unregister_device(int type, snd_card_t *card, int dev);
258 #ifdef CONFIG_SND_OSSEMUL
259 int snd_register_oss_device(int type, snd_card_t *card, int dev, snd_minor_t *reg, const char *name);
260 int snd_unregister_oss_device(int type, snd_card_t *card, int dev);
263 int snd_minor_info_init(void);
264 int snd_minor_info_done(void);
268 #ifdef CONFIG_SND_OSSEMUL
269 int snd_minor_info_oss_init(void);
270 int snd_minor_info_oss_done(void);
271 int snd_oss_init_module(void);
273 #define snd_minor_info_oss_init() /*NOP*/
274 #define snd_minor_info_oss_done() /*NOP*/
275 #define snd_oss_init_module() 0
280 #ifdef CONFIG_SND_DEBUG_MEMORY
281 void snd_memory_init(void);
282 void snd_memory_done(void);
283 int snd_memory_info_init(void);
284 int snd_memory_info_done(void);
285 void *snd_hidden_kmalloc(size_t size, int flags);
286 void *snd_hidden_kcalloc(size_t n, size_t size, int flags);
287 void snd_hidden_kfree(const void *obj);
288 void *snd_hidden_vmalloc(unsigned long size);
289 void snd_hidden_vfree(void *obj);
290 #define kmalloc(size, flags) snd_hidden_kmalloc(size, flags)
291 #define kcalloc(n, size, flags) snd_hidden_kcalloc(n, size, flags)
292 #define kfree(obj) snd_hidden_kfree(obj)
293 #define vmalloc(size) snd_hidden_vmalloc(size)
294 #define vfree(obj) snd_hidden_vfree(obj)
295 #define kmalloc_nocheck(size, flags) snd_wrapper_kmalloc(size, flags)
296 #define vmalloc_nocheck(size) snd_wrapper_vmalloc(size)
297 #define kfree_nocheck(obj) snd_wrapper_kfree(obj)
298 #define vfree_nocheck(obj) snd_wrapper_vfree(obj)
300 #define snd_memory_init() /*NOP*/
301 #define snd_memory_done() /*NOP*/
302 #define snd_memory_info_init() /*NOP*/
303 #define snd_memory_info_done() /*NOP*/
304 #define kmalloc_nocheck(size, flags) kmalloc(size, flags)
305 #define vmalloc_nocheck(size) vmalloc(size)
306 #define kfree_nocheck(obj) kfree(obj)
307 #define vfree_nocheck(obj) vfree(obj)
309 char *snd_kmalloc_strdup(const char *string, int flags);
310 int copy_to_user_fromio(void __user *dst, unsigned long src, size_t count);
311 int copy_from_user_toio(unsigned long dst, const void __user *src, size_t count);
315 extern int snd_cards_count;
316 extern unsigned int snd_cards_lock;
317 extern snd_card_t *snd_cards[SNDRV_CARDS];
318 extern rwlock_t snd_card_rwlock;
319 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
320 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
321 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
322 #define SND_MIXER_OSS_NOTIFY_FREE 2
323 extern int (*snd_mixer_oss_notify_callback)(snd_card_t *card, int cmd);
326 snd_card_t *snd_card_new(int idx, const char *id,
327 struct module *module, int extra_size);
328 int snd_card_disconnect(snd_card_t *card);
329 int snd_card_free(snd_card_t *card);
330 int snd_card_free_in_thread(snd_card_t *card);
331 int snd_card_register(snd_card_t *card);
332 int snd_card_info_init(void);
333 int snd_card_info_done(void);
334 int snd_component_add(snd_card_t *card, const char *component);
335 int snd_card_file_add(snd_card_t *card, struct file *file);
336 int snd_card_file_remove(snd_card_t *card, struct file *file);
338 #ifndef snd_card_set_dev
339 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
344 int snd_device_new(snd_card_t *card, snd_device_type_t type,
345 void *device_data, snd_device_ops_t *ops);
346 int snd_device_register(snd_card_t *card, void *device_data);
347 int snd_device_register_all(snd_card_t *card);
348 int snd_device_disconnect(snd_card_t *card, void *device_data);
349 int snd_device_disconnect_all(snd_card_t *card);
350 int snd_device_free(snd_card_t *card, void *device_data);
351 int snd_device_free_all(snd_card_t *card, snd_device_cmd_t cmd);
355 #define DMA_MODE_NO_ENABLE 0x0100
357 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
358 void snd_dma_disable(unsigned long dma);
359 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
363 int snd_task_name(struct task_struct *task, char *name, size_t size);
364 #ifdef CONFIG_SND_VERBOSE_PRINTK
365 void snd_verbose_printk(const char *file, int line, const char *format, ...)
366 __attribute__ ((format (printf, 3, 4)));
368 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
369 void snd_verbose_printd(const char *file, int line, const char *format, ...)
370 __attribute__ ((format (printf, 3, 4)));
375 #ifdef CONFIG_SND_VERBOSE_PRINTK
377 * snd_printk - printk wrapper
378 * @fmt: format string
380 * Works like print() but prints the file and the line of the caller
381 * when configured with CONFIG_SND_VERBOSE_PRINTK.
383 #define snd_printk(fmt, args...) \
384 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
386 #define snd_printk(fmt, args...) \
390 #ifdef CONFIG_SND_DEBUG
392 #define __ASTRING__(x) #x
394 #ifdef CONFIG_SND_VERBOSE_PRINTK
396 * snd_printd - debug printk
397 * @format: format string
399 * Compiled only when Works like snd_printk() for debugging purpose.
400 * Ignored when CONFIG_SND_DEBUG is not set.
402 #define snd_printd(fmt, args...) \
403 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
405 #define snd_printd(fmt, args...) \
409 * snd_assert - run-time assersion macro
411 * @args...: the action
413 * This macro checks the expression in run-time and invokes the commands
414 * given in the rest arguments if the assertion is failed.
415 * When CONFIG_SND_DEBUG is not set, the expression is executed but
418 #define snd_assert(expr, args...) do {\
419 if (unlikely(!(expr))) { \
420 snd_printk("BUG? (%s) (called from %p)\n", __ASTRING__(expr), __builtin_return_address(0));\
425 * snd_runtime_check - run-time assersion macro
427 * @args...: the action
429 * This macro checks the expression in run-time and invokes the commands
430 * given in the rest arguments if the assertion is failed.
431 * Unlike snd_assert(), the action commands are executed even if
432 * CONFIG_SND_DEBUG is not set but without any error messages.
434 #define snd_runtime_check(expr, args...) do {\
435 if (unlikely(!(expr))) { \
436 snd_printk("ERROR (%s) (called from %p)\n", __ASTRING__(expr), __builtin_return_address(0));\
441 #else /* !CONFIG_SND_DEBUG */
443 #define snd_printd(fmt, args...) /* nothing */
444 #define snd_assert(expr, args...) (void)(expr)
445 #define snd_runtime_check(expr, args...) do { if (!(expr)) { args; } } while (0)
447 #endif /* CONFIG_SND_DEBUG */
449 #ifdef CONFIG_SND_DEBUG_DETECT
451 * snd_printdd - debug printk
452 * @format: format string
454 * Compiled only when Works like snd_printk() for debugging purpose.
455 * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
457 #define snd_printdd(format, args...) snd_printk(format, ##args)
459 #define snd_printdd(format, args...) /* nothing */
462 #define snd_BUG() snd_assert(0, )
465 static inline void snd_timestamp_now(struct timespec *tstamp, int timespec)
468 /* FIXME: use a linear time source */
469 do_gettimeofday(&val);
470 tstamp->tv_sec = val.tv_sec;
471 tstamp->tv_nsec = val.tv_usec;
473 tstamp->tv_nsec *= 1000L;
476 static inline void snd_timestamp_zero(struct timespec *tstamp)
482 static inline int snd_timestamp_null(struct timespec *tstamp)
484 return tstamp->tv_sec == 0 && tstamp->tv_nsec == 0;
487 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
489 #endif /* __SOUND_CORE_H */