blob: 1fa2407c966fdc5240d9853395fd22af6f435724 [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 */
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100136 struct device *card_dev; /* cardX object for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 unsigned int power_state; /* power state */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100140 struct mutex power_lock; /* power lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142#endif
143
144#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100145 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 int mixer_oss_change_count;
147#endif
148};
149
150#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100151static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100153 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154}
155
Takashi Iwai512bbd62005-11-17 13:51:18 +0100156static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100158 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159}
160
Takashi Iwai512bbd62005-11-17 13:51:18 +0100161static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162{
163 return card->power_state;
164}
165
Takashi Iwai512bbd62005-11-17 13:51:18 +0100166static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
168 card->power_state = state;
169 wake_up(&card->power_sleep);
170}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200171
172/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200173int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#else /* ! CONFIG_PM */
176
177#define snd_power_lock(card) do { (void)(card); } while (0)
178#define snd_power_unlock(card) do { (void)(card); } while (0)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700179static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400180#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183#endif /* CONFIG_PM */
184
Takashi Iwai512bbd62005-11-17 13:51:18 +0100185struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100186 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100187 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800189 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100190 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700191 struct device *dev; /* device for sysfs */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192};
193
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100194/* return a device pointer linked to each sound device as a parent */
195static inline struct device *snd_card_get_device_link(struct snd_card *card)
196{
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100197 return card ? card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100198}
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200/* sound.c */
201
Clemens Ladischf1902862005-10-24 17:05:03 +0200202extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700204extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206void snd_request_card(int card);
207
Johannes Berg12b131c2006-10-05 15:05:34 +0200208int snd_register_device_for_dev(int type, struct snd_card *card,
209 int dev,
210 const struct file_operations *f_ops,
211 void *private_data,
212 const char *name,
213 struct device *device);
214
215/**
216 * snd_register_device - Register the ALSA device file for the card
217 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
218 * @card: the card instance
219 * @dev: the device index
220 * @f_ops: the file operations
221 * @private_data: user pointer for f_ops->open()
222 * @name: the device file name
223 *
224 * Registers an ALSA device file for the given card.
225 * The operators have to be set in reg parameter.
226 *
227 * This function uses the card's device pointer to link to the
228 * correct &struct device.
229 *
230 * Returns zero if successful, or a negative error code on failure.
231 */
232static inline int snd_register_device(int type, struct snd_card *card, int dev,
233 const struct file_operations *f_ops,
234 void *private_data,
235 const char *name)
236{
237 return snd_register_device_for_dev(type, card, dev, f_ops,
238 private_data, name,
Takashi Iwaic2902c82007-02-09 16:25:48 +0100239 snd_card_get_device_link(card));
Johannes Berg12b131c2006-10-05 15:05:34 +0200240}
241
Takashi Iwai512bbd62005-11-17 13:51:18 +0100242int snd_unregister_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100243void *snd_lookup_minor_data(unsigned int minor, int type);
Takashi Iwai9d19f482006-09-06 14:27:46 +0200244int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700245 struct device_attribute *attr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100248int snd_register_oss_device(int type, struct snd_card *card, int dev,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800249 const struct file_operations *f_ops, void *private_data,
Clemens Ladischf87135f2005-11-20 14:06:59 +0100250 const char *name);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100251int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100252void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#endif
254
255int snd_minor_info_init(void);
256int snd_minor_info_done(void);
257
258/* sound_oss.c */
259
260#ifdef CONFIG_SND_OSSEMUL
261int snd_minor_info_oss_init(void);
262int snd_minor_info_oss_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200264static inline int snd_minor_info_oss_init(void) { return 0; }
265static inline int snd_minor_info_oss_done(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266#endif
267
268/* memory.c */
269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
271int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
272
273/* init.c */
274
Takashi Iwai512bbd62005-11-17 13:51:18 +0100275extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200276int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
278#define SND_MIXER_OSS_NOTIFY_REGISTER 0
279#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
280#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100281extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282#endif
283
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100284int snd_card_create(int idx, const char *id,
285 struct module *module, int extra_size,
286 struct snd_card **card_ret);
287
Takashi Iwai512bbd62005-11-17 13:51:18 +0100288int snd_card_disconnect(struct snd_card *card);
289int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200290int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200291void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100292int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293int snd_card_info_init(void);
294int snd_card_info_done(void);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100295int snd_component_add(struct snd_card *card, const char *component);
296int snd_card_file_add(struct snd_card *card, struct file *file);
297int snd_card_file_remove(struct snd_card *card, struct file *file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Pavel Machekedab9382008-04-01 15:33:22 +0200299#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301/* device.c */
302
Takashi Iwai512bbd62005-11-17 13:51:18 +0100303int snd_device_new(struct snd_card *card, snd_device_type_t type,
304 void *device_data, struct snd_device_ops *ops);
305int snd_device_register(struct snd_card *card, void *device_data);
306int snd_device_register_all(struct snd_card *card);
307int snd_device_disconnect(struct snd_card *card, void *device_data);
308int snd_device_disconnect_all(struct snd_card *card);
309int snd_device_free(struct snd_card *card, void *device_data);
310int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312/* isadma.c */
313
Al Viro276bd312005-08-23 22:45:06 +0100314#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#define DMA_MODE_NO_ENABLE 0x0100
316
317void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
318void snd_dma_disable(unsigned long dma);
319unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100320#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200323struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200324void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326/* --- */
327
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200328#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
329void __snd_printk(unsigned int level, const char *file, int line,
330 const char *format, ...)
331 __attribute__ ((format (printf, 4, 5)));
332#else
333#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200334 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200335#endif
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337/**
338 * snd_printk - printk wrapper
339 * @fmt: format string
340 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100341 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 * when configured with CONFIG_SND_VERBOSE_PRINTK.
343 */
344#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200345 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348/**
349 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800350 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 *
Pavel Machekedab9382008-04-01 15:33:22 +0200352 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 * Ignored when CONFIG_SND_DEBUG is not set.
354 */
355#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200356 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200357
Takashi Iwaif66fced2008-11-07 09:37:22 +0100358/**
359 * snd_BUG - give a BUG warning message and stack trace
360 *
361 * Calls WARN() if CONFIG_SND_DEBUG is set.
362 * Ignored when CONFIG_SND_DEBUG is not set.
363 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200364#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100365
366/**
367 * snd_BUG_ON - debugging check macro
368 * @cond: condition to evaluate
369 *
370 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
371 * and call WARN() and returns the value if it's non-zero.
372 *
373 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
374 * condition is ignored.
375 *
376 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
377 * Thus, don't put any statement that influences on the code behavior,
378 * such as pre/post increment, to the argument of this macro.
379 * If you want to evaluate and give a warning, use standard WARN_ON().
380 */
Takashi Iwai5ef03462008-08-08 17:06:01 +0200381#define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383#else /* !CONFIG_SND_DEBUG */
384
Andrew Mortonfcef7832008-11-06 12:05:21 -0800385#define snd_printd(fmt, args...) do { } while (0)
386#define snd_BUG() do { } while (0)
Takashi Iwai945eed02008-11-07 09:08:15 +0100387static inline int __snd_bug_on(int cond)
Andrew Mortonfcef7832008-11-06 12:05:21 -0800388{
389 return 0;
390}
Takashi Iwai945eed02008-11-07 09:08:15 +0100391#define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393#endif /* CONFIG_SND_DEBUG */
394
Takashi Iwai62cf8722008-05-20 12:15:15 +0200395#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396/**
397 * snd_printdd - debug printk
398 * @format: format string
399 *
Pavel Machekedab9382008-04-01 15:33:22 +0200400 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200401 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200403#define snd_printdd(format, args...) \
404 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405#else
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200406#define snd_printdd(format, args...) do { } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407#endif
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
411
412/* for easier backward-porting */
413#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
415#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
416#define gameport_get_port_data(gp) (gp)->port_data
417#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100419/* PCI quirk list helper */
420struct snd_pci_quirk {
421 unsigned short subvendor; /* PCI subvendor ID */
422 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100423 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100424 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200425#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100426 const char *name; /* name of the device (optional) */
427#endif
428};
429
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100430#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
431 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
432#define _SND_PCI_QUIRK_ID(vend, dev) \
433 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100434#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200435#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100436#define SND_PCI_QUIRK(vend,dev,xname,val) \
437 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100438#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
439 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
440#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
441 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
442 .value = (val), .name = (xname)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100443#else
444#define SND_PCI_QUIRK(vend,dev,xname,val) \
445 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100446#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
447 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
448#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
449 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100450#endif
451
452const struct snd_pci_quirk *
453snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
454
Takashi Iwaid1458272010-01-14 09:16:52 +0100455const struct snd_pci_quirk *
456snd_pci_quirk_lookup_id(u16 vendor, u16 device,
457 const struct snd_pci_quirk *list);
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459#endif /* __SOUND_CORE_H */