[mirror_ubuntu-jammy-kernel.git] / include / sound / core.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __SOUND_CORE_H
#define __SOUND_CORE_H

/*
 *  Main header file for the ALSA driver
 *  Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
 */

#include <linux/device.h>
#include <linux/sched.h>		/* wake_up() */
#include <linux/mutex.h>		/* struct mutex */
#include <linux/rwsem.h>		/* struct rw_semaphore */
#include <linux/pm.h>			/* pm_message_t */
#include <linux/stringify.h>
#include <linux/printk.h>

/* number of supported soundcards */
#ifdef CONFIG_SND_DYNAMIC_MINORS
#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
#else
#define SNDRV_CARDS 8		/* don't change - minor numbers */
#endif

#define CONFIG_SND_MAJOR	116	/* standard configuration */

/* forward declarations */
struct pci_dev;
struct module;
struct completion;

/* device allocation stuff */

/* type of the object used in snd_device_*()
 * this also defines the calling order
 */
enum snd_device_type {
	SNDRV_DEV_LOWLEVEL,
	SNDRV_DEV_INFO,
	SNDRV_DEV_BUS,
	SNDRV_DEV_CODEC,
	SNDRV_DEV_PCM,
	SNDRV_DEV_COMPRESS,
	SNDRV_DEV_RAWMIDI,
	SNDRV_DEV_TIMER,
	SNDRV_DEV_SEQUENCER,
	SNDRV_DEV_HWDEP,
	SNDRV_DEV_JACK,
	SNDRV_DEV_CONTROL,	/* NOTE: this must be the last one */
};

enum snd_device_state {
	SNDRV_DEV_BUILD,
	SNDRV_DEV_REGISTERED,
	SNDRV_DEV_DISCONNECTED,
};

struct snd_device;

struct snd_device_ops {
	int (*dev_free)(struct snd_device *dev);
	int (*dev_register)(struct snd_device *dev);
	int (*dev_disconnect)(struct snd_device *dev);
};

struct snd_device {
	struct list_head list;		/* list of registered devices */
	struct snd_card *card;		/* card which holds this device */
	enum snd_device_state state;	/* state of the device */
	enum snd_device_type type;	/* device type */
	void *device_data;		/* device structure */
	const struct snd_device_ops *ops;	/* operations */
};

#define snd_device(n) list_entry(n, struct snd_device, list)

/* main structure for soundcard */

struct snd_card {
	int number;			/* number of soundcard (index to
								snd_cards) */

	char id[16];			/* id string of this card */
	char driver[16];		/* driver name */
	char shortname[32];		/* short name of this soundcard */
	char longname[80];		/* name of this soundcard */
	char irq_descr[32];		/* Interrupt description */
	char mixername[80];		/* mixer name */
	char components[128];		/* card components delimited with
								space */
	struct module *module;		/* top-level module */

	void *private_data;		/* private data for soundcard */
	void (*private_free) (struct snd_card *card); /* callback for freeing of
								private data */
	struct list_head devices;	/* devices */

	struct device ctl_dev;		/* control device */
	unsigned int last_numid;	/* last used numeric ID */
	struct rw_semaphore controls_rwsem;	/* controls list lock */
	rwlock_t ctl_files_rwlock;	/* ctl_files list lock */
	int controls_count;		/* count of all controls */
	int user_ctl_count;		/* count of all user controls */
	struct list_head controls;	/* all controls for this card */
	struct list_head ctl_files;	/* active control files */

	struct snd_info_entry *proc_root;	/* root for soundcard specific files */
	struct proc_dir_entry *proc_root_link;	/* number link to real id */

	struct list_head files_list;	/* all files associated to this card */
	struct snd_shutdown_f_ops *s_f_ops; /* file operations in the shutdown
								state */
	spinlock_t files_lock;		/* lock the files for this card */
	int shutdown;			/* this card is going down */
	struct completion *release_completion;
	struct device *dev;		/* device assigned to this card */
	struct device card_dev;		/* cardX object for sysfs */
	const struct attribute_group *dev_groups[4]; /* assigned sysfs attr */
	bool registered;		/* card_dev is registered? */
	int sync_irq;			/* assigned irq, used for PCM sync */
	wait_queue_head_t remove_sleep;

