blob: d3f5f818e0b901909f1ad8c92f8d0930b338cd78 [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 Iwai8bfb1812014-01-29 11:46:11 +010025#include <linux/device.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 Iwai5ef03462008-08-08 17:06:01 +020030#include <linux/stringify.h>
Tim Gardnerbcbb1552013-08-16 11:18:59 -060031#include <linux/printk.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
Takashi Iwai7bb24912013-05-15 08:46:39 +020035#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
Takashi Iwai9004acc2008-01-08 18:13:27 +010036#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043struct pci_dev;
Paul Gortmakerde477252011-05-26 13:46:22 -040044struct module;
Takashi Iwaif2464062014-01-29 12:13:43 +010045struct completion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47/* device allocation stuff */
48
Takashi Iwai289ca022014-01-29 15:53:35 +010049/* type of the object used in snd_device_*()
50 * this also defines the calling order
51 */
Takashi Iwai9ce50542014-01-29 15:13:33 +010052enum snd_device_type {
Takashi Iwai289ca022014-01-29 15:53:35 +010053 SNDRV_DEV_LOWLEVEL,
54 SNDRV_DEV_CONTROL,
55 SNDRV_DEV_INFO,
56 SNDRV_DEV_BUS,
57 SNDRV_DEV_CODEC,
Takashi Iwai9ce50542014-01-29 15:13:33 +010058 SNDRV_DEV_PCM,
Takashi Iwai289ca022014-01-29 15:53:35 +010059 SNDRV_DEV_COMPRESS,
Takashi Iwai9ce50542014-01-29 15:13:33 +010060 SNDRV_DEV_RAWMIDI,
61 SNDRV_DEV_TIMER,
62 SNDRV_DEV_SEQUENCER,
63 SNDRV_DEV_HWDEP,
Takashi Iwai9ce50542014-01-29 15:13:33 +010064 SNDRV_DEV_JACK,
Takashi Iwai9ce50542014-01-29 15:13:33 +010065};
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
Takashi Iwai9ce50542014-01-29 15:13:33 +010067enum snd_device_state {
68 SNDRV_DEV_BUILD,
69 SNDRV_DEV_REGISTERED,
70 SNDRV_DEV_DISCONNECTED,
71};
Linus Torvalds1da177e2005-04-16 15:20:36 -070072
Takashi Iwai512bbd62005-11-17 13:51:18 +010073struct snd_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Takashi Iwai512bbd62005-11-17 13:51:18 +010075struct snd_device_ops {
76 int (*dev_free)(struct snd_device *dev);
77 int (*dev_register)(struct snd_device *dev);
78 int (*dev_disconnect)(struct snd_device *dev);
Takashi Iwai512bbd62005-11-17 13:51:18 +010079};
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Takashi Iwai512bbd62005-11-17 13:51:18 +010081struct snd_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 struct list_head list; /* list of registered devices */
Takashi Iwai512bbd62005-11-17 13:51:18 +010083 struct snd_card *card; /* card which holds this device */
Takashi Iwai9ce50542014-01-29 15:13:33 +010084 enum snd_device_state state; /* state of the device */
85 enum snd_device_type type; /* device type */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 void *device_data; /* device structure */
Takashi Iwai512bbd62005-11-17 13:51:18 +010087 struct snd_device_ops *ops; /* operations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088};
89
Takashi Iwai512bbd62005-11-17 13:51:18 +010090#define snd_device(n) list_entry(n, struct snd_device, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Linus Torvalds1da177e2005-04-16 15:20:36 -070092/* main structure for soundcard */
93
Takashi Iwai512bbd62005-11-17 13:51:18 +010094struct snd_card {
Henrik Kretzschmard5750f62005-06-29 19:31:06 +020095 int number; /* number of soundcard (index to
96 snd_cards) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98 char id[16]; /* id string of this card */
99 char driver[16]; /* driver name */
100 char shortname[32]; /* short name of this soundcard */
101 char longname[80]; /* name of this soundcard */
102 char mixername[80]; /* mixer name */
Takashi Iwaiff33f232008-10-07 11:38:09 +0200103 char components[128]; /* card components delimited with
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200104 space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 struct module *module; /* top-level module */
106
107 void *private_data; /* private data for soundcard */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100108 void (*private_free) (struct snd_card *card); /* callback for freeing of
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200109 private data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 struct list_head devices; /* devices */
111
112 unsigned int last_numid; /* last used numeric ID */
113 struct rw_semaphore controls_rwsem; /* controls list lock */
114 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
115 int controls_count; /* count of all controls */
116 int user_ctl_count; /* count of all user controls */
117 struct list_head controls; /* all controls for this card */
118 struct list_head ctl_files; /* active control files */
119
Takashi Iwai512bbd62005-11-17 13:51:18 +0100120 struct snd_info_entry *proc_root; /* root for soundcard specific files */
121 struct snd_info_entry *proc_id; /* the card id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 struct proc_dir_entry *proc_root_link; /* number link to real id */
123
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100124 struct list_head files_list; /* all files associated to this card */
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200125 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
126 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 spinlock_t files_lock; /* lock the files for this card */
128 int shutdown; /* this card is going down */
Takashi Iwaif2464062014-01-29 12:13:43 +0100129 struct completion *release_completion;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100130 struct device *dev; /* device assigned to this card */
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100131 struct device card_dev; /* cardX object for sysfs */
132 bool registered; /* card_dev is registered? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 unsigned int power_state; /* power state */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100136 struct mutex power_lock; /* power lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#endif
139
140#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100141 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 int mixer_oss_change_count;
143#endif
144};
145
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100146#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100149static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100151 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152}
153
Takashi Iwai512bbd62005-11-17 13:51:18 +0100154static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100156 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Takashi Iwai512bbd62005-11-17 13:51:18 +0100159static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
161 return card->power_state;
162}
163
Takashi Iwai512bbd62005-11-17 13:51:18 +0100164static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 card->power_state = state;
167 wake_up(&card->power_sleep);
168}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200169
170/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200171int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173#else /* ! CONFIG_PM */
174
175#define snd_power_lock(card) do { (void)(card); } while (0)
176#define snd_power_unlock(card) do { (void)(card); } while (0)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700177static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400178#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181#endif /* CONFIG_PM */
182
Takashi Iwai512bbd62005-11-17 13:51:18 +0100183struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100184 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100185 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800187 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100188 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700189 struct device *dev; /* device for sysfs */
Takashi Iwaia0830db2012-10-16 13:05:59 +0200190 struct snd_card *card_ptr; /* assigned card instance */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191};
192
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100193/* return a device pointer linked to each sound device as a parent */
194static inline struct device *snd_card_get_device_link(struct snd_card *card)
195{
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100196 return card ? &card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100197}
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199/* sound.c */
200
Clemens Ladischf1902862005-10-24 17:05:03 +0200201extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700203extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205void snd_request_card(int card);
206
Johannes Berg12b131c2006-10-05 15:05:34 +0200207int snd_register_device_for_dev(int type, struct snd_card *card,
208 int dev,
209 const struct file_operations *f_ops,
210 void *private_data,
211 const char *name,
212 struct device *device);
213
214/**
215 * snd_register_device - Register the ALSA device file for the card
216 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
217 * @card: the card instance
218 * @dev: the device index
219 * @f_ops: the file operations
220 * @private_data: user pointer for f_ops->open()
221 * @name: the device file name
222 *
223 * Registers an ALSA device file for the given card.
224 * The operators have to be set in reg parameter.
225 *
226 * This function uses the card's device pointer to link to the
227 * correct &struct device.
228 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100229 * Return: Zero if successful, or a negative error code on failure.
Johannes Berg12b131c2006-10-05 15:05:34 +0200230 */
231static inline int snd_register_device(int type, struct snd_card *card, int dev,
232 const struct file_operations *f_ops,
233 void *private_data,
234 const char *name)
235{
236 return snd_register_device_for_dev(type, card, dev, f_ops,
237 private_data, name,
Takashi Iwaic2902c82007-02-09 16:25:48 +0100238 snd_card_get_device_link(card));
Johannes Berg12b131c2006-10-05 15:05:34 +0200239}
240
Takashi Iwai512bbd62005-11-17 13:51:18 +0100241int snd_unregister_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100242void *snd_lookup_minor_data(unsigned int minor, int type);
Takashi Iwaicaa751b2014-02-25 08:30:50 +0100243struct device *snd_get_device(int type, struct snd_card *card, int dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
245#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100246int snd_register_oss_device(int type, struct snd_card *card, int dev,
Takashi Iwai80d7d772014-02-04 13:51:45 +0100247 const struct file_operations *f_ops, void *private_data);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100248int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100249void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250#endif
251
252int snd_minor_info_init(void);
253int snd_minor_info_done(void);
254
255/* sound_oss.c */
256
257#ifdef CONFIG_SND_OSSEMUL
258int snd_minor_info_oss_init(void);
259int snd_minor_info_oss_done(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200261static inline int snd_minor_info_oss_init(void) { return 0; }
262static inline int snd_minor_info_oss_done(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263#endif
264
265/* memory.c */
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
268int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
269
270/* init.c */
271
Takashi Iwai512bbd62005-11-17 13:51:18 +0100272extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200273int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
275#define SND_MIXER_OSS_NOTIFY_REGISTER 0
276#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
277#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100278extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279#endif
280
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100281int snd_card_new(struct device *parent, int idx, const char *xid,
282 struct module *module, int extra_size,
283 struct snd_card **card_ret);
284
285static inline int __deprecated
286snd_card_create(int idx, const char *id, struct module *module, int extra_size,
287 struct snd_card **ret)
288{
289 return snd_card_new(NULL, idx, id, module, extra_size, ret);
290}
Takashi Iwai53fb1e62008-12-28 16:32:08 +0100291
Takashi Iwai512bbd62005-11-17 13:51:18 +0100292int snd_card_disconnect(struct snd_card *card);
293int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200294int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200295void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100296int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297int snd_card_info_init(void);
298int snd_card_info_done(void);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100299int snd_component_add(struct snd_card *card, const char *component);
300int snd_card_file_add(struct snd_card *card, struct file *file);
301int snd_card_file_remove(struct snd_card *card, struct file *file);
Takashi Iwaif2464062014-01-29 12:13:43 +0100302#define snd_card_unref(card) put_device(&(card)->card_dev)
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 Iwai9ce50542014-01-29 15:13:33 +0100308int snd_device_new(struct snd_card *card, enum snd_device_type type,
Takashi Iwai512bbd62005-11-17 13:51:18 +0100309 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);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100312int snd_device_disconnect_all(struct snd_card *card);
Takashi Iwai72620d62014-02-04 11:36:11 +0100313void snd_device_free(struct snd_card *card, void *device_data);
314void snd_device_free_all(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316/* isadma.c */
317
Al Viro276bd312005-08-23 22:45:06 +0100318#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319#define DMA_MODE_NO_ENABLE 0x0100
320
321void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
322void snd_dma_disable(unsigned long dma);
323unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100324#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200327struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200328void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330/* --- */
331
Fengguang Wufae3d882012-04-10 17:00:35 +0800332/* sound printk debug levels */
333enum {
334 SND_PR_ALWAYS,
335 SND_PR_DEBUG,
336 SND_PR_VERBOSE,
337};
338
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200339#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700340__printf(4, 5)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200341void __snd_printk(unsigned int level, const char *file, int line,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700342 const char *format, ...);
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200343#else
344#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200345 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200346#endif
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348/**
349 * snd_printk - printk wrapper
350 * @fmt: format string
351 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100352 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 * when configured with CONFIG_SND_VERBOSE_PRINTK.
354 */
355#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200356 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
358#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359/**
360 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800361 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 *
Pavel Machekedab9382008-04-01 15:33:22 +0200363 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 * Ignored when CONFIG_SND_DEBUG is not set.
365 */
366#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200367 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Fengguang Wufae3d882012-04-10 17:00:35 +0800368#define _snd_printd(level, fmt, args...) \
369 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200370
Takashi Iwaif66fced2008-11-07 09:37:22 +0100371/**
372 * snd_BUG - give a BUG warning message and stack trace
373 *
374 * Calls WARN() if CONFIG_SND_DEBUG is set.
375 * Ignored when CONFIG_SND_DEBUG is not set.
376 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200377#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100378
379/**
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600380 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
381 */
382#define snd_printd_ratelimit() printk_ratelimit()
383
384/**
Takashi Iwaif66fced2008-11-07 09:37:22 +0100385 * snd_BUG_ON - debugging check macro
386 * @cond: condition to evaluate
387 *
Christine Spangd5702162013-03-04 17:02:59 -0500388 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
389 * otherwise just evaluates the conditional and returns the value.
Takashi Iwaif66fced2008-11-07 09:37:22 +0100390 */
Christine Spangd5702162013-03-04 17:02:59 -0500391#define snd_BUG_ON(cond) WARN_ON((cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393#else /* !CONFIG_SND_DEBUG */
394
Takashi Iwai86b27232013-01-25 10:54:07 +0100395__printf(1, 2)
396static inline void snd_printd(const char *format, ...) {}
397__printf(2, 3)
398static inline void _snd_printd(int level, const char *format, ...) {}
399
Andrew Mortonfcef7832008-11-06 12:05:21 -0800400#define snd_BUG() do { } while (0)
Christine Spangd5702162013-03-04 17:02:59 -0500401
402#define snd_BUG_ON(condition) ({ \
403 int __ret_warn_on = !!(condition); \
404 unlikely(__ret_warn_on); \
405})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600407static inline bool snd_printd_ratelimit(void) { return false; }
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409#endif /* CONFIG_SND_DEBUG */
410
Takashi Iwai62cf8722008-05-20 12:15:15 +0200411#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412/**
413 * snd_printdd - debug printk
414 * @format: format string
415 *
Pavel Machekedab9382008-04-01 15:33:22 +0200416 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200417 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200419#define snd_printdd(format, args...) \
420 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421#else
Takashi Iwai86b27232013-01-25 10:54:07 +0100422__printf(1, 2)
423static inline void snd_printdd(const char *format, ...) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424#endif
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
428
429/* for easier backward-porting */
430#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
432#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
433#define gameport_get_port_data(gp) (gp)->port_data
434#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100436/* PCI quirk list helper */
437struct snd_pci_quirk {
438 unsigned short subvendor; /* PCI subvendor ID */
439 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100440 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100441 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200442#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100443 const char *name; /* name of the device (optional) */
444#endif
445};
446
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100447#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
448 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
449#define _SND_PCI_QUIRK_ID(vend, dev) \
450 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100451#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200452#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100453#define SND_PCI_QUIRK(vend,dev,xname,val) \
454 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100455#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
456 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
457#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
458 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
459 .value = (val), .name = (xname)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100460#define snd_pci_quirk_name(q) ((q)->name)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100461#else
462#define SND_PCI_QUIRK(vend,dev,xname,val) \
463 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100464#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
465 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
466#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
467 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100468#define snd_pci_quirk_name(q) ""
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100469#endif
470
Dylan Reidf0a220d2014-02-28 15:41:31 -0800471#ifdef CONFIG_PCI
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100472const struct snd_pci_quirk *
473snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
474
Takashi Iwaid1458272010-01-14 09:16:52 +0100475const struct snd_pci_quirk *
476snd_pci_quirk_lookup_id(u16 vendor, u16 device,
477 const struct snd_pci_quirk *list);
Dylan Reidf0a220d2014-02-28 15:41:31 -0800478#else
479static inline const struct snd_pci_quirk *
480snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
481{
482 return NULL;
483}
484
485static inline const struct snd_pci_quirk *
486snd_pci_quirk_lookup_id(u16 vendor, u16 device,
487 const struct snd_pci_quirk *list)
488{
489 return NULL;
490}
Axel Lin8422fa12012-01-30 17:10:58 +0800491#endif
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493#endif /* __SOUND_CORE_H */