[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/module.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/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

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

/* monitor files for graceful shutdown (hotplug) */

struct snd_monitor_file {
	struct file *file;
	struct snd_monitor_file *next;
	const struct file_operations *disconnected_f_op;
	struct list_head shutdown_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 snd_monitor_file *files; /* 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 */
#ifndef CONFIG_SYSFS_DEPRECATED
	struct device *card_dev;	/* cardX object for sysfs */
#endif

#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)	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)
{
#ifdef CONFIG_SYSFS_DEPRECATED
	return card ? card->dev : NULL;
#else
	return card ? card->card_dev : NULL;
#endif
}

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

static inline __deprecated
struct snd_card *snd_card_new(int idx, const char *id,
			      struct module *module, int extra_size)
{
	struct snd_card *card;
	if (snd_card_create(idx, id, module, extra_size, &card) < 0)
		return NULL;
	return card;
}

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

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

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

#ifdef CONFIG_SND_VERBOSE_PRINTK
void snd_verbose_printk(const char *file, int line, const char *format, ...)
     __attribute__ ((format (printf, 3, 4)));
#endif
#if defined(CONFIG_SND_DEBUG) && defined(CONFIG_SND_VERBOSE_PRINTK)
void snd_verbose_printd(const char *file, int line, const char *format, ...)
     __attribute__ ((format (printf, 3, 4)));
#endif

/* --- */

#ifdef CONFIG_SND_VERBOSE_PRINTK
/**
 * 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_verbose_printk(__FILE__, __LINE__, fmt ,##args)
#else
#define snd_printk(fmt, args...) \
	printk(fmt ,##args)
#endif

#ifdef CONFIG_SND_DEBUG

#ifdef CONFIG_SND_VERBOSE_PRINTK
/**
 * 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_verbose_printd(__FILE__, __LINE__, fmt ,##args)
#else
#define snd_printd(fmt, args...) \
	printk(fmt ,##args)
#endif

/**
 * 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(format, ##args)
#else
#define snd_printdd(format, args...) /* nothing */
#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)
#ifndef gameport_set_dev_parent
#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
#endif

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

#define _SND_PCI_QUIRK_ID(vend,dev) \
	.subvendor = (vend), .subdevice = (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)}
#else
#define SND_PCI_QUIRK(vend,dev,xname,val) \
	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
#endif

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