blob: 31079ea5e48466575bfdf0bbc0e2c87fde26deeb [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 */
Heiner Kallweitde653602015-12-22 19:09:05 +0100102 char irq_descr[32]; /* Interrupt description */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 char mixername[80]; /* mixer name */
Takashi Iwaiff33f232008-10-07 11:38:09 +0200104 char components[128]; /* card components delimited with
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200105 space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 struct module *module; /* top-level module */
107
108 void *private_data; /* private data for soundcard */
Takashi Iwai512bbd62005-11-17 13:51:18 +0100109 void (*private_free) (struct snd_card *card); /* callback for freeing of
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200110 private data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 struct list_head devices; /* devices */
112
Takashi Iwai0fcd9f42015-01-29 16:41:27 +0100113 struct device ctl_dev; /* control device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 unsigned int last_numid; /* last used numeric ID */
115 struct rw_semaphore controls_rwsem; /* controls list lock */
116 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
117 int controls_count; /* count of all controls */
118 int user_ctl_count; /* count of all user controls */
119 struct list_head controls; /* all controls for this card */
120 struct list_head ctl_files; /* active control files */
Lars-Peter Clausen07f4d9d2014-06-18 13:32:31 +0200121 struct mutex user_ctl_lock; /* protects user controls against
122 concurrent access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
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 Iwaif2464062014-01-29 12:13:43 +0100133 struct completion *release_completion;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100134 struct device *dev; /* device assigned to this card */
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100135 struct device card_dev; /* cardX object for sysfs */
Takashi Iwai6bbc7fe2015-01-30 12:27:43 +0100136 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100137 bool registered; /* card_dev is registered? */
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
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100151#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100154static inline void snd_power_lock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100156 mutex_lock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Takashi Iwai512bbd62005-11-17 13:51:18 +0100159static inline void snd_power_unlock(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100161 mutex_unlock(&card->power_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162}
163
Takashi Iwai512bbd62005-11-17 13:51:18 +0100164static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 return card->power_state;
167}
168
Takashi Iwai512bbd62005-11-17 13:51:18 +0100169static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
171 card->power_state = state;
172 wake_up(&card->power_sleep);
173}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200174
175/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200176int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178#else /* ! CONFIG_PM */
179
180#define snd_power_lock(card) do { (void)(card); } while (0)
181#define snd_power_unlock(card) do { (void)(card); } while (0)
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700182static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400183#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186#endif /* CONFIG_PM */
187
Takashi Iwai512bbd62005-11-17 13:51:18 +0100188struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100189 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100190 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800192 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100193 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700194 struct device *dev; /* device for sysfs */
Takashi Iwaia0830db2012-10-16 13:05:59 +0200195 struct snd_card *card_ptr; /* assigned card instance */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196};
197
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100198/* return a device pointer linked to each sound device as a parent */
199static inline struct device *snd_card_get_device_link(struct snd_card *card)
200{
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100201 return card ? &card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100202}
203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204/* sound.c */
205
Clemens Ladischf1902862005-10-24 17:05:03 +0200206extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700208extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210void snd_request_card(int card);
211
Takashi Iwai4b440be2015-01-29 21:32:47 +0100212void snd_device_initialize(struct device *dev, struct snd_card *card);
213
Takashi Iwai40a4b262015-01-30 08:34:58 +0100214int snd_register_device(int type, struct snd_card *card, int dev,
215 const struct file_operations *f_ops,
216 void *private_data, struct device *device);
217int snd_unregister_device(struct device *dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100218void *snd_lookup_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
220#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100221int snd_register_oss_device(int type, struct snd_card *card, int dev,
Takashi Iwai80d7d772014-02-04 13:51:45 +0100222 const struct file_operations *f_ops, void *private_data);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100223int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100224void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225#endif
226
227int snd_minor_info_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229/* sound_oss.c */
230
231#ifdef CONFIG_SND_OSSEMUL
232int snd_minor_info_oss_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200234static inline int snd_minor_info_oss_init(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235#endif
236
237/* memory.c */
238
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
240int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
241
242/* init.c */
243
Takashi Iwai512bbd62005-11-17 13:51:18 +0100244extern struct snd_card *snd_cards[SNDRV_CARDS];
Takashi Iwai746df942006-05-15 19:49:05 +0200245int snd_card_locked(int card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
247#define SND_MIXER_OSS_NOTIFY_REGISTER 0
248#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
249#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100250extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#endif
252
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100253int snd_card_new(struct device *parent, int idx, const char *xid,
254 struct module *module, int extra_size,
255 struct snd_card **card_ret);
256
Takashi Iwai512bbd62005-11-17 13:51:18 +0100257int snd_card_disconnect(struct snd_card *card);
258int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200259int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200260void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100261int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262int snd_card_info_init(void);
Takashi Iwai6bbc7fe2015-01-30 12:27:43 +0100263int snd_card_add_dev_attr(struct snd_card *card,
264 const struct attribute_group *group);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100265int snd_component_add(struct snd_card *card, const char *component);
266int snd_card_file_add(struct snd_card *card, struct file *file);
267int snd_card_file_remove(struct snd_card *card, struct file *file);
Takashi Iwaif2464062014-01-29 12:13:43 +0100268#define snd_card_unref(card) put_device(&(card)->card_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Pavel Machekedab9382008-04-01 15:33:22 +0200270#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272/* device.c */
273
Takashi Iwai9ce50542014-01-29 15:13:33 +0100274int snd_device_new(struct snd_card *card, enum snd_device_type type,
Takashi Iwai512bbd62005-11-17 13:51:18 +0100275 void *device_data, struct snd_device_ops *ops);
276int snd_device_register(struct snd_card *card, void *device_data);
277int snd_device_register_all(struct snd_card *card);
Takashi Iwaie086e302015-02-27 18:01:22 +0100278void snd_device_disconnect(struct snd_card *card, void *device_data);
279void snd_device_disconnect_all(struct snd_card *card);
Takashi Iwai72620d62014-02-04 11:36:11 +0100280void snd_device_free(struct snd_card *card, void *device_data);
281void snd_device_free_all(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/* isadma.c */
284
Al Viro276bd312005-08-23 22:45:06 +0100285#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286#define DMA_MODE_NO_ENABLE 0x0100
287
288void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
289void snd_dma_disable(unsigned long dma);
290unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100291#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200294struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200295void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297/* --- */
298
Fengguang Wufae3d882012-04-10 17:00:35 +0800299/* sound printk debug levels */
300enum {
301 SND_PR_ALWAYS,
302 SND_PR_DEBUG,
303 SND_PR_VERBOSE,
304};
305
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200306#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700307__printf(4, 5)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200308void __snd_printk(unsigned int level, const char *file, int line,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700309 const char *format, ...);
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200310#else
311#define __snd_printk(level, file, line, format, args...) \
Takashi Iwaicf0baf12009-08-28 07:22:05 +0200312 printk(format, ##args)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200313#endif
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315/**
316 * snd_printk - printk wrapper
317 * @fmt: format string
318 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100319 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 * when configured with CONFIG_SND_VERBOSE_PRINTK.
321 */
322#define snd_printk(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200323 __snd_printk(0, __FILE__, __LINE__, fmt, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
325#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326/**
327 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800328 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 *
Pavel Machekedab9382008-04-01 15:33:22 +0200330 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 * Ignored when CONFIG_SND_DEBUG is not set.
332 */
333#define snd_printd(fmt, args...) \
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200334 __snd_printk(1, __FILE__, __LINE__, fmt, ##args)
Fengguang Wufae3d882012-04-10 17:00:35 +0800335#define _snd_printd(level, fmt, args...) \
336 __snd_printk(level, __FILE__, __LINE__, fmt, ##args)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200337
Takashi Iwaif66fced2008-11-07 09:37:22 +0100338/**
339 * snd_BUG - give a BUG warning message and stack trace
340 *
341 * Calls WARN() if CONFIG_SND_DEBUG is set.
342 * Ignored when CONFIG_SND_DEBUG is not set.
343 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200344#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100345
346/**
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600347 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
348 */
349#define snd_printd_ratelimit() printk_ratelimit()
350
351/**
Takashi Iwaif66fced2008-11-07 09:37:22 +0100352 * snd_BUG_ON - debugging check macro
353 * @cond: condition to evaluate
354 *
Christine Spangd5702162013-03-04 17:02:59 -0500355 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
356 * otherwise just evaluates the conditional and returns the value.
Takashi Iwaif66fced2008-11-07 09:37:22 +0100357 */
Christine Spangd5702162013-03-04 17:02:59 -0500358#define snd_BUG_ON(cond) WARN_ON((cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360#else /* !CONFIG_SND_DEBUG */
361
Takashi Iwai86b27232013-01-25 10:54:07 +0100362__printf(1, 2)
363static inline void snd_printd(const char *format, ...) {}
364__printf(2, 3)
365static inline void _snd_printd(int level, const char *format, ...) {}
366
Andrew Mortonfcef7832008-11-06 12:05:21 -0800367#define snd_BUG() do { } while (0)
Christine Spangd5702162013-03-04 17:02:59 -0500368
369#define snd_BUG_ON(condition) ({ \
370 int __ret_warn_on = !!(condition); \
371 unlikely(__ret_warn_on); \
372})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600374static inline bool snd_printd_ratelimit(void) { return false; }
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376#endif /* CONFIG_SND_DEBUG */
377
Takashi Iwai62cf8722008-05-20 12:15:15 +0200378#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/**
380 * snd_printdd - debug printk
381 * @format: format string
382 *
Pavel Machekedab9382008-04-01 15:33:22 +0200383 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200384 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 */
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200386#define snd_printdd(format, args...) \
387 __snd_printk(2, __FILE__, __LINE__, format, ##args)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388#else
Takashi Iwai86b27232013-01-25 10:54:07 +0100389__printf(1, 2)
390static inline void snd_printdd(const char *format, ...) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391#endif
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
395
396/* for easier backward-porting */
397#if defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
399#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
400#define gameport_get_port_data(gp) (gp)->port_data
401#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100403/* PCI quirk list helper */
404struct snd_pci_quirk {
405 unsigned short subvendor; /* PCI subvendor ID */
406 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100407 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100408 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200409#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100410 const char *name; /* name of the device (optional) */
411#endif
412};
413
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100414#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
415 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
416#define _SND_PCI_QUIRK_ID(vend, dev) \
417 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100418#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200419#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100420#define SND_PCI_QUIRK(vend,dev,xname,val) \
421 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100422#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
423 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
424#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
425 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
426 .value = (val), .name = (xname)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100427#define snd_pci_quirk_name(q) ((q)->name)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100428#else
429#define SND_PCI_QUIRK(vend,dev,xname,val) \
430 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100431#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
432 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
433#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
434 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100435#define snd_pci_quirk_name(q) ""
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100436#endif
437
Dylan Reidf0a220d2014-02-28 15:41:31 -0800438#ifdef CONFIG_PCI
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100439const struct snd_pci_quirk *
440snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
441
Takashi Iwaid1458272010-01-14 09:16:52 +0100442const struct snd_pci_quirk *
443snd_pci_quirk_lookup_id(u16 vendor, u16 device,
444 const struct snd_pci_quirk *list);
Dylan Reidf0a220d2014-02-28 15:41:31 -0800445#else
446static inline const struct snd_pci_quirk *
447snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
448{
449 return NULL;
450}
451
452static inline const struct snd_pci_quirk *
453snd_pci_quirk_lookup_id(u16 vendor, u16 device,
454 const struct snd_pci_quirk *list)
455{
456 return NULL;
457}
Axel Lin8422fa12012-01-30 17:10:58 +0800458#endif
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100459
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460#endif /* __SOUND_CORE_H */