	size_t total_pcm_alloc_bytes;	/* total amount of allocated buffers */
	struct mutex memory_mutex;	/* protection for the above */

#ifdef CONFIG_PM
	unsigned int power_state;	/* power state */
	wait_queue_head_t power_sleep;
#endif

#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
	struct snd_mixer_oss *mixer_oss;
	int mixer_oss_change_count;
#endif
};

#define dev_to_snd_card(p)	container_of(p, struct snd_card, card_dev)

#ifdef CONFIG_PM
static inline unsigned int snd_power_get_state(struct snd_card *card)
{
	return card->power_state;
}

static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
{
	card->power_state = state;
	wake_up(&card->power_sleep);
}

/* init.c */
int snd_power_wait(struct snd_card *card, unsigned int power_state);

#else /* ! CONFIG_PM */

static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
#define snd_power_get_state(card)	({ (void)(card); SNDRV_CTL_POWER_D0; })
#define snd_power_change_state(card, state)	do { (void)(card); } while (0)

#endif /* CONFIG_PM */

struct snd_minor {
	int type;			/* SNDRV_DEVICE_TYPE_XXX */
	int card;			/* card number */
	int device;			/* device number */
	const struct file_operations *f_ops;	/* file operations */
	void *private_data;		/* private data for f_ops->open */
	struct device *dev;		/* device for sysfs */
	struct snd_card *card_ptr;	/* assigned card instance */
};

/* return a device pointer linked to each sound device as a parent */
static inline struct device *snd_card_get_device_link(struct snd_card *card)
{
	return card ? &card->card_dev : NULL;
}

/* sound.c */

extern int snd_major;
extern int snd_ecards_limit;
extern struct class *sound_class;

void snd_request_card(int card);

void snd_device_initialize(struct device *dev, struct snd_card *card);

int snd_register_device(int type, struct snd_card *card, int dev,
			const struct file_operations *f_ops,
			void *private_data, struct device *device);
int snd_unregister_device(struct device *dev);
void *snd_lookup_minor_data(unsigned int minor, int type);

#ifdef CONFIG_SND_OSSEMUL
int snd_register_oss_device(int type, struct snd_card *card, int dev,
			    const struct file_operations *f_ops, void *private_data);
int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
void *snd_lookup_oss_minor_data(unsigned int minor, int type);
#endif

int snd_minor_info_init(void);

/* sound_oss.c */

#ifdef CONFIG_SND_OSSEMUL
int snd_minor_info_oss_init(void);
#else
static inline int snd_minor_info_oss_init(void) { return 0; }
#endif

/* memory.c */

int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count);
int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count);

/* init.c */

int snd_card_locked(int card);
#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
#define SND_MIXER_OSS_NOTIFY_REGISTER	0
#define SND_MIXER_OSS_NOTIFY_DISCONNECT	1
#define SND_MIXER_OSS_NOTIFY_FREE	2
extern int (*snd_mixer_oss_notify_callback)(struct snd_card *card, int cmd);
#endif

int snd_card_new(struct device *parent, int idx, const char *xid,
		 struct module *module, int extra_size,
		 struct snd_card **card_ret);

int snd_card_disconnect(struct snd_card *card);
void snd_card_disconnect_sync(struct snd_card *card);
int snd_card_free(struct snd_card *card);
int snd_card_free_when_closed(struct snd_card *card);
void snd_card_set_id(struct snd_card *card, const char *id);
int snd_card_register(struct snd_card *card);
int snd_card_info_init(void);
int snd_card_add_dev_attr(struct snd_card *card,
			  const struct attribute_group *group);
