[deliverable/linux.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 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 */

	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 */
	bool registered;		/* card_dev is registered? */

#ifdef CONFIG_PM
	unsigned int power_state;	/* power state */
	struct mutex power_lock;	/* power lock */
	wait_queue_head_t power_sleep;
#endif

#if defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
	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 void snd_power_lock(struct snd_card *card)
{
	mutex_lock(&card->power_lock);
}

static inline void snd_power_unlock(struct snd_card *card)
{
	mutex_unlock(&card->power_lock);
}

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

#define snd_power_lock(card)		do { (void)(card); } while (0)
#define snd_power_unlock(card)		do { (void)(card); } while (0)
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);

int snd_register_device_for_dev(int type, struct snd_card *card,
				int dev,
				const struct file_operations *f_ops,
				void *private_data,
				const char *name,
				struct device *device);

/**
 * snd_register_device - Register the ALSA device file for the card
 * @type: the device type, SNDRV_DEVICE_TYPE_XXX
 * @card: the card instance
 * @dev: the device index
 * @f_ops: the file operations
 * @private_data: user pointer for f_ops->open()
 * @name: the device file name
 *
 * Registers an ALSA device file for the given card.
 * The operators have to be set in reg parameter.
 *
 * This function uses the card's device pointer to link to the
 * correct &struct device.
 *
 * Return: Zero if successful, or a negative error code on failure.
 */
static inline int snd_register_device(int type, struct snd_card *card, int dev,
				      const struct file_operations *f_ops,
				      void *private_data,
				      const char *name)
{
	return snd_register_device_for_dev(type, card, dev, f_ops,
					   private_data, name,
					   snd_card_get_device_link(card));
}

int snd_unregister_device(int type, struct snd_card *card, int dev);
void *snd_lookup_minor_data(unsigned int minor, int type);
struct device *snd_get_device(int type, struct snd_card *card, int dev);

#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);
int snd_minor_info_done(void);

/* sound_oss.c */

