blob: 5ab255f196cc85c6b894adc2182f1271562a301e [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 Iwai9d19f482006-09-06 14:27:46 +020029#include <linux/device.h>
Takashi Iwai5ef03462008-08-08 17:06:01 +020030#include <linux/stringify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Takashi Iwai9004acc2008-01-08 18:13:27 +010032/* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070041/* forward declarations */
42#ifdef CONFIG_PCI
43struct pci_dev;
44#endif
Paul Gortmakerde477252011-05-26 13:46:22 -040045struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47/* device allocation stuff */
48
49#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
50
Takashi Iwai512bbd62005-11-17 13:51:18 +010051typedef int __bitwise snd_device_type_t;
52#define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
53#define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
54#define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
55#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
56#define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
57#define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
58#define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
59#define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
60#define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
61#define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
62#define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
63#define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
Mark Browne76d8ce2008-07-28 19:05:35 +010064#define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
Omair Mohammed Abdullah3eafc952011-12-23 10:36:36 +053065#define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
Takashi Iwai512bbd62005-11-17 13:51:18 +010066#define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
Takashi Iwai512bbd62005-11-17 13:51:18 +010068typedef 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Takashi Iwai512bbd62005-11-17 13:51:18 +010073typedef 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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Takashi Iwai512bbd62005-11-17 13:51:18 +010078struct snd_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Takashi Iwai512bbd62005-11-17 13:51:18 +010080struct 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);
Takashi Iwai512bbd62005-11-17 13:51:18 +010084};
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Takashi Iwai512bbd62005-11-17 13:51:18 +010086struct snd_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 struct list_head list; /* list of registered devices */
Takashi Iwai512bbd62005-11-17 13:51:18 +010088 struct snd_card *card; /* card which holds this device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 snd_device_state_t state; /* state of the device */
90 snd_device_type_t type; /* device type */
91 void *device_data; /* device structure */
Takashi Iwai512bbd62005-11-17 13:51:18 +010092 struct snd_device_ops *ops; /* operations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94
Takashi Iwai512bbd62005-11-17 13:51:18 +010095#define snd_device(n) list_entry(n, struct snd_device, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/* main structure for soundcard */
98
Takashi Iwai512bbd62005-11-17 13:51:18 +010099struct snd_card {
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200100 int number; /* number of soundcard (index to
101 snd_cards) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 char id[16]; /* id string of this card */
104 char driver[16]; /* driver name */
105 char shortname[32]; /* short name of this soundcard */
106 char longname[80]; /* name of this soundcard */
107 char mixername[80]; /* mixer name */
Takashi Iwaiff33f232008-10-07 11:38:09 +0200108 char components[128]; /* card components delimited with
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200109 space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 struct module *module; /* top-level module */
111
112 void *private_data; /* private data for soundcard */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100113 void (*private_free) (struct snd_card *card); /* callback for freeing of
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200114 private data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 struct list_head devices; /* devices */
116
117 unsigned int last_numid; /* last used numeric ID */
118 struct rw_semaphore controls_rwsem; /* controls list lock */
119 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
120 int controls_count; /* count of all controls */
121 int user_ctl_count; /* count of all user controls */
122 struct list_head controls; /* all controls for this card */
123 struct list_head ctl_files; /* active control files */
124
Takashi Iwai512bbd62005-11-17 13:51:18 +0100125 struct snd_info_entry *proc_root; /* root for soundcard specific files */
126 struct snd_info_entry *proc_id; /* the card id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 struct proc_dir_entry *proc_root_link; /* number link to real id */
128
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100129 struct list_head files_list; /* all files associated to this card */
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200130 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
131 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 spinlock_t files_lock; /* lock the files for this card */
133 int shutdown; /* this card is going down */
Takashi Iwaic4614822006-06-23 14:38:23 +0200134 int free_on_last_close; /* free in context of file_release */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 wait_queue_head_t shutdown_sleep;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100136 struct device *dev; /* device assigned to this card */
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100137 struct device *card_dev; /* cardX object for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 unsigned int power_state; /* power state */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100141 struct mutex power_lock; /* power lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143#endif
144
145#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100146 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 int mixer_oss_change_count;
148#endif
149};
150
151#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100152static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100154 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155}
156
Takashi Iwai512bbd62005-11-17 13:51:18 +0100157static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100159 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160}
161
Takashi Iwai512bbd62005-11-17 13:51:18 +0100162static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163{
164 return card->power_state;
165}
166
Takashi Iwai512bbd62005-11-17 13:51:18 +0100167static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168{
169 card->power_state = state;
170 wake_up(&card->power_sleep);
171}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200172
173/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200174int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176#else /* ! CONFIG_PM */
177
178#define snd_power_lock(card) do { (void)(card); } while (0)
179#define snd_power_unlock(card) do { (void)(card); } while (0)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700180static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400181#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184#endif /* CONFIG_PM */
185
Takashi Iwai512bbd62005-11-17 13:51:18 +0100186struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100187 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100188 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800190 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100191 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700192 struct device *dev; /* device for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193};
194
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100195/* return a device pointer linked to each sound device as a parent */
196static inline struct device *snd_card_get_device_link(struct snd_card *card)
197{
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100198 return card ? card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100199}
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201/* sound.c */
202
Clemens Ladischf1902862005-10-24 17:05:03 +0200203extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700205extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207void snd_request_card(int card);
208
Johannes Berg12b131c2006-10-05 15:05:34 +0200209int snd_register_device_for_dev(int type, struct snd_card *card,
210 int dev,
211 const struct file_operations *f_ops,
212 void *private_data,
213 const char *name,
214 struct device *device);
215
216/**
217 * snd_register_device - Register the ALSA device file for the card
218 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
219 * @card: the card instance
220 * @dev: the device index
221 * @f_ops: the file operations
222 * @private_data: user pointer for f_ops->open()
223 * @name: the device file name
224 *
225 * Registers an ALSA device file for the given card.
226 * The operators have to be set in reg parameter.
227 *
228 * This function uses the card's device pointer to link to the
229 * correct &struct device.
230 *
231 * Returns zero if successful, or a negative error code on failure.
232 */
233static inline int snd_register_device(int type, struct snd_card *card, int dev,
234 const struct file_operations *f_ops,
235 void *private_data,
236 const char *name)
237{
238 return snd_register_device_for_dev(type, card, dev, f_ops,
239 private_data, name,
Takashi Iwaic2902c82007-02-09 16:25:48 +0100240 snd_card_get_device_link(card));
Johannes Berg12b131c2006-10-05 15:05:34 +0200241}
242
Takashi Iwai512bbd62005-11-17 13:51:18 +0100243int snd_unregister_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100244void *snd_lookup_minor_data(unsigned int minor, int type);
Takashi Iwai9d19f482006-09-06 14:27:46 +0200245int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700246 struct device_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100249int snd_register_oss_device(int type, struct snd_card *card, int dev,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800250 const struct file_operations *f_ops, void *private_data,
Clemens Ladischf87135f2005-11-20 14:06:59 +0100251 const char *name);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100252int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100253void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254#endif
255
256int snd_minor_info_init(void);
257int snd_minor_info_done(void);
258
259/* sound_oss.c */
260
261#ifdef CONFIG_SND_OSSEMUL
262int snd_minor_info_oss_init(void);
263int snd_minor_info_oss_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200265static inline int snd_minor_info_oss_init(void) { return 0; }
266static inline int snd_minor_info_oss_done(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267#endif
268
269/* memory.c */
270
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
272int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
273
274/* init.c */
275
Takashi Iwai512bbd62005-11-17 13:51:18 +0100276extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200277int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
279#define SND_MIXER_OSS_NOTIFY_REGISTER 0
280#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
281#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100282extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#endif
284
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100285int snd_card_create(int idx, const char *id,
286 struct module *module, int extra_size,
287 struct snd_card **card_ret);
288
Takashi Iwai512bbd62005-11-17 13:51:18 +0100289int snd_card_disconnect(struct snd_card *card);
290int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200291int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200292void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100293int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294int snd_card_info_init(void);
295int snd_card_info_done(void);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100296int snd_component_add(struct snd_card *card, const char *component);
297int snd_card_file_add(struct snd_card *card, struct file *file);
298int snd_card_file_remove(struct snd_card *card, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Pavel Machekedab9382008-04-01 15:33:22 +0200300#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/* device.c */
303
Takashi Iwai512bbd62005-11-17 13:51:18 +0100304int snd_device_new(struct snd_card *card, snd_device_type_t type,
305 void *device_data, struct snd_device_ops *ops);
306int snd_device_register(struct snd_card *card, void *device_data);
307int snd_device_register_all(struct snd_card *card);
308int snd_device_disconnect(struct snd_card *card, void *device_data);
309int snd_device_disconnect_all(struct snd_card *card);
310int snd_device_free(struct snd_card *card, void *device_data);
311int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313/* isadma.c */
314
Al Viro276bd312005-08-23 22:45:06 +0100315#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316#define DMA_MODE_NO_ENABLE 0x0100
317
318void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
319void snd_dma_disable(unsigned long dma);
320unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100321#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200324struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200325void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327/* --- */
328
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200329#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700330__printf(4, 5)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200331void __snd_printk(unsigned int level, const char *file, int line,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700332 const char *format, ...);
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200333#else
334#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200335 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200336#endif
337
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338/**
339 * snd_printk - printk wrapper
340 * @fmt: format string
341 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100342 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 * when configured with CONFIG_SND_VERBOSE_PRINTK.
344 */
345#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200346 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/**
350 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800351 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 *
Pavel Machekedab9382008-04-01 15:33:22 +0200353 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 * Ignored when CONFIG_SND_DEBUG is not set.
355 */
356#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200357 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200358
Takashi Iwaif66fced2008-11-07 09:37:22 +0100359/**
360 * snd_BUG - give a BUG warning message and stack trace
361 *
362 * Calls WARN() if CONFIG_SND_DEBUG is set.
363 * Ignored when CONFIG_SND_DEBUG is not set.
364 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200365#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100366
367/**
368 * snd_BUG_ON - debugging check macro
369 * @cond: condition to evaluate
370 *
371 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
372 * and call WARN() and returns the value if it's non-zero.
373 *
374 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
375 * condition is ignored.
376 *
377 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
378 * Thus, don't put any statement that influences on the code behavior,
379 * such as pre/post increment, to the argument of this macro.
380 * If you want to evaluate and give a warning, use standard WARN_ON().
381 */
Takashi Iwai5ef03462008-08-08 17:06:01 +0200382#define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384#else /* !CONFIG_SND_DEBUG */
385
Andrew Mortonfcef7832008-11-06 12:05:21 -0800386#define snd_printd(fmt, args...) do { } while (0)
387#define snd_BUG() do { } while (0)
Takashi Iwai945eed02008-11-07 09:08:15 +0100388static inline int __snd_bug_on(int cond)
Andrew Mortonfcef7832008-11-06 12:05:21 -0800389{
390 return 0;
391}
Takashi Iwai945eed02008-11-07 09:08:15 +0100392#define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394#endif /* CONFIG_SND_DEBUG */
395
Takashi Iwai62cf8722008-05-20 12:15:15 +0200396#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397/**
398 * snd_printdd - debug printk
399 * @format: format string
400 *
Pavel Machekedab9382008-04-01 15:33:22 +0200401 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200402 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200404#define snd_printdd(format, args...) \
405 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406#else
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200407#define snd_printdd(format, args...) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408#endif
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
412
413/* for easier backward-porting */
414#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
416#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
417#define gameport_get_port_data(gp) (gp)->port_data
418#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100420/* PCI quirk list helper */
421struct snd_pci_quirk {
422 unsigned short subvendor; /* PCI subvendor ID */
423 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100424 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100425 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200426#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100427 const char *name; /* name of the device (optional) */
428#endif
429};
430
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100431#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)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100435#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200436#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100437#define SND_PCI_QUIRK(vend,dev,xname,val) \
438 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100439#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)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100444#else
445#define SND_PCI_QUIRK(vend,dev,xname,val) \
446 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100447#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)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100451#endif
452
453const struct snd_pci_quirk *
454snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
455
Takashi Iwaid1458272010-01-14 09:16:52 +0100456const struct snd_pci_quirk *
457snd_pci_quirk_lookup_id(u16 vendor, u16 device,
458 const struct snd_pci_quirk *list);
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460#endif /* __SOUND_CORE_H */