int snd_component_add(struct snd_card *card, const char *component);
int snd_card_file_add(struct snd_card *card, struct file *file);
int snd_card_file_remove(struct snd_card *card, struct file *file);

struct snd_card *snd_card_ref(int card);

/**
 * snd_card_unref - Unreference the card object
 * @card: the card object to unreference
 *
 * Call this function for the card object that was obtained via snd_card_ref()
 * or snd_lookup_minor_data().
 */
static inline void snd_card_unref(struct snd_card *card)
{
	put_device(&card->card_dev);
}

#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))

/* device.c */

int snd_device_new(struct snd_card *card, enum snd_device_type type,
		   void *device_data, const struct snd_device_ops *ops);
int snd_device_register(struct snd_card *card, void *device_data);
int snd_device_register_all(struct snd_card *card);
void snd_device_disconnect(struct snd_card *card, void *device_data);
void snd_device_disconnect_all(struct snd_card *card);
void snd_device_free(struct snd_card *card, void *device_data);
void snd_device_free_all(struct snd_card *card);
int snd_device_get_state(struct snd_card *card, void *device_data);

/* isadma.c */

#ifdef CONFIG_ISA_DMA_API
#define DMA_MODE_NO_ENABLE	0x0100

void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
void snd_dma_disable(unsigned long dma);
unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
#endif

/* misc.c */
struct resource;
void release_and_free_resource(struct resource *res);

/* --- */

/* sound printk debug levels */
enum {
	SND_PR_ALWAYS,
	SND_PR_DEBUG,
	SND_PR_VERBOSE,
};

#if defined(CONFIG_SND_DEBUG) || defined(CONFIG_SND_VERBOSE_PRINTK)
__printf(4, 5)
void __snd_printk(unsigned int level, const char *file, int line,
		  const char *format, ...);
#else
#define __snd_printk(level, file, line, format, ...) \
	printk(format, ##__VA_ARGS__)
#endif

/**
 * snd_printk - printk wrapper
 * @fmt: format string
 *
 * Works like printk() but prints the file and the line of the caller
 * when configured with CONFIG_SND_VERBOSE_PRINTK.
 */
#define snd_printk(fmt, ...) \
	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)

#ifdef CONFIG_SND_DEBUG
/**
 * snd_printd - debug printk
 * @fmt: format string
 *
 * Works like snd_printk() for debugging purposes.
 * Ignored when CONFIG_SND_DEBUG is not set.
 */
#define snd_printd(fmt, ...) \
	__snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
#define _snd_printd(level, fmt, ...) \
	__snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)

/**
 * snd_BUG - give a BUG warning message and stack trace
 *
 * Calls WARN() if CONFIG_SND_DEBUG is set.
 * Ignored when CONFIG_SND_DEBUG is not set.
 */
#define snd_BUG()		WARN(1, "BUG?\n")

/**
 * Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
 */
#define snd_printd_ratelimit() printk_ratelimit()

/**
 * snd_BUG_ON - debugging check macro
 * @cond: condition to evaluate
 *
 * Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
 * otherwise just evaluates the conditional and returns the value.
 */
#define snd_BUG_ON(cond)	WARN_ON((cond))

#else /* !CONFIG_SND_DEBUG */

__printf(1, 2)
static inline void snd_printd(const char *format, ...) {}
__printf(2, 3)
static inline void _snd_printd(int level, const char *format, ...) {}

#define snd_BUG()			do { } while (0)

#define snd_BUG_ON(condition) ({ \
	int __ret_warn_on = !!(condition); \
	unlikely(__ret_warn_on); \
})

static inline bool snd_printd_ratelimit(void) { return false; }

#endif /* CONFIG_SND_DEBUG */

#ifdef CONFIG_SND_DEBUG_VERBOSE
/**
 * snd_printdd - debug printk
 * @format: format string
 *
 * Works like snd_printk() for debugging purposes.
 * Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
 */
#define snd_printdd(format, ...) \
	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
