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

#ifndef __SOUND_CORE_H
#define __SOUND_CORE_H

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

#include <linux/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
#ifdef CONFIG_SBUS
struct sbus_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

struct snd_card *snd_card_new(int idx, const char *id,
			 struct module *module, int extra_size);
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 print() 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

#define snd_BUG()		WARN(1, "BUG?\n")
#define snd_BUG_ON(cond)	WARN((cond), "BUG? (%s)\n", __stringify(cond))

#else /* !CONFIG_SND_DEBUG */

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