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

#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>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#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_CONTROL,
	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,
};

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 */
	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 snd_info_entry *proc_id;	/* the card id */
	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? */
	wait_queue_head_t remove_sleep;

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

extern struct snd_card *snd_cards[SNDRV_CARDS];
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);
#define snd_card_unref(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, 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);

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