Merge branch 'for-linus' into for-next
[linux-2.6-block.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/device.h>
26 #include <linux/sched.h>                /* wake_up() */
27 #include <linux/mutex.h>                /* struct mutex */
28 #include <linux/rwsem.h>                /* struct rw_semaphore */
29 #include <linux/pm.h>                   /* pm_message_t */
30 #include <linux/stringify.h>
31 #include <linux/printk.h>
32
33 /* number of supported soundcards */
34 #ifdef CONFIG_SND_DYNAMIC_MINORS
35 #define SNDRV_CARDS CONFIG_SND_MAX_CARDS
36 #else
37 #define SNDRV_CARDS 8           /* don't change - minor numbers */
38 #endif
39
40 #define CONFIG_SND_MAJOR        116     /* standard configuration */
41
42 /* forward declarations */
43 struct pci_dev;
44 struct module;
45 struct completion;
46
47 /* device allocation stuff */
48
49 /* type of the object used in snd_device_*()
50  * this also defines the calling order
51  */
52 enum snd_device_type {
53         SNDRV_DEV_LOWLEVEL,
54         SNDRV_DEV_CONTROL,
55         SNDRV_DEV_INFO,
56         SNDRV_DEV_BUS,
57         SNDRV_DEV_CODEC,
58         SNDRV_DEV_PCM,
59         SNDRV_DEV_COMPRESS,
60         SNDRV_DEV_RAWMIDI,
61         SNDRV_DEV_TIMER,
62         SNDRV_DEV_SEQUENCER,
63         SNDRV_DEV_HWDEP,
64         SNDRV_DEV_JACK,
65 };
66
67 enum snd_device_state {
68         SNDRV_DEV_BUILD,
69         SNDRV_DEV_REGISTERED,
70         SNDRV_DEV_DISCONNECTED,
71 };
72
73 struct snd_device;
74
75 struct snd_device_ops {
76         int (*dev_free)(struct snd_device *dev);
77         int (*dev_register)(struct snd_device *dev);
78         int (*dev_disconnect)(struct snd_device *dev);
79 };
80
81 struct snd_device {
82         struct list_head list;          /* list of registered devices */
83         struct snd_card *card;          /* card which holds this device */
84         enum snd_device_state state;    /* state of the device */
85         enum snd_device_type type;      /* device type */
86         void *device_data;              /* device structure */
87         struct snd_device_ops *ops;     /* operations */
88 };
89
90 #define snd_device(n) list_entry(n, struct snd_device, list)
91
92 /* main structure for soundcard */
93
94 struct snd_card {
95         int number;                     /* number of soundcard (index to
96                                                                 snd_cards) */
97
98         char id[16];                    /* id string of this card */
99         char driver[16];                /* driver name */
100         char shortname[32];             /* short name of this soundcard */
101         char longname[80];              /* name of this soundcard */
102         char mixername[80];             /* mixer name */
103         char components[128];           /* card components delimited with
104                                                                 space */
105         struct module *module;          /* top-level module */
106
107         void *private_data;             /* private data for soundcard */
108         void (*private_free) (struct snd_card *card); /* callback for freeing of
109                                                                 private data */
110         struct list_head devices;       /* devices */
111
112         struct device ctl_dev;          /* control device */
113         unsigned int last_numid;        /* last used numeric ID */
114         struct rw_semaphore controls_rwsem;     /* controls list lock */
115         rwlock_t ctl_files_rwlock;      /* ctl_files list lock */
116         int controls_count;             /* count of all controls */
117         int user_ctl_count;             /* count of all user controls */
118         struct list_head controls;      /* all controls for this card */
119         struct list_head ctl_files;     /* active control files */
120         struct mutex user_ctl_lock;     /* protects user controls against
121                                            concurrent access */
122
123         struct snd_info_entry *proc_root;       /* root for soundcard specific files */
124         struct snd_info_entry *proc_id; /* the card id */
125         struct proc_dir_entry *proc_root_link;  /* number link to real id */
126
127         struct list_head files_list;    /* all files associated to this card */
128         struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
129                                                                 state */
130         spinlock_t files_lock;          /* lock the files for this card */
131         int shutdown;                   /* this card is going down */
132         struct completion *release_completion;
133         struct device *dev;             /* device assigned to this card */
134         struct device card_dev;         /* cardX object for sysfs */
135         const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
136         bool registered;                /* card_dev is registered? */
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 #define dev_to_snd_card(p)      container_of(p, struct snd_card, card_dev)
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)       ({ (void)(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         struct snd_card *card_ptr;      /* assigned card instance */
195 };
196
197 /* return a device pointer linked to each sound device as a parent */
198 static inline struct device *snd_card_get_device_link(struct snd_card *card)
199 {
200         return card ? &card->card_dev : NULL;
201 }
202
203 /* sound.c */
204
205 extern int snd_major;
206 extern int snd_ecards_limit;
207 extern struct class *sound_class;
208
209 void snd_request_card(int card);
210
211 void snd_device_initialize(struct device *dev, struct snd_card *card);
212
213 int snd_register_device(int type, struct snd_card *card, int dev,
214                         const struct file_operations *f_ops,
215                         void *private_data, struct device *device);
216 int snd_unregister_device(struct device *dev);
217 void *snd_lookup_minor_data(unsigned int minor, int type);
218
219 #ifdef CONFIG_SND_OSSEMUL
220 int snd_register_oss_device(int type, struct snd_card *card, int dev,
221                             const struct file_operations *f_ops, void *private_data);
222 int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
223 void *snd_lookup_oss_minor_data(unsigned int minor, int type);
224 #endif
225
226 int snd_minor_info_init(void);
227
228 /* sound_oss.c */
229
230 #ifdef CONFIG_SND_OSSEMUL
231 int snd_minor_info_oss_init(void);
232 #else
233 static inline int snd_minor_info_oss_init(void) { return 0; }
234 #endif
235
236 /* memory.c */
237
238 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
239 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
240
241 /* init.c */
242
243 extern struct snd_card *snd_cards[SNDRV_CARDS];
244 int snd_card_locked(int card);
245 #if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
246 #define SND_MIXER_OSS_NOTIFY_REGISTER   0
247 #define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
248 #define SND_MIXER_OSS_NOTIFY_FREE       2
249 extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
250 #endif
251
252 int snd_card_new(struct device *parent, int idx, const char *xid,
253                  struct module *module, int extra_size,
254                  struct snd_card **card_ret);
255
256 int snd_card_disconnect(struct snd_card *card);
257 int snd_card_free(struct snd_card *card);
258 int snd_card_free_when_closed(struct snd_card *card);
259 void snd_card_set_id(struct snd_card *card, const char *id);
260 int snd_card_register(struct snd_card *card);
261 int snd_card_info_init(void);
262 int snd_card_add_dev_attr(struct snd_card *card,
263                           const struct attribute_group *group);
264 int snd_component_add(struct snd_card *card, const char *component);
265 int snd_card_file_add(struct snd_card *card, struct file *file);
266 int snd_card_file_remove(struct snd_card *card, struct file *file);
267 #define snd_card_unref(card)    put_device(&(card)->card_dev)
268
269 #define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
270
271 /* device.c */
272
273 int snd_device_new(struct snd_card *card, enum snd_device_type type,
274                    void *device_data, struct snd_device_ops *ops);
275 int snd_device_register(struct snd_card *card, void *device_data);
276 int snd_device_register_all(struct snd_card *card);
277 void snd_device_disconnect(struct snd_card *card, void *device_data);
278 void snd_device_disconnect_all(struct snd_card *card);
279 void snd_device_free(struct snd_card *card, void *device_data);
280 void snd_device_free_all(struct snd_card *card);
281
282 /* isadma.c */
283
284 #ifdef CONFIG_ISA_DMA_API
285 #define DMA_MODE_NO_ENABLE      0x0100
286
287 void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
288 void snd_dma_disable(unsigned long dma);
289 unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
290 #endif
291
292 /* misc.c */
293 struct resource;
294 void release_and_free_resource(struct resource *res);
295
296 /* --- */
297
298 /* sound printk debug levels */
299 enum {
300         SND_PR_ALWAYS,
301         SND_PR_DEBUG,
302         SND_PR_VERBOSE,
303 };
304
305 #if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
306 __printf(4, 5)
307 void __snd_printk(unsigned int level, const char *file, int line,
308                   const char *format, ...);
309 #else
310 #define __snd_printk(level, file, line, format, args...) \
311         printk(format, ##args)
312 #endif
313
314 /**
315  * snd_printk - printk wrapper
316  * @fmt: format string
317  *
318  * Works like printk() but prints the file and the line of the caller
319  * when configured with CONFIG_SND_VERBOSE_PRINTK.
320  */
321 #define snd_printk(fmt, args...) \
322         __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
323
324 #ifdef CONFIG_SND_DEBUG
325 /**
326  * snd_printd - debug printk
327  * @fmt: format string
328  *
329  * Works like snd_printk() for debugging purposes.
330  * Ignored when CONFIG_SND_DEBUG is not set.
331  */
332 #define snd_printd(fmt, args...) \
333         __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
334 #define _snd_printd(level, fmt, args...) \
335         __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
336
337 /**
338  * snd_BUG - give a BUG warning message and stack trace
339  *
340  * Calls WARN() if CONFIG_SND_DEBUG is set.
341  * Ignored when CONFIG_SND_DEBUG is not set.
342  */
343 #define snd_BUG()               WARN(1, "BUG?\n")
344
345 /**
346  * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
347  */
348 #define snd_printd_ratelimit() printk_ratelimit()
349
350 /**
351  * snd_BUG_ON - debugging check macro
352  * @cond: condition to evaluate
353  *
354  * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
355  * otherwise just evaluates the conditional and returns the value.
356  */
357 #define snd_BUG_ON(cond)        WARN_ON((cond))
358
359 #else /* !CONFIG_SND_DEBUG */
360
361 __printf(1, 2)
362 static inline void snd_printd(const char *format, ...) {}
363 __printf(2, 3)
364 static inline void _snd_printd(int level, const char *format, ...) {}
365
366 #define snd_BUG()                       do { } while (0)
367
368 #define snd_BUG_ON(condition) ({ \
369         int __ret_warn_on = !!(condition); \
370         unlikely(__ret_warn_on); \
371 })
372
373 static inline bool snd_printd_ratelimit(void) { return false; }
374
375 #endif /* CONFIG_SND_DEBUG */
376
377 #ifdef CONFIG_SND_DEBUG_VERBOSE
378 /**
379  * snd_printdd - debug printk
380  * @format: format string
381  *
382  * Works like snd_printk() for debugging purposes.
383  * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
384  */
385 #define snd_printdd(format, args...) \
386         __snd_printk(2, __FILE__, __LINE__, format, ##args)
387 #else
388 __printf(1, 2)
389 static inline void snd_printdd(const char *format, ...) {}
390 #endif
391
392
393 #define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))   /* 3.8.1a */
394
395 /* for easier backward-porting */
396 #if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
397 #define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
398 #define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
399 #define gameport_get_port_data(gp) (gp)->port_data
400 #endif
401
402 /* PCI quirk list helper */
403 struct snd_pci_quirk {
404         unsigned short subvendor;       /* PCI subvendor ID */
405         unsigned short subdevice;       /* PCI subdevice ID */
406         unsigned short subdevice_mask;  /* bitmask to match */
407         int value;                      /* value */
408 #ifdef CONFIG_SND_DEBUG_VERBOSE
409         const char *name;               /* name of the device (optional) */
410 #endif
411 };
412
413 #define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
414         .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
415 #define _SND_PCI_QUIRK_ID(vend, dev) \
416         _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
417 #define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
418 #ifdef CONFIG_SND_DEBUG_VERBOSE
419 #define SND_PCI_QUIRK(vend,dev,xname,val) \
420         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
421 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
422         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
423 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
424         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),                       \
425                         .value = (val), .name = (xname)}
426 #define snd_pci_quirk_name(q)   ((q)->name)
427 #else
428 #define SND_PCI_QUIRK(vend,dev,xname,val) \
429         {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
430 #define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)                 \
431         {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
432 #define SND_PCI_QUIRK_VENDOR(vend, xname, val)                  \
433         {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
434 #define snd_pci_quirk_name(q)   ""
435 #endif
436
437 #ifdef CONFIG_PCI
438 const struct snd_pci_quirk *
439 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
440
441 const struct snd_pci_quirk *
442 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
443                         const struct snd_pci_quirk *list);
444 #else
445 static inline const struct snd_pci_quirk *
446 snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
447 {
448         return NULL;
449 }
450
451 static inline const struct snd_pci_quirk *
452 snd_pci_quirk_lookup_id(u16 vendor, u16 device,
453                         const struct snd_pci_quirk *list)
454 {
455         return NULL;
456 }
457 #endif
458
459 #endif /* __SOUND_CORE_H */