[linux-block.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>
#include <linux/xarray.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 */
	size_t user_ctl_alloc_size;	// current memory allocation by user controls.
	struct list_head controls;	/* all controls for this card */
	struct list_head ctl_files;	/* active control files */
#ifdef CONFIG_SND_CTL_FAST_LOOKUP
	struct xarray ctl_numids;	/* hash table for numids */
	struct xarray ctl_hash;		/* hash table for ctl id matching */
	bool ctl_hash_collision;	/* ctl_hash collision seen? */
#endif

	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? */
	bool managed;			/* managed via devres */
	bool releasing;			/* during card free process */
	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_SND_DEBUG
	struct dentry *debugfs_root;    /* debugfs root for card */
#endif

#ifdef CONFIG_PM
	unsigned int power_state;	/* power state */
	atomic_t power_ref;
	wait_queue_head_t power_sleep;
	wait_queue_head_t power_ref_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 READ_ONCE(card->power_state);
}

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

/**
 * snd_power_ref - Take the reference count for power control
 * @card: sound card object
 *
 * The power_ref reference of the card is used for managing to block
 * the snd_power_sync_ref() operation.  This function increments the reference.
 * The counterpart snd_power_unref() has to be called appropriately later.
 */
static inline void snd_power_ref(struct snd_card *card)
{
	atomic_inc(&card->power_ref);
}

/**
 * snd_power_unref - Release the reference count for power control
 * @card: sound card object
 */
static inline void snd_power_unref(struct snd_card *card)
{
	if (atomic_dec_and_test(&card->power_ref))
		wake_up(&card->power_ref_sleep);
}

/**
 * snd_power_sync_ref - wait until the card power_ref is freed
 * @card: sound card object
 *
 * This function is used to synchronize with the pending power_ref being
 * released.
 */
static inline void snd_power_sync_ref(struct snd_card *card)
{
	wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
}

/* init.c */
int snd_power_wait(struct snd_card *card);
int snd_power_ref_and_wait(struct snd_card *card);

#else /* ! CONFIG_PM */

static inline int snd_power_wait(struct snd_card *card) { return 0; }
static inline void snd_power_ref(struct snd_card *card) {}
static inline void snd_power_unref(struct snd_card *card) {}
static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
static inline void snd_power_sync_ref(struct snd_card *card) {}
#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;
#ifdef CONFIG_SND_DEBUG
extern struct dentry *sound_debugfs_root;
#endif

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_devm_card_new(struct device *parent, int idx, const char *xid,
		      struct module *module, size_t extra_size,
		      struct snd_card **card_ret);

void snd_card_disconnect(struct snd_card *card);
void snd_card_disconnect_sync(struct snd_card *card);
void snd_card_free(struct snd_card *card);
void snd_card_free_when_closed(struct snd_card *card);
int snd_card_free_on_error(struct device *dev, int ret);
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);
int snd_devm_request_dma(struct device *dev, int dma, const char *name);
#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")

/**
 * snd_printd_ratelimit - 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

/* async signal helpers */
struct snd_fasync;

int snd_fasync_helper(int fd, struct file *file, int on,
		      struct snd_fasync **fasyncp);
void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);
void snd_fasync_free(struct snd_fasync *fasync);

#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>
c27e1efb	17	#include <linux/xarray.h>
1da177e4	18
9004acc7 TI	19	/* number of supported soundcards */
9004acc7 TI	20	#ifdef CONFIG_SND_DYNAMIC_MINORS
7bb2491b	21	#define SNDRV_CARDS CONFIG_SND_MAX_CARDS
9004acc7 TI	22	#else
	23	#define SNDRV_CARDS 8 /* don't change - minor numbers */
	24	#endif
	25
	26	#define CONFIG_SND_MAJOR 116 /* standard configuration */
	27
1da177e4	28	/* forward declarations */
1da177e4	29	struct pci_dev;
de477254	30	struct module;
f2464064	31	struct completion;
1da177e4 LT	32
	33	/* device allocation stuff */
	34
289ca025 TI	35	/* type of the object used in snd_device_*()
	36	* this also defines the calling order
	37	*/
