[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/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/device.h>
#include <linux/stringify.h>

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

#define CONFIG_SND_MAJOR	116	/* standard configuration */

/* forward declarations */
#ifdef CONFIG_PCI
struct pci_dev;
#endif
struct module;

/* device allocation stuff */

#define SNDRV_DEV_TYPE_RANGE_SIZE		0x1000

typedef int __bitwise snd_device_type_t;
#define	SNDRV_DEV_TOPLEVEL	((__force snd_device_type_t) 0)
#define	SNDRV_DEV_CONTROL	((__force snd_device_type_t) 1)
#define	SNDRV_DEV_LOWLEVEL_PRE	((__force snd_device_type_t) 2)
#define	SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
#define	SNDRV_DEV_PCM		((__force snd_device_type_t) 0x1001)
#define	SNDRV_DEV_RAWMIDI	((__force snd_device_type_t) 0x1002)
#define	SNDRV_DEV_TIMER		((__force snd_device_type_t) 0x1003)
#define	SNDRV_DEV_SEQUENCER	((__force snd_device_type_t) 0x1004)
#define	SNDRV_DEV_HWDEP		((__force snd_device_type_t) 0x1005)
#define	SNDRV_DEV_INFO		((__force snd_device_type_t) 0x1006)
#define	SNDRV_DEV_BUS		((__force snd_device_type_t) 0x1007)
#define	SNDRV_DEV_CODEC		((__force snd_device_type_t) 0x1008)
#define	SNDRV_DEV_JACK          ((__force snd_device_type_t) 0x1009)
#define	SNDRV_DEV_COMPRESS	((__force snd_device_type_t) 0x100A)
#define	SNDRV_DEV_LOWLEVEL	((__force snd_device_type_t) 0x2000)

typedef int __bitwise snd_device_state_t;
#define	SNDRV_DEV_BUILD		((__force snd_device_state_t) 0)
#define	SNDRV_DEV_REGISTERED	((__force snd_device_state_t) 1)
#define	SNDRV_DEV_DISCONNECTED	((__force snd_device_state_t) 2)

typedef int __bitwise snd_device_cmd_t;
#define	SNDRV_DEV_CMD_PRE	((__force snd_device_cmd_t) 0)
#define	SNDRV_DEV_CMD_NORMAL	((__force snd_device_cmd_t) 1)	
#define	SNDRV_DEV_CMD_POST	((__force snd_device_cmd_t) 2)

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 */
	snd_device_state_t state;	/* state of the device */
	snd_device_type_t 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 */
	int free_on_last_close;		/* free in context of file_release */
	wait_queue_head_t shutdown_sleep;
	struct device *dev;		/* device assigned to this card */
	struct device *card_dev;	/* cardX object for sysfs */

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

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

/* 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.
 *
 * Returns 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);
int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
			      struct device_attribute *attr);

#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,
			    const char *name);
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_create(int idx, const char *id,
		    struct module *module, int extra_size,
		    struct snd_card **card_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_set_dev(card, devptr) ((card)->dev = (devptr))

/* device.c */

int snd_device_new(struct snd_card *card, snd_device_type_t 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(struct snd_card *card, void *device_data);
int snd_device_disconnect_all(struct snd_card *card);
int snd_device_free(struct snd_card *card, void *device_data);
int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);

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

/* --- */

#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)

/**
 * 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_BUG_ON - debugging check macro
 * @cond: condition to evaluate
 *
 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
 * and call WARN() and returns the value if it's non-zero.
 * 
 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
 * condition is ignored.
 *
 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
 * Thus, don't put any statement that influences on the code behavior,
 * such as pre/post increment, to the argument of this macro.
 * If you want to evaluate and give a warning, use standard WARN_ON().
 */
#define snd_BUG_ON(cond)	WARN((cond), "BUG? (%s)\n", __stringify(cond))

#else /* !CONFIG_SND_DEBUG */

#define snd_printd(fmt, args...)	do { } while (0)
#define snd_BUG()			do { } while (0)
static inline int __snd_bug_on(int cond)
{
	return 0;
}
#define snd_BUG_ON(cond)	__snd_bug_on(0 && (cond))  /* always 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
#define snd_printdd(format, args...)	do { } while (0)
#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)}
#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)}
#endif

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);

