[deliverable/linux.git] / include / sound / control.h

#ifndef __SOUND_CONTROL_H
#define __SOUND_CONTROL_H

/*
 *  Header file for control interface
 *  Copyright (c) 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 <sound/asound.h>

#define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)

struct snd_kcontrol;
typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol,
				    int op_flag, /* SNDRV_CTL_TLV_OP_XXX */
				    unsigned int size,
				    unsigned int __user *tlv);

enum {
	SNDRV_CTL_TLV_OP_READ = 0,
	SNDRV_CTL_TLV_OP_WRITE = 1,
	SNDRV_CTL_TLV_OP_CMD = -1,
};

struct snd_kcontrol_new {
	snd_ctl_elem_iface_t iface;	/* interface identifier */
	unsigned int device;		/* device/client number */
	unsigned int subdevice;		/* subdevice (substream) number */
	const unsigned char *name;	/* ASCII name of item */
	unsigned int index;		/* index of item */
	unsigned int access;		/* access rights */
	unsigned int count;		/* count of same elements */
	snd_kcontrol_info_t *info;
	snd_kcontrol_get_t *get;
	snd_kcontrol_put_t *put;
	union {
		snd_kcontrol_tlv_rw_t *c;
		const unsigned int *p;
	} tlv;
	unsigned long private_value;
};

struct snd_kcontrol_volatile {
	struct snd_ctl_file *owner;	/* locked */
	unsigned int access;	/* access rights */
};

struct snd_kcontrol {
	struct list_head list;		/* list of controls */
	struct snd_ctl_elem_id id;
	unsigned int count;		/* count of same elements */
	snd_kcontrol_info_t *info;
	snd_kcontrol_get_t *get;
	snd_kcontrol_put_t *put;
	union {
		snd_kcontrol_tlv_rw_t *c;
		const unsigned int *p;
	} tlv;
	unsigned long private_value;
	void *private_data;
	void (*private_free)(struct snd_kcontrol *kcontrol);
	struct snd_kcontrol_volatile vd[0];	/* volatile data */
};

#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)

struct snd_kctl_event {
	struct list_head list;	/* list of events */
	struct snd_ctl_elem_id id;
	unsigned int mask;
};

#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)

struct pid;

struct snd_ctl_file {
	struct list_head list;		/* list of all control files */
	struct snd_card *card;
	struct pid *pid;
	int prefer_pcm_subdevice;
	int prefer_rawmidi_subdevice;
	wait_queue_head_t change_sleep;
	spinlock_t read_lock;
	struct fasync_struct *fasync;
	int subscribed;			/* read interface is activated */
	struct list_head events;	/* waiting events for read */
};

#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)

typedef int (*snd_kctl_ioctl_func_t) (struct snd_card * card,
				      struct snd_ctl_file * control,
				      unsigned int cmd, unsigned long arg);

void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);

struct snd_kcontrol *snd_ctl_new1(const struct snd_kcontrol_new * kcontrolnew, void * private_data);
void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
int snd_ctl_replace(struct snd_card *card, struct snd_kcontrol *kcontrol, bool add_on_replace);
int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id *src_id, struct snd_ctl_elem_id *dst_id);
int snd_ctl_activate_id(struct snd_card *card, struct snd_ctl_elem_id *id,
			int active);
struct snd_kcontrol *snd_ctl_find_numid(struct snd_card * card, unsigned int numid);
struct snd_kcontrol *snd_ctl_find_id(struct snd_card * card, struct snd_ctl_elem_id *id);

int snd_ctl_create(struct snd_card *card);

int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
#ifdef CONFIG_COMPAT
int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
#else
#define snd_ctl_register_ioctl_compat(fcn)
#define snd_ctl_unregister_ioctl_compat(fcn)
#endif

static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
{
	return id->numid - kctl->id.numid;
}

static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
{
	return id->index - kctl->id.index;
}

static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol *kctl, struct snd_ctl_elem_id *id)
{
	if (id->numid) {
		return snd_ctl_get_ioffnum(kctl, id);
	} else {
		return snd_ctl_get_ioffidx(kctl, id);
	}
}

static inline struct snd_ctl_elem_id *snd_ctl_build_ioff(struct snd_ctl_elem_id *dst_id,
						    struct snd_kcontrol *src_kctl,
						    unsigned int offset)
{
	*dst_id = src_kctl->id;
	dst_id->index += offset;
	dst_id->numid += offset;
	return dst_id;
}

/*
 * Frequently used control callbacks/helpers
 */
int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
			      struct snd_ctl_elem_info *uinfo);