9ce50543	38	enum snd_device_type {
289ca025	39	SNDRV_DEV_LOWLEVEL,
289ca025 TI	40	SNDRV_DEV_INFO,
	41	SNDRV_DEV_BUS,
	42	SNDRV_DEV_CODEC,
9ce50543	43	SNDRV_DEV_PCM,
289ca025	44	SNDRV_DEV_COMPRESS,
9ce50543 TI	45	SNDRV_DEV_RAWMIDI,
	46	SNDRV_DEV_TIMER,
	47	SNDRV_DEV_SEQUENCER,
	48	SNDRV_DEV_HWDEP,
9ce50543	49	SNDRV_DEV_JACK,
dc82e524	50	SNDRV_DEV_CONTROL, /* NOTE: this must be the last one */
9ce50543 TI	51	};
	52
	53	enum snd_device_state {
	54	SNDRV_DEV_BUILD,
	55	SNDRV_DEV_REGISTERED,
	56	SNDRV_DEV_DISCONNECTED,
	57	};
	58
512bbd6a TI	59	struct snd_device;
	60
	61	struct snd_device_ops {
	62	int (dev_free)(struct snd_device dev);
	63	int (dev_register)(struct snd_device dev);
	64	int (dev_disconnect)(struct snd_device dev);
512bbd6a TI	65	};
	66
	67	struct snd_device {
1da177e4	68	struct list_head list; /* list of registered devices */
512bbd6a	69	struct snd_card card; / card which holds this device */
9ce50543 TI	70	enum snd_device_state state; /* state of the device */
9ce50543 TI	71	enum snd_device_type type; /* device type */
1da177e4	72	void device_data; / device structure */
8b575824	73	const struct snd_device_ops ops; / operations */
1da177e4 LT	74	};
1da177e4 LT	75
512bbd6a	76	#define snd_device(n) list_entry(n, struct snd_device, list)
1da177e4	77
1da177e4 LT	78	/* main structure for soundcard */
1da177e4 LT	79
512bbd6a	80	struct snd_card {
d5750f67 HK	81	int number; /* number of soundcard (index to
d5750f67 HK	82	snd_cards) */
1da177e4 LT	83
	84	char id[16]; /* id string of this card */
	85	char driver[16]; /* driver name */
	86	char shortname[32]; /* short name of this soundcard */
	87	char longname[80]; /* name of this soundcard */
de65360b	88	char irq_descr[32]; /* Interrupt description */
1da177e4	89	char mixername[80]; /* mixer name */
ff33f230	90	char components[128]; /* card components delimited with
d5750f67	91	space */
1da177e4 LT	92	struct module module; / top-level module */
	93
	94	void private_data; / private data for soundcard */
512bbd6a	95	void (private_free) (struct snd_card card); /* callback for freeing of
d5750f67	96	private data */
1da177e4 LT	97	struct list_head devices; /* devices */
1da177e4 LT	98
0fcd9f4b	99	struct device ctl_dev; /* control device */
1da177e4 LT	100	unsigned int last_numid; /* last used numeric ID */
	101	struct rw_semaphore controls_rwsem; /* controls list lock */
	102	rwlock_t ctl_files_rwlock; /* ctl_files list lock */
	103	int controls_count; /* count of all controls */
66c6d1ef	104	size_t user_ctl_alloc_size; // current memory allocation by user controls.
1da177e4 LT	105	struct list_head controls; /* all controls for this card */
1da177e4 LT	106	struct list_head ctl_files; /* active control files */
c27e1efb TI	107	#ifdef CONFIG_SND_CTL_FAST_LOOKUP
	108	struct xarray ctl_numids; /* hash table for numids */
	109	struct xarray ctl_hash; /* hash table for ctl id matching */
	110	bool ctl_hash_collision; /* ctl_hash collision seen? */
	111	#endif
1da177e4	112
512bbd6a	113	struct snd_info_entry proc_root; / root for soundcard specific files */
1da177e4 LT	114	struct proc_dir_entry proc_root_link; / number link to real id */
1da177e4 LT	115
118dd6bf	116	struct list_head files_list; /* all files associated to this card */
d5750f67 HK	117	struct snd_shutdown_f_ops s_f_ops; / file operations in the shutdown
d5750f67 HK	118	state */
1da177e4 LT	119	spinlock_t files_lock; /* lock the files for this card */
1da177e4 LT	120	int shutdown; /* this card is going down */
f2464064	121	struct completion *release_completion;
7d2aae1e	122	struct device dev; / device assigned to this card */
8bfb181c	123	struct device card_dev; /* cardX object for sysfs */
6bbc7fed	124	const struct attribute_group dev_groups[4]; / assigned sysfs attr */
8bfb181c	125	bool registered; /* card_dev is registered? */
e8ad415b TI	126	bool managed; /* managed via devres */
e8ad415b TI	127	bool releasing; /* during card free process */
fabb26dc	128	int sync_irq; /* assigned irq, used for PCM sync */
c44027c8	129	wait_queue_head_t remove_sleep;
1da177e4	130
d4cfb30f TI	131	size_t total_pcm_alloc_bytes; /* total amount of allocated buffers */
d4cfb30f TI	132	struct mutex memory_mutex; /* protection for the above */
2d670ea2 HW	133	#ifdef CONFIG_SND_DEBUG
	134	struct dentry debugfs_root; / debugfs root for card */
	135	#endif
d4cfb30f	136
1da177e4	137	#ifdef CONFIG_PM
1da177e4	138	unsigned int power_state; /* power state */
e94fdbd7	139	atomic_t power_ref;
1da177e4	140	wait_queue_head_t power_sleep;
e94fdbd7	141	wait_queue_head_t power_ref_sleep;
1da177e4 LT	142	#endif
1da177e4 LT	143
6d2412b8	144	#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
512bbd6a	145	struct snd_mixer_oss *mixer_oss;
1da177e4 LT	146	int mixer_oss_change_count;
	147	#endif
	148	};
	149
