[linux-2.6-block.git] / include / sound / control.h

#ifndef __SOUND_CONTROL_H
#define __SOUND_CONTROL_H

/*
 *  Header file for control interface
 *  Copyright (c) by Jaroslav Kysela <perex@suse.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);

struct snd_kcontrol_new {
	snd_ctl_elem_iface_t iface;	/* interface identifier */
	unsigned int device;		/* device/client number */
	unsigned int subdevice;		/* subdevice (substream) number */
	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;
	unsigned int *tlv;
	unsigned long private_value;
};

struct snd_kcontrol_volatile {
	struct snd_ctl_file *owner;	/* locked */
	pid_t owner_pid;
	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;
	unsigned int *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 snd_ctl_file {
	struct list_head list;		/* list of all control files */
	struct snd_card *card;
	pid_t 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_new(struct snd_kcontrol * kcontrol, unsigned int access);
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_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);
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

int snd_ctl_elem_read(struct snd_card *card, struct snd_ctl_elem_value *control);
int snd_ctl_elem_write(struct snd_card *card, struct snd_ctl_file *file, struct snd_ctl_elem_value *control);

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

#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
	6	* Copyright (c) by Jaroslav Kysela <perex@suse.cz>
	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);
1da177e4	33
82e9bae6	34	struct snd_kcontrol_new {
1da177e4 LT	35	snd_ctl_elem_iface_t iface; /* interface identifier */
	36	unsigned int device; /* device/client number */
	37	unsigned int subdevice; /* subdevice (substream) number */
	38	unsigned char name; / ASCII name of item */
	39	unsigned int index; /* index of item */
	40	unsigned int access; /* access rights */
	41	unsigned int count; /* count of same elements */
	42	snd_kcontrol_info_t *info;
	43	snd_kcontrol_get_t *get;
	44	snd_kcontrol_put_t *put;
42750b04	45	unsigned int *tlv;
1da177e4	46	unsigned long private_value;
82e9bae6	47	};
1da177e4	48
82e9bae6 TI	49	struct snd_kcontrol_volatile {
82e9bae6 TI	50	struct snd_ctl_file owner; / locked */
1da177e4 LT	51	pid_t owner_pid;
1da177e4 LT	52	unsigned int access; /* access rights */
82e9bae6	53	};
1da177e4	54
82e9bae6	55	struct snd_kcontrol {
1da177e4	56	struct list_head list; /* list of controls */
82e9bae6	57	struct snd_ctl_elem_id id;
1da177e4 LT	58	unsigned int count; /* count of same elements */
	59	snd_kcontrol_info_t *info;
	60	snd_kcontrol_get_t *get;
	61	snd_kcontrol_put_t *put;
42750b04	62	unsigned int *tlv;
1da177e4 LT	63	unsigned long private_value;
1da177e4 LT	64	void *private_data;
82e9bae6 TI	65	void (private_free)(struct snd_kcontrol kcontrol);
82e9bae6 TI	66	struct snd_kcontrol_volatile vd[0]; /* volatile data */
1da177e4 LT	67	};
1da177e4 LT	68
82e9bae6	69	#define snd_kcontrol(n) list_entry(n, struct snd_kcontrol, list)
1da177e4	70
82e9bae6	71	struct snd_kctl_event {
1da177e4	72	struct list_head list; /* list of events */
82e9bae6	73	struct snd_ctl_elem_id id;
1da177e4	74	unsigned int mask;
82e9bae6	75	};
1da177e4	76
82e9bae6	77	#define snd_kctl_event(n) list_entry(n, struct snd_kctl_event, list)
1da177e4	78
82e9bae6	79	struct snd_ctl_file {
1da177e4	80	struct list_head list; /* list of all control files */
82e9bae6	81	struct snd_card *card;
1da177e4 LT	82	pid_t pid;
	83	int prefer_pcm_subdevice;
	84	int prefer_rawmidi_subdevice;
	85	wait_queue_head_t change_sleep;
	86	spinlock_t read_lock;
	87	struct fasync_struct *fasync;
	88	int subscribed; /* read interface is activated */
	89	struct list_head events; /* waiting events for read */
	90	};
	91