#else
__printf(1, 2)
static inline void snd_printdd(const char *format, ...) {}
#endif


#define SNDRV_OSS_VERSION         ((3<<16)|(8<<8)|(1<<4)|(0))	/* 3.8.1a */

/* for easier backward-porting */
#if IS_ENABLED(CONFIG_GAMEPORT)
#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
#define gameport_get_port_data(gp) (gp)->port_data
#endif

/* PCI quirk list helper */
struct snd_pci_quirk {
	unsigned short subvendor;	/* PCI subvendor ID */
	unsigned short subdevice;	/* PCI subdevice ID */
	unsigned short subdevice_mask;	/* bitmask to match */
	int value;			/* value */
#ifdef CONFIG_SND_DEBUG_VERBOSE
	const char *name;		/* name of the device (optional) */
#endif
};

#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev)	\
	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
#define _SND_PCI_QUIRK_ID(vend, dev) \
	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
#ifdef CONFIG_SND_DEBUG_VERBOSE
#define SND_PCI_QUIRK(vend,dev,xname,val) \
	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
#define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev),			\
			.value = (val), .name = (xname)}
#define snd_pci_quirk_name(q)	((q)->name)
#else
#define SND_PCI_QUIRK(vend,dev,xname,val) \
	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val)			\
	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
#define SND_PCI_QUIRK_VENDOR(vend, xname, val)			\
	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
#define snd_pci_quirk_name(q)	""
#endif

#ifdef CONFIG_PCI
const struct snd_pci_quirk *
snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list);

const struct snd_pci_quirk *
snd_pci_quirk_lookup_id(u16 vendor, u16 device,
			const struct snd_pci_quirk *list);
#else
static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup(struct pci_dev *pci, const struct snd_pci_quirk *list)
{
	return NULL;
}

static inline const struct snd_pci_quirk *
snd_pci_quirk_lookup_id(u16 vendor, u16 device,
			const struct snd_pci_quirk *list)
{
	return NULL;
}
#endif

#endif /* __SOUND_CORE_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	#ifndef __SOUND_CORE_H
	3	#define __SOUND_CORE_H
	4
	5	/*
	6	* Main header file for the ALSA driver
c1017a4c	7	* Copyright (c) 1994-2001 by Jaroslav Kysela <perex@perex.cz>
1da177e4 LT	8	*/
1da177e4 LT	9
8bfb181c	10	#include <linux/device.h>
1da177e4	11	#include <linux/sched.h> /* wake_up() */
1a60d4c5	12	#include <linux/mutex.h> /* struct mutex */
1da177e4	13	#include <linux/rwsem.h> /* struct rw_semaphore */
1da177e4	14	#include <linux/pm.h> /* pm_message_t */
5ef03460	15	#include <linux/stringify.h>
bcbb1553	16	#include <linux/printk.h>
1da177e4	17
9004acc7 TI	18	/* number of supported soundcards */
9004acc7 TI	19	#ifdef CONFIG_SND_DYNAMIC_MINORS
7bb2491b	20	#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
9004acc7 TI	21	#else
	22	#define SNDRV_CARDS 8 /* don't change - minor numbers */
	23	#endif
	24
	25	#define CONFIG_SND_MAJOR 116 /* standard configuration */
	26
1da177e4	27	/* forward declarations */
1da177e4	28	struct pci_dev;
de477254	29	struct module;
f2464064	30	struct completion;
1da177e4 LT	31
	32	/* device allocation stuff */
	33
289ca025 TI	34	/* type of the object used in snd_device_*()
	35	* this also defines the calling order
	36	*/
