blob: 5b9969e398b68607d21ce701385aa8bbb84896e2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_CORE_H
2#define __SOUND_CORE_H
3
4/*
5 * Main header file for the ALSA driver
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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() */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010026#include <linux/mutex.h> /* struct mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/rwsem.h> /* struct rw_semaphore */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/pm.h> /* pm_message_t */
Takashi Iwai5ef03462008-08-08 17:06:01 +020029#include <linux/stringify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Takashi Iwai9004acc2008-01-08 18:13:27 +010031/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/* forward declarations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041struct pci_dev;
Paul Gortmakerde477252011-05-26 13:46:22 -040042struct module;
Paul Gortmaker313162d2012-01-30 11:46:54 -050043struct device;
44struct device_attribute;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46/* device allocation stuff */
47
48#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
49
Takashi Iwai512bbd62005-11-17 13:51:18 +010050typedef 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)
Mark Browne76d8ce2008-07-28 19:05:35 +010063#define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
Omair Mohammed Abdullah3eafc952011-12-23 10:36:36 +053064#define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
Takashi Iwai512bbd62005-11-17 13:51:18 +010065#define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Takashi Iwai512bbd62005-11-17 13:51:18 +010067typedef 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
Takashi Iwai512bbd62005-11-17 13:51:18 +010072typedef 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Takashi Iwai512bbd62005-11-17 13:51:18 +010077struct snd_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
Takashi Iwai512bbd62005-11-17 13:51:18 +010079struct 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);
Takashi Iwai512bbd62005-11-17 13:51:18 +010083};
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Takashi Iwai512bbd62005-11-17 13:51:18 +010085struct snd_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 struct list_head list; /* list of registered devices */
Takashi Iwai512bbd62005-11-17 13:51:18 +010087 struct snd_card *card; /* card which holds this device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 snd_device_state_t state; /* state of the device */
89 snd_device_type_t type; /* device type */
90 void *device_data; /* device structure */
Takashi Iwai512bbd62005-11-17 13:51:18 +010091 struct snd_device_ops *ops; /* operations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092};
93
Takashi Iwai512bbd62005-11-17 13:51:18 +010094#define snd_device(n) list_entry(n, struct snd_device, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096/* main structure for soundcard */
97
Takashi Iwai512bbd62005-11-17 13:51:18 +010098struct snd_card {
Henrik Kretzschmard5750f62005-06-29 19:31:06 +020099 int number; /* number of soundcard (index to
100 snd_cards) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
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 */
Takashi Iwaiff33f232008-10-07 11:38:09 +0200107 char components[128]; /* card components delimited with
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200108 space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 struct module *module; /* top-level module */
110
111 void *private_data; /* private data for soundcard */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100112 void (*private_free) (struct snd_card *card); /* callback for freeing of
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200113 private data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 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
Takashi Iwai512bbd62005-11-17 13:51:18 +0100124 struct snd_info_entry *proc_root; /* root for soundcard specific files */
125 struct snd_info_entry *proc_id; /* the card id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 struct proc_dir_entry *proc_root_link; /* number link to real id */
127
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100128 struct list_head files_list; /* all files associated to this card */
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200129 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
130 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 spinlock_t files_lock; /* lock the files for this card */
132 int shutdown; /* this card is going down */
Takashi Iwaic4614822006-06-23 14:38:23 +0200133 int free_on_last_close; /* free in context of file_release */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 wait_queue_head_t shutdown_sleep;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100135 struct device *dev; /* device assigned to this card */
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100136 struct device *card_dev; /* cardX object for sysfs */
Joonwoo Park6fb64392013-08-07 18:59:09 -0700137 int offline; /* if this sound card is offline */
138 unsigned long offline_change;
139 wait_queue_head_t offline_poll_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
141#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 unsigned int power_state; /* power state */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100143 struct mutex power_lock; /* power lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#endif
146
147#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100148 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 int mixer_oss_change_count;
150#endif
151};
152
153#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100154static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100156 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Takashi Iwai512bbd62005-11-17 13:51:18 +0100159static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100161 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162}
163
Takashi Iwai512bbd62005-11-17 13:51:18 +0100164static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 return card->power_state;
167}
168
Takashi Iwai512bbd62005-11-17 13:51:18 +0100169static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
171 card->power_state = state;
172 wake_up(&card->power_sleep);
173}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200174
175/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200176int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178#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)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700182static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400183#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186#endif /* CONFIG_PM */
187
Takashi Iwai512bbd62005-11-17 13:51:18 +0100188struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100189 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100190 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800192 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100193 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700194 struct device *dev; /* device for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195};
196
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100197/* return a device pointer linked to each sound device as a parent */
198static inline struct device *snd_card_get_device_link(struct snd_card *card)
199{
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100200 return card ? card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100201}
202
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203/* sound.c */
204
Clemens Ladischf1902862005-10-24 17:05:03 +0200205extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700207extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209void snd_request_card(int card);
210
Johannes Berg12b131c2006-10-05 15:05:34 +0200211int snd_register_device_for_dev(int type, struct snd_card *card,
212 int dev,
213 const struct file_operations *f_ops,
214 void *private_data,
215 const char *name,
216 struct device *device);
217
218/**
219 * snd_register_device - Register the ALSA device file for the card
220 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
221 * @card: the card instance
222 * @dev: the device index
223 * @f_ops: the file operations
224 * @private_data: user pointer for f_ops->open()
225 * @name: the device file name
226 *
227 * Registers an ALSA device file for the given card.
228 * The operators have to be set in reg parameter.
229 *
230 * This function uses the card's device pointer to link to the
231 * correct &struct device.
232 *
233 * Returns zero if successful, or a negative error code on failure.
234 */
235static inline int snd_register_device(int type, struct snd_card *card, int dev,
236 const struct file_operations *f_ops,
237 void *private_data,
238 const char *name)
239{
240 return snd_register_device_for_dev(type, card, dev, f_ops,
241 private_data, name,
Takashi Iwaic2902c82007-02-09 16:25:48 +0100242 snd_card_get_device_link(card));
Johannes Berg12b131c2006-10-05 15:05:34 +0200243}
244
Takashi Iwai512bbd62005-11-17 13:51:18 +0100245int snd_unregister_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100246void *snd_lookup_minor_data(unsigned int minor, int type);
Takashi Iwai9d19f482006-09-06 14:27:46 +0200247int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700248 struct device_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100251int snd_register_oss_device(int type, struct snd_card *card, int dev,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800252 const struct file_operations *f_ops, void *private_data,
Clemens Ladischf87135f2005-11-20 14:06:59 +0100253 const char *name);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100254int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100255void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256#endif
257
258int snd_minor_info_init(void);
259int snd_minor_info_done(void);
260
261/* sound_oss.c */
262
263#ifdef CONFIG_SND_OSSEMUL
264int snd_minor_info_oss_init(void);
265int snd_minor_info_oss_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200267static inline int snd_minor_info_oss_init(void) { return 0; }
268static inline int snd_minor_info_oss_done(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269#endif
270
271/* memory.c */
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
274int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
275
276/* init.c */
277
Takashi Iwai512bbd62005-11-17 13:51:18 +0100278extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200279int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
281#define SND_MIXER_OSS_NOTIFY_REGISTER 0
282#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
283#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100284extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285#endif
286
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100287int snd_card_create(int idx, const char *id,
288 struct module *module, int extra_size,
289 struct snd_card **card_ret);
290
Takashi Iwai512bbd62005-11-17 13:51:18 +0100291int snd_card_disconnect(struct snd_card *card);
292int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200293int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200294void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100295int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296int snd_card_info_init(void);
297int snd_card_info_done(void);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100298int snd_component_add(struct snd_card *card, const char *component);
299int snd_card_file_add(struct snd_card *card, struct file *file);
300int snd_card_file_remove(struct snd_card *card, struct file *file);
Joonwoo Park6fb64392013-08-07 18:59:09 -0700301void snd_card_change_online_state(struct snd_card *card, int online);
302bool snd_card_is_online_state(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Pavel Machekedab9382008-04-01 15:33:22 +0200304#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306/* device.c */
307
Takashi Iwai512bbd62005-11-17 13:51:18 +0100308int 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317/* isadma.c */
318
Al Viro276bd312005-08-23 22:45:06 +0100319#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320#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);
Al Viro276bd312005-08-23 22:45:06 +0100325#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200328struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200329void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331/* --- */
332
Fengguang Wufae3d882012-04-10 17:00:35 +0800333/* sound printk debug levels */
334enum {
335 SND_PR_ALWAYS,
336 SND_PR_DEBUG,
337 SND_PR_VERBOSE,
338};
339
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200340#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700341__printf(4, 5)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200342void __snd_printk(unsigned int level, const char *file, int line,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700343 const char *format, ...);
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200344#else
345#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200346 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200347#endif
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/**
350 * snd_printk - printk wrapper
351 * @fmt: format string
352 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100353 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 * when configured with CONFIG_SND_VERBOSE_PRINTK.
355 */
356#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200357 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/**
361 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800362 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 *
Pavel Machekedab9382008-04-01 15:33:22 +0200364 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 * Ignored when CONFIG_SND_DEBUG is not set.
366 */
367#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200368 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Fengguang Wufae3d882012-04-10 17:00:35 +0800369#define _snd_printd(level, fmt, args...) \
370 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200371
Takashi Iwaif66fced2008-11-07 09:37:22 +0100372/**
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 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200378#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100379
380/**
381 * snd_BUG_ON - debugging check macro
382 * @cond: condition to evaluate
383 *
384 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
385 * and call WARN() and returns the value if it's non-zero.
386 *
387 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
388 * condition is ignored.
389 *
390 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
391 * Thus, don't put any statement that influences on the code behavior,
392 * such as pre/post increment, to the argument of this macro.
393 * If you want to evaluate and give a warning, use standard WARN_ON().
394 */
Takashi Iwai5ef03462008-08-08 17:06:01 +0200395#define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397#else /* !CONFIG_SND_DEBUG */
398
Andrew Mortonfcef7832008-11-06 12:05:21 -0800399#define snd_printd(fmt, args...) do { } while (0)
Fengguang Wufae3d882012-04-10 17:00:35 +0800400#define _snd_printd(level, fmt, args...) do { } while (0)
Andrew Mortonfcef7832008-11-06 12:05:21 -0800401#define snd_BUG() do { } while (0)
Takashi Iwai945eed02008-11-07 09:08:15 +0100402static inline int __snd_bug_on(int cond)
Andrew Mortonfcef7832008-11-06 12:05:21 -0800403{
404 return 0;
405}
Takashi Iwai945eed02008-11-07 09:08:15 +0100406#define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408#endif /* CONFIG_SND_DEBUG */
409
Takashi Iwai62cf8722008-05-20 12:15:15 +0200410#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411/**
412 * snd_printdd - debug printk
413 * @format: format string
414 *
Pavel Machekedab9382008-04-01 15:33:22 +0200415 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200416 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200418#define snd_printdd(format, args...) \
419 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#else
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200421#define snd_printdd(format, args...) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422#endif
423
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
426
427/* for easier backward-porting */
428#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
430#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
431#define gameport_get_port_data(gp) (gp)->port_data
432#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Axel Lin8422fa12012-01-30 17:10:58 +0800434#ifdef CONFIG_PCI
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100435/* PCI quirk list helper */
436struct snd_pci_quirk {
437 unsigned short subvendor; /* PCI subvendor ID */
438 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100439 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100440 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200441#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100442 const char *name; /* name of the device (optional) */
443#endif
444};
445
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100446#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
447 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
448#define _SND_PCI_QUIRK_ID(vend, dev) \
449 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100450#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200451#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100452#define SND_PCI_QUIRK(vend,dev,xname,val) \
453 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100454#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
455 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
456#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
457 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
458 .value = (val), .name = (xname)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100459#else
460#define SND_PCI_QUIRK(vend,dev,xname,val) \
461 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100462#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
463 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
464#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
465 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100466#endif
467
468const struct snd_pci_quirk *
469snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
470
Takashi Iwaid1458272010-01-14 09:16:52 +0100471const struct snd_pci_quirk *
472snd_pci_quirk_lookup_id(u16 vendor, u16 device,
473 const struct snd_pci_quirk *list);
Axel Lin8422fa12012-01-30 17:10:58 +0800474#endif
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100475
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#endif /* __SOUND_CORE_H */