[ALSA] Changed Jaroslav Kysela's e-mail from perex@suse.cz to perex@perex.cz
[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@perex.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 <linux/mutex.h>                /* struct mutex */
27 #include <linux/rwsem.h>                /* struct rw_semaphore */
28 #include <linux/pm.h>                   /* pm_message_t */
29 #include <linux/device.h>
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 };
75
76 struct snd_device {
77         struct list_head list;          /* list of registered devices */
78         struct snd_card *card;          /* card which holds this device */
79         snd_device_state_t state;       /* state of the device */
80         snd_device_type_t type;         /* device type */
81         void *device_data;              /* device structure */
82         struct snd_device_ops *ops;     /* operations */
83 };
84
85 #define snd_device(n) list_entry(n, struct snd_device, list)
86
87 /* monitor files for graceful shutdown (hotplug) */
88
89 struct snd_monitor_file {
90         struct file *file;
91         struct snd_monitor_file *next;
92         const struct file_operations *disconnected_f_op;
93         struct list_head shutdown_list;
94 };
95
96 /* main structure for soundcard */
97
98 struct snd_card {
99         int number;                     /* number of soundcard (index to
100                                                                 snd_cards) */
101
102         char id[16];                    /* id string of this card */
103         char driver[16];                /* driver name */
104         char shortname[32];             /* short name of this soundcard */
105         char longname[80];              /* name of this soundcard */
106         char mixername[80];             /* mixer name */
107         char components[80];            /* card components delimited with
108                                                                 space */
109         struct module *module;          /* top-level module */
110
111         void *private_data;             /* private data for soundcard */
112         void (*private_free) (struct snd_card *card); /* callback for freeing of
113                                                                 private data */
114         struct list_head devices;       /* devices */
115
116         unsigned int last_numid;        /* last used numeric ID */
117         struct rw_semaphore controls_rwsem;     /* controls list lock */
118         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
119         int controls_count;             /* count of all controls */
120         int user_ctl_count;             /* count of all user controls */
121         struct list_head controls;      /* all controls for this card */
122         struct list_head ctl_files;     /* active control files */
123
124         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
125         struct snd_info_entry *proc_id; /* the card id */
126         struct proc_dir_entry *proc_root_link;  /* number link to real id */
127
128         struct snd_monitor_file *files; /* all files associated to this card */
129         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
130                                                                 state */
131         spinlock_t files_lock;          /* lock the files for this card */
132         int shutdown;                   /* this card is going down */
133         int free_on_last_close;         /* free in context of file_release */
134         wait_queue_head_t shutdown_sleep;
135         struct device *dev;             /* device assigned to this card */
136 #ifndef CONFIG_SYSFS_DEPRECATED
137         struct device *card_dev;        /* cardX object for sysfs */
138 #endif
139
140 #ifdef CONFIG_PM
141         unsigned int power_state;       /* power state */
142         struct mutex power_lock;        /* power lock */
143         wait_queue_head_t power_sleep;
144 #endif
145
146 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
147         struct snd_mixer_oss *mixer_oss;
148         int mixer_oss_change_count;
149 #endif
150 };
151
152 #ifdef CONFIG_PM
153 static inline void snd_power_lock(struct snd_card *card)
154 {
155         mutex_lock(&card->power_lock);
156 }
157
158 static inline void snd_power_unlock(struct snd_card *card)
159 {
160         mutex_unlock(&card->power_lock);
161 }
162
163 static inline unsigned int snd_power_get_state(struct snd_card *card)
164 {
165         return card->power_state;
166 }
167
168 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
169 {
170         card->power_state = state;
171         wake_up(&card->power_sleep);
172 }
173
174 /* init.c */
175 int snd_power_wait(struct snd_card *card, unsigned int power_state);
176
177 #else /* ! CONFIG_PM */
178
179 #define snd_power_lock(card)            do { (void)(card); } while (0)
180 #define snd_power_unlock(card)          do { (void)(card); } while (0)
181 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
182 #define snd_power_get_state(card)       SNDRV_CTL_POWER_D0
183 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
184
185 #endif /* CONFIG_PM */
186
187 struct snd_minor {
188         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
189         int card;                       /* card number */
190         int device;                     /* device number */
191         const struct file_operations *f_ops;    /* file operations */
192         void *private_data;             /* private data for f_ops->open */
193         struct device *dev;             /* device for sysfs */
194 };
195
196 /* return a device pointer linked to each sound device as a parent */
197 static inline struct device *snd_card_get_device_link(struct snd_card *card)
198 {
199 #ifdef CONFIG_SYSFS_DEPRECATED
200         return card ? card->dev : NULL;
201 #else
202         return card ? card->card_dev : NULL;
203 #endif
204 }
205
206 /* sound.c */
207
208 extern int snd_major;
209 extern int snd_ecards_limit;
210 extern struct class *sound_class;
211
212 void snd_request_card(int card);
213
214 int snd_register_device_for_dev(int type, struct snd_card *card,
215                                 int dev,
216                                 const struct file_operations *f_ops,
217                                 void *private_data,
218                                 const char *name,
219                                 struct device *device);
220
221 /**
222  * snd_register_device - Register the ALSA device file for the card
223  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
224  * @card: the card instance
225  * @dev: the device index
226  * @f_ops: the file operations
227  * @private_data: user pointer for f_ops->open()
228  * @name: the device file name
229  *
230  * Registers an ALSA device file for the given card.
231  * The operators have to be set in reg parameter.
232  *
233  * This function uses the card's device pointer to link to the
234  * correct &struct device.
235  *
236  * Returns zero if successful, or a negative error code on failure.
237  */
238 static inline int snd_register_device(int type, struct snd_card *card, int dev,
239                                       const struct file_operations *f_ops,
240                                       void *private_data,
241                                       const char *name)
242 {
243         return snd_register_device_for_dev(type, card, dev, f_ops,
244                                            private_data, name,
245                                            snd_card_get_device_link(card));
246 }
247
248 int snd_unregister_device(int type, struct snd_card *card, int dev);
249 void *snd_lookup_minor_data(unsigned int minor, int type);
250 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
251                               struct device_attribute *attr);
252
253 #ifdef CONFIG_SND_OSSEMUL
254 int snd_register_oss_device(int type, struct snd_card *card, int dev,
255                             const struct file_operations *f_ops, void *private_data,
256                             const char *name);
257 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
258 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
259 #endif
260
261 int snd_minor_info_init(void);
262 int snd_minor_info_done(void);
263
264 /* sound_oss.c */
265
266 #ifdef CONFIG_SND_OSSEMUL
267 int snd_minor_info_oss_init(void);
268 int snd_minor_info_oss_done(void);
269 #else
270 #define snd_minor_info_oss_init() /*NOP*/
271 #define snd_minor_info_oss_done() /*NOP*/
272 #endif
273
274 /* memory.c */
275
276 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
277 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
278
279 /* init.c */
280
281 extern struct snd_card *snd_cards[SNDRV_CARDS];
282 int snd_card_locked(int card);
283 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
284 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
285 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
286 #define SND_MIXER_OSS_NOTIFY_FREE       2
287 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
288 #endif
289
290 struct snd_card *snd_card_new(int idx, const char *id,
291                          struct module *module, int extra_size);
292 int snd_card_disconnect(struct snd_card *card);
293 int snd_card_free(struct snd_card *card);
294 int snd_card_free_when_closed(struct snd_card *card);
295 int snd_card_register(struct snd_card *card);
296 int snd_card_info_init(void);
297 int snd_card_info_done(void);
298 int snd_component_add(struct snd_card *card, const char *component);
299 int snd_card_file_add(struct snd_card *card, struct file *file);
300 int snd_card_file_remove(struct snd_card *card, struct file *file);
301
302 #ifndef snd_card_set_dev
303 #define snd_card_set_dev(card,devptr) ((card)->dev = (devptr))
304 #endif
305
306 /* device.c */
307
308 int snd_device_new(struct snd_card *card, snd_device_type_t type,
309                    void *device_data, struct snd_device_ops *ops);
310 int snd_device_register(struct snd_card *card, void *device_data);
311 int snd_device_register_all(struct snd_card *card);
312 int snd_device_disconnect(struct snd_card *card, void *device_data);
313 int snd_device_disconnect_all(struct snd_card *card);
314 int snd_device_free(struct snd_card *card, void *device_data);
315 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
316
317 /* isadma.c */
318
319 #ifdef CONFIG_ISA_DMA_API
320 #define DMA_MODE_NO_ENABLE      0x0100
321
322 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
323 void snd_dma_disable(unsigned long dma);
324 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
325 #endif
326
327 /* misc.c */
328 struct resource;
329 void release_and_free_resource(struct resource *res);
330
331 #ifdef CONFIG_SND_VERBOSE_PRINTK
332 void snd_verbose_printk(const char *file, int line, const char *format, ...)
333      __attribute__ ((format (printf, 3, 4)));
334 #endif
335 #if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
336 void snd_verbose_printd(const char *file, int line, const char *format, ...)
337      __attribute__ ((format (printf, 3, 4)));
338 #endif
339
340 /* --- */
341
342 #ifdef CONFIG_SND_VERBOSE_PRINTK
343 /**
344  * snd_printk - printk wrapper
345  * @fmt: format string
346  *
347  * Works like print() but prints the file and the line of the caller
348  * when configured with CONFIG_SND_VERBOSE_PRINTK.
349  */
350 #define snd_printk(fmt, args...) \
351         snd_verbose_printk(__FILE__, __LINE__, fmt ,##args)
352 #else
353 #define snd_printk(fmt, args...) \
354         printk(fmt ,##args)
355 #endif
356
357 #ifdef CONFIG_SND_DEBUG
358
359 #define __ASTRING__(x) #x
360
361 #ifdef CONFIG_SND_VERBOSE_PRINTK
362 /**
363  * snd_printd - debug printk
364  * @fmt: format string
365  *
366  * Compiled only when Works like snd_printk() for debugging purpose.
367  * Ignored when CONFIG_SND_DEBUG is not set.
368  */
369 #define snd_printd(fmt, args...) \
370         snd_verbose_printd(__FILE__, __LINE__, fmt ,##args)
371 #else
372 #define snd_printd(fmt, args...) \
373         printk(fmt ,##args)
374 #endif
375 /**
376  * snd_assert - run-time assertion macro
377  * @expr: expression
378  *
379  * This macro checks the expression in run-time and invokes the commands
380  * given in the rest arguments if the assertion is failed.
381  * When CONFIG_SND_DEBUG is not set, the expression is executed but
382  * not checked.
383  */
384 #define snd_assert(expr, args...) do {                                  \
385         if (unlikely(!(expr))) {                                        \
386                 snd_printk(KERN_ERR "BUG? (%s)\n", __ASTRING__(expr));  \
387                 dump_stack();                                           \
388                 args;                                                   \
389         }                                                               \
390 } while (0)
391
392 #define snd_BUG() do {                          \
393         snd_printk(KERN_ERR "BUG?\n");          \
394         dump_stack();                           \
395 } while (0)
396
397 #else /* !CONFIG_SND_DEBUG */
398
399 #define snd_printd(fmt, args...)        /* nothing */
400 #define snd_assert(expr, args...)       (void)(expr)
401 #define snd_BUG()                       /* nothing */
402
403 #endif /* CONFIG_SND_DEBUG */
404
405 #ifdef CONFIG_SND_DEBUG_DETECT
406 /**
407  * snd_printdd - debug printk
408  * @format: format string
409  *
410  * Compiled only when Works like snd_printk() for debugging purpose.
411  * Ignored when CONFIG_SND_DEBUG_DETECT is not set.
412  */
413 #define snd_printdd(format, args...) snd_printk(format, ##args)
414 #else
415 #define snd_printdd(format, args...) /* nothing */
416 #endif
417
418
419 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
420
421 /* for easier backward-porting */
422 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
423 #ifndef gameport_set_dev_parent
424 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
425 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
426 #define gameport_get_port_data(gp) (gp)->port_data
427 #endif
428 #endif
429
430 /* PCI quirk list helper */
431 struct snd_pci_quirk {
432         unsigned short subvendor;       /* PCI subvendor ID */
433         unsigned short subdevice;       /* PCI subdevice ID */
434         int value;                      /* value */
435 #ifdef CONFIG_SND_DEBUG_DETECT
436         const char *name;               /* name of the device (optional) */
437 #endif
438 };
439
440 #define _SND_PCI_QUIRK_ID(vend,dev) \
441         .subvendor = (vend), .subdevice = (dev)
442 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
443 #ifdef CONFIG_SND_DEBUG_DETECT
444 #define SND_PCI_QUIRK(vend,dev,xname,val) \
445         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
446 #else
447 #define SND_PCI_QUIRK(vend,dev,xname,val) \
448         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
449 #endif
450
451 const struct snd_pci_quirk *
452 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
453
454
455 #endif /* __SOUND_CORE_H */