blob: a61499c22b0b96044314048791b3152e5249d98e [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
Takashi Iwai9004acc2008-01-08 18:13:27 +010025#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/sched.h> /* wake_up() */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010027#include <linux/mutex.h> /* struct mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/rwsem.h> /* struct rw_semaphore */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/pm.h> /* pm_message_t */
Takashi Iwai9d19f482006-09-06 14:27:46 +020030#include <linux/device.h>
Takashi Iwai5ef03462008-08-08 17:06:01 +020031#include <linux/stringify.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Takashi Iwai9004acc2008-01-08 18:13:27 +010033/* number of supported soundcards */
34#ifdef CONFIG_SND_DYNAMIC_MINORS
35#define SNDRV_CARDS 32
36#else
37#define SNDRV_CARDS 8 /* don't change - minor numbers */
38#endif
39
40#define CONFIG_SND_MAJOR 116 /* standard configuration */
41
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* forward declarations */
43#ifdef CONFIG_PCI
44struct pci_dev;
45#endif
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)
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 */
136#ifndef CONFIG_SYSFS_DEPRECATED
137 struct device *card_dev; /* cardX object for sysfs */
138#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 unsigned int power_state; /* power state */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100142 struct mutex power_lock; /* power lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144#endif
145
146#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100147 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 int mixer_oss_change_count;
149#endif
150};
151
152#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100153static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100155 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
Takashi Iwai512bbd62005-11-17 13:51:18 +0100158static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100160 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Takashi Iwai512bbd62005-11-17 13:51:18 +0100163static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164{
165 return card->power_state;
166}
167
Takashi Iwai512bbd62005-11-17 13:51:18 +0100168static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169{
170 card->power_state = state;
171 wake_up(&card->power_sleep);
172}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200173
174/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200175int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200176
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177#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)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700181static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182#define snd_power_get_state(card) SNDRV_CTL_POWER_D0
183#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185#endif /* CONFIG_PM */
186
Takashi Iwai512bbd62005-11-17 13:51:18 +0100187struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100188 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100189 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800191 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100192 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700193 struct device *dev; /* device for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194};
195
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100196/* return a device pointer linked to each sound device as a parent */
197static inline struct device *snd_card_get_device_link(struct snd_card *card)
198{
199#ifdef CONFIG_SYSFS_DEPRECATED
200 return card ? card->dev : NULL;
201#else
202 return card ? card->card_dev : NULL;
203#endif
204}
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206/* sound.c */
207
Clemens Ladischf1902862005-10-24 17:05:03 +0200208extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700210extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212void snd_request_card(int card);
213
Johannes Berg12b131c2006-10-05 15:05:34 +0200214int snd_register_device_for_dev(int type, struct snd_card *card,
215 int dev,
216 const struct file_operations *f_ops,
217 void *private_data,
218 const char *name,
219 struct device *device);
220
221/**
222 * snd_register_device - Register the ALSA device file for the card
223 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
224 * @card: the card instance
225 * @dev: the device index
226 * @f_ops: the file operations
227 * @private_data: user pointer for f_ops->open()
228 * @name: the device file name
229 *
230 * Registers an ALSA device file for the given card.
231 * The operators have to be set in reg parameter.
232 *
233 * This function uses the card's device pointer to link to the
234 * correct &struct device.
235 *
236 * Returns zero if successful, or a negative error code on failure.
237 */
238static inline int snd_register_device(int type, struct snd_card *card, int dev,
239 const struct file_operations *f_ops,
240 void *private_data,
241 const char *name)
242{
243 return snd_register_device_for_dev(type, card, dev, f_ops,
244 private_data, name,
Takashi Iwaic2902c82007-02-09 16:25:48 +0100245 snd_card_get_device_link(card));
Johannes Berg12b131c2006-10-05 15:05:34 +0200246}
247
Takashi Iwai512bbd62005-11-17 13:51:18 +0100248int snd_unregister_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100249void *snd_lookup_minor_data(unsigned int minor, int type);
Takashi Iwai9d19f482006-09-06 14:27:46 +0200250int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700251 struct device_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
253#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100254int snd_register_oss_device(int type, struct snd_card *card, int dev,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800255 const struct file_operations *f_ops, void *private_data,
Clemens Ladischf87135f2005-11-20 14:06:59 +0100256 const char *name);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100257int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100258void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259#endif
260
261int snd_minor_info_init(void);
262int snd_minor_info_done(void);
263
264/* sound_oss.c */
265
266#ifdef CONFIG_SND_OSSEMUL
267int snd_minor_info_oss_init(void);
268int snd_minor_info_oss_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200270static inline int snd_minor_info_oss_init(void) { return 0; }
271static inline int snd_minor_info_oss_done(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272#endif
273
274/* memory.c */
275
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
277int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
278
279/* init.c */
280
Takashi Iwai512bbd62005-11-17 13:51:18 +0100281extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200282int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
284#define SND_MIXER_OSS_NOTIFY_REGISTER 0
285#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
286#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100287extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288#endif
289
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100290int snd_card_create(int idx, const char *id,
291 struct module *module, int extra_size,
292 struct snd_card **card_ret);
293
Takashi Iwai512bbd62005-11-17 13:51:18 +0100294int snd_card_disconnect(struct snd_card *card);
295int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200296int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200297void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100298int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299int snd_card_info_init(void);
300int snd_card_info_done(void);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100301int snd_component_add(struct snd_card *card, const char *component);
302int snd_card_file_add(struct snd_card *card, struct file *file);
303int snd_card_file_remove(struct snd_card *card, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Pavel Machekedab9382008-04-01 15:33:22 +0200305#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307/* device.c */
308
Takashi Iwai512bbd62005-11-17 13:51:18 +0100309int snd_device_new(struct snd_card *card, snd_device_type_t type,
310 void *device_data, struct snd_device_ops *ops);
311int snd_device_register(struct snd_card *card, void *device_data);
312int snd_device_register_all(struct snd_card *card);
313int snd_device_disconnect(struct snd_card *card, void *device_data);
314int snd_device_disconnect_all(struct snd_card *card);
315int snd_device_free(struct snd_card *card, void *device_data);
316int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318/* isadma.c */
319
Al Viro276bd312005-08-23 22:45:06 +0100320#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321#define DMA_MODE_NO_ENABLE 0x0100
322
323void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
324void snd_dma_disable(unsigned long dma);
325unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100326#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200329struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200330void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332/* --- */
333
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200334#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
335void __snd_printk(unsigned int level, const char *file, int line,
336 const char *format, ...)
337 __attribute__ ((format (printf, 4, 5)));
338#else
339#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200340 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200341#endif
342
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343/**
344 * snd_printk - printk wrapper
345 * @fmt: format string
346 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100347 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 * when configured with CONFIG_SND_VERBOSE_PRINTK.
349 */
350#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200351 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
353#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354/**
355 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800356 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 *
Pavel Machekedab9382008-04-01 15:33:22 +0200358 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 * Ignored when CONFIG_SND_DEBUG is not set.
360 */
361#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200362 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200363
Takashi Iwaif66fced2008-11-07 09:37:22 +0100364/**
365 * snd_BUG - give a BUG warning message and stack trace
366 *
367 * Calls WARN() if CONFIG_SND_DEBUG is set.
368 * Ignored when CONFIG_SND_DEBUG is not set.
369 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200370#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100371
372/**
373 * snd_BUG_ON - debugging check macro
374 * @cond: condition to evaluate
375 *
376 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
377 * and call WARN() and returns the value if it's non-zero.
378 *
379 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
380 * condition is ignored.
381 *
382 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
383 * Thus, don't put any statement that influences on the code behavior,
384 * such as pre/post increment, to the argument of this macro.
385 * If you want to evaluate and give a warning, use standard WARN_ON().
386 */
Takashi Iwai5ef03462008-08-08 17:06:01 +0200387#define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
389#else /* !CONFIG_SND_DEBUG */
390
Andrew Mortonfcef7832008-11-06 12:05:21 -0800391#define snd_printd(fmt, args...) do { } while (0)
392#define snd_BUG() do { } while (0)
Takashi Iwai945eed02008-11-07 09:08:15 +0100393static inline int __snd_bug_on(int cond)
Andrew Mortonfcef7832008-11-06 12:05:21 -0800394{
395 return 0;
396}
Takashi Iwai945eed02008-11-07 09:08:15 +0100397#define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399#endif /* CONFIG_SND_DEBUG */
400
Takashi Iwai62cf8722008-05-20 12:15:15 +0200401#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402/**
403 * snd_printdd - debug printk
404 * @format: format string
405 *
Pavel Machekedab9382008-04-01 15:33:22 +0200406 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200407 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200409#define snd_printdd(format, args...) \
410 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411#else
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200412#define snd_printdd(format, args...) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413#endif
414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
417
418/* for easier backward-porting */
419#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
421#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
422#define gameport_get_port_data(gp) (gp)->port_data
423#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100425/* PCI quirk list helper */
426struct snd_pci_quirk {
427 unsigned short subvendor; /* PCI subvendor ID */
428 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100429 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100430 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200431#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100432 const char *name; /* name of the device (optional) */
433#endif
434};
435
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100436#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
437 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
438#define _SND_PCI_QUIRK_ID(vend, dev) \
439 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100440#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200441#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100442#define SND_PCI_QUIRK(vend,dev,xname,val) \
443 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100444#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
445 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
446#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
447 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
448 .value = (val), .name = (xname)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100449#else
450#define SND_PCI_QUIRK(vend,dev,xname,val) \
451 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100452#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
453 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
454#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
455 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100456#endif
457
458const struct snd_pci_quirk *
459snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
460
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462#endif /* __SOUND_CORE_H */