8bfb181c TI	150	#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
8bfb181c TI	151
1da177e4	152	#ifdef CONFIG_PM
512bbd6a	153	static inline unsigned int snd_power_get_state(struct snd_card *card)
1da177e4	154	{
533a7ed9	155	return READ_ONCE(card->power_state);
1da177e4 LT	156	}
1da177e4 LT	157
512bbd6a	158	static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
1da177e4	159	{
533a7ed9	160	WRITE_ONCE(card->power_state, state);
1da177e4 LT	161	wake_up(&card->power_sleep);
1da177e4 LT	162	}
d5750f67	163
e94fdbd7 TI	164	/**
	165	* snd_power_ref - Take the reference count for power control
	166	* @card: sound card object
	167	*
	168	* The power_ref reference of the card is used for managing to block
	169	* the snd_power_sync_ref() operation. This function increments the reference.
	170	* The counterpart snd_power_unref() has to be called appropriately later.
	171	*/
	172	static inline void snd_power_ref(struct snd_card *card)
	173	{
	174	atomic_inc(&card->power_ref);
	175	}
	176
	177	/**
	178	* snd_power_unref - Release the reference count for power control
	179	* @card: sound card object
	180	*/
	181	static inline void snd_power_unref(struct snd_card *card)
	182	{
	183	if (atomic_dec_and_test(&card->power_ref))
	184	wake_up(&card->power_ref_sleep);
	185	}
	186
	187	/**
	188	* snd_power_sync_ref - wait until the card power_ref is freed
	189	* @card: sound card object
	190	*
	191	* This function is used to synchronize with the pending power_ref being
	192	* released.
	193	*/
	194	static inline void snd_power_sync_ref(struct snd_card *card)
	195	{
	196	wait_event(card->power_ref_sleep, !atomic_read(&card->power_ref));
	197	}
	198
d5750f67	199	/* init.c */
b6cc78da	200	int snd_power_wait(struct snd_card *card);
e94fdbd7	201	int snd_power_ref_and_wait(struct snd_card *card);
d5750f67	202
1da177e4 LT	203	#else /* ! CONFIG_PM */
1da177e4 LT	204
b6cc78da	205	static inline int snd_power_wait(struct snd_card *card) { return 0; }
e94fdbd7 TI	206	static inline void snd_power_ref(struct snd_card *card) {}
	207	static inline void snd_power_unref(struct snd_card *card) {}
	208	static inline int snd_power_ref_and_wait(struct snd_card *card) { return 0; }
	209	static inline void snd_power_sync_ref(struct snd_card *card) {}
363129ea	210	#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
1da177e4	211	#define snd_power_change_state(card, state) do { (void)(card); } while (0)
1da177e4 LT	212
	213	#endif /* CONFIG_PM */
	214
