[GitHub/mt8127/android_kernel_alcatel_ttab.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/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 */
struct pci_dev;
struct module;
struct device;
struct device_attribute;

/* 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;
	atomic_t refcount;		/* refcount for disconnection */
	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 */
	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);
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);
void snd_card_unref(struct snd_card *card);

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

/* --- */

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

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

#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

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

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

#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 */
5ef03460	29	#include <linux/stringify.h>
1da177e4	30
9004acc7 TI	31	/* number of supported soundcards */
	32	#ifdef CONFIG_SND_DYNAMIC_MINORS
	33	#define SNDRV_CARDS 32
	34	#else
	35	#define SNDRV_CARDS 8 /* don't change - minor numbers */
	36	#endif
	37
	38	#define CONFIG_SND_MAJOR 116 /* standard configuration */
	39
1da177e4	40	/* forward declarations */
1da177e4	41	struct pci_dev;
de477254	42	struct module;
313162d0 PG	43	struct device;
313162d0 PG	44	struct device_attribute;
1da177e4 LT	45
	46	/* device allocation stuff */
	47
	48	#define SNDRV_DEV_TYPE_RANGE_SIZE 0x1000
	49
512bbd6a TI	50	typedef int __bitwise snd_device_type_t;
	51	#define SNDRV_DEV_TOPLEVEL ((__force snd_device_type_t) 0)
	52	#define SNDRV_DEV_CONTROL ((__force snd_device_type_t) 1)
	53	#define SNDRV_DEV_LOWLEVEL_PRE ((__force snd_device_type_t) 2)
	54	#define SNDRV_DEV_LOWLEVEL_NORMAL ((__force snd_device_type_t) 0x1000)
	55	#define SNDRV_DEV_PCM ((__force snd_device_type_t) 0x1001)
	56	#define SNDRV_DEV_RAWMIDI ((__force snd_device_type_t) 0x1002)
	57	#define SNDRV_DEV_TIMER ((__force snd_device_type_t) 0x1003)
	58	#define SNDRV_DEV_SEQUENCER ((__force snd_device_type_t) 0x1004)
	59	#define SNDRV_DEV_HWDEP ((__force snd_device_type_t) 0x1005)
	60	#define SNDRV_DEV_INFO ((__force snd_device_type_t) 0x1006)
	61	#define SNDRV_DEV_BUS ((__force snd_device_type_t) 0x1007)
	62	#define SNDRV_DEV_CODEC ((__force snd_device_type_t) 0x1008)
