xref: /openbmc/linux/include/sound/tlv.h (revision f3539c12)
1 #ifndef __SOUND_TLV_H
2 #define __SOUND_TLV_H
3 
4 /*
5  *  Advanced Linux Sound Architecture - ALSA - Driver
6  *  Copyright (c) 2006 by Jaroslav Kysela <perex@perex.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 /*
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 #include <uapi/sound/tlv.h>
35 
36 #define TLV_ITEM(type, ...) \
37 	(type), TLV_LENGTH(__VA_ARGS__), __VA_ARGS__
38 #define TLV_LENGTH(...) \
39 	((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))
40 
41 #define TLV_CONTAINER_ITEM(...) \
42 	TLV_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
43 #define DECLARE_TLV_CONTAINER(name, ...) \
44 	unsigned int name[] = { TLV_CONTAINER_ITEM(__VA_ARGS__) }
45 
46 #define TLV_DB_SCALE_MASK	0xffff
47 #define TLV_DB_SCALE_MUTE	0x10000
48 #define TLV_DB_SCALE_ITEM(min, step, mute)			\
49 	TLV_ITEM(SNDRV_CTL_TLVT_DB_SCALE,			\
50 		 (min),					\
51 		 ((step) & TLV_DB_SCALE_MASK) |		\
52 			((mute) ? TLV_DB_SCALE_MUTE : 0))
53 #define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
54 	unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }
55 
56 /* dB scale specified with min/max values instead of step */
57 #define TLV_DB_MINMAX_ITEM(min_dB, max_dB)			\
58 	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
59 #define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB)			\
60 	TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
61 #define DECLARE_TLV_DB_MINMAX(name, min_dB, max_dB) \
62 	unsigned int name[] = { TLV_DB_MINMAX_ITEM(min_dB, max_dB) }
63 #define DECLARE_TLV_DB_MINMAX_MUTE(name, min_dB, max_dB) \
64 	unsigned int name[] = { TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) }
65 
66 /* linear volume between min_dB and max_dB (.01dB unit) */
67 #define TLV_DB_LINEAR_ITEM(min_dB, max_dB)		    \
68 	TLV_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
69 #define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB)	\
70 	unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }
71 
72 /* dB range container:
73  * Items in dB range container must be ordered by their values and by their
74  * dB values. This implies that larger values must correspond with larger
75  * dB values (which is also required for all other mixer controls).
76  */
77 /* Each item is: <min> <max> <TLV> */
78 #define TLV_DB_RANGE_ITEM(...) \
79 	TLV_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
80 #define DECLARE_TLV_DB_RANGE(name, ...) \
81 	unsigned int name[] = { TLV_DB_RANGE_ITEM(__VA_ARGS__) }
82 /* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
83 #define TLV_DB_RANGE_HEAD(num)			\
84 	SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)
85 
86 #define TLV_DB_GAIN_MUTE	-9999999
87 
88 #endif /* __SOUND_TLV_H */
89