blob: 381a010a1bd4d2f38d953340f3f42f9e66306848 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002#ifndef __SOUND_CORE_H
3#define __SOUND_CORE_H
4
5/*
6 * Main header file for the ALSA driver
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02007 * Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
9
Takashi Iwai8bfb1812014-01-29 11:46:11 +010010#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/sched.h> /* wake_up() */
Ingo Molnar1a60d4c2006-01-16 16:29:08 +010012#include <linux/mutex.h> /* struct mutex */
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/rwsem.h> /* struct rw_semaphore */
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/pm.h> /* pm_message_t */
Takashi Iwai5ef03462008-08-08 17:06:01 +020015#include <linux/stringify.h>
Tim Gardnerbcbb1552013-08-16 11:18:59 -060016#include <linux/printk.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
Takashi Iwai9004acc2008-01-08 18:13:27 +010018/* number of supported soundcards */
19#ifdef CONFIG_SND_DYNAMIC_MINORS
Takashi Iwai7bb24912013-05-15 08:46:39 +020020#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
Takashi Iwai9004acc2008-01-08 18:13:27 +010021#else
22#define SNDRV_CARDS 8 /* don't change - minor numbers */
23#endif
24
25#define CONFIG_SND_MAJOR 116 /* standard configuration */
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027/* forward declarations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070028struct pci_dev;
Paul Gortmakerde477252011-05-26 13:46:22 -040029struct module;
Takashi Iwaif2464062014-01-29 12:13:43 +010030struct completion;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32/* device allocation stuff */
33
Takashi Iwai289ca022014-01-29 15:53:35 +010034/* type of the object used in snd_device_*()
35 * this also defines the calling order
36 */
Takashi Iwai9ce50542014-01-29 15:13:33 +010037enum snd_device_type {
Takashi Iwai289ca022014-01-29 15:53:35 +010038 SNDRV_DEV_LOWLEVEL,
Takashi Iwai289ca022014-01-29 15:53:35 +010039 SNDRV_DEV_INFO,
40 SNDRV_DEV_BUS,
41 SNDRV_DEV_CODEC,
Takashi Iwai9ce50542014-01-29 15:13:33 +010042 SNDRV_DEV_PCM,
Takashi Iwai289ca022014-01-29 15:53:35 +010043 SNDRV_DEV_COMPRESS,
Takashi Iwai9ce50542014-01-29 15:13:33 +010044 SNDRV_DEV_RAWMIDI,
45 SNDRV_DEV_TIMER,
46 SNDRV_DEV_SEQUENCER,
47 SNDRV_DEV_HWDEP,
Takashi Iwai9ce50542014-01-29 15:13:33 +010048 SNDRV_DEV_JACK,
Takashi Iwaidc82e5242018-05-15 20:25:29 +020049 SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
Takashi Iwai9ce50542014-01-29 15:13:33 +010050};
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Takashi Iwai9ce50542014-01-29 15:13:33 +010052enum snd_device_state {
53 SNDRV_DEV_BUILD,
54 SNDRV_DEV_REGISTERED,
55 SNDRV_DEV_DISCONNECTED,
56};
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Takashi Iwai512bbd62005-11-17 13:51:18 +010058struct snd_device;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Takashi Iwai512bbd62005-11-17 13:51:18 +010060struct snd_device_ops {
61 int (*dev_free)(struct snd_device *dev);
62 int (*dev_register)(struct snd_device *dev);
63 int (*dev_disconnect)(struct snd_device *dev);
Takashi Iwai512bbd62005-11-17 13:51:18 +010064};
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Takashi Iwai512bbd62005-11-17 13:51:18 +010066struct snd_device {
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 struct list_head list; /* list of registered devices */
Takashi Iwai512bbd62005-11-17 13:51:18 +010068 struct snd_card *card; /* card which holds this device */
Takashi Iwai9ce50542014-01-29 15:13:33 +010069 enum snd_device_state state; /* state of the device */
70 enum snd_device_type type; /* device type */
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 void *device_data; /* device structure */
Takashi Iwai8b575822020-01-03 09:16:19 +010072 const struct snd_device_ops *ops; /* operations */
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
74
Takashi Iwai512bbd62005-11-17 13:51:18 +010075#define snd_device(n) list_entry(n, struct snd_device, list)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Linus Torvalds1da177e2005-04-16 15:20:36 -070077/* main structure for soundcard */
78
Takashi Iwai512bbd62005-11-17 13:51:18 +010079struct snd_card {
Henrik Kretzschmard5750f62005-06-29 19:31:06 +020080 int number; /* number of soundcard (index to
81 snd_cards) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 char id[16]; /* id string of this card */
84 char driver[16]; /* driver name */
85 char shortname[32]; /* short name of this soundcard */
86 char longname[80]; /* name of this soundcard */
Heiner Kallweitde653602015-12-22 19:09:05 +010087 char irq_descr[32]; /* Interrupt description */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 char mixername[80]; /* mixer name */
Takashi Iwaiff33f232008-10-07 11:38:09 +020089 char components[128]; /* card components delimited with
Henrik Kretzschmard5750f62005-06-29 19:31:06 +020090 space */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 struct module *module; /* top-level module */
92
93 void *private_data; /* private data for soundcard */
Takashi Iwai512bbd62005-11-17 13:51:18 +010094 void (*private_free) (struct snd_card *card); /* callback for freeing of
Henrik Kretzschmard5750f62005-06-29 19:31:06 +020095 private data */
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 struct list_head devices; /* devices */
97
Takashi Iwai0fcd9f42015-01-29 16:41:27 +010098 struct device ctl_dev; /* control device */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 unsigned int last_numid; /* last used numeric ID */
100 struct rw_semaphore controls_rwsem; /* controls list lock */
101 rwlock_t ctl_files_rwlock; /* ctl_files list lock */
102 int controls_count; /* count of all controls */
103 int user_ctl_count; /* count of all user controls */
104 struct list_head controls; /* all controls for this card */
105 struct list_head ctl_files; /* active control files */
106
Takashi Iwai512bbd62005-11-17 13:51:18 +0100107 struct snd_info_entry *proc_root; /* root for soundcard specific files */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 struct proc_dir_entry *proc_root_link; /* number link to real id */
109
Takashi Iwai118dd6b2009-02-23 16:35:21 +0100110 struct list_head files_list; /* all files associated to this card */
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200111 struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
112 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 spinlock_t files_lock; /* lock the files for this card */
114 int shutdown; /* this card is going down */
Takashi Iwaif2464062014-01-29 12:13:43 +0100115 struct completion *release_completion;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100116 struct device *dev; /* device assigned to this card */
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100117 struct device card_dev; /* cardX object for sysfs */
Takashi Iwai6bbc7fe2015-01-30 12:27:43 +0100118 const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100119 bool registered; /* card_dev is registered? */
Takashi Iwaifabb26d2019-11-17 09:53:07 +0100120 int sync_irq; /* assigned irq, used for PCM sync */
Takashi Iwaic44027c2017-10-11 06:36:13 +0000121 wait_queue_head_t remove_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Takashi Iwaid4cfb302020-01-20 13:44:22 +0100123 size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */
124 struct mutex memory_mutex; /* protection for the above */
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 unsigned int power_state; /* power state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 wait_queue_head_t power_sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129#endif
130
Takashi Iwai6d2412b2017-05-12 11:44:03 +0200131#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Takashi Iwai512bbd62005-11-17 13:51:18 +0100132 struct snd_mixer_oss *mixer_oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int mixer_oss_change_count;
134#endif
135};
136
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100137#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139#ifdef CONFIG_PM
Takashi Iwai512bbd62005-11-17 13:51:18 +0100140static inline unsigned int snd_power_get_state(struct snd_card *card)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141{
142 return card->power_state;
143}
144
Takashi Iwai512bbd62005-11-17 13:51:18 +0100145static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
147 card->power_state = state;
148 wake_up(&card->power_sleep);
149}
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200150
151/* init.c */
Takashi Iwaicbac4b02006-03-27 12:38:07 +0200152int snd_power_wait(struct snd_card *card, unsigned int power_state);
Henrik Kretzschmard5750f62005-06-29 19:31:06 +0200153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#else /* ! CONFIG_PM */
155
Linus Torvalds6fdb94b2006-04-02 14:37:36 -0700156static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
Mike Frysinger363129e2010-10-16 13:24:52 -0400157#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158#define snd_power_change_state(card, state) do { (void)(card); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160#endif /* CONFIG_PM */
161
Takashi Iwai512bbd62005-11-17 13:51:18 +0100162struct snd_minor {
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100163 int type; /* SNDRV_DEVICE_TYPE_XXX */
Clemens Ladisch6983b722005-11-20 14:05:49 +0100164 int card; /* card number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 int device; /* device number */
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800166 const struct file_operations *f_ops; /* file operations */
Clemens Ladischf87135f2005-11-20 14:06:59 +0100167 void *private_data; /* private data for f_ops->open */
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700168 struct device *dev; /* device for sysfs */
Takashi Iwaia0830db2012-10-16 13:05:59 +0200169 struct snd_card *card_ptr; /* assigned card instance */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170};
171
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100172/* return a device pointer linked to each sound device as a parent */
173static inline struct device *snd_card_get_device_link(struct snd_card *card)
174{
Takashi Iwai8bfb1812014-01-29 11:46:11 +0100175 return card ? &card->card_dev : NULL;
Takashi Iwai7d2aae12007-01-26 12:40:31 +0100176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178/* sound.c */
179
Clemens Ladischf1902862005-10-24 17:05:03 +0200180extern int snd_major;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181extern int snd_ecards_limit;
Greg Kroah-Hartmand80f19f2006-08-07 22:19:37 -0700182extern struct class *sound_class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184void snd_request_card(int card);
185
Takashi Iwai4b440be2015-01-29 21:32:47 +0100186void snd_device_initialize(struct device *dev, struct snd_card *card);
187
Takashi Iwai40a4b262015-01-30 08:34:58 +0100188int snd_register_device(int type, struct snd_card *card, int dev,
189 const struct file_operations *f_ops,
190 void *private_data, struct device *device);
191int snd_unregister_device(struct device *dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100192void *snd_lookup_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194#ifdef CONFIG_SND_OSSEMUL
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100195int snd_register_oss_device(int type, struct snd_card *card, int dev,
Takashi Iwai80d7d772014-02-04 13:51:45 +0100196 const struct file_operations *f_ops, void *private_data);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100197int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
Clemens Ladischf87135f2005-11-20 14:06:59 +0100198void *snd_lookup_oss_minor_data(unsigned int minor, int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199#endif
200
201int snd_minor_info_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203/* sound_oss.c */
204
205#ifdef CONFIG_SND_OSSEMUL
206int snd_minor_info_oss_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207#else
Pavel Machekad5fada2008-04-14 18:31:35 +0200208static inline int snd_minor_info_oss_init(void) { return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209#endif
210
211/* memory.c */
212
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
214int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);
215
216/* init.c */
217
Takashi Iwai746df9482006-05-15 19:49:05 +0200218int snd_card_locked(int card);
Takashi Iwai6d2412b2017-05-12 11:44:03 +0200219#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220#define SND_MIXER_OSS_NOTIFY_REGISTER 0
221#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
222#define SND_MIXER_OSS_NOTIFY_FREE 2
Takashi Iwai512bbd62005-11-17 13:51:18 +0100223extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224#endif
225
Takashi Iwai393aa9c2014-01-29 12:51:12 +0100226int snd_card_new(struct device *parent, int idx, const char *xid,
227 struct module *module, int extra_size,
228 struct snd_card **card_ret);
229
Takashi Iwai512bbd62005-11-17 13:51:18 +0100230int snd_card_disconnect(struct snd_card *card);
Takashi Iwaic44027c2017-10-11 06:36:13 +0000231void snd_card_disconnect_sync(struct snd_card *card);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100232int snd_card_free(struct snd_card *card);
Takashi Iwaic4614822006-06-23 14:38:23 +0200233int snd_card_free_when_closed(struct snd_card *card);
Jaroslav Kysela10a8ebb2009-06-02 12:02:38 +0200234void snd_card_set_id(struct snd_card *card, const char *id);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100235int snd_card_register(struct snd_card *card);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236int snd_card_info_init(void);
Takashi Iwai6bbc7fe2015-01-30 12:27:43 +0100237int snd_card_add_dev_attr(struct snd_card *card,
238 const struct attribute_group *group);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100239int snd_component_add(struct snd_card *card, const char *component);
240int snd_card_file_add(struct snd_card *card, struct file *file);
241int snd_card_file_remove(struct snd_card *card, struct file *file);
Takashi Iwaif4fa9682019-04-16 18:18:47 +0200242
243struct snd_card *snd_card_ref(int card);
244
245/**
246 * snd_card_unref - Unreference the card object
247 * @card: the card object to unreference
248 *
249 * Call this function for the card object that was obtained via snd_card_ref()
250 * or snd_lookup_minor_data().
251 */
252static inline void snd_card_unref(struct snd_card *card)
253{
254 put_device(&card->card_dev);
255}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Pavel Machekedab9382008-04-01 15:33:22 +0200257#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
259/* device.c */
260
Takashi Iwai9ce50542014-01-29 15:13:33 +0100261int snd_device_new(struct snd_card *card, enum snd_device_type type,
Takashi Iwai8b575822020-01-03 09:16:19 +0100262 void *device_data, const struct snd_device_ops *ops);
Takashi Iwai512bbd62005-11-17 13:51:18 +0100263int snd_device_register(struct snd_card *card, void *device_data);
264int snd_device_register_all(struct snd_card *card);
Takashi Iwaie086e302015-02-27 18:01:22 +0100265void snd_device_disconnect(struct snd_card *card, void *device_data);
266void snd_device_disconnect_all(struct snd_card *card);
Takashi Iwai72620d62014-02-04 11:36:11 +0100267void snd_device_free(struct snd_card *card, void *device_data);
268void snd_device_free_all(struct snd_card *card);
Takashi Iwaic208a532020-03-23 18:06:42 +0100269int snd_device_get_state(struct snd_card *card, void *device_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271/* isadma.c */
272
Al Viro276bd312005-08-23 22:45:06 +0100273#ifdef CONFIG_ISA_DMA_API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274#define DMA_MODE_NO_ENABLE 0x0100
275
276void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
277void snd_dma_disable(unsigned long dma);
278unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
Al Viro276bd312005-08-23 22:45:06 +0100279#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281/* misc.c */
Takashi Iwaib709e572005-10-11 17:28:58 +0200282struct resource;
Takashi Iwaib1d57762005-10-10 11:56:31 +0200283void release_and_free_resource(struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285/* --- */
286
Fengguang Wufae3d882012-04-10 17:00:35 +0800287/* sound printk debug levels */
288enum {
289 SND_PR_ALWAYS,
290 SND_PR_DEBUG,
291 SND_PR_VERBOSE,
292};
293
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200294#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700295__printf(4, 5)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200296void __snd_printk(unsigned int level, const char *file, int line,
Joe Perchesb9075fa2011-10-31 17:11:33 -0700297 const char *format, ...);
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200298#else
Takashi Iwai43e575f2016-11-14 22:25:33 +0100299#define __snd_printk(level, file, line, format, ...) \
300 printk(format, ##__VA_ARGS__)
Takashi Iwai36ce99c2009-08-27 16:45:07 +0200301#endif
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/**
304 * snd_printk - printk wrapper
305 * @fmt: format string
306 *
Takashi Iwaif66fced2008-11-07 09:37:22 +0100307 * Works like printk() but prints the file and the line of the caller
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 * when configured with CONFIG_SND_VERBOSE_PRINTK.
309 */
Takashi Iwai43e575f2016-11-14 22:25:33 +0100310#define snd_printk(fmt, ...) \
311 __snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313#ifdef CONFIG_SND_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314/**
315 * snd_printd - debug printk
Martin Waitz0863afb2006-01-09 20:53:55 -0800316 * @fmt: format string
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 *
Pavel Machekedab9382008-04-01 15:33:22 +0200318 * Works like snd_printk() for debugging purposes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 * Ignored when CONFIG_SND_DEBUG is not set.
320 */
Takashi Iwai43e575f2016-11-14 22:25:33 +0100321#define snd_printd(fmt, ...) \
322 __snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
323#define _snd_printd(level, fmt, ...) \
324 __snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
Takashi Iwai7c22f1a2005-10-10 11:46:31 +0200325
Takashi Iwaif66fced2008-11-07 09:37:22 +0100326/**
327 * snd_BUG - give a BUG warning message and stack trace
328 *
329 * Calls WARN() if CONFIG_SND_DEBUG is set.
330 * Ignored when CONFIG_SND_DEBUG is not set.
331 */
Takashi Iwaibdbecf52008-08-08 17:18:08 +0200332#define snd_BUG() WARN(1, "BUG?\n")
Takashi Iwaif66fced2008-11-07 09:37:22 +0100333
334/**
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600335 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
336 */
337#define snd_printd_ratelimit() printk_ratelimit()
338
339/**
Takashi Iwaif66fced2008-11-07 09:37:22 +0100340 * snd_BUG_ON - debugging check macro
341 * @cond: condition to evaluate
342 *
Christine Spangd5702162013-03-04 17:02:59 -0500343 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
344 * otherwise just evaluates the conditional and returns the value.
Takashi Iwaif66fced2008-11-07 09:37:22 +0100345 */
Christine Spangd5702162013-03-04 17:02:59 -0500346#define snd_BUG_ON(cond) WARN_ON((cond))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348#else /* !CONFIG_SND_DEBUG */
349
Takashi Iwai86b27232013-01-25 10:54:07 +0100350__printf(1, 2)
351static inline void snd_printd(const char *format, ...) {}
352__printf(2, 3)
353static inline void _snd_printd(int level, const char *format, ...) {}
354
Andrew Mortonfcef78362008-11-06 12:05:21 -0800355#define snd_BUG() do { } while (0)
Christine Spangd5702162013-03-04 17:02:59 -0500356
357#define snd_BUG_ON(condition) ({ \
358 int __ret_warn_on = !!(condition); \
359 unlikely(__ret_warn_on); \
360})
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Tim Gardnerbcbb1552013-08-16 11:18:59 -0600362static inline bool snd_printd_ratelimit(void) { return false; }
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364#endif /* CONFIG_SND_DEBUG */
365
Takashi Iwai62cf8722008-05-20 12:15:15 +0200366#ifdef CONFIG_SND_DEBUG_VERBOSE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367/**
368 * snd_printdd - debug printk
369 * @format: format string
370 *
Pavel Machekedab9382008-04-01 15:33:22 +0200371 * Works like snd_printk() for debugging purposes.
Takashi Iwai62cf8722008-05-20 12:15:15 +0200372 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 */
Takashi Iwai43e575f2016-11-14 22:25:33 +0100374#define snd_printdd(format, ...) \
375 __snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376#else
Takashi Iwai86b27232013-01-25 10:54:07 +0100377__printf(1, 2)
378static inline void snd_printdd(const char *format, ...) {}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379#endif
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382#define SNDRV_OSS_VERSION ((3<<16)|(8<<8)|(1<<4)|(0)) /* 3.8.1a */
383
384/* for easier backward-porting */
Takashi Iwai6d2412b2017-05-12 11:44:03 +0200385#if IS_ENABLED(CONFIG_GAMEPORT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
387#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
388#define gameport_get_port_data(gp) (gp)->port_data
389#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100391/* PCI quirk list helper */
392struct snd_pci_quirk {
393 unsigned short subvendor; /* PCI subvendor ID */
394 unsigned short subdevice; /* PCI subdevice ID */
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100395 unsigned short subdevice_mask; /* bitmask to match */
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100396 int value; /* value */
Takashi Iwai62cf8722008-05-20 12:15:15 +0200397#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100398 const char *name; /* name of the device (optional) */
399#endif
400};
401
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100402#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
403 .subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
404#define _SND_PCI_QUIRK_ID(vend, dev) \
405 _SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100406#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
Takashi Iwai62cf8722008-05-20 12:15:15 +0200407#ifdef CONFIG_SND_DEBUG_VERBOSE
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100408#define SND_PCI_QUIRK(vend,dev,xname,val) \
409 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100410#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
411 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
412#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
413 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
414 .value = (val), .name = (xname)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100415#define snd_pci_quirk_name(q) ((q)->name)
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100416#else
417#define SND_PCI_QUIRK(vend,dev,xname,val) \
418 {_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
Takashi Iwai8bd4bb72009-01-30 17:27:45 +0100419#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
420 {_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
421#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
422 {_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
Takashi Iwai86b27232013-01-25 10:54:07 +0100423#define snd_pci_quirk_name(q) ""
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100424#endif
425
Dylan Reidf0a220d2014-02-28 15:41:31 -0800426#ifdef CONFIG_PCI
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100427const struct snd_pci_quirk *
428snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);
429
Takashi Iwaid1458272010-01-14 09:16:52 +0100430const struct snd_pci_quirk *
431snd_pci_quirk_lookup_id(u16 vendor, u16 device,
432 const struct snd_pci_quirk *list);
Dylan Reidf0a220d2014-02-28 15:41:31 -0800433#else
434static inline const struct snd_pci_quirk *
435snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
436{
437 return NULL;
438}
439
440static inline const struct snd_pci_quirk *
441snd_pci_quirk_lookup_id(u16 vendor, u16 device,
442 const struct snd_pci_quirk *list)
443{
444 return NULL;
445}
Axel Lin8422fa12012-01-30 17:10:58 +0800446#endif
Takashi Iwaid9ea4722006-11-24 15:34:06 +0100447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448#endif /* __SOUND_CORE_H */