e76d8cea	63	#define SNDRV_DEV_JACK ((__force snd_device_type_t) 0x1009)
3eafc959	64	#define SNDRV_DEV_COMPRESS ((__force snd_device_type_t) 0x100A)
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	95
1da177e4 LT	96	/* main structure for soundcard */
1da177e4 LT	97
512bbd6a	98	struct snd_card {
d5750f67 HK	99	int number; /* number of soundcard (index to
d5750f67 HK	100	snd_cards) */
1da177e4 LT	101
	102	char id[16]; /* id string of this card */
	103	char driver[16]; /* driver name */
	104	char shortname[32]; /* short name of this soundcard */
	105	char longname[80]; /* name of this soundcard */
	106	char mixername[80]; /* mixer name */
ff33f230	107	char components[128]; /* card components delimited with
d5750f67	108	space */
1da177e4 LT	109	struct module module; / top-level module */
	110
	111	void private_data; / private data for soundcard */
512bbd6a	112	void (private_free) (struct snd_card card); /* callback for freeing of
d5750f67	113	private data */
1da177e4 LT	114	struct list_head devices; /* devices */
	115
	116	unsigned int last_numid; /* last used numeric ID */
	117	struct rw_semaphore controls_rwsem; /* controls list lock */
	118	rwlock_t ctl_files_rwlock; /* ctl_files list lock */
	119	int controls_count; /* count of all controls */
	120	int user_ctl_count; /* count of all user controls */
	121	struct list_head controls; /* all controls for this card */
	122	struct list_head ctl_files; /* active control files */
	123
512bbd6a TI	124	struct snd_info_entry proc_root; / root for soundcard specific files */
512bbd6a TI	125	struct snd_info_entry proc_id; / the card id */
1da177e4 LT	126	struct proc_dir_entry proc_root_link; / number link to real id */
1da177e4 LT	127
118dd6bf	128	struct list_head files_list; /* all files associated to this card */
d5750f67 HK	129	struct snd_shutdown_f_ops s_f_ops; / file operations in the shutdown
d5750f67 HK	130	state */
1da177e4 LT	131	spinlock_t files_lock; /* lock the files for this card */
1da177e4 LT	132	int shutdown; /* this card is going down */
c461482c	133	int free_on_last_close; /* free in context of file_release */
1da177e4	134	wait_queue_head_t shutdown_sleep;
a0830dbd	135	atomic_t refcount; /* refcount for disconnection */
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 */
a0830dbd	193	struct snd_card card_ptr; / assigned card instance */
1da177e4 LT	194	};
1da177e4 LT	195
7d2aae1e TI	196	/* return a device pointer linked to each sound device as a parent */
	197	static inline struct device snd_card_get_device_link(struct snd_card card)
	198	{
7d2aae1e	199	return card ? card->card_dev : NULL;
7d2aae1e TI	200	}
7d2aae1e TI	201
1da177e4 LT	202	/* sound.c */
1da177e4 LT	203
f1902860	204	extern int snd_major;
1da177e4	205	extern int snd_ecards_limit;
d80f19fa	206	extern struct class *sound_class;
1da177e4 LT	207
	208	void snd_request_card(int card);
	209
12b131c4 JB	210	int snd_register_device_for_dev(int type, struct snd_card *card,
	211	int dev,
	212	const struct file_operations *f_ops,
	213	void *private_data,
	214	const char *name,
	215	struct device *device);
	216
	217	/**
	218	* snd_register_device - Register the ALSA device file for the card
	219	* @type: the device type, SNDRV_DEVICE_TYPE_XXX
	220	* @card: the card instance
	221	* @dev: the device index
	222	* @f_ops: the file operations
	223	* @private_data: user pointer for f_ops->open()
	224	* @name: the device file name
	225	*
	226	* Registers an ALSA device file for the given card.
	227	* The operators have to be set in reg parameter.
	228	*
	229	* This function uses the card's device pointer to link to the
	230	* correct &struct device.
	231	*
eb7c06e8	232	* Return: Zero if successful, or a negative error code on failure.
12b131c4 JB	233	*/
	234	static inline int snd_register_device(int type, struct snd_card *card, int dev,
	235	const struct file_operations *f_ops,
	236	void *private_data,
	237	const char *name)
	238	{
	239	return snd_register_device_for_dev(type, card, dev, f_ops,
	240	private_data, name,
c2902c8a	241	snd_card_get_device_link(card));
12b131c4 JB	242	}
12b131c4 JB	243
512bbd6a	244	int snd_unregister_device(int type, struct snd_card *card, int dev);
f87135f5	245	void *snd_lookup_minor_data(unsigned int minor, int type);
9d19f48c	246	int snd_add_device_sysfs_file(int type, struct snd_card *card, int dev,
d80f19fa	247	struct device_attribute *attr);
1da177e4 LT	248
1da177e4 LT	249	#ifdef CONFIG_SND_OSSEMUL
2af677fc	250	int snd_register_oss_device(int type, struct snd_card *card, int dev,
99ac48f5	251	const struct file_operations f_ops, void private_data,
f87135f5	252	const char *name);
512bbd6a	253	int snd_unregister_oss_device(int type, struct snd_card *card, int dev);
f87135f5	254	void *snd_lookup_oss_minor_data(unsigned int minor, int type);
1da177e4 LT	255	#endif
	256
	257	int snd_minor_info_init(void);
	258	int snd_minor_info_done(void);
	259
	260	/* sound_oss.c */
	261
	262	#ifdef CONFIG_SND_OSSEMUL
	263	int snd_minor_info_oss_init(void);
	264	int snd_minor_info_oss_done(void);