int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
				struct snd_ctl_elem_info *uinfo);
int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
		      unsigned int items, const char *const names[]);

/*
 * virtual master control
 */
struct snd_kcontrol *snd_ctl_make_virtual_master(char *name,
						 const unsigned int *tlv);
int _snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave,
		       unsigned int flags);
/* optional flags for slave */
#define SND_CTL_SLAVE_NEED_UPDATE	(1 << 0)

/**
 * snd_ctl_add_slave - Add a virtual slave control
 * @master: vmaster element
 * @slave: slave element to add
 *
 * Add a virtual slave control to the given master element created via
 * snd_ctl_create_virtual_master() beforehand.
 *
 * All slaves must be the same type (returning the same information
 * via info callback).  The function doesn't check it, so it's your
 * responsibility.
 *
 * Also, some additional limitations:
 * at most two channels,
 * logarithmic volume control (dB level) thus no linear volume,
 * master can only attenuate the volume without gain
 *
 * Return: Zero if successful or a negative error code.
 */
static inline int
snd_ctl_add_slave(struct snd_kcontrol *master, struct snd_kcontrol *slave)
{
	return _snd_ctl_add_slave(master, slave, 0);
}

/**
 * snd_ctl_add_slave_uncached - Add a virtual slave control
 * @master: vmaster element
 * @slave: slave element to add
 *
 * Add a virtual slave control to the given master.
 * Unlike snd_ctl_add_slave(), the element added via this function
 * is supposed to have volatile values, and get callback is called
 * at each time quried from the master.
 *
 * When the control peeks the hardware values directly and the value
 * can be changed by other means than the put callback of the element,
 * this function should be used to keep the value always up-to-date.
 *
 * Return: Zero if successful or a negative error code.
 */
static inline int
snd_ctl_add_slave_uncached(struct snd_kcontrol *master,
			   struct snd_kcontrol *slave)
{
	return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE);
}

int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
			     void (*hook)(void *private_data, int),
			     void *private_data);
void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only);
#define snd_ctl_sync_vmaster_hook(kctl)	snd_ctl_sync_vmaster(kctl, true)

/*
 * Helper functions for jack-detection controls
 */
struct snd_kcontrol *
snd_kctl_jack_new(const char *name, int idx, void *private_data);
void snd_kctl_jack_report(struct snd_card *card,
			  struct snd_kcontrol *kctl, bool status);

#endif	/* __SOUND_CONTROL_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __SOUND_CONTROL_H
	2	#define __SOUND_CONTROL_H
	3
	4	/*
	5	* Header file for control interface
c1017a4c	6	* Copyright (c) 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 <sound/asound.h>
	26
1da177e4 LT	27	#define snd_kcontrol_chip(kcontrol) ((kcontrol)->private_data)
1da177e4 LT	28
82e9bae6 TI	29	struct snd_kcontrol;
	30	typedef int (snd_kcontrol_info_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_info * uinfo);
	31	typedef int (snd_kcontrol_get_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
	32	typedef int (snd_kcontrol_put_t) (struct snd_kcontrol * kcontrol, struct snd_ctl_elem_value * ucontrol);
8aa9b586	33	typedef int (snd_kcontrol_tlv_rw_t)(struct snd_kcontrol *kcontrol,
0cea76f3	34	int op_flag, /* SNDRV_CTL_TLV_OP_XXX */
8aa9b586 JK	35	unsigned int size,
	36	unsigned int __user *tlv);
	37
0cea76f3 TI	38	enum {
	39	SNDRV_CTL_TLV_OP_READ = 0,
	40	SNDRV_CTL_TLV_OP_WRITE = 1,
	41	SNDRV_CTL_TLV_OP_CMD = -1,
	42	};