512bbd6a	215	struct snd_minor {
2af677fc	216	int type; /* SNDRV_DEVICE_TYPE_XXX */
6983b724	217	int card; /* card number */
1da177e4	218	int device; /* device number */
99ac48f5	219	const struct file_operations f_ops; / file operations */
f87135f5	220	void private_data; / private data for f_ops->open */
d80f19fa	221	struct device dev; / device for sysfs */
a0830dbd	222	struct snd_card card_ptr; / assigned card instance */
1da177e4 LT	223	};
1da177e4 LT	224
7d2aae1e TI	225	/* return a device pointer linked to each sound device as a parent */
	226	static inline struct device snd_card_get_device_link(struct snd_card card)
	227	{
8bfb181c	228	return card ? &card->card_dev : NULL;
7d2aae1e TI	229	}
7d2aae1e TI	230
1da177e4 LT	231	/* sound.c */
1da177e4 LT	232
f1902860	233	extern int snd_major;
1da177e4	234	extern int snd_ecards_limit;
d80f19fa	235	extern struct class *sound_class;
2d670ea2 HW	236	#ifdef CONFIG_SND_DEBUG
	237	extern struct dentry *sound_debugfs_root;
	238	#endif
1da177e4 LT	239
	240	void snd_request_card(int card);
	241
4b440be6 TI	242	void snd_device_initialize(struct device dev, struct snd_card card);
4b440be6 TI	243
40a4b263 TI	244	int snd_register_device(int type, struct snd_card *card, int dev,
	245	const struct file_operations *f_ops,
	246	void private_data, struct device device);
	247	int snd_unregister_device(struct device *dev);
f87135f5	248	void *snd_lookup_minor_data(unsigned int minor, int type);
1da177e4 LT	249
1da177e4 LT	250	#ifdef CONFIG_SND_OSSEMUL
2af677fc	251	int snd_register_oss_device(int type, struct snd_card *card, int dev,
80d7d771	252	const struct file_operations f_ops, void private_data);
512bbd6a	253	int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5	254	void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4 LT	255	#endif
	256
	257	int snd_minor_info_init(void);
1da177e4 LT	258
	259	/* sound_oss.c */
	260
	261	#ifdef CONFIG_SND_OSSEMUL
	262	int snd_minor_info_oss_init(void);
1da177e4	263	#else
ad5fada5	264	static inline int snd_minor_info_oss_init(void) { return 0; }
1da177e4 LT	265	#endif
	266
	267	/* memory.c */
	268
1da177e4 LT	269	int copy_to_user_fromio(void __user dst, const volatile void __iomem src, size_t count);
	270	int copy_from_user_toio(volatile void __iomem dst, const void __user src, size_t count);
	271
	272	/* init.c */
	273
746df948	274	int snd_card_locked(int card);
6d2412b8	275	#if IS_ENABLED(CONFIG_SND_MIXER_OSS)
1da177e4 LT	276	#define SND_MIXER_OSS_NOTIFY_REGISTER 0
	277	#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
	278	#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a	279	extern int (snd_mixer_oss_notify_callback)(struct snd_card card, int cmd);
1da177e4 LT	280	#endif
1da177e4 LT	281
393aa9c1 TI	282	int snd_card_new(struct device parent, int idx, const char xid,
	283	struct module *module, int extra_size,
	284	struct snd_card **card_ret);
e8ad415b TI	285	int snd_devm_card_new(struct device parent, int idx, const char xid,
	286	struct module *module, size_t extra_size,
	287	struct snd_card **card_ret);
393aa9c1	288
663f922f	289	void snd_card_disconnect(struct snd_card *card);
c44027c8	290	void snd_card_disconnect_sync(struct snd_card *card);
25a5a77a	291	void snd_card_free(struct snd_card *card);
73c5685c	292	void snd_card_free_when_closed(struct snd_card *card);
fee2b871	293	int snd_card_free_on_error(struct device *dev, int ret);
10a8ebbb	294	void snd_card_set_id(struct snd_card card, const char id);
512bbd6a	295	int snd_card_register(struct snd_card *card);
1da177e4	296	int snd_card_info_init(void);
6bbc7fed TI	297	int snd_card_add_dev_attr(struct snd_card *card,
6bbc7fed TI	298	const struct attribute_group *group);
512bbd6a TI	299	int snd_component_add(struct snd_card card, const char component);
	300	int snd_card_file_add(struct snd_card card, struct file file);
	301	int snd_card_file_remove(struct snd_card card, struct file file);