9ce50543	37	enum snd_device_type {
289ca025	38	SNDRV_DEV_LOWLEVEL,
289ca025 TI	39	SNDRV_DEV_INFO,
	40	SNDRV_DEV_BUS,
	41	SNDRV_DEV_CODEC,
9ce50543	42	SNDRV_DEV_PCM,
289ca025	43	SNDRV_DEV_COMPRESS,
9ce50543 TI	44	SNDRV_DEV_RAWMIDI,
	45	SNDRV_DEV_TIMER,
	46	SNDRV_DEV_SEQUENCER,
	47	SNDRV_DEV_HWDEP,
9ce50543	48	SNDRV_DEV_JACK,
dc82e524	49	SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
9ce50543 TI	50	};
	51
	52	enum snd_device_state {
	53	SNDRV_DEV_BUILD,
	54	SNDRV_DEV_REGISTERED,
	55	SNDRV_DEV_DISCONNECTED,
	56	};
	57
512bbd6a TI	58	struct snd_device;
	59
	60	struct 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);
512bbd6a TI	64	};
	65
	66	struct snd_device {
1da177e4	67	struct list_head list; /* list of registered devices */
512bbd6a	68	struct snd_card card; / card which holds this device */
9ce50543 TI	69	enum snd_device_state state; /* state of the device */
9ce50543 TI	70	enum snd_device_type type; /* device type */
1da177e4	71	void device_data; / device structure */
8b575824	72	const struct snd_device_ops ops; / operations */
1da177e4 LT	73	};
1da177e4 LT	74
512bbd6a	75	#define snd_device(n) list_entry(n, struct snd_device, list)
1da177e4	76
1da177e4 LT	77	/* main structure for soundcard */
1da177e4 LT	78
512bbd6a	79	struct snd_card {
d5750f67 HK	80	int number; /* number of soundcard (index to
d5750f67 HK	81	snd_cards) */
1da177e4 LT	82
	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 */
de65360b	87	char irq_descr[32]; /* Interrupt description */
1da177e4	88	char mixername[80]; /* mixer name */
ff33f230	89	char components[128]; /* card components delimited with
d5750f67	90	space */
1da177e4 LT	91	struct module module; / top-level module */
	92
	93	void private_data; / private data for soundcard */
512bbd6a	94	void (private_free) (struct snd_card card); /* callback for freeing of
d5750f67	95	private data */
1da177e4 LT	96	struct list_head devices; /* devices */
1da177e4 LT	97
0fcd9f4b	98	struct device ctl_dev; /* control device */
1da177e4 LT	99	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
512bbd6a	107	struct snd_info_entry proc_root; / root for soundcard specific files */
1da177e4 LT	108	struct proc_dir_entry proc_root_link; / number link to real id */
1da177e4 LT	109
118dd6bf	110	struct list_head files_list; /* all files associated to this card */
d5750f67 HK	111	struct snd_shutdown_f_ops s_f_ops; / file operations in the shutdown
d5750f67 HK	112	state */
1da177e4 LT	113	spinlock_t files_lock; /* lock the files for this card */
1da177e4 LT	114	int shutdown; /* this card is going down */
f2464064	115	struct completion *release_completion;
7d2aae1e	116	struct device dev; / device assigned to this card */
8bfb181c	117	struct device card_dev; /* cardX object for sysfs */
6bbc7fed	118	const struct attribute_group dev_groups[4]; / assigned sysfs attr */
8bfb181c	119	bool registered; /* card_dev is registered? */
fabb26dc	120	int sync_irq; /* assigned irq, used for PCM sync */
c44027c8	121	wait_queue_head_t remove_sleep;
1da177e4	122
d4cfb30f TI	123	size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */
	124	struct mutex memory_mutex; /* protection for the above */
	125
1da177e4	126	#ifdef CONFIG_PM
1da177e4	127	unsigned int power_state; /* power state */
1da177e4	128	wait_queue_head_t power_sleep;
1da177e4 LT	129	#endif
1da177e4 LT	130
6d2412b8	131	#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
512bbd6a	132	struct snd_mixer_oss *mixer_oss;
1da177e4 LT	133	int mixer_oss_change_count;
	134	#endif
	135	};
	136