1da177e4	265	#else
ad5fada5 PM	266	static inline int snd_minor_info_oss_init(void) { return 0; }
ad5fada5 PM	267	static inline int snd_minor_info_oss_done(void) { return 0; }
1da177e4 LT	268	#endif
	269
	270	/* memory.c */
	271
1da177e4 LT	272	int copy_to_user_fromio(void __user dst, const volatile void __iomem src, size_t count);
	273	int copy_from_user_toio(volatile void __iomem dst, const void __user src, size_t count);
	274
	275	/* init.c */
	276
512bbd6a	277	extern struct snd_card *snd_cards[SNDRV_CARDS];
746df948	278	int snd_card_locked(int card);
1da177e4 LT	279	#if defined(CONFIG_SND_MIXER_OSS) \|\| defined(CONFIG_SND_MIXER_OSS_MODULE)
	280	#define SND_MIXER_OSS_NOTIFY_REGISTER 0
	281	#define SND_MIXER_OSS_NOTIFY_DISCONNECT 1
	282	#define SND_MIXER_OSS_NOTIFY_FREE 2
512bbd6a	283	extern int (snd_mixer_oss_notify_callback)(struct snd_card card, int cmd);
1da177e4 LT	284	#endif
1da177e4 LT	285
53fb1e63 TI	286	int snd_card_create(int idx, const char *id,
	287	struct module *module, int extra_size,
	288	struct snd_card **card_ret);
	289
512bbd6a TI	290	int snd_card_disconnect(struct snd_card *card);
512bbd6a TI	291	int snd_card_free(struct snd_card *card);
c461482c	292	int snd_card_free_when_closed(struct snd_card *card);
10a8ebbb	293	void snd_card_set_id(struct snd_card card, const char id);
512bbd6a	294	int snd_card_register(struct snd_card *card);
1da177e4 LT	295	int snd_card_info_init(void);
1da177e4 LT	296	int snd_card_info_done(void);
512bbd6a TI	297	int snd_component_add(struct snd_card card, const char component);
	298	int snd_card_file_add(struct snd_card card, struct file file);
	299	int snd_card_file_remove(struct snd_card card, struct file file);
a0830dbd	300	void snd_card_unref(struct snd_card *card);
1da177e4	301
edab938e	302	#define snd_card_set_dev(card, devptr) ((card)->dev = (devptr))
1da177e4 LT	303
	304	/* device.c */
	305
512bbd6a TI	306	int snd_device_new(struct snd_card *card, snd_device_type_t type,
	307	void device_data, struct snd_device_ops ops);
	308	int snd_device_register(struct snd_card card, void device_data);
	309	int snd_device_register_all(struct snd_card *card);
	310	int snd_device_disconnect(struct snd_card card, void device_data);
	311	int snd_device_disconnect_all(struct snd_card *card);
	312	int snd_device_free(struct snd_card card, void device_data);
	313	int snd_device_free_all(struct snd_card *card, snd_device_cmd_t cmd);
1da177e4 LT	314
	315	/* isadma.c */
	316
276bd31c	317	#ifdef CONFIG_ISA_DMA_API
1da177e4 LT	318	#define DMA_MODE_NO_ENABLE 0x0100
	319
	320	void snd_dma_program(unsigned long dma, unsigned long addr, unsigned int size, unsigned short mode);
	321	void snd_dma_disable(unsigned long dma);
	322	unsigned int snd_dma_pointer(unsigned long dma, unsigned int size);