1da177e4	43
82e9bae6	44	struct snd_kcontrol_new {
1da177e4 LT	45	snd_ctl_elem_iface_t iface; /* interface identifier */
	46	unsigned int device; /* device/client number */
	47	unsigned int subdevice; /* subdevice (substream) number */
5ac2ba94	48	const unsigned char name; / ASCII name of item */
1da177e4 LT	49	unsigned int index; /* index of item */
	50	unsigned int access; /* access rights */
	51	unsigned int count; /* count of same elements */
	52	snd_kcontrol_info_t *info;
	53	snd_kcontrol_get_t *get;
	54	snd_kcontrol_put_t *put;
8aa9b586 JK	55	union {
8aa9b586 JK	56	snd_kcontrol_tlv_rw_t *c;
0cb29ea0	57	const unsigned int *p;
8aa9b586	58	} tlv;
1da177e4	59	unsigned long private_value;
82e9bae6	60	};
1da177e4	61
82e9bae6 TI	62	struct snd_kcontrol_volatile {
82e9bae6 TI	63	struct snd_ctl_file owner; / locked */
1da177e4	64	unsigned int access; /* access rights */
82e9bae6	65	};
1da177e4	66
82e9bae6	67	struct snd_kcontrol {
1da177e4	68	struct list_head list; /* list of controls */
82e9bae6	69	struct snd_ctl_elem_id id;
1da177e4 LT	70	unsigned int count; /* count of same elements */
	71	snd_kcontrol_info_t *info;
	72	snd_kcontrol_get_t *get;
	73	snd_kcontrol_put_t *put;
8aa9b586 JK	74	union {
8aa9b586 JK	75	snd_kcontrol_tlv_rw_t *c;
0cb29ea0	76	const unsigned int *p;
8aa9b586	77	} tlv;
1da177e4 LT	78	unsigned long private_value;
1da177e4 LT	79	void *private_data;
82e9bae6 TI	80	void (private_free)(struct snd_kcontrol kcontrol);
82e9bae6 TI	81	struct snd_kcontrol_volatile vd[0]; /* volatile data */
1da177e4 LT	82	};
1da177e4 LT	83
82e9bae6	84	#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
1da177e4	85
82e9bae6	86	struct snd_kctl_event {
1da177e4	87	struct list_head list; /* list of events */
82e9bae6	88	struct snd_ctl_elem_id id;
1da177e4	89	unsigned int mask;
82e9bae6	90	};
1da177e4	91
82e9bae6	92	#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
1da177e4	93
25d27ede CL	94	struct pid;
25d27ede CL	95
82e9bae6	96	struct snd_ctl_file {
1da177e4	97	struct list_head list; /* list of all control files */
82e9bae6	98	struct snd_card *card;
25d27ede	99	struct pid *pid;
1da177e4 LT	100	int prefer_pcm_subdevice;
	101	int prefer_rawmidi_subdevice;
	102	wait_queue_head_t change_sleep;
	103	spinlock_t read_lock;
	104	struct fasync_struct *fasync;
	105	int subscribed; /* read interface is activated */
	106	struct list_head events; /* waiting events for read */
	107	};
	108
82e9bae6	109	#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
1da177e4	110
82e9bae6 TI	111	typedef int (snd_kctl_ioctl_func_t) (struct snd_card card,
	112	struct snd_ctl_file * control,
	113	unsigned int cmd, unsigned long arg);
1da177e4	114
82e9bae6	115	void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
1da177e4	116
82e9bae6 TI	117	struct snd_kcontrol snd_ctl_new1(const struct snd_kcontrol_new kcontrolnew, void * private_data);
	118	void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
	119	int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
	120	int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
66b5b972	121	int snd_ctl_replace(struct snd_card card, struct snd_kcontrol kcontrol, bool add_on_replace);
82e9bae6 TI	122	int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
82e9bae6 TI	123	int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id src_id, struct snd_ctl_elem_id dst_id);
3cbdd753 TI	124	int snd_ctl_activate_id(struct snd_card card, struct snd_ctl_elem_id id,
3cbdd753 TI	125	int active);
82e9bae6 TI	126	struct snd_kcontrol snd_ctl_find_numid(struct snd_card card, unsigned int numid);
82e9bae6 TI	127	struct snd_kcontrol snd_ctl_find_id(struct snd_card card, struct snd_ctl_elem_id *id);
1da177e4	128
82e9bae6	129	int snd_ctl_create(struct snd_card *card);
1da177e4 LT	130
	131	int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
	132	int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
	133	#ifdef CONFIG_COMPAT
	134	int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
	135	int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
	136	#else
	137	#define snd_ctl_register_ioctl_compat(fcn)
	138	#define snd_ctl_unregister_ioctl_compat(fcn)
	139	#endif
	140
82e9bae6	141	static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	142	{
	143	return id->numid - kctl->id.numid;
	144	}
	145
82e9bae6	146	static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	147	{
	148	return id->index - kctl->id.index;
	149	}
	150
82e9bae6	151	static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	152	{
	153	if (id->numid) {
	154	return snd_ctl_get_ioffnum(kctl, id);
	155	} else {
	156	return snd_ctl_get_ioffidx(kctl, id);
	157	}
	158	}
	159
