b6e0f57d451d28fe27edb602ae02cba552d5709e
[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/stringify.h>
30
31 /* number of supported soundcards */
32 #ifdef CONFIG_SND_DYNAMIC_MINORS
33 #define SNDRV_CARDS 32
34 #else
35 #define SNDRV_CARDS 8           /* don't change - minor numbers */
36 #endif
37
38 #define CONFIG_SND_MAJOR        116     /* standard configuration */
39
40 /* forward declarations */
41 struct pci_dev;
42 struct module;
43 struct device;
44 struct device_attribute;
45
46 /* device allocation stuff */
47
48 #define SNDRV_DEV_TYPE_RANGE_SIZE               0x1000
49
50 typedef int __bitwise snd_device_type_t;
51 #define SNDRV_DEV_TOPLEVEL      ((__force snd_device_type_t) 0)
52 #define SNDRV_DEV_CONTROL       ((__force snd_device_type_t) 1)
53 #define SNDRV_DEV_LOWLEVEL_PRE  ((__force snd_device_type_t) 2)
54 #define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
55 #define SNDRV_DEV_PCM           ((__force snd_device_type_t) 0x1001)
56 #define SNDRV_DEV_RAWMIDI       ((__force snd_device_type_t) 0x1002)
57 #define SNDRV_DEV_TIMER         ((__force snd_device_type_t) 0x1003)
58 #define SNDRV_DEV_SEQUENCER     ((__force snd_device_type_t) 0x1004)
59 #define SNDRV_DEV_HWDEP         ((__force snd_device_type_t) 0x1005)
60 #define SNDRV_DEV_INFO          ((__force snd_device_type_t) 0x1006)
61 #define SNDRV_DEV_BUS           ((__force snd_device_type_t) 0x1007)
62 #define SNDRV_DEV_CODEC         ((__force snd_device_type_t) 0x1008)
63 #define SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
64 #define SNDRV_DEV_COMPRESS      ((__force snd_device_type_t) 0x100A)
65 #define SNDRV_DEV_LOWLEVEL      ((__force snd_device_type_t) 0x2000)
66
67 typedef int __bitwise snd_device_state_t;
68 #define SNDRV_DEV_BUILD         ((__force snd_device_state_t) 0)
69 #define SNDRV_DEV_REGISTERED    ((__force snd_device_state_t) 1)
70 #define SNDRV_DEV_DISCONNECTED  ((__force snd_device_state_t) 2)
71
72 typedef int __bitwise snd_device_cmd_t;
73 #define SNDRV_DEV_CMD_PRE       ((__force snd_device_cmd_t) 0)
74 #define SNDRV_DEV_CMD_NORMAL    ((__force snd_device_cmd_t) 1)  
75 #define SNDRV_DEV_CMD_POST      ((__force snd_device_cmd_t) 2)
76
77 struct snd_device;
78
79 struct snd_device_ops {
80         int (*dev_free)(struct snd_device *dev);
81         int (*dev_register)(struct snd_device *dev);
82         int (*dev_disconnect)(struct snd_device *dev);
83 };
84
85 struct snd_device {
86         struct list_head list;          /* list of registered devices */
87         struct snd_card *card;          /* card which holds this device */
88         snd_device_state_t state;       /* state of the device */
89         snd_device_type_t type;         /* device type */
90         void *device_data;              /* device structure */
91         struct snd_device_ops *ops;     /* operations */
92 };
93
94 #define snd_device(n) list_entry(n, struct snd_device, list)
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[128];           /* 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 list_head files_list;    /* 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         struct device *card_dev;        /* cardX object for sysfs */
137
138 #ifdef CONFIG_PM
139         unsigned int power_state;       /* power state */
140         struct mutex power_lock;        /* power lock */
141         wait_queue_head_t power_sleep;
142 #endif
143
144 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
145         struct snd_mixer_oss *mixer_oss;
146         int mixer_oss_change_count;
147 #endif
148 };
149
150 #ifdef CONFIG_PM
151 static inline void snd_power_lock(struct snd_card *card)
152 {
153         mutex_lock(&card->power_lock);
154 }
155
156 static inline void snd_power_unlock(struct snd_card *card)
157 {
158         mutex_unlock(&card->power_lock);
159 }
160
161 static inline unsigned int snd_power_get_state(struct snd_card *card)
162 {
163         return card->power_state;
164 }
165
166 static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
167 {
168         card->power_state = state;
169         wake_up(&card->power_sleep);
170 }
171
172 /* init.c */
173 int snd_power_wait(struct snd_card *card, unsigned int power_state);
174
175 #else /* ! CONFIG_PM */
176
177 #define snd_power_lock(card)            do { (void)(card); } while (0)
178 #define snd_power_unlock(card)          do { (void)(card); } while (0)
179 static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
180 #define snd_power_get_state(card)       ({ (void)(card); SNDRV_CTL_POWER_D0; })
181 #define snd_power_change_state(card, state)     do { (void)(card); } while (0)
182
183 #endif /* CONFIG_PM */
184
185 struct snd_minor {
186         int type;                       /* SNDRV_DEVICE_TYPE_XXX */
187         int card;                       /* card number */
188         int device;                     /* device number */
189         const struct file_operations *f_ops;    /* file operations */
190         void *private_data;             /* private data for f_ops->open */
191         struct device *dev;             /* device for sysfs */
192 };
193
194 /* return a device pointer linked to each sound device as a parent */
195 static inline struct device *snd_card_get_device_link(struct snd_card *card)
196 {
197         return card ? card->card_dev : NULL;
198 }
199
200 /* sound.c */
201
202 extern int snd_major;
203 extern int snd_ecards_limit;
204 extern struct class *sound_class;
205
206 void snd_request_card(int card);
207
208 int snd_register_device_for_dev(int type, struct snd_card *card,
209                                 int dev,
210                                 const struct file_operations *f_ops,
211                                 void *private_data,
212                                 const char *name,
213                                 struct device *device);
214
215 /**
216  * snd_register_device - Register the ALSA device file for the card
217  * @type: the device type, SNDRV_DEVICE_TYPE_XXX
218  * @card: the card instance
219  * @dev: the device index
220  * @f_ops: the file operations
221  * @private_data: user pointer for f_ops->open()
222  * @name: the device file name
223  *
224  * Registers an ALSA device file for the given card.
225  * The operators have to be set in reg parameter.
226  *
227  * This function uses the card's device pointer to link to the
228  * correct &struct device.
229  *
230  * Returns zero if successful, or a negative error code on failure.
231  */
232 static inline int snd_register_device(int type, struct snd_card *card, int dev,
233                                       const struct file_operations *f_ops,
234                                       void *private_data,
235                                       const char *name)
236 {
237         return snd_register_device_for_dev(type, card, dev, f_ops,
238                                            private_data, name,
239                                            snd_card_get_device_link(card));
240 }
241
242 int snd_unregister_device(int type, struct snd_card *card, int dev);
243 void *snd_lookup_minor_data(unsigned int minor, int type);
244 int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
245                               struct device_attribute *attr);
246
247 #ifdef CONFIG_SND_OSSEMUL
248 int snd_register_oss_device(int type, struct snd_card *card, int dev,
249                             const struct file_operations *f_ops, void *private_data,
250                             const char *name);
251 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
252 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
253 #endif
254
255 int snd_minor_info_init(void);
256 int snd_minor_info_done(void);
257
258 /* sound_oss.c */
259
260 #ifdef CONFIG_SND_OSSEMUL
261 int snd_minor_info_oss_init(void);
262 int snd_minor_info_oss_done(void);
263 #else
264 static inline int snd_minor_info_oss_init(void) { return 0; }
265 static inline int snd_minor_info_oss_done(void) { return 0; }
266 #endif
267
268 /* memory.c */
269
270 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
271 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
272
273 /* init.c */
274
275 extern struct snd_card *snd_cards[SNDRV_CARDS];
276 int snd_card_locked(int card);
277 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
278 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
279 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
280 #define SND_MIXER_OSS_NOTIFY_FREE       2
281 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
282 #endif
283
284 int snd_card_create(int idx, const char *id,
285                     struct module *module, int extra_size,
286                     struct snd_card **card_ret);
287
288 int snd_card_disconnect(struct snd_card *card);
289 int snd_card_free(struct snd_card *card);
290 int snd_card_free_when_closed(struct snd_card *card);
291 void snd_card_set_id(struct snd_card *card, const char *id);
292 int snd_card_register(struct snd_card *card);
293 int snd_card_info_init(void);
294 int snd_card_info_done(void);
295 int snd_component_add(struct snd_card *card, const char *component);
296 int snd_card_file_add(struct snd_card *card, struct file *file);
297 int snd_card_file_remove(struct snd_card *card, struct file *file);
298
299 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
300
301 /* device.c */
302
303 int snd_device_new(struct snd_card *card, snd_device_type_t type,
304                    void *device_data, struct snd_device_ops *ops);
305 int snd_device_register(struct snd_card *card, void *device_data);
306 int snd_device_register_all(struct snd_card *card);
307 int snd_device_disconnect(struct snd_card *card, void *device_data);
308 int snd_device_disconnect_all(struct snd_card *card);
309 int snd_device_free(struct snd_card *card, void *device_data);
310 int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
311
312 /* isadma.c */
313
314 #ifdef CONFIG_ISA_DMA_API
315 #define DMA_MODE_NO_ENABLE      0x0100
316
317 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
318 void snd_dma_disable(unsigned long dma);
319 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
320 #endif
321
322 /* misc.c */
323 struct resource;
324 void release_and_free_resource(struct resource *res);
325
326 /* --- */
327
328 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
329 __printf(4, 5)
330 void __snd_printk(unsigned int level, const char *file, int line,
331                   const char *format, ...);
332 #else
333 #define __snd_printk(level, file, line, format, args...) \
334         printk(format, ##args)
335 #endif
336
337 /**
338  * snd_printk - printk wrapper
339  * @fmt: format string
340  *
341  * Works like printk() but prints the file and the line of the caller
342  * when configured with CONFIG_SND_VERBOSE_PRINTK.
343  */
344 #define snd_printk(fmt, args...) \
345         __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
346
347 #ifdef CONFIG_SND_DEBUG
348 /**
349  * snd_printd - debug printk
350  * @fmt: format string
351  *
352  * Works like snd_printk() for debugging purposes.
353  * Ignored when CONFIG_SND_DEBUG is not set.
354  */
355 #define snd_printd(fmt, args...) \
356         __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
357
358 /**
359  * snd_BUG - give a BUG warning message and stack trace
360  *
361  * Calls WARN() if CONFIG_SND_DEBUG is set.
362  * Ignored when CONFIG_SND_DEBUG is not set.
363  */
364 #define snd_BUG()               WARN(1, "BUG?\n")
365
366 /**
367  * snd_BUG_ON - debugging check macro
368  * @cond: condition to evaluate
369  *
370  * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
371  * and call WARN() and returns the value if it's non-zero.
372  * 
373  * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
374  * condition is ignored.
375  *
376  * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
377  * Thus, don't put any statement that influences on the code behavior,
378  * such as pre/post increment, to the argument of this macro.
379  * If you want to evaluate and give a warning, use standard WARN_ON().
380  */
381 #define snd_BUG_ON(cond)        WARN((cond), "BUG? (%s)\n", __stringify(cond))
382
383 #else /* !CONFIG_SND_DEBUG */
384
385 #define snd_printd(fmt, args...)        do { } while (0)
386 #define snd_BUG()                       do { } while (0)
387 static inline int __snd_bug_on(int cond)
388 {
389         return 0;
390 }
391 #define snd_BUG_ON(cond)        __snd_bug_on(0 && (cond))  /* always false */
392
393 #endif /* CONFIG_SND_DEBUG */
394
395 #ifdef CONFIG_SND_DEBUG_VERBOSE
396 /**
397  * snd_printdd - debug printk
398  * @format: format string
399  *
400  * Works like snd_printk() for debugging purposes.
401  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
402  */
403 #define snd_printdd(format, args...) \
404         __snd_printk(2, __FILE__, __LINE__, format, ##args)
405 #else
406 #define snd_printdd(format, args...)    do { } while (0)
407 #endif
408
409
410 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
411
412 /* for easier backward-porting */
413 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
414 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
415 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
416 #define gameport_get_port_data(gp) (gp)->port_data
417 #endif
418
419 #ifdef CONFIG_PCI
420 /* PCI quirk list helper */
421 struct snd_pci_quirk {
422         unsigned short subvendor;       /* PCI subvendor ID */
423         unsigned short subdevice;       /* PCI subdevice ID */
424         unsigned short subdevice_mask;  /* bitmask to match */
425         int value;                      /* value */
426 #ifdef CONFIG_SND_DEBUG_VERBOSE
427         const char *name;               /* name of the device (optional) */
428 #endif
429 };
430
431 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
432         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
433 #define _SND_PCI_QUIRK_ID(vend, dev) \
434         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
435 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
436 #ifdef CONFIG_SND_DEBUG_VERBOSE
437 #define SND_PCI_QUIRK(vend,dev,xname,val) \
438         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
439 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
440         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
441 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
442         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
443                         .value = (val), .name = (xname)}
444 #else
445 #define SND_PCI_QUIRK(vend,dev,xname,val) \
446         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
447 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
448         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
449 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
450         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
451 #endif
452
453 const struct snd_pci_quirk *
454 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
455
456 const struct snd_pci_quirk *
457 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
458                         const struct snd_pci_quirk *list);
459 #endif
460
461 #endif /* __SOUND_CORE_H */