f4fa9689 TI	302
	303	struct snd_card *snd_card_ref(int card);
	304
	305	/**
	306	* snd_card_unref - Unreference the card object
	307	* @card: the card object to unreference
	308	*
	309	* Call this function for the card object that was obtained via snd_card_ref()
	310	* or snd_lookup_minor_data().
	311	*/
	312	static inline void snd_card_unref(struct snd_card *card)
	313	{
	314	put_device(&card->card_dev);
	315	}
1da177e4	316
edab938e	317	#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4 LT	318
	319	/* device.c */
	320
9ce50543	321	int snd_device_new(struct snd_card *card, enum snd_device_type type,
8b575824	322	void device_data, const struct snd_device_ops ops);
512bbd6a TI	323	int snd_device_register(struct snd_card card, void device_data);
512bbd6a TI	324	int snd_device_register_all(struct snd_card *card);
e086e303 TI	325	void snd_device_disconnect(struct snd_card card, void device_data);
e086e303 TI	326	void snd_device_disconnect_all(struct snd_card *card);
72620d60 TI	327	void snd_device_free(struct snd_card card, void device_data);
72620d60 TI	328	void snd_device_free_all(struct snd_card *card);
c208a533	329	int snd_device_get_state(struct snd_card card, void device_data);
1da177e4 LT	330
	331	/* isadma.c */
	332
276bd31c	333	#ifdef CONFIG_ISA_DMA_API
1da177e4 LT	334	#define DMA_MODE_NO_ENABLE 0x0100
	335
	336	void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
	337	void snd_dma_disable(unsigned long dma);
	338	unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
c2b94954	339	int snd_devm_request_dma(struct device dev, int dma, const char name);
276bd31c	340	#endif
1da177e4 LT	341
1da177e4 LT	342	/* misc.c */
b709e574	343	struct resource;
b1d5776d	344	void release_and_free_resource(struct resource *res);
1da177e4	345
1da177e4 LT	346	/* --- */
1da177e4 LT	347
fae3d88a FW	348	/* sound printk debug levels */
	349	enum {
	350	SND_PR_ALWAYS,
	351	SND_PR_DEBUG,
	352	SND_PR_VERBOSE,
	353	};
	354