#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
	25	#include <linux/sched.h> /* wake_up() */
1a60d4c5	26	#include <linux/mutex.h> /* struct mutex */
1da177e4	27	#include <linux/rwsem.h> /* struct rw_semaphore */
1da177e4	28	#include <linux/pm.h> /* pm_message_t */
9d19f48c	29	#include <linux/device.h>
5ef03460	30	#include <linux/stringify.h>
1da177e4	31
9004acc7 TI	32	/* number of supported soundcards */
	33	#ifdef CONFIG_SND_DYNAMIC_MINORS
	34	#define SNDRV_CARDS 32
	35	#else
	36	#define SNDRV_CARDS 8 /* don't change - minor numbers */
	37	#endif
	38
	39	#define CONFIG_SND_MAJOR 116 /* standard configuration */
	40
1da177e4 LT	41	/* forward declarations */
	42	#ifdef CONFIG_PCI
	43	struct pci_dev;
	44	#endif
de477254	45	struct module;
1da177e4 LT	46
	47	/* device allocation stuff */
	48
	49	#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
	50
512bbd6a TI	51	typedef int __bitwise snd_device_type_t;
	52	#define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
	53	#define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
	54	#define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
	55	#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
	56	#define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
	57	#define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
	58	#define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
	59	#define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
	60	#define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
	61	#define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
	62	#define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
	63	#define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
e76d8cea	64	#define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
3eafc959	65	#define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
512bbd6a TI	66	#define SNDRV_DEV_LOWLEVEL ((__force snd_device_type_t) 0x2000)
	67
	68	typedef int __bitwise snd_device_state_t;
	69	#define SNDRV_DEV_BUILD ((__force snd_device_state_t) 0)
	70	#define SNDRV_DEV_REGISTERED ((__force snd_device_state_t) 1)
	71	#define SNDRV_DEV_DISCONNECTED ((__force snd_device_state_t) 2)
	72
	73	typedef int __bitwise snd_device_cmd_t;
	74	#define SNDRV_DEV_CMD_PRE ((__force snd_device_cmd_t) 0)
	75	#define SNDRV_DEV_CMD_NORMAL ((__force snd_device_cmd_t) 1)
	76	#define SNDRV_DEV_CMD_POST ((__force snd_device_cmd_t) 2)
	77
	78	struct snd_device;
	79
	80	struct snd_device_ops {
	81	int (dev_free)(struct snd_device dev);
	82	int (dev_register)(struct snd_device dev);
	83	int (dev_disconnect)(struct snd_device dev);
512bbd6a TI	84	};
	85
	86	struct snd_device {
1da177e4	87	struct list_head list; /* list of registered devices */
512bbd6a	88	struct snd_card card; / card which holds this device */
1da177e4 LT	89	snd_device_state_t state; /* state of the device */
	90	snd_device_type_t type; /* device type */
	91	void device_data; / device structure */
512bbd6a	92	struct snd_device_ops ops; / operations */
1da177e4 LT	93	};
1da177e4 LT	94
512bbd6a	95	#define snd_device(n) list_entry(n, struct snd_device, list)
1da177e4	96
1da177e4 LT	97	/* main structure for soundcard */
1da177e4 LT	98
512bbd6a	99	struct snd_card {
d5750f67 HK	100	int number; /* number of soundcard (index to
d5750f67 HK	101	snd_cards) */
1da177e4 LT	102
	103	char id[16]; /* id string of this card */
	104	char driver[16]; /* driver name */
	105	char shortname[32]; /* short name of this soundcard */
	106	char longname[80]; /* name of this soundcard */
	107	char mixername[80]; /* mixer name */
ff33f230	108	char components[128]; /* card components delimited with
d5750f67	109	space */
1da177e4 LT	110	struct module module; / top-level module */
	111
	112	void private_data; / private data for soundcard */
512bbd6a	113	void (private_free) (struct snd_card card); /* callback for freeing of
d5750f67	114	private data */
1da177e4 LT	115	struct list_head devices; /* devices */
	116
	117	unsigned int last_numid; /* last used numeric ID */
	118	struct rw_semaphore controls_rwsem; /* controls list lock */
	119	rwlock_t ctl_files_rwlock; /* ctl_files list lock */
	120	int controls_count; /* count of all controls */
	121	int user_ctl_count; /* count of all user controls */
	122	struct list_head controls; /* all controls for this card */
	123	struct list_head ctl_files; /* active control files */
	124
512bbd6a TI	125	struct snd_info_entry proc_root; / root for soundcard specific files */
512bbd6a TI	126	struct snd_info_entry proc_id; / the card id */
1da177e4 LT	127	struct proc_dir_entry proc_root_link; / number link to real id */
1da177e4 LT	128
118dd6bf	129	struct list_head files_list; /* all files associated to this card */
d5750f67 HK	130	struct snd_shutdown_f_ops s_f_ops; / file operations in the shutdown
d5750f67 HK	131	state */
1da177e4 LT	132	spinlock_t files_lock; /* lock the files for this card */
1da177e4 LT	133	int shutdown; /* this card is going down */
c461482c	134	int free_on_last_close; /* free in context of file_release */
1da177e4	135	wait_queue_head_t shutdown_sleep;
7d2aae1e	136	struct device dev; / device assigned to this card */
7d2aae1e	137	struct device card_dev; / cardX object for sysfs */
1da177e4 LT	138
1da177e4 LT	139	#ifdef CONFIG_PM
1da177e4	140	unsigned int power_state; /* power state */
1a60d4c5	141	struct mutex power_lock; /* power lock */
1da177e4	142	wait_queue_head_t power_sleep;
1da177e4 LT	143	#endif
	144
	145	#if defined(CONFIG_SND_MIXER_OSS) \|\| defined(CONFIG_SND_MIXER_OSS_MODULE)
512bbd6a	146	struct snd_mixer_oss *mixer_oss;
1da177e4 LT	147	int mixer_oss_change_count;
	148	#endif
	149	};
	150
	151	#ifdef CONFIG_PM