82e9bae6 TI	160	static inline struct snd_ctl_elem_id snd_ctl_build_ioff(struct snd_ctl_elem_id dst_id,
82e9bae6 TI	161	struct snd_kcontrol *src_kctl,
1da177e4 LT	162	unsigned int offset)
	163	{
	164	*dst_id = src_kctl->id;
	165	dst_id->index += offset;
	166	dst_id->numid += offset;
	167	return dst_id;
	168	}
	169
b9ed4f2b	170	/*
9600732b	171	* Frequently used control callbacks/helpers
b9ed4f2b TI	172	*/
	173	int snd_ctl_boolean_mono_info(struct snd_kcontrol *kcontrol,
	174	struct snd_ctl_elem_info *uinfo);
	175	int snd_ctl_boolean_stereo_info(struct snd_kcontrol *kcontrol,
	176	struct snd_ctl_elem_info *uinfo);
9600732b CL	177	int snd_ctl_enum_info(struct snd_ctl_elem_info *info, unsigned int channels,
9600732b CL	178	unsigned int items, const char *const names[]);
b9ed4f2b	179
e922b002 TI	180	/*
	181	* virtual master control
	182	*/
	183	struct snd_kcontrol snd_ctl_make_virtual_master(char name,
	184	const unsigned int *tlv);
f5b1db63 TI	185	int _snd_ctl_add_slave(struct snd_kcontrol master, struct snd_kcontrol slave,
	186	unsigned int flags);
	187	/* optional flags for slave */
	188	#define SND_CTL_SLAVE_NEED_UPDATE (1 << 0)
	189
79c7cdd5 TI	190	/**
	191	* snd_ctl_add_slave - Add a virtual slave control
	192	* @master: vmaster element
	193	* @slave: slave element to add
	194	*
	195	* Add a virtual slave control to the given master element created via
	196	* snd_ctl_create_virtual_master() beforehand.
79c7cdd5 TI	197	*
79c7cdd5 TI	198	* All slaves must be the same type (returning the same information
25985edc	199	* via info callback). The function doesn't check it, so it's your
79c7cdd5 TI	200	* responsibility.
	201	*
	202	* Also, some additional limitations:
	203	* at most two channels,
	204	* logarithmic volume control (dB level) thus no linear volume,
	205	* master can only attenuate the volume without gain
eb7c06e8 YB	206	*
eb7c06e8 YB	207	* Return: Zero if successful or a negative error code.
79c7cdd5	208	*/
f5b1db63 TI	209	static inline int
	210	snd_ctl_add_slave(struct snd_kcontrol master, struct snd_kcontrol slave)
	211	{
	212	return _snd_ctl_add_slave(master, slave, 0);
	213	}
	214
79c7cdd5 TI	215	/**
	216	* snd_ctl_add_slave_uncached - Add a virtual slave control
	217	* @master: vmaster element
	218	* @slave: slave element to add
	219	*
	220	* Add a virtual slave control to the given master.
	221	* Unlike snd_ctl_add_slave(), the element added via this function
	222	* is supposed to have volatile values, and get callback is called
	223	* at each time quried from the master.
	224	*
	225	* When the control peeks the hardware values directly and the value
	226	* can be changed by other means than the put callback of the element,
	227	* this function should be used to keep the value always up-to-date.
eb7c06e8 YB	228	*
eb7c06e8 YB	229	* Return: Zero if successful or a negative error code.
79c7cdd5	230	*/
f5b1db63 TI	231	static inline int
	232	snd_ctl_add_slave_uncached(struct snd_kcontrol *master,
	233	struct snd_kcontrol *slave)
	234	{
	235	return _snd_ctl_add_slave(master, slave, SND_CTL_SLAVE_NEED_UPDATE);
	236	}
	237
2ad787e9 TI	238	int snd_ctl_add_vmaster_hook(struct snd_kcontrol *kctl,
	239	void (hook)(void private_data, int),
	240	void *private_data);
1ca2f2ec TI	241	void snd_ctl_sync_vmaster(struct snd_kcontrol *kctl, bool hook_only);
1ca2f2ec TI	242	#define snd_ctl_sync_vmaster_hook(kctl) snd_ctl_sync_vmaster(kctl, true)
2ad787e9	243
35be544a TI	244	/*
	245	* Helper functions for jack-detection controls
	246	*/
	247	struct snd_kcontrol *
	248	snd_kctl_jack_new(const char name, int idx, void private_data);
	249	void snd_kctl_jack_report(struct snd_card *card,
	250	struct snd_kcontrol *kctl, bool status);
	251
1da177e4	252	#endif /* __SOUND_CONTROL_H */