36ce99c1	355	#if defined(CONFIG_SND_DEBUG) \|\| defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9	356	__printf(4, 5)
36ce99c1	357	void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9	358	const char *format, ...);
36ce99c1	359	#else
43e575fa TI	360	#define __snd_printk(level, file, line, format, ...) \
43e575fa TI	361	printk(format, ##__VA_ARGS__)
36ce99c1 TI	362	#endif
36ce99c1 TI	363
1da177e4 LT	364	/**
	365	* snd_printk - printk wrapper
	366	* @fmt: format string
	367	*
f66fcedc	368	* Works like printk() but prints the file and the line of the caller
1da177e4 LT	369	* when configured with CONFIG_SND_VERBOSE_PRINTK.
1da177e4 LT	370	*/
43e575fa TI	371	#define snd_printk(fmt, ...) \
43e575fa TI	372	__snd_printk(0, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
1da177e4 LT	373
1da177e4 LT	374	#ifdef CONFIG_SND_DEBUG
1da177e4 LT	375	/**
1da177e4 LT	376	* snd_printd - debug printk
0863afb3	377	* @fmt: format string
1da177e4	378	*
edab938e	379	* Works like snd_printk() for debugging purposes.
1da177e4 LT	380	* Ignored when CONFIG_SND_DEBUG is not set.
1da177e4 LT	381	*/
43e575fa TI	382	#define snd_printd(fmt, ...) \
	383	__snd_printk(1, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
	384	#define _snd_printd(level, fmt, ...) \
	385	__snd_printk(level, __FILE__, __LINE__, fmt, ##__VA_ARGS__)
7c22f1aa	386
f66fcedc TI	387	/**
	388	* snd_BUG - give a BUG warning message and stack trace
	389	*
	390	* Calls WARN() if CONFIG_SND_DEBUG is set.
	391	* Ignored when CONFIG_SND_DEBUG is not set.
	392	*/
bdbecf50	393	#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc	394
bcbb1553	395	/**
f7b6603c MCC	396	* snd_printd_ratelimit - Suppress high rates of output when
f7b6603c MCC	397	* CONFIG_SND_DEBUG is enabled.
bcbb1553 TG	398	*/
	399	#define snd_printd_ratelimit() printk_ratelimit()
	400
f66fcedc TI	401	/**
	402	* snd_BUG_ON - debugging check macro
	403	* @cond: condition to evaluate
	404	*
d5702162 CS	405	* Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
d5702162 CS	406	* otherwise just evaluates the conditional and returns the value.
f66fcedc	407	*/
d5702162	408	#define snd_BUG_ON(cond) WARN_ON((cond))
1da177e4 LT	409
	410	#else /* !CONFIG_SND_DEBUG */
	411
86b27237 TI	412	__printf(1, 2)
	413	static inline void snd_printd(const char *format, ...) {}
	414	__printf(2, 3)
	415	static inline void _snd_printd(int level, const char *format, ...) {}
	416
fcef7836	417	#define snd_BUG() do { } while (0)
d5702162 CS	418
	419	#define snd_BUG_ON(condition) ({ \
	420	int __ret_warn_on = !!(condition); \
	421	unlikely(__ret_warn_on); \
	422	})
1da177e4	423
bcbb1553 TG	424	static inline bool snd_printd_ratelimit(void) { return false; }
bcbb1553 TG	425
1da177e4 LT	426	#endif /* CONFIG_SND_DEBUG */
1da177e4 LT	427
62cf872a	428	#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4 LT	429	/**
	430	* snd_printdd - debug printk
	431	* @format: format string
	432	*
edab938e	433	* Works like snd_printk() for debugging purposes.
62cf872a	434	* Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4	435	*/
43e575fa TI	436	#define snd_printdd(format, ...) \
43e575fa TI	437	__snd_printk(2, __FILE__, __LINE__, format, ##__VA_ARGS__)
1da177e4	438	#else
86b27237 TI	439	__printf(1, 2)
86b27237 TI	440	static inline void snd_printdd(const char *format, ...) {}
1da177e4 LT	441	#endif
1da177e4 LT	442
1da177e4	443
1da177e4 LT	444	#define SNDRV_OSS_VERSION ((3<<16)\|(8<<8)\|(1<<4)\|(0)) /* 3.8.1a */
	445
	446	/* for easier backward-porting */
6d2412b8	447	#if IS_ENABLED(CONFIG_GAMEPORT)
1da177e4 LT	448	#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
	449	#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
	450	#define gameport_get_port_data(gp) (gp)->port_data
	451	#endif
1da177e4	452
d9ea472c TI	453	/* PCI quirk list helper */
	454	struct snd_pci_quirk {
	455	unsigned short subvendor; /* PCI subvendor ID */
	456	unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a	457	unsigned short subdevice_mask; /* bitmask to match */
d9ea472c	458	int value; /* value */
62cf872a	459	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	460	const char name; / name of the device (optional) */
	461	#endif
	462	};
	463
8bd4bb7a TI	464	#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
	465	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
	466	#define _SND_PCI_QUIRK_ID(vend, dev) \
	467	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
d9ea472c	468	#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a	469	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	470	#define SND_PCI_QUIRK(vend,dev,xname,val) \
d9ea472c TI	471	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a TI	472	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	473	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
	474	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	475	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
	476	.value = (val), .name = (xname)}
86b27237	477	#define snd_pci_quirk_name(q) ((q)->name)
d9ea472c TI	478	#else
	479	#define SND_PCI_QUIRK(vend,dev,xname,val) \
	480	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a TI	481	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	482	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
	483	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	484	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
86b27237	485	#define snd_pci_quirk_name(q) ""
d9ea472c TI	486	#endif
d9ea472c TI	487
f0a220de	488	#ifdef CONFIG_PCI
d9ea472c TI	489	const struct snd_pci_quirk *
	490	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list);
	491
d1458279 TI	492	const struct snd_pci_quirk *
	493	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	494	const struct snd_pci_quirk *list);
f0a220de DR	495	#else
	496	static inline const struct snd_pci_quirk *
	497	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list)
	498	{
	499	return NULL;
	500	}
	501
	502	static inline const struct snd_pci_quirk *
	503	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	504	const struct snd_pci_quirk *list)
	505	{
	506	return NULL;
	507	}
8422fa11	508	#endif
d9ea472c	509
ef34a0ae TI	510	/* async signal helpers */
	511	struct snd_fasync;
	512
	513	int snd_fasync_helper(int fd, struct file *file, int on,
	514	struct snd_fasync **fasyncp);
	515	void snd_kill_fasync(struct snd_fasync *fasync, int signal, int poll);
	516	void snd_fasync_free(struct snd_fasync *fasync);
	517
1da177e4	518	#endif /* __SOUND_CORE_H */