Merge tag 'v3.10.62' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / sound / core.h
CommitLineData
1da177e4
LT
1#ifndef __SOUND_CORE_H
2#define __SOUND_CORE_H
3
4/*
5 * Main header file for the ALSA driver
c1017a4c 6 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT
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() */
1a60d4c5 26#include <linux/mutex.h> /* struct mutex */
1da177e4 27#include <linux/rwsem.h> /* struct rw_semaphore */
1da177e4 28#include <linux/pm.h> /* pm_message_t */
5ef03460 29#include <linux/stringify.h>
1da177e4 30
9004acc7
TI
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
1da177e4 40/* forward declarations */
1da177e4 41struct pci_dev;
de477254 42struct module;
313162d0
PG
43struct device;
44struct device_attribute;
1da177e4
LT
45
46/* device allocation stuff */
47
48#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
49
512bbd6a
TI
50typedef 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)
e76d8cea 63#define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
3eafc959 64#define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
512bbd6a
TI
65#define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
66
67typedef 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
72typedef 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
77struct snd_device;
78
79struct 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);
512bbd6a
TI
83};
84
85struct snd_device {
1da177e4 86 struct list_head list; /* list of registered devices */
512bbd6a 87 struct snd_card *card; /* card which holds this device */
1da177e4
LT
88 snd_device_state_t state; /* state of the device */
89 snd_device_type_t type; /* device type */
90 void *device_data; /* device structure */
512bbd6a 91 struct snd_device_ops *ops; /* operations */
1da177e4
LT
92};
93
512bbd6a 94#define snd_device(n) list_entry(n, struct snd_device, list)
1da177e4 95
1da177e4
LT
96/* main structure for soundcard */
97
512bbd6a 98struct snd_card {
d5750f67
HK
99 int number; /* number of soundcard (index to
100 snd_cards) */
1da177e4
LT
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 */
ff33f230 107 char components[128]; /* card components delimited with
d5750f67 108 space */
1da177e4
LT
109 struct module *module; /* top-level module */
110
111 void *private_data; /* private data for soundcard */
512bbd6a 112 void (*private_free) (struct snd_card *card); /* callback for freeing of
d5750f67 113 private data */
1da177e4
LT
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 */
be3bae53
LPC
123 struct mutex user_ctl_lock; /* protects user controls against
124 concurrent access */
1da177e4 125
512bbd6a
TI
126 struct snd_info_entry *proc_root; /* root for soundcard specific files */
127 struct snd_info_entry *proc_id; /* the card id */
1da177e4
LT
128 struct proc_dir_entry *proc_root_link; /* number link to real id */
129
118dd6bf 130 struct list_head files_list; /* all files associated to this card */
d5750f67
HK
131 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
132 state */
1da177e4
LT
133 spinlock_t files_lock; /* lock the files for this card */
134 int shutdown; /* this card is going down */
c461482c 135 int free_on_last_close; /* free in context of file_release */
1da177e4 136 wait_queue_head_t shutdown_sleep;
a0830dbd 137 atomic_t refcount; /* refcount for disconnection */
7d2aae1e 138 struct device *dev; /* device assigned to this card */
7d2aae1e 139 struct device *card_dev; /* cardX object for sysfs */
1da177e4
LT
140
141#ifdef CONFIG_PM
1da177e4 142 unsigned int power_state; /* power state */
1a60d4c5 143 struct mutex power_lock; /* power lock */
1da177e4 144 wait_queue_head_t power_sleep;
1da177e4
LT
145#endif
146
147#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
512bbd6a 148 struct snd_mixer_oss *mixer_oss;
1da177e4
LT
149 int mixer_oss_change_count;
150#endif
151};
152
153#ifdef CONFIG_PM
512bbd6a 154static inline void snd_power_lock(struct snd_card *card)
1da177e4 155{
1a60d4c5 156 mutex_lock(&card->power_lock);
1da177e4
LT
157}
158
512bbd6a 159static inline void snd_power_unlock(struct snd_card *card)
1da177e4 160{
1a60d4c5 161 mutex_unlock(&card->power_lock);
1da177e4
LT
162}
163
512bbd6a 164static inline unsigned int snd_power_get_state(struct snd_card *card)
1da177e4
LT
165{
166 return card->power_state;
167}
168
512bbd6a 169static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
1da177e4
LT
170{
171 card->power_state = state;
172 wake_up(&card->power_sleep);
173}
d5750f67
HK
174
175/* init.c */
cbac4b0c 176int snd_power_wait(struct snd_card *card, unsigned int power_state);
d5750f67 177
1da177e4
LT
178#else /* ! CONFIG_PM */
179
180#define snd_power_lock(card) do { (void)(card); } while (0)
181#define snd_power_unlock(card) do { (void)(card); } while (0)
6fdb94bd 182static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
363129ea 183#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
1da177e4 184#define snd_power_change_state(card, state) do { (void)(card); } while (0)
1da177e4
LT
185
186#endif /* CONFIG_PM */
187
512bbd6a 188struct snd_minor {
2af677fc 189 int type; /* SNDRV_DEVICE_TYPE_XXX */
6983b724 190 int card; /* card number */
1da177e4 191 int device; /* device number */
99ac48f5 192 const struct file_operations *f_ops; /* file operations */
f87135f5 193 void *private_data; /* private data for f_ops->open */
d80f19fa 194 struct device *dev; /* device for sysfs */
a0830dbd 195 struct snd_card *card_ptr; /* assigned card instance */
1da177e4
LT
196};
197
7d2aae1e
TI
198/* return a device pointer linked to each sound device as a parent */
199static inline struct device *snd_card_get_device_link(struct snd_card *card)
200{
7d2aae1e 201 return card ? card->card_dev : NULL;
7d2aae1e
TI
202}
203
1da177e4
LT
204/* sound.c */
205
f1902860 206extern int snd_major;
1da177e4 207extern int snd_ecards_limit;
d80f19fa 208extern struct class *sound_class;
1da177e4
LT
209
210void snd_request_card(int card);
211
12b131c4
JB
212int snd_register_device_for_dev(int type, struct snd_card *card,
213 int dev,
214 const struct file_operations *f_ops,
215 void *private_data,
216 const char *name,
217 struct device *device);
218
219/**
220 * snd_register_device - Register the ALSA device file for the card
221 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
222 * @card: the card instance
223 * @dev: the device index
224 * @f_ops: the file operations
225 * @private_data: user pointer for f_ops->open()
226 * @name: the device file name
227 *
228 * Registers an ALSA device file for the given card.
229 * The operators have to be set in reg parameter.
230 *
231 * This function uses the card's device pointer to link to the
232 * correct &struct device.
233 *
eb7c06e8 234 * Return: Zero if successful, or a negative error code on failure.
12b131c4
JB
235 */
236static inline int snd_register_device(int type, struct snd_card *card, int dev,
237 const struct file_operations *f_ops,
238 void *private_data,
239 const char *name)
240{
241 return snd_register_device_for_dev(type, card, dev, f_ops,
242 private_data, name,
c2902c8a 243 snd_card_get_device_link(card));
12b131c4
JB
244}
245
512bbd6a 246int snd_unregister_device(int type, struct snd_card *card, int dev);
f87135f5 247void *snd_lookup_minor_data(unsigned int minor, int type);
9d19f48c 248int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
d80f19fa 249 struct device_attribute *attr);
1da177e4
LT
250
251#ifdef CONFIG_SND_OSSEMUL
2af677fc 252int snd_register_oss_device(int type, struct snd_card *card, int dev,
99ac48f5 253 const struct file_operations *f_ops, void *private_data,
f87135f5 254 const char *name);
512bbd6a 255int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5 256void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4
LT
257#endif
258
259int snd_minor_info_init(void);
260int snd_minor_info_done(void);
261
262/* sound_oss.c */
263
264#ifdef CONFIG_SND_OSSEMUL
265int snd_minor_info_oss_init(void);
266int snd_minor_info_oss_done(void);
1da177e4 267#else
ad5fada5
PM
268static inline int snd_minor_info_oss_init(void) { return 0; }
269static inline int snd_minor_info_oss_done(void) { return 0; }
1da177e4
LT
270#endif
271
272/* memory.c */
273
1da177e4
LT
274int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
275int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
276
277/* init.c */
278
512bbd6a 279extern struct snd_card *snd_cards[SNDRV_CARDS];
746df948 280int snd_card_locked(int card);
1da177e4
LT
281#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
282#define SND_MIXER_OSS_NOTIFY_REGISTER 0
283#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
284#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a 285extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
1da177e4
LT
286#endif
287
53fb1e63
TI
288int snd_card_create(int idx, const char *id,
289 struct module *module, int extra_size,
290 struct snd_card **card_ret);
291
512bbd6a
TI
292int snd_card_disconnect(struct snd_card *card);
293int snd_card_free(struct snd_card *card);
c461482c 294int snd_card_free_when_closed(struct snd_card *card);
10a8ebbb 295void snd_card_set_id(struct snd_card *card, const char *id);
512bbd6a 296int snd_card_register(struct snd_card *card);
1da177e4
LT
297int snd_card_info_init(void);
298int snd_card_info_done(void);
512bbd6a
TI
299int snd_component_add(struct snd_card *card, const char *component);
300int snd_card_file_add(struct snd_card *card, struct file *file);
301int snd_card_file_remove(struct snd_card *card, struct file *file);
a0830dbd 302void snd_card_unref(struct snd_card *card);
1da177e4 303
edab938e 304#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4
LT
305
306/* device.c */
307
512bbd6a
TI
308int snd_device_new(struct snd_card *card, snd_device_type_t type,
309 void *device_data, struct snd_device_ops *ops);
310int snd_device_register(struct snd_card *card, void *device_data);
311int snd_device_register_all(struct snd_card *card);
312int snd_device_disconnect(struct snd_card *card, void *device_data);
313int snd_device_disconnect_all(struct snd_card *card);
314int snd_device_free(struct snd_card *card, void *device_data);
315int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
1da177e4
LT
316
317/* isadma.c */
318
276bd31c 319#ifdef CONFIG_ISA_DMA_API
1da177e4
LT
320#define DMA_MODE_NO_ENABLE 0x0100
321
322void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
323void snd_dma_disable(unsigned long dma);
324unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
276bd31c 325#endif
1da177e4
LT
326
327/* misc.c */
b709e574 328struct resource;
b1d5776d 329void release_and_free_resource(struct resource *res);
1da177e4 330
1da177e4
LT
331/* --- */
332
fae3d88a
FW
333/* sound printk debug levels */
334enum {
335 SND_PR_ALWAYS,
336 SND_PR_DEBUG,
337 SND_PR_VERBOSE,
338};
339
36ce99c1 340#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9 341__printf(4, 5)
36ce99c1 342void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9 343 const char *format, ...);
36ce99c1
TI
344#else
345#define __snd_printk(level, file, line, format, args...) \
cf0baf16 346 printk(format, ##args)
36ce99c1
TI
347#endif
348
1da177e4
LT
349/**
350 * snd_printk - printk wrapper
351 * @fmt: format string
352 *
f66fcedc 353 * Works like printk() but prints the file and the line of the caller
1da177e4
LT
354 * when configured with CONFIG_SND_VERBOSE_PRINTK.
355 */
356#define snd_printk(fmt, args...) \
36ce99c1 357 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
1da177e4
LT
358
359#ifdef CONFIG_SND_DEBUG
1da177e4
LT
360/**
361 * snd_printd - debug printk
0863afb3 362 * @fmt: format string
1da177e4 363 *
edab938e 364 * Works like snd_printk() for debugging purposes.
1da177e4
LT
365 * Ignored when CONFIG_SND_DEBUG is not set.
366 */
367#define snd_printd(fmt, args...) \
36ce99c1 368 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
fae3d88a
FW
369#define _snd_printd(level, fmt, args...) \
370 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
7c22f1aa 371
f66fcedc
TI
372/**
373 * snd_BUG - give a BUG warning message and stack trace
374 *
375 * Calls WARN() if CONFIG_SND_DEBUG is set.
376 * Ignored when CONFIG_SND_DEBUG is not set.
377 */
bdbecf50 378#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc
TI
379
380/**
381 * snd_BUG_ON - debugging check macro
382 * @cond: condition to evaluate
383 *
d5702162
CS
384 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
385 * otherwise just evaluates the conditional and returns the value.
f66fcedc 386 */
d5702162 387#define snd_BUG_ON(cond) WARN_ON((cond))
1da177e4
LT
388
389#else /* !CONFIG_SND_DEBUG */
390
86b27237
TI
391__printf(1, 2)
392static inline void snd_printd(const char *format, ...) {}
393__printf(2, 3)
394static inline void _snd_printd(int level, const char *format, ...) {}
395
fcef7836 396#define snd_BUG() do { } while (0)
d5702162
CS
397
398#define snd_BUG_ON(condition) ({ \
399 int __ret_warn_on = !!(condition); \
400 unlikely(__ret_warn_on); \
401})
1da177e4
LT
402
403#endif /* CONFIG_SND_DEBUG */
404
62cf872a 405#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4
LT
406/**
407 * snd_printdd - debug printk
408 * @format: format string
409 *
edab938e 410 * Works like snd_printk() for debugging purposes.
62cf872a 411 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4 412 */
36ce99c1
TI
413#define snd_printdd(format, args...) \
414 __snd_printk(2, __FILE__, __LINE__, format, ##args)
1da177e4 415#else
86b27237
TI
416__printf(1, 2)
417static inline void snd_printdd(const char *format, ...) {}
1da177e4
LT
418#endif
419
1da177e4 420
1da177e4
LT
421#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
422
423/* for easier backward-porting */
424#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
1da177e4
LT
425#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
426#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
427#define gameport_get_port_data(gp) (gp)->port_data
428#endif
1da177e4 429
8422fa11 430#ifdef CONFIG_PCI
d9ea472c
TI
431/* PCI quirk list helper */
432struct snd_pci_quirk {
433 unsigned short subvendor; /* PCI subvendor ID */
434 unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a 435 unsigned short subdevice_mask; /* bitmask to match */
d9ea472c 436 int value; /* value */
62cf872a 437#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c
TI
438 const char *name; /* name of the device (optional) */
439#endif
440};
441
8bd4bb7a
TI
442#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
443 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
444#define _SND_PCI_QUIRK_ID(vend, dev) \
445 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
d9ea472c 446#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a 447#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c
TI
448#define SND_PCI_QUIRK(vend,dev,xname,val) \
449 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a
TI
450#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
451 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
452#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
453 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
454 .value = (val), .name = (xname)}
86b27237 455#define snd_pci_quirk_name(q) ((q)->name)
d9ea472c
TI
456#else
457#define SND_PCI_QUIRK(vend,dev,xname,val) \
458 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a
TI
459#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
460 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
461#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
462 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
86b27237 463#define snd_pci_quirk_name(q) ""
d9ea472c
TI
464#endif
465
466const struct snd_pci_quirk *
467snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
468
d1458279
TI
469const struct snd_pci_quirk *
470snd_pci_quirk_lookup_id(u16 vendor, u16 device,
471 const struct snd_pci_quirk *list);
8422fa11 472#endif
d9ea472c 473
1da177e4 474#endif /* __SOUND_CORE_H */