8bfb181c TI	137	#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
8bfb181c TI	138
1da177e4	139	#ifdef CONFIG_PM
512bbd6a	140	static inline unsigned int snd_power_get_state(struct snd_card *card)
1da177e4 LT	141	{
	142	return card->power_state;
	143	}
	144
512bbd6a	145	static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
1da177e4 LT	146	{
	147	card->power_state = state;
	148	wake_up(&card->power_sleep);
	149	}
d5750f67 HK	150
d5750f67 HK	151	/* init.c */
cbac4b0c	152	int snd_power_wait(struct snd_card *card, unsigned int power_state);
d5750f67	153
1da177e4 LT	154	#else /* ! CONFIG_PM */
1da177e4 LT	155
6fdb94bd	156	static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
363129ea	157	#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
1da177e4	158	#define snd_power_change_state(card, state) do { (void)(card); } while (0)
1da177e4 LT	159
	160	#endif /* CONFIG_PM */
	161
512bbd6a	162	struct snd_minor {
2af677fc	163	int type; /* SNDRV_DEVICE_TYPE_XXX */
6983b724	164	int card; /* card number */
1da177e4	165	int device; /* device number */
99ac48f5	166	const struct file_operations f_ops; / file operations */
f87135f5	167	void private_data; / private data for f_ops->open */
d80f19fa	168	struct device dev; / device for sysfs */
a0830dbd	169	struct snd_card card_ptr; / assigned card instance */
1da177e4 LT	170	};
1da177e4 LT	171
7d2aae1e TI	172	/* return a device pointer linked to each sound device as a parent */
	173	static inline struct device snd_card_get_device_link(struct snd_card card)
	174	{
8bfb181c	175	return card ? &card->card_dev : NULL;
7d2aae1e TI	176	}
7d2aae1e TI	177
1da177e4 LT	178	/* sound.c */
1da177e4 LT	179
f1902860	180	extern int snd_major;
1da177e4	181	extern int snd_ecards_limit;
d80f19fa	182	extern struct class *sound_class;
1da177e4 LT	183
	184	void snd_request_card(int card);
	185
4b440be6 TI	186	void snd_device_initialize(struct device dev, struct snd_card card);
4b440be6 TI	187
40a4b263 TI	188	int 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);
	191	int snd_unregister_device(struct device *dev);
f87135f5	192	void *snd_lookup_minor_data(unsigned int minor, int type);
1da177e4 LT	193
1da177e4 LT	194	#ifdef CONFIG_SND_OSSEMUL
2af677fc	195	int snd_register_oss_device(int type, struct snd_card *card, int dev,
80d7d771	196	const struct file_operations f_ops, void private_data);
512bbd6a	197	int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5	198	void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4 LT	199	#endif
	200
	201	int snd_minor_info_init(void);
1da177e4 LT	202
	203	/* sound_oss.c */
	204
	205	#ifdef CONFIG_SND_OSSEMUL
	206	int snd_minor_info_oss_init(void);
1da177e4	207	#else
ad5fada5	208	static inline int snd_minor_info_oss_init(void) { return 0; }
1da177e4 LT	209	#endif
	210
	211	/* memory.c */
	212
1da177e4 LT	213	int copy_to_user_fromio(void __user dst, const volatile void __iomem src, size_t count);
	214	int copy_from_user_toio(volatile void __iomem dst, const void __user src, size_t count);
	215
	216	/* init.c */
	217
746df948	218	int snd_card_locked(int card);
6d2412b8	219	#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
1da177e4 LT	220	#define SND_MIXER_OSS_NOTIFY_REGISTER 0
	221	#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
	222	#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a	223	extern int (snd_mixer_oss_notify_callback)(struct snd_card card, int cmd);
