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

#ifndef __SOUND_TLV_H
#define __SOUND_TLV_H

/*
 *  Advanced Linux Sound Architecture - ALSA - Driver
 *  Copyright (c) 2006 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
 *
 */

/*
 * TLV structure is right behind the struct snd_ctl_tlv:
 *   unsigned int type  	- see SNDRV_CTL_TLVT_*
 *   unsigned int length
 *   .... data aligned to sizeof(unsigned int), use
 *        block_length = (length + (sizeof(unsigned int) - 1)) &
 *                       ~(sizeof(unsigned int) - 1)) ....
 */

#define SNDRV_CTL_TLVT_CONTAINER 0	/* one level down - group of TLVs */
#define SNDRV_CTL_TLVT_DB_SCALE	1       /* dB scale */
#define SNDRV_CTL_TLVT_DB_LINEAR 2	/* linear volume */
#define SNDRV_CTL_TLVT_DB_RANGE 3	/* dB range container */
#define SNDRV_CTL_TLVT_DB_MINMAX 4	/* dB scale with min/max */
#define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5	/* dB scale with min/max with mute */

#define TLV_ITEM(type, ...) \
	(type), TLV_LENGTH(__VA_ARGS__), __VA_ARGS__
#define TLV_LENGTH(...) \
	((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))

#define TLV_CONTAINER_ITEM(...) \
	TLV_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
#define DECLARE_TLV_CONTAINER(name, ...) \
	unsigned int name[] = { TLV_CONTAINER_ITEM(__VA_ARGS__) }

#define TLV_DB_SCALE_MASK	0xffff
#define TLV_DB_SCALE_MUTE	0x10000
#define TLV_DB_SCALE_ITEM(min, step, mute)			\
	TLV_ITEM(SNDRV_CTL_TLVT_DB_SCALE,			\
		 (min),					\
		 ((step) & TLV_DB_SCALE_MASK) |		\
			((mute) ? TLV_DB_SCALE_MUTE : 0))
#define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
	unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }

/* dB scale specified with min/max values instead of step */
#define TLV_DB_MINMAX_ITEM(min_dB, max_dB)			\
	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
#define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB)			\
	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
#define DECLARE_TLV_DB_MINMAX(name, min_dB, max_dB) \
	unsigned int name[] = { TLV_DB_MINMAX_ITEM(min_dB, max_dB) }
#define DECLARE_TLV_DB_MINMAX_MUTE(name, min_dB, max_dB) \
	unsigned int name[] = { TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) }

/* linear volume between min_dB and max_dB (.01dB unit) */
#define TLV_DB_LINEAR_ITEM(min_dB, max_dB)		    \
	TLV_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
#define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB)	\
	unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }

/* dB range container */
/* Each item is: <min> <max> <TLV> */
#define TLV_DB_RANGE_ITEM(...) \
	TLV_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
#define DECLARE_TLV_DB_RANGE(name, ...) \
	unsigned int name[] = { TLV_DB_RANGE_ITEM(__VA_ARGS__) }
/* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
#define TLV_DB_RANGE_HEAD(num)			\
	SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)

#define TLV_DB_GAIN_MUTE	-9999999

/*
 * channel-mapping TLV items
 *  TLV length must match with num_channels
 */
#define SNDRV_CTL_TLVT_CHMAP_FIXED	0x101	/* fixed channel position */
#define SNDRV_CTL_TLVT_CHMAP_VAR	0x102	/* channels freely swappable */
#define SNDRV_CTL_TLVT_CHMAP_PAIRED	0x103	/* pair-wise swappable */

#endif /* __SOUND_TLV_H */
Commit	Line	Data
42750b04 JK	1	#ifndef __SOUND_TLV_H
	2	#define __SOUND_TLV_H
	3
	4	/*
	5	* Advanced Linux Sound Architecture - ALSA - Driver
c1017a4c	6	* Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
42750b04 JK	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	/*
	26	* TLV structure is right behind the struct snd_ctl_tlv:
	27	* unsigned int type - see SNDRV_CTL_TLVT_*
	28	* unsigned int length
	29	* .... data aligned to sizeof(unsigned int), use
	30	* block_length = (length + (sizeof(unsigned int) - 1)) &
	31	* ~(sizeof(unsigned int) - 1)) ....
	32	*/
	33
	34	#define SNDRV_CTL_TLVT_CONTAINER 0 /* one level down - group of TLVs */
	35	#define SNDRV_CTL_TLVT_DB_SCALE 1 /* dB scale */