82e9bae6	92	#define snd_ctl_file(n) list_entry(n, struct snd_ctl_file, list)
1da177e4	93
82e9bae6 TI	94	typedef int (snd_kctl_ioctl_func_t) (struct snd_card card,
	95	struct snd_ctl_file * control,
	96	unsigned int cmd, unsigned long arg);
1da177e4	97
82e9bae6	98	void snd_ctl_notify(struct snd_card * card, unsigned int mask, struct snd_ctl_elem_id * id);
1da177e4	99
82e9bae6 TI	100	struct snd_kcontrol snd_ctl_new(struct snd_kcontrol kcontrol, unsigned int access);
	101	struct snd_kcontrol snd_ctl_new1(const struct snd_kcontrol_new kcontrolnew, void * private_data);
	102	void snd_ctl_free_one(struct snd_kcontrol * kcontrol);
	103	int snd_ctl_add(struct snd_card * card, struct snd_kcontrol * kcontrol);
	104	int snd_ctl_remove(struct snd_card * card, struct snd_kcontrol * kcontrol);
	105	int snd_ctl_remove_id(struct snd_card * card, struct snd_ctl_elem_id *id);
	106	int snd_ctl_rename_id(struct snd_card * card, struct snd_ctl_elem_id src_id, struct snd_ctl_elem_id dst_id);
	107	struct snd_kcontrol snd_ctl_find_numid(struct snd_card card, unsigned int numid);
	108	struct snd_kcontrol snd_ctl_find_id(struct snd_card card, struct snd_ctl_elem_id *id);
1da177e4	109
82e9bae6	110	int snd_ctl_create(struct snd_card *card);
1da177e4 LT	111
	112	int snd_ctl_register_ioctl(snd_kctl_ioctl_func_t fcn);
	113	int snd_ctl_unregister_ioctl(snd_kctl_ioctl_func_t fcn);
	114	#ifdef CONFIG_COMPAT
	115	int snd_ctl_register_ioctl_compat(snd_kctl_ioctl_func_t fcn);
	116	int snd_ctl_unregister_ioctl_compat(snd_kctl_ioctl_func_t fcn);
	117	#else
	118	#define snd_ctl_register_ioctl_compat(fcn)
	119	#define snd_ctl_unregister_ioctl_compat(fcn)
	120	#endif
	121
82e9bae6 TI	122	int snd_ctl_elem_read(struct snd_card card, struct snd_ctl_elem_value control);
82e9bae6 TI	123	int snd_ctl_elem_write(struct snd_card card, struct snd_ctl_file file, struct snd_ctl_elem_value *control);
1da177e4	124
82e9bae6	125	static inline unsigned int snd_ctl_get_ioffnum(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	126	{
	127	return id->numid - kctl->id.numid;
	128	}
	129
82e9bae6	130	static inline unsigned int snd_ctl_get_ioffidx(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	131	{
	132	return id->index - kctl->id.index;
	133	}
	134
82e9bae6	135	static inline unsigned int snd_ctl_get_ioff(struct snd_kcontrol kctl, struct snd_ctl_elem_id id)
1da177e4 LT	136	{
	137	if (id->numid) {
	138	return snd_ctl_get_ioffnum(kctl, id);
	139	} else {
	140	return snd_ctl_get_ioffidx(kctl, id);
	141	}
	142	}
	143
82e9bae6 TI	144	static inline struct snd_ctl_elem_id snd_ctl_build_ioff(struct snd_ctl_elem_id dst_id,
82e9bae6 TI	145	struct snd_kcontrol *src_kctl,
1da177e4 LT	146	unsigned int offset)
	147	{
	148	*dst_id = src_kctl->id;
	149	dst_id->index += offset;
	150	dst_id->numid += offset;
	151	return dst_id;
	152	}
	153
	154	#endif /* __SOUND_CONTROL_H */