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