1da177e4 LT	224	#endif
1da177e4 LT	225
393aa9c1 TI	226	int 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
512bbd6a	230	int snd_card_disconnect(struct snd_card *card);
c44027c8	231	void snd_card_disconnect_sync(struct snd_card *card);
512bbd6a	232	int snd_card_free(struct snd_card *card);
c461482c	233	int snd_card_free_when_closed(struct snd_card *card);
10a8ebbb	234	void snd_card_set_id(struct snd_card card, const char id);
512bbd6a	235	int snd_card_register(struct snd_card *card);
1da177e4	236	int snd_card_info_init(void);
6bbc7fed TI	237	int snd_card_add_dev_attr(struct snd_card *card,
6bbc7fed TI	238	const struct attribute_group *group);
512bbd6a TI	239	int snd_component_add(struct snd_card card, const char component);
	240	int snd_card_file_add(struct snd_card card, struct file file);
	241	int snd_card_file_remove(struct snd_card card, struct file file);
f4fa9689 TI	242
	243	struct 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	*/
	252	static inline void snd_card_unref(struct snd_card *card)
	253	{
	254	put_device(&card->card_dev);
	255	}
1da177e4	256
edab938e	257	#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4 LT	258
	259	/* device.c */
	260
9ce50543	261	int snd_device_new(struct snd_card *card, enum snd_device_type type,
8b575824	262	void device_data, const struct snd_device_ops ops);
512bbd6a TI	263	int snd_device_register(struct snd_card card, void device_data);
512bbd6a TI	264	int snd_device_register_all(struct snd_card *card);
e086e303 TI	265	void snd_device_disconnect(struct snd_card card, void device_data);
e086e303 TI	266	void snd_device_disconnect_all(struct snd_card *card);
72620d60 TI	267	void snd_device_free(struct snd_card card, void device_data);
72620d60 TI	268	void snd_device_free_all(struct snd_card *card);
c208a533	269	int snd_device_get_state(struct snd_card card, void device_data);
1da177e4 LT	270
	271	/* isadma.c */
	272
276bd31c	273	#ifdef CONFIG_ISA_DMA_API
1da177e4 LT	274	#define DMA_MODE_NO_ENABLE 0x0100
	275
	276	void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
	277	void snd_dma_disable(unsigned long dma);
	278	unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
276bd31c	279	#endif
1da177e4 LT	280
1da177e4 LT	281	/* misc.c */
b709e574	282	struct resource;
b1d5776d	283	void release_and_free_resource(struct resource *res);
1da177e4	284
1da177e4 LT	285	/* --- */
1da177e4 LT	286
fae3d88a FW	287	/* sound printk debug levels */
	288	enum {
	289	SND_PR_ALWAYS,
	290	SND_PR_DEBUG,
	291	SND_PR_VERBOSE,
	292	};
	293
36ce99c1	294	#if defined(CONFIG_SND_DEBUG) \|\| defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9	295	__printf(4, 5)
36ce99c1	296	void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9	297	const char *format, ...);
36ce99c1	298	#else
43e575fa TI	299	#define __snd_printk(level, file, line, format, ...) \
43e575fa TI	300	printk(format, ##__VA_ARGS__)
36ce99c1 TI	301	#endif
36ce99c1 TI	302
1da177e4 LT	303	/**
	304	* snd_printk - printk wrapper
	305	* @fmt: format string
	306	*
f66fcedc	307	* Works like printk() but prints the file and the line of the caller
1da177e4 LT	308	* when configured with CONFIG_SND_VERBOSE_PRINTK.
1da177e4 LT	309	*/
43e575fa TI	310	#define snd_printk(fmt, ...) \
43e575fa TI	311	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
1da177e4 LT	312
1da177e4 LT	313	#ifdef CONFIG_SND_DEBUG
1da177e4 LT	314	/**
1da177e4 LT	315	* snd_printd - debug printk
0863afb3	316	* @fmt: format string
1da177e4	317	*
edab938e	318	* Works like snd_printk() for debugging purposes.
1da177e4 LT	319	* Ignored when CONFIG_SND_DEBUG is not set.
1da177e4 LT	320	*/
43e575fa TI	321	#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__)
7c22f1aa	325
f66fcedc TI	326	/**
	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	*/
bdbecf50	332	#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc	333
bcbb1553 TG	334	/**
	335	* Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
	336	*/
	337	#define snd_printd_ratelimit() printk_ratelimit()
	338
f66fcedc TI	339	/**
	340	* snd_BUG_ON - debugging check macro
	341	* @cond: condition to evaluate
	342	*
d5702162 CS	343	* Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
d5702162 CS	344	* otherwise just evaluates the conditional and returns the value.
f66fcedc	345	*/
d5702162	346	#define snd_BUG_ON(cond) WARN_ON((cond))
1da177e4 LT	347
	348	#else /* !CONFIG_SND_DEBUG */
	349
86b27237 TI	350	__printf(1, 2)
	351	static inline void snd_printd(const char *format, ...) {}
	352	__printf(2, 3)
	353	static inline void _snd_printd(int level, const char *format, ...) {}
	354
fcef7836	355	#define snd_BUG() do { } while (0)
d5702162 CS	356
	357	#define snd_BUG_ON(condition) ({ \
	358	int __ret_warn_on = !!(condition); \
	359	unlikely(__ret_warn_on); \
	360	})