276bd31c	323	#endif
1da177e4 LT	324
1da177e4 LT	325	/* misc.c */
b709e574	326	struct resource;
b1d5776d	327	void release_and_free_resource(struct resource *res);
1da177e4	328
1da177e4 LT	329	/* --- */
1da177e4 LT	330
fae3d88a FW	331	/* sound printk debug levels */
	332	enum {
	333	SND_PR_ALWAYS,
	334	SND_PR_DEBUG,
	335	SND_PR_VERBOSE,
	336	};
	337
36ce99c1	338	#if defined(CONFIG_SND_DEBUG) \|\| defined(CONFIG_SND_VERBOSE_PRINTK)
b9075fa9	339	__printf(4, 5)
36ce99c1	340	void __snd_printk(unsigned int level, const char *file, int line,
b9075fa9	341	const char *format, ...);
36ce99c1 TI	342	#else
36ce99c1 TI	343	#define __snd_printk(level, file, line, format, args...) \
cf0baf16	344	printk(format, ##args)
36ce99c1 TI	345	#endif
36ce99c1 TI	346
1da177e4 LT	347	/**
	348	* snd_printk - printk wrapper
	349	* @fmt: format string
	350	*
f66fcedc	351	* Works like printk() but prints the file and the line of the caller
1da177e4 LT	352	* when configured with CONFIG_SND_VERBOSE_PRINTK.
	353	*/
	354	#define snd_printk(fmt, args...) \
36ce99c1	355	__snd_printk(0, __FILE__, __LINE__, fmt, ##args)
1da177e4 LT	356
1da177e4 LT	357	#ifdef CONFIG_SND_DEBUG
1da177e4 LT	358	/**
1da177e4 LT	359	* snd_printd - debug printk
0863afb3	360	* @fmt: format string
1da177e4	361	*
edab938e	362	* Works like snd_printk() for debugging purposes.
1da177e4 LT	363	* Ignored when CONFIG_SND_DEBUG is not set.
	364	*/
	365	#define snd_printd(fmt, args...) \
36ce99c1	366	__snd_printk(1, __FILE__, __LINE__, fmt, ##args)
fae3d88a FW	367	#define _snd_printd(level, fmt, args...) \
fae3d88a FW	368	__snd_printk(level, __FILE__, __LINE__, fmt, ##args)
7c22f1aa	369
f66fcedc TI	370	/**
	371	* snd_BUG - give a BUG warning message and stack trace
	372	*
	373	* Calls WARN() if CONFIG_SND_DEBUG is set.
	374	* Ignored when CONFIG_SND_DEBUG is not set.
	375	*/
bdbecf50	376	#define snd_BUG() WARN(1, "BUG?\n")
f66fcedc TI	377
	378	/**
	379	* snd_BUG_ON - debugging check macro
	380	* @cond: condition to evaluate
	381	*
d5702162 CS	382	* Has the same behavior as WARN_ON when CONFIG_SND_DEBUG is set,
d5702162 CS	383	* otherwise just evaluates the conditional and returns the value.
f66fcedc	384	*/
d5702162	385	#define snd_BUG_ON(cond) WARN_ON((cond))
1da177e4 LT	386
	387	#else /* !CONFIG_SND_DEBUG */
	388
86b27237 TI	389	__printf(1, 2)
	390	static inline void snd_printd(const char *format, ...) {}
	391	__printf(2, 3)
	392	static inline void _snd_printd(int level, const char *format, ...) {}
	393
fcef7836	394	#define snd_BUG() do { } while (0)
d5702162 CS	395
	396	#define snd_BUG_ON(condition) ({ \
	397	int __ret_warn_on = !!(condition); \
	398	unlikely(__ret_warn_on); \
	399	})
1da177e4 LT	400
	401	#endif /* CONFIG_SND_DEBUG */
	402
62cf872a	403	#ifdef CONFIG_SND_DEBUG_VERBOSE
1da177e4 LT	404	/**
	405	* snd_printdd - debug printk
	406	* @format: format string
	407	*
edab938e	408	* Works like snd_printk() for debugging purposes.
62cf872a	409	* Ignored when CONFIG_SND_DEBUG_VERBOSE is not set.
1da177e4	410	*/
36ce99c1 TI	411	#define snd_printdd(format, args...) \
36ce99c1 TI	412	__snd_printk(2, __FILE__, __LINE__, format, ##args)
1da177e4	413	#else
86b27237 TI	414	__printf(1, 2)
86b27237 TI	415	static inline void snd_printdd(const char *format, ...) {}
1da177e4 LT	416	#endif
1da177e4 LT	417
1da177e4	418
1da177e4 LT	419	#define SNDRV_OSS_VERSION ((3<<16)\|(8<<8)\|(1<<4)\|(0)) /* 3.8.1a */
	420
	421	/* for easier backward-porting */
	422	#if defined(CONFIG_GAMEPORT) \|\| defined(CONFIG_GAMEPORT_MODULE)
1da177e4 LT	423	#define gameport_set_dev_parent(gp,xdev) ((gp)->dev.parent = (xdev))
	424	#define gameport_set_port_data(gp,r) ((gp)->port_data = (r))
	425	#define gameport_get_port_data(gp) (gp)->port_data
	426	#endif
1da177e4	427
8422fa11	428	#ifdef CONFIG_PCI
d9ea472c TI	429	/* PCI quirk list helper */
	430	struct snd_pci_quirk {
	431	unsigned short subvendor; /* PCI subvendor ID */
	432	unsigned short subdevice; /* PCI subdevice ID */
8bd4bb7a	433	unsigned short subdevice_mask; /* bitmask to match */
d9ea472c	434	int value; /* value */
62cf872a	435	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	436	const char name; / name of the device (optional) */
	437	#endif
	438	};
	439
8bd4bb7a TI	440	#define _SND_PCI_QUIRK_ID_MASK(vend, mask, dev) \
	441	.subvendor = (vend), .subdevice = (dev), .subdevice_mask = (mask)
	442	#define _SND_PCI_QUIRK_ID(vend, dev) \
	443	_SND_PCI_QUIRK_ID_MASK(vend, 0xffff, dev)
d9ea472c	444	#define SND_PCI_QUIRK_ID(vend,dev) {_SND_PCI_QUIRK_ID(vend, dev)}
62cf872a	445	#ifdef CONFIG_SND_DEBUG_VERBOSE
d9ea472c TI	446	#define SND_PCI_QUIRK(vend,dev,xname,val) \
d9ea472c TI	447	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val), .name = (xname)}
8bd4bb7a TI	448	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	449	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val), .name = (xname)}
	450	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	451	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), \
	452	.value = (val), .name = (xname)}
86b27237	453	#define snd_pci_quirk_name(q) ((q)->name)
d9ea472c TI	454	#else
	455	#define SND_PCI_QUIRK(vend,dev,xname,val) \
	456	{_SND_PCI_QUIRK_ID(vend, dev), .value = (val)}
8bd4bb7a TI	457	#define SND_PCI_QUIRK_MASK(vend, mask, dev, xname, val) \
	458	{_SND_PCI_QUIRK_ID_MASK(vend, mask, dev), .value = (val)}
	459	#define SND_PCI_QUIRK_VENDOR(vend, xname, val) \
	460	{_SND_PCI_QUIRK_ID_MASK(vend, 0, 0), .value = (val)}
86b27237	461	#define snd_pci_quirk_name(q) ""
d9ea472c TI	462	#endif
	463
	464	const struct snd_pci_quirk *
	465	snd_pci_quirk_lookup(struct pci_dev pci, const struct snd_pci_quirk list);
	466
d1458279 TI	467	const struct snd_pci_quirk *
	468	snd_pci_quirk_lookup_id(u16 vendor, u16 device,
	469	const struct snd_pci_quirk *list);
8422fa11	470	#endif
d9ea472c	471
1da177e4	472	#endif /* __SOUND_CORE_H */