512bbd6a	152	static inline void snd_power_lock(struct snd_card *card)
1da177e4	153	{
1a60d4c5	154	mutex_lock(&card->power_lock);
1da177e4 LT	155	}
1da177e4 LT	156
512bbd6a	157	static inline void snd_power_unlock(struct snd_card *card)
1da177e4	158	{
1a60d4c5	159	mutex_unlock(&card->power_lock);
1da177e4 LT	160	}
1da177e4 LT	161
512bbd6a	162	static inline unsigned int snd_power_get_state(struct snd_card *card)
1da177e4 LT	163	{
	164	return card->power_state;
	165	}
	166
512bbd6a	167	static inline void snd_power_change_state(struct snd_card *card, unsigned int state)
1da177e4 LT	168	{
	169	card->power_state = state;
	170	wake_up(&card->power_sleep);
	171	}
d5750f67 HK	172
d5750f67 HK	173	/* init.c */
cbac4b0c	174	int snd_power_wait(struct snd_card *card, unsigned int power_state);
d5750f67	175
1da177e4 LT	176	#else /* ! CONFIG_PM */
	177
	178	#define snd_power_lock(card) do { (void)(card); } while (0)
	179	#define snd_power_unlock(card) do { (void)(card); } while (0)
6fdb94bd	180	static inline int snd_power_wait(struct snd_card *card, unsigned int state) { return 0; }
363129ea	181	#define snd_power_get_state(card) ({ (void)(card); SNDRV_CTL_POWER_D0; })
1da177e4	182	#define snd_power_change_state(card, state) do { (void)(card); } while (0)
1da177e4 LT	183
	184	#endif /* CONFIG_PM */
	185