1da177e4	361
bcbb1553 TG	362	static inline bool snd_printd_ratelimit(void) { return false; }
bcbb1553 TG	363
1da177e4 LT	364	#endif /* CONFIG_SND_DEBUG */
1da177e4 LT	365
62cf872a	366	#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4 LT	367	/**
	368	* snd_printdd - debug printk
	369	* @format: format string
	370	*
edab938e	371	* Works like snd_printk() for debugging purposes.
62cf872a	372	* Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4	373	*/
43e575fa TI	374	#define snd_printdd(format, ...) \
43e575fa TI	375	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
1da177e4	376	#else
86b27237 TI	377	__printf(1, 2)
86b27237 TI	378	static inline void snd_printdd(const char *format, ...) {}
1da177e4 LT	379	#endif
1da177e4 LT	380
1da177e4	381
1da177e4 LT	382	#define SNDRV_OSS_VERSION ((3<<16)\|(8<<8)\|(1<<4)\|(0)) /* 3.8.1a */
	383
	384	/* for easier backward-porting */
6d2412b8	385	#if IS_ENABLED(CONFIG_GAMEPORT)
1da177e4 LT	386	#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
1da177e4	390
d9ea472c TI	391	/* PCI quirk list helper */
	392	struct snd_pci_quirk {
	393	unsigned short subvendor; /* PCI subvendor ID */
	394	unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a	395	unsigned short subdevice_mask; /* bitmask to match */
d9ea472c	396	int value; /* value */
62cf872a	397	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	398	const char name; / name of the device (optional) */
	399	#endif
	400	};
	401
8bd4bb7a TI	402	#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)
d9ea472c	406	#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a	407	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	408	#define SND_PCI_QUIRK(vend,dev,xname,val) \
d9ea472c TI	409	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a TI	410	#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)}
86b27237	415	#define snd_pci_quirk_name(q) ((q)->name)
d9ea472c TI	416	#else
	417	#define SND_PCI_QUIRK(vend,dev,xname,val) \
	418	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a TI	419	#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)}
86b27237	423	#define snd_pci_quirk_name(q) ""
d9ea472c TI	424	#endif
d9ea472c TI	425
f0a220de	426	#ifdef CONFIG_PCI
d9ea472c TI	427	const struct snd_pci_quirk *
	428	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list);
	429
d1458279 TI	430	const struct snd_pci_quirk *
	431	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	432	const struct snd_pci_quirk *list);
f0a220de DR	433	#else
	434	static inline const struct snd_pci_quirk *
	435	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list)
	436	{
	437	return NULL;
	438	}
	439
	440	static inline const struct snd_pci_quirk *
	441	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	442	const struct snd_pci_quirk *list)
	443	{
	444	return NULL;
	445	}
8422fa11	446	#endif
d9ea472c	447
1da177e4	448	#endif /* __SOUND_CORE_H */