063a40d9	36	#define SNDRV_CTL_TLVT_DB_LINEAR 2 /* linear volume */
55a29af5	37	#define SNDRV_CTL_TLVT_DB_RANGE 3 /* dB range container */
085f3065 TI	38	#define SNDRV_CTL_TLVT_DB_MINMAX 4 /* dB scale with min/max */
085f3065 TI	39	#define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5 /* dB scale with min/max with mute */
42750b04	40
b5b9eb54 CL	41	#define TLV_ITEM(type, ...) \
	42	(type), TLV_LENGTH(__VA_ARGS__), __VA_ARGS__
	43	#define TLV_LENGTH(...) \
	44	((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))
	45
570aef5d CL	46	#define TLV_CONTAINER_ITEM(...) \
	47	TLV_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
	48	#define DECLARE_TLV_CONTAINER(name, ...) \
	49	unsigned int name[] = { TLV_CONTAINER_ITEM(__VA_ARGS__) }
	50
c08d9169 TI	51	#define TLV_DB_SCALE_MASK 0xffff
c08d9169 TI	52	#define TLV_DB_SCALE_MUTE 0x10000
55a29af5	53	#define TLV_DB_SCALE_ITEM(min, step, mute) \
b5b9eb54 CL	54	TLV_ITEM(SNDRV_CTL_TLVT_DB_SCALE, \
	55	(min), \
	56	((step) & TLV_DB_SCALE_MASK) \| \
	57	((mute) ? TLV_DB_SCALE_MUTE : 0))
42750b04	58	#define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
55a29af5	59	unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }
42750b04	60
085f3065 TI	61	/* dB scale specified with min/max values instead of step */
085f3065 TI	62	#define TLV_DB_MINMAX_ITEM(min_dB, max_dB) \
b5b9eb54	63	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
085f3065	64	#define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
b5b9eb54	65	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
085f3065 TI	66	#define DECLARE_TLV_DB_MINMAX(name, min_dB, max_dB) \
	67	unsigned int name[] = { TLV_DB_MINMAX_ITEM(min_dB, max_dB) }
	68	#define DECLARE_TLV_DB_MINMAX_MUTE(name, min_dB, max_dB) \
	69	unsigned int name[] = { TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) }
	70
063a40d9	71	/* linear volume between min_dB and max_dB (.01dB unit) */
55a29af5	72	#define TLV_DB_LINEAR_ITEM(min_dB, max_dB) \
b5b9eb54	73	TLV_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
063a40d9	74	#define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB) \
55a29af5 TI	75	unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }
	76
	77	/* dB range container */
	78	/* Each item is: <min> <max> <TLV> */
bf1d1c9b CL	79	#define TLV_DB_RANGE_ITEM(...) \
	80	TLV_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
	81	#define DECLARE_TLV_DB_RANGE(name, ...) \
	82	unsigned int name[] = { TLV_DB_RANGE_ITEM(__VA_ARGS__) }
55a29af5 TI	83	/* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
	84	#define TLV_DB_RANGE_HEAD(num) \
	85	SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)
063a40d9 TI	86
	87	#define TLV_DB_GAIN_MUTE -9999999
	88
2d3391ec TI	89	/*
	90	* channel-mapping TLV items
	91	* TLV length must match with num_channels
	92	*/
	93	#define SNDRV_CTL_TLVT_CHMAP_FIXED 0x101 /* fixed channel position */
	94	#define SNDRV_CTL_TLVT_CHMAP_VAR 0x102 /* channels freely swappable */
	95	#define SNDRV_CTL_TLVT_CHMAP_PAIRED 0x103 /* pair-wise swappable */
	96
42750b04	97	#endif /* __SOUND_TLV_H */