512bbd6a	186	struct snd_minor {
2af677fc	187	int type; /* SNDRV_DEVICE_TYPE_XXX */
6983b724	188	int card; /* card number */
1da177e4	189	int device; /* device number */
99ac48f5	190	const struct file_operations f_ops; / file operations */
f87135f5	191	void private_data; / private data for f_ops->open */
d80f19fa	192	struct device dev; / device for sysfs */
1da177e4 LT	193	};
1da177e4 LT	194
7d2aae1e TI	195	/* return a device pointer linked to each sound device as a parent */
	196	static inline struct device snd_card_get_device_link(struct snd_card card)
	197	{
7d2aae1e	198	return card ? card->card_dev : NULL;
7d2aae1e TI	199	}
7d2aae1e TI	200
1da177e4 LT	201	/* sound.c */
1da177e4 LT	202
f1902860	203	extern int snd_major;
1da177e4	204	extern int snd_ecards_limit;
d80f19fa	205	extern struct class *sound_class;
1da177e4 LT	206
	207	void snd_request_card(int card);
	208
12b131c4 JB	209	int snd_register_device_for_dev(int type, struct snd_card *card,
	210	int dev,
	211	const struct file_operations *f_ops,
	212	void *private_data,
	213	const char *name,
	214	struct device *device);
	215
	216	/**
	217	* snd_register_device - Register the ALSA device file for the card
	218	* @type: the device type, SNDRV_DEVICE_TYPE_XXX
	219	* @card: the card instance
	220	* @dev: the device index
	221	* @f_ops: the file operations
	222	* @private_data: user pointer for f_ops->open()
	223	* @name: the device file name
	224	*
	225	* Registers an ALSA device file for the given card.
	226	* The operators have to be set in reg parameter.
	227	*
	228	* This function uses the card's device pointer to link to the
	229	* correct &struct device.
	230	*
	231	* Returns zero if successful, or a negative error code on failure.
	232	*/
	233	static inline int snd_register_device(int type, struct snd_card *card, int dev,
	234	const struct file_operations *f_ops,
	235	void *private_data,
	236	const char *name)
	237	{
	238	return snd_register_device_for_dev(type, card, dev, f_ops,
	239	private_data, name,
c2902c8a	240	snd_card_get_device_link(card));
12b131c4 JB	241	}
12b131c4 JB	242
512bbd6a	243	int snd_unregister_device(int type, struct snd_card *card, int dev);
f87135f5	244	void *snd_lookup_minor_data(unsigned int minor, int type);
9d19f48c	245	int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
d80f19fa	246	struct device_attribute *attr);
1da177e4 LT	247
1da177e4 LT	248	#ifdef CONFIG_SND_OSSEMUL
2af677fc	249	int snd_register_oss_device(int type, struct snd_card *card, int dev,
99ac48f5	250	const struct file_operations f_ops, void private_data,
f87135f5	251	const char *name);
512bbd6a	252	int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5	253	void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4 LT	254	#endif
	255
	256	int snd_minor_info_init(void);
	257	int snd_minor_info_done(void);
	258
	259	/* sound_oss.c */
	260
	261	#ifdef CONFIG_SND_OSSEMUL
	262	int snd_minor_info_oss_init(void);
	263	int snd_minor_info_oss_done(void);
1da177e4	264	#else
ad5fada5 PM	265	static inline int snd_minor_info_oss_init(void) { return 0; }
ad5fada5 PM	266	static inline int snd_minor_info_oss_done(void) { return 0; }
1da177e4 LT	267	#endif
	268
	269	/* memory.c */
	270
1da177e4 LT	271	int copy_to_user_fromio(void __user dst, const volatile void __iomem src, size_t count);
	272	int copy_from_user_toio(volatile void __iomem dst, const void __user src, size_t count);
	273
	274	/* init.c */
	275