#ifdef CONFIG_SND_OSSEMUL
int snd_minor_info_oss_init(void);
int snd_minor_info_oss_done(void);
#else
static inline int snd_minor_info_oss_init(void) { return 0; }
static inline int snd_minor_info_oss_done(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 defined(CONFIG_SND_MIXER_OSS) || defined(CONFIG_SND_MIXER_OSS_MODULE)
#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);

static inline int __deprecated
snd_card_create(int idx, const char *id, struct module *module, int extra_size,
		struct snd_card **ret)
{
	return snd_card_new(NULL, idx, id, module, extra_size, ret);
}

int snd_card_disconnect(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_info_done(void);
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);
int 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, args...) \
	printk(format, ##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, args...) \
	__snd_printk(0, __FILE__, __LINE__, fmt, ##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, args...) \
	__snd_printk(1, __FILE__, __LINE__, fmt, ##args)
#define _snd_printd(level, fmt, args...) \
	__snd_printk(level, __FILE__, __LINE__, fmt, ##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, args...) \
	__snd_printk(2, __FILE__, __LINE__, format, ##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 defined(CONFIG_GAMEPORT) || defined(CONFIG_GAMEPORT_MODULE)
#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 */
	102	char mixername[80]; /* mixer name */
ff33f230	103	char components[128]; /* card components delimited with
d5750f67	104	space */
1da177e4 LT	105	struct module module; / top-level module */
	106
	107	void private_data; / private data for soundcard */
512bbd6a	108	void (private_free) (struct snd_card card); /* callback for freeing of
d5750f67	109	private data */
1da177e4 LT	110	struct list_head devices; /* devices */
	111
	112	unsigned int last_numid; /* last used numeric ID */
	113	struct rw_semaphore controls_rwsem; /* controls list lock */
	114	rwlock_t ctl_files_rwlock; /* ctl_files list lock */
	115	int controls_count; /* count of all controls */
	116	int user_ctl_count; /* count of all user controls */
	117	struct list_head controls; /* all controls for this card */
	118	struct list_head ctl_files; /* active control files */
	119
512bbd6a TI	120	struct snd_info_entry proc_root; / root for soundcard specific files */
512bbd6a TI	121	struct snd_info_entry proc_id; / the card id */
1da177e4 LT	122	struct proc_dir_entry proc_root_link; / number link to real id */
1da177e4 LT	123
118dd6bf	124	struct list_head files_list; /* all files associated to this card */
d5750f67 HK	125	struct snd_shutdown_f_ops s_f_ops; / file operations in the shutdown
d5750f67 HK	126	state */
1da177e4 LT	127	spinlock_t files_lock; /* lock the files for this card */
1da177e4 LT	128	int shutdown; /* this card is going down */
f2464064	129	struct completion *release_completion;
7d2aae1e	130	struct device dev; / device assigned to this card */
8bfb181c TI	131	struct device card_dev; /* cardX object for sysfs */
8bfb181c TI	132	bool registered; /* card_dev is registered? */
1da177e4 LT	133
1da177e4 LT	134	#ifdef CONFIG_PM
1da177e4	135	unsigned int power_state; /* power state */
1a60d4c5	136	struct mutex power_lock; /* power lock */
1da177e4	137	wait_queue_head_t power_sleep;
1da177e4 LT	138	#endif
	139
	140	#if defined(CONFIG_SND_MIXER_OSS) \|\| defined(CONFIG_SND_MIXER_OSS_MODULE)
512bbd6a	141	struct snd_mixer_oss *mixer_oss;
1da177e4 LT	142	int mixer_oss_change_count;
	143	#endif
	144	};
	145
8bfb181c TI	146	#define dev_to_snd_card(p) container_of(p, struct snd_card, card_dev)
8bfb181c TI	147
1da177e4	148	#ifdef CONFIG_PM
512bbd6a	149	static inline void snd_power_lock(struct snd_card *card)
1da177e4	150	{
1a60d4c5	151	mutex_lock(&card->power_lock);
1da177e4 LT	152	}
1da177e4 LT	153
512bbd6a	154	static inline void snd_power_unlock(struct snd_card *card)
1da177e4	155	{
1a60d4c5	156	mutex_unlock(&card->power_lock);
1da177e4 LT	157	}
1da177e4 LT	158
512bbd6a	159	static inline unsigned int snd_power_get_state(struct snd_card *card)
1da177e4 LT	160	{
	161	return card->power_state;
	162	}
	163
512bbd6a	164	static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
1da177e4 LT	165	{
	166	card->power_state = state;
	167	wake_up(&card->power_sleep);
	168	}
d5750f67 HK	169
d5750f67 HK	170	/* init.c */
cbac4b0c	171	int snd_power_wait(struct snd_card *card, unsigned int power_state);
d5750f67	172
1da177e4 LT	173	#else /* ! CONFIG_PM */
	174
	175	#define snd_power_lock(card) do { (void)(card); } while (0)
	176	#define snd_power_unlock(card) do { (void)(card); } while (0)
6fdb94bd	177	static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
363129ea	178	#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
1da177e4	179	#define snd_power_change_state(card, state) do { (void)(card); } while (0)
1da177e4 LT	180
	181	#endif /* CONFIG_PM */
	182
512bbd6a	183	struct snd_minor {
2af677fc	184	int type; /* SNDRV_DEVICE_TYPE_XXX */
6983b724	185	int card; /* card number */
1da177e4	186	int device; /* device number */
99ac48f5	187	const struct file_operations f_ops; / file operations */
f87135f5	188	void private_data; / private data for f_ops->open */
d80f19fa	189	struct device dev; / device for sysfs */
a0830dbd	190	struct snd_card card_ptr; / assigned card instance */
1da177e4 LT	191	};
1da177e4 LT	192
7d2aae1e TI	193	/* return a device pointer linked to each sound device as a parent */
	194	static inline struct device snd_card_get_device_link(struct snd_card card)
	195	{
8bfb181c	196	return card ? &card->card_dev : NULL;
7d2aae1e TI	197	}
7d2aae1e TI	198
1da177e4 LT	199	/* sound.c */
1da177e4 LT	200
f1902860	201	extern int snd_major;
1da177e4	202	extern int snd_ecards_limit;
d80f19fa	203	extern struct class *sound_class;
1da177e4 LT	204
	205	void snd_request_card(int card);
	206
12b131c4 JB	207	int snd_register_device_for_dev(int type, struct snd_card *card,
	208	int dev,
	209	const struct file_operations *f_ops,
	210	void *private_data,
	211	const char *name,
	212	struct device *device);
	213
	214	/**
	215	* snd_register_device - Register the ALSA device file for the card
	216	* @type: the device type, SNDRV_DEVICE_TYPE_XXX
	217	* @card: the card instance
	218	* @dev: the device index
	219	* @f_ops: the file operations
	220	* @private_data: user pointer for f_ops->open()
	221	* @name: the device file name
	222	*
	223	* Registers an ALSA device file for the given card.
	224	* The operators have to be set in reg parameter.
	225	*
	226	* This function uses the card's device pointer to link to the
	227	* correct &struct device.
	228	*
eb7c06e8	229	* Return: Zero if successful, or a negative error code on failure.
12b131c4 JB	230	*/
	231	static inline int snd_register_device(int type, struct snd_card *card, int dev,
	232	const struct file_operations *f_ops,
	233	void *private_data,
	234	const char *name)
	235	{
	236	return snd_register_device_for_dev(type, card, dev, f_ops,
	237	private_data, name,
c2902c8a	238	snd_card_get_device_link(card));
12b131c4 JB	239	}
12b131c4 JB	240
512bbd6a	241	int snd_unregister_device(int type, struct snd_card *card, int dev);
f87135f5	242	void *snd_lookup_minor_data(unsigned int minor, int type);
caa751ba	243	struct device snd_get_device(int type, struct snd_card card, int dev);
1da177e4 LT	244
1da177e4 LT	245	#ifdef CONFIG_SND_OSSEMUL
2af677fc	246	int snd_register_oss_device(int type, struct snd_card *card, int dev,
80d7d771	247	const struct file_operations f_ops, void private_data);
512bbd6a	248	int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5	249	void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4 LT	250	#endif
	251
	252	int snd_minor_info_init(void);
	253	int snd_minor_info_done(void);
	254
	255	/* sound_oss.c */
	256
	257	#ifdef CONFIG_SND_OSSEMUL
	258	int snd_minor_info_oss_init(void);
	259	int snd_minor_info_oss_done(void);
1da177e4	260	#else
ad5fada5 PM	261	static inline int snd_minor_info_oss_init(void) { return 0; }
ad5fada5 PM	262	static inline int snd_minor_info_oss_done(void) { return 0; }
1da177e4 LT	263	#endif
	264
	265	/* memory.c */
	266
1da177e4 LT	267	int copy_to_user_fromio(void __user dst, const volatile void __iomem src, size_t count);
	268	int copy_from_user_toio(volatile void __iomem dst, const void __user src, size_t count);
	269
	270	/* init.c */
	271
512bbd6a	272	extern struct snd_card *snd_cards[SNDRV_CARDS];
746df948	273	int snd_card_locked(int card);
1da177e4 LT	274	#if defined(CONFIG_SND_MIXER_OSS) \|\| defined(CONFIG_SND_MIXER_OSS_MODULE)
	275	#define SND_MIXER_OSS_NOTIFY_REGISTER 0
	276	#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
	277	#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a	278	extern int (snd_mixer_oss_notify_callback)(struct snd_card card, int cmd);
1da177e4 LT	279	#endif
1da177e4 LT	280
393aa9c1 TI	281	int snd_card_new(struct device parent, int idx, const char xid,
	282	struct module *module, int extra_size,
	283	struct snd_card **card_ret);
	284
	285	static inline int __deprecated
	286	snd_card_create(int idx, const char id, struct module module, int extra_size,
	287	struct snd_card **ret)
	288	{
	289	return snd_card_new(NULL, idx, id, module, extra_size, ret);
	290	}
53fb1e63	291
512bbd6a TI	292	int snd_card_disconnect(struct snd_card *card);
512bbd6a TI	293	int snd_card_free(struct snd_card *card);
c461482c	294	int snd_card_free_when_closed(struct snd_card *card);
10a8ebbb	295	void snd_card_set_id(struct snd_card card, const char id);
512bbd6a	296	int snd_card_register(struct snd_card *card);
1da177e4 LT	297	int snd_card_info_init(void);
1da177e4 LT	298	int snd_card_info_done(void);
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);
f2464064	302	#define snd_card_unref(card) put_device(&(card)->card_dev)
1da177e4	303
edab938e	304	#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4 LT	305
	306	/* device.c */
	307
9ce50543	308	int snd_device_new(struct snd_card *card, enum snd_device_type type,
512bbd6a TI	309	void device_data, struct snd_device_ops ops);
	310	int snd_device_register(struct snd_card card, void device_data);
	311	int snd_device_register_all(struct snd_card *card);
512bbd6a	312	int snd_device_disconnect_all(struct snd_card *card);
72620d60 TI	313	void snd_device_free(struct snd_card card, void device_data);
72620d60 TI	314	void snd_device_free_all(struct snd_card *card);
1da177e4 LT	315
	316	/* isadma.c */
	317
276bd31c	318	#ifdef CONFIG_ISA_DMA_API
1da177e4 LT	319	#define DMA_MODE_NO_ENABLE 0x0100
	320
	321	void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
	322	void snd_dma_disable(unsigned long dma);
	323	unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
276bd31c	324	#endif
1da177e4 LT	325
1da177e4 LT	326	/* misc.c */
b709e574	327	struct resource;
b1d5776d	328	void release_and_free_resource(struct resource *res);
1da177e4	329
1da177e4 LT	330	/* --- */
1da177e4 LT	331
fae3d88a FW	332	/* sound printk debug levels */
	333	enum {
	334	SND_PR_ALWAYS,
	335	SND_PR_DEBUG,
	336	SND_PR_VERBOSE,
	337	};
	338
36ce99c1	339	#if defined(CONFIG_SND_DEBUG) \|\| defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9	340	__printf(4, 5)
36ce99c1	341	void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9	342	const char *format, ...);
36ce99c1 TI	343	#else
36ce99c1 TI	344	#define __snd_printk(level, file, line, format, args...) \
cf0baf16	345	printk(format, ##args)
36ce99c1 TI	346	#endif
36ce99c1 TI	347
1da177e4 LT	348	/**
	349	* snd_printk - printk wrapper
	350	* @fmt: format string
	351	*
f66fcedc	352	* Works like printk() but prints the file and the line of the caller
1da177e4 LT	353	* when configured with CONFIG_SND_VERBOSE_PRINTK.
	354	*/
	355	#define snd_printk(fmt, args...) \
36ce99c1	356	__snd_printk(0, __FILE__, __LINE__, fmt, ##args)
1da177e4 LT	357
1da177e4 LT	358	#ifdef CONFIG_SND_DEBUG
1da177e4 LT	359	/**
1da177e4 LT	360	* snd_printd - debug printk
0863afb3	361	* @fmt: format string
1da177e4	362	*
edab938e	363	* Works like snd_printk() for debugging purposes.
1da177e4 LT	364	* Ignored when CONFIG_SND_DEBUG is not set.
	365	*/
	366	#define snd_printd(fmt, args...) \
36ce99c1	367	__snd_printk(1, __FILE__, __LINE__, fmt, ##args)
fae3d88a FW	368	#define _snd_printd(level, fmt, args...) \
fae3d88a FW	369	__snd_printk(level, __FILE__, __LINE__, fmt, ##args)
7c22f1aa	370
f66fcedc TI	371	/**
	372	* snd_BUG - give a BUG warning message and stack trace
	373	*
	374	* Calls WARN() if CONFIG_SND_DEBUG is set.
	375	* Ignored when CONFIG_SND_DEBUG is not set.
	376	*/
bdbecf50	377	#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc	378
bcbb1553 TG	379	/**
	380	* Suppress high rates of output when CONFIG_SND_DEBUG is enabled.
	381	*/
	382	#define snd_printd_ratelimit() printk_ratelimit()
	383
f66fcedc TI	384	/**
	385	* snd_BUG_ON - debugging check macro
	386	* @cond: condition to evaluate
	387	*
d5702162 CS	388	* Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
d5702162 CS	389	* otherwise just evaluates the conditional and returns the value.
f66fcedc	390	*/
d5702162	391	#define snd_BUG_ON(cond) WARN_ON((cond))
1da177e4 LT	392
	393	#else /* !CONFIG_SND_DEBUG */
	394
86b27237 TI	395	__printf(1, 2)
	396	static inline void snd_printd(const char *format, ...) {}
	397	__printf(2, 3)
	398	static inline void _snd_printd(int level, const char *format, ...) {}
	399
fcef7836	400	#define snd_BUG() do { } while (0)
d5702162 CS	401
	402	#define snd_BUG_ON(condition) ({ \
	403	int __ret_warn_on = !!(condition); \
	404	unlikely(__ret_warn_on); \
	405	})
1da177e4	406
bcbb1553 TG	407	static inline bool snd_printd_ratelimit(void) { return false; }
bcbb1553 TG	408
1da177e4 LT	409	#endif /* CONFIG_SND_DEBUG */
1da177e4 LT	410
62cf872a	411	#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4 LT	412	/**
	413	* snd_printdd - debug printk
	414	* @format: format string
	415	*
edab938e	416	* Works like snd_printk() for debugging purposes.
62cf872a	417	* Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4	418	*/
36ce99c1 TI	419	#define snd_printdd(format, args...) \
36ce99c1 TI	420	__snd_printk(2, __FILE__, __LINE__, format, ##args)
1da177e4	421	#else
86b27237 TI	422	__printf(1, 2)
86b27237 TI	423	static inline void snd_printdd(const char *format, ...) {}
1da177e4 LT	424	#endif
1da177e4 LT	425
1da177e4	426
1da177e4 LT	427	#define SNDRV_OSS_VERSION ((3<<16)\|(8<<8)\|(1<<4)\|(0)) /* 3.8.1a */
	428
	429	/* for easier backward-porting */
	430	#if defined(CONFIG_GAMEPORT) \|\| defined(CONFIG_GAMEPORT_MODULE)
1da177e4 LT	431	#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
	432	#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
	433	#define gameport_get_port_data(gp) (gp)->port_data
	434	#endif
1da177e4	435
d9ea472c TI	436	/* PCI quirk list helper */
	437	struct snd_pci_quirk {
	438	unsigned short subvendor; /* PCI subvendor ID */
	439	unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a	440	unsigned short subdevice_mask; /* bitmask to match */
d9ea472c	441	int value; /* value */
62cf872a	442	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	443	const char name; / name of the device (optional) */
	444	#endif
	445	};
	446
8bd4bb7a TI	447	#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
	448	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
	449	#define _SND_PCI_QUIRK_ID(vend, dev) \
	450	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
d9ea472c	451	#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a	452	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	453	#define SND_PCI_QUIRK(vend,dev,xname,val) \
d9ea472c TI	454	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a TI	455	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	456	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
	457	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	458	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
	459	.value = (val), .name = (xname)}
86b27237	460	#define snd_pci_quirk_name(q) ((q)->name)
d9ea472c TI	461	#else
	462	#define SND_PCI_QUIRK(vend,dev,xname,val) \
	463	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a TI	464	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	465	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
	466	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	467	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
86b27237	468	#define snd_pci_quirk_name(q) ""
d9ea472c TI	469	#endif
d9ea472c TI	470
f0a220de	471	#ifdef CONFIG_PCI
d9ea472c TI	472	const struct snd_pci_quirk *
	473	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list);
	474
d1458279 TI	475	const struct snd_pci_quirk *
	476	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	477	const struct snd_pci_quirk *list);
f0a220de DR	478	#else
	479	static inline const struct snd_pci_quirk *
	480	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list)
	481	{
	482	return NULL;
	483	}
	484
	485	static inline const struct snd_pci_quirk *
	486	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	487	const struct snd_pci_quirk *list)
	488	{
	489	return NULL;
	490	}
8422fa11	491	#endif
d9ea472c	492
1da177e4	493	#endif /* __SOUND_CORE_H */