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 */
29 #include <linux/pm.h> /* pm_message_t */
31 /* forward declarations */
39 /* device allocation stuff */
41 #define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
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)
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)
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)
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);
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 */
86 #define snd_device(n) list_entry(n, struct snd_device, list)
88 /* monitor files for graceful shutdown (hotplug) */
90 struct snd_monitor_file {
92 struct snd_monitor_file *next;
95 struct snd_shutdown_f_ops; /* define it later in init.c */
97 /* main structure for soundcard */
100 int number; /* number of soundcard (index to
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
110 struct module *module; /* top-level module */
112 void *private_data; /* private data for soundcard */
113 void (*private_free) (struct snd_card *card); /* callback for freeing of
115 struct list_head devices; /* devices */
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 */
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 */
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
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 */
137 #ifdef CONFIG_SND_GENERIC_DRIVER
138 struct snd_generic_device *generic_dev;
142 int (*pm_suspend)(struct snd_card *card, pm_message_t state);
143 int (*pm_resume)(struct snd_card *card);
144 void *pm_private_data;
145 unsigned int power_state; /* power state */
146 struct semaphore power_lock; /* power lock */
147 wait_queue_head_t power_sleep;
150 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
151 struct snd_mixer_oss *mixer_oss;
152 int mixer_oss_change_count;
157 static inline void snd_power_lock(struct snd_card *card)
159 down(&card->power_lock);
162 static inline void snd_power_unlock(struct snd_card *card)
164 up(&card->power_lock);
167 static inline unsigned int snd_power_get_state(struct snd_card *card)
169 return card->power_state;
172 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
174 card->power_state = state;
175 wake_up(&card->power_sleep);
179 int snd_power_wait(struct snd_card *card, unsigned int power_state, struct file *file);
181 int snd_card_set_pm_callback(struct snd_card *card,
182 int (*suspend)(struct snd_card *, pm_message_t),
183 int (*resume)(struct snd_card *),
185 int snd_card_set_generic_pm_callback(struct snd_card *card,
186 int (*suspend)(struct snd_card *, pm_message_t),
187 int (*resume)(struct snd_card *),
189 #define snd_card_set_isa_pm_callback(card,suspend,resume,data) \
190 snd_card_set_generic_pm_callback(card, suspend, resume, data)
192 int snd_card_pci_suspend(struct pci_dev *dev, pm_message_t state);
193 int snd_card_pci_resume(struct pci_dev *dev);
194 #define SND_PCI_PM_CALLBACKS \
195 .suspend = snd_card_pci_suspend, .resume = snd_card_pci_resume
197 #else /* ! CONFIG_PM */
199 #define snd_power_lock(card) do { (void)(card); } while (0)
200 #define snd_power_unlock(card) do { (void)(card); } while (0)
201 static inline int snd_power_wait(struct snd_card *card, unsigned int state, struct file *file) { return 0; }
202 #define snd_power_get_state(card) SNDRV_CTL_POWER_D0
203 #define snd_power_change_state(card, state) do { (void)(card); } while (0)
204 #define snd_card_set_pm_callback(card,suspend,resume,data)
205 #define snd_card_set_generic_pm_callback(card,suspend,resume,data)
206 #define snd_card_set_isa_pm_callback(card,suspend,resume,data)
207 #define SND_PCI_PM_CALLBACKS
209 #endif /* CONFIG_PM */
212 struct list_head list; /* list of all minors per card */
213 int number; /* minor number */
214 int device; /* device number */
215 const char *comment; /* for /proc/asound/devices */
216 struct file_operations *f_ops; /* file operations */
217 char name[0]; /* device name (keep at the end of
223 extern int snd_major;
224 extern int snd_ecards_limit;
226 void snd_request_card(int card);
228 int snd_register_device(int type, struct snd_card *card, int dev, struct snd_minor *reg, const char *name);
229 int snd_unregister_device(int type, struct snd_card *card, int dev);
231 #ifdef CONFIG_SND_OSSEMUL
232 int snd_register_oss_device(int type, struct snd_card *card, int dev, struct snd_minor *reg, const char *name);
233 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
236 int snd_minor_info_init(void);
237 int snd_minor_info_done(void);
241 #ifdef CONFIG_SND_OSSEMUL
242 int snd_minor_info_oss_init(void);
243 int snd_minor_info_oss_done(void);
244 int snd_oss_init_module(void);
246 #define snd_minor_info_oss_init() /*NOP*/
247 #define snd_minor_info_oss_done() /*NOP*/
248 #define snd_oss_init_module() 0
253 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
254 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
258 extern unsigned int snd_cards_lock;
259 extern struct snd_card *snd_cards[SNDRV_CARDS];
260 extern rwlock_t snd_card_rwlock;
261 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
262 #define SND_MIXER_OSS_NOTIFY_REGISTER 0
263 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
264 #define SND_MIXER_OSS_NOTIFY_FREE 2
265 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
268 struct snd_card *snd_card_new(int idx, const char *id,
269 struct module *module, int extra_size);
270 int snd_card_disconnect(struct snd_card *card);
271 int snd_card_free(struct snd_card *card);
272 int snd_card_free_in_thread(struct snd_card *card);
273 int snd_card_register(struct snd_card *card);
274 int snd_card_info_init(void);
275 int snd_card_info_done(void);
276 int snd_component_add(struct snd_card *card, const char *component);
277 int snd_card_file_add(struct snd_card *card, struct file *file);
278 int snd_card_file_remove(struct snd_card *card, struct file *file);
280 #ifndef snd_card_set_dev
281 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
283 /* register a generic device (for ISA, etc) */
284 int snd_card_set_generic_dev(struct snd_card *card);
288 int snd_device_new(struct snd_card *card, snd_device_type_t type,
289 void *device_data, struct snd_device_ops *ops);
290 int snd_device_register(struct snd_card *card, void *device_data);
291 int snd_device_register_all(struct snd_card *card);
292 int snd_device_disconnect(struct snd_card *card, void *device_data);
293 int snd_device_disconnect_all(struct snd_card *card);
294 int snd_device_free(struct snd_card *card, void *device_data);
295 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
299 #ifdef CONFIG_ISA_DMA_API
300 #define DMA_MODE_NO_ENABLE 0x0100
302 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
303 void snd_dma_disable(unsigned long dma);
304 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
309 void release_and_free_resource(struct resource *res);
311 #ifdef CONFIG_SND_VERBOSE_PRINTK
312 void snd_verbose_printk(const char *file, int line, const char *format, ...)
313 __attribute__ ((format (printf, 3, 4)));
315 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
316 void snd_verbose_printd(const char *file, int line, const char *format, ...)
317 __attribute__ ((format (printf, 3, 4)));
322 #ifdef CONFIG_SND_VERBOSE_PRINTK
324 * snd_printk - printk wrapper
325 * @fmt: format string
327 * Works like print() but prints the file and the line of the caller
328 * when configured with CONFIG_SND_VERBOSE_PRINTK.
330 #define snd_printk(fmt, args...) \
331 snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
333 #define snd_printk(fmt, args...) \
337 #ifdef CONFIG_SND_DEBUG
339 #define __ASTRING__(x) #x
341 #ifdef CONFIG_SND_VERBOSE_PRINTK
343 * snd_printd - debug printk
344 * @format: format string
346 * Compiled only when Works like snd_printk() for debugging purpose.
347 * Ignored when CONFIG_SND_DEBUG is not set.
349 #define snd_printd(fmt, args...) \
350 snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
352 #define snd_printd(fmt, args...) \
356 * snd_assert - run-time assertion macro
358 * @args...: the action
360 * This macro checks the expression in run-time and invokes the commands
361 * given in the rest arguments if the assertion is failed.
362 * When CONFIG_SND_DEBUG is not set, the expression is executed but
365 #define snd_assert(expr, args...) do { \
366 if (unlikely(!(expr))) { \
367 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr)); \
373 #define snd_BUG() do { \
374 snd_printk(KERN_ERR "BUG?\n"); \
378 #else /* !CONFIG_SND_DEBUG */
380 #define snd_printd(fmt, args...) /* nothing */
381 #define snd_assert(expr, args...) (void)(expr)
382 #define snd_BUG() /* nothing */
384 #endif /* CONFIG_SND_DEBUG */
386 #ifdef CONFIG_SND_DEBUG_DETECT
388 * snd_printdd - debug printk
389 * @format: format string
391 * Compiled only when Works like snd_printk() for debugging purpose.
392 * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
394 #define snd_printdd(format, args...) snd_printk(format, ##args)
396 #define snd_printdd(format, args...) /* nothing */
400 #define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
402 /* for easier backward-porting */
403 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
404 #ifndef gameport_set_dev_parent
405 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
406 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
407 #define gameport_get_port_data(gp) (gp)->port_data
411 #include "typedefs.h"
413 #endif /* __SOUND_CORE_H */