512bbd6a	276	extern struct snd_card *snd_cards[SNDRV_CARDS];
746df948	277	int snd_card_locked(int card);
1da177e4 LT	278	#if defined(CONFIG_SND_MIXER_OSS) \|\| defined(CONFIG_SND_MIXER_OSS_MODULE)
	279	#define SND_MIXER_OSS_NOTIFY_REGISTER 0
	280	#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
	281	#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a	282	extern int (snd_mixer_oss_notify_callback)(struct snd_card card, int cmd);
1da177e4 LT	283	#endif
1da177e4 LT	284
53fb1e63 TI	285	int snd_card_create(int idx, const char *id,
	286	struct module *module, int extra_size,
	287	struct snd_card **card_ret);
	288
512bbd6a TI	289	int snd_card_disconnect(struct snd_card *card);
512bbd6a TI	290	int snd_card_free(struct snd_card *card);
c461482c	291	int snd_card_free_when_closed(struct snd_card *card);
10a8ebbb	292	void snd_card_set_id(struct snd_card card, const char id);
512bbd6a	293	int snd_card_register(struct snd_card *card);
1da177e4 LT	294	int snd_card_info_init(void);
1da177e4 LT	295	int snd_card_info_done(void);
512bbd6a TI	296	int snd_component_add(struct snd_card card, const char component);
	297	int snd_card_file_add(struct snd_card card, struct file file);
	298	int snd_card_file_remove(struct snd_card card, struct file file);
1da177e4	299
edab938e	300	#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4 LT	301
	302	/* device.c */
	303
512bbd6a TI	304	int snd_device_new(struct snd_card *card, snd_device_type_t type,
	305	void device_data, struct snd_device_ops ops);
	306	int snd_device_register(struct snd_card card, void device_data);
	307	int snd_device_register_all(struct snd_card *card);
	308	int snd_device_disconnect(struct snd_card card, void device_data);
	309	int snd_device_disconnect_all(struct snd_card *card);
	310	int snd_device_free(struct snd_card card, void device_data);
	311	int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
1da177e4 LT	312
	313	/* isadma.c */
	314
276bd31c	315	#ifdef CONFIG_ISA_DMA_API
1da177e4 LT	316	#define DMA_MODE_NO_ENABLE 0x0100
	317
	318	void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
	319	void snd_dma_disable(unsigned long dma);
	320	unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
276bd31c	321	#endif
1da177e4 LT	322
1da177e4 LT	323	/* misc.c */
b709e574	324	struct resource;
b1d5776d	325	void release_and_free_resource(struct resource *res);
1da177e4	326
1da177e4 LT	327	/* --- */
1da177e4 LT	328
36ce99c1	329	#if defined(CONFIG_SND_DEBUG) \|\| defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9	330	__printf(4, 5)
36ce99c1	331	void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9	332	const char *format, ...);
36ce99c1 TI	333	#else
36ce99c1 TI	334	#define __snd_printk(level, file, line, format, args...) \
cf0baf16	335	printk(format, ##args)
36ce99c1 TI	336	#endif
36ce99c1 TI	337
1da177e4 LT	338	/**
	339	* snd_printk - printk wrapper
	340	* @fmt: format string
	341	*
f66fcedc	342	* Works like printk() but prints the file and the line of the caller
1da177e4 LT	343	* when configured with CONFIG_SND_VERBOSE_PRINTK.
	344	*/
	345	#define snd_printk(fmt, args...) \
36ce99c1	346	__snd_printk(0, __FILE__, __LINE__, fmt, ##args)
1da177e4 LT	347
1da177e4 LT	348	#ifdef CONFIG_SND_DEBUG
1da177e4 LT	349	/**
1da177e4 LT	350	* snd_printd - debug printk
0863afb3	351	* @fmt: format string
1da177e4	352	*
edab938e	353	* Works like snd_printk() for debugging purposes.
1da177e4 LT	354	* Ignored when CONFIG_SND_DEBUG is not set.
	355	*/
	356	#define snd_printd(fmt, args...) \
36ce99c1	357	__snd_printk(1, __FILE__, __LINE__, fmt, ##args)
7c22f1aa	358
f66fcedc TI	359	/**
	360	* snd_BUG - give a BUG warning message and stack trace
	361	*
	362	* Calls WARN() if CONFIG_SND_DEBUG is set.
	363	* Ignored when CONFIG_SND_DEBUG is not set.
	364	*/
bdbecf50	365	#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc TI	366
	367	/**
	368	* snd_BUG_ON - debugging check macro
	369	* @cond: condition to evaluate
	370	*
	371	* When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,
	372	* and call WARN() and returns the value if it's non-zero.
	373	*
	374	* When CONFIG_SND_DEBUG is not set, this just returns zero, and the given
	375	* condition is ignored.
	376	*
	377	* NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.
	378	* Thus, don't put any statement that influences on the code behavior,
	379	* such as pre/post increment, to the argument of this macro.
	380	* If you want to evaluate and give a warning, use standard WARN_ON().
	381	*/
5ef03460	382	#define snd_BUG_ON(cond) WARN((cond), "BUG? (%s)\n", __stringify(cond))
1da177e4 LT	383
	384	#else /* !CONFIG_SND_DEBUG */
	385
fcef7836 AM	386	#define snd_printd(fmt, args...) do { } while (0)
fcef7836 AM	387	#define snd_BUG() do { } while (0)
945eed02	388	static inline int __snd_bug_on(int cond)
fcef7836 AM	389	{
	390	return 0;
	391	}
945eed02	392	#define snd_BUG_ON(cond) __snd_bug_on(0 && (cond)) /* always false */
1da177e4 LT	393
	394	#endif /* CONFIG_SND_DEBUG */
	395
62cf872a	396	#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4 LT	397	/**
	398	* snd_printdd - debug printk
	399	* @format: format string
	400	*
edab938e	401	* Works like snd_printk() for debugging purposes.
62cf872a	402	* Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4	403	*/
36ce99c1 TI	404	#define snd_printdd(format, args...) \
36ce99c1 TI	405	__snd_printk(2, __FILE__, __LINE__, format, ##args)
1da177e4	406	#else
36ce99c1	407	#define snd_printdd(format, args...) do { } while (0)
1da177e4 LT	408	#endif
1da177e4 LT	409
1da177e4	410
1da177e4 LT	411	#define SNDRV_OSS_VERSION ((3<<16)\|(8<<8)\|(1<<4)\|(0)) /* 3.8.1a */
	412
	413	/* for easier backward-porting */
	414	#if defined(CONFIG_GAMEPORT) \|\| defined(CONFIG_GAMEPORT_MODULE)
1da177e4 LT	415	#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
	416	#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
	417	#define gameport_get_port_data(gp) (gp)->port_data
	418	#endif
1da177e4	419
d9ea472c TI	420	/* PCI quirk list helper */
	421	struct snd_pci_quirk {
	422	unsigned short subvendor; /* PCI subvendor ID */
	423	unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a	424	unsigned short subdevice_mask; /* bitmask to match */
d9ea472c	425	int value; /* value */
62cf872a	426	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	427	const char name; / name of the device (optional) */
	428	#endif
	429	};
	430
8bd4bb7a TI	431	#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
	432	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
	433	#define _SND_PCI_QUIRK_ID(vend, dev) \
	434	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
d9ea472c	435	#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a	436	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	437	#define SND_PCI_QUIRK(vend,dev,xname,val) \
d9ea472c TI	438	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a TI	439	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	440	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
	441	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	442	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
	443	.value = (val), .name = (xname)}
d9ea472c TI	444	#else
	445	#define SND_PCI_QUIRK(vend,dev,xname,val) \
	446	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a TI	447	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	448	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
	449	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	450	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
d9ea472c TI	451	#endif
	452
	453	const struct snd_pci_quirk *
	454	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list);
	455
d1458279 TI	456	const struct snd_pci_quirk *
	457	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	458	const struct snd_pci_quirk *list);
d9ea472c	459
1da177e4	460	#endif /* __SOUND_CORE_H */