xref: /openbmc/linux/include/uapi/sound/tlv.h (revision 65417d9f)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  *   This program is free software; you can redistribute it and/or modify
4  *   it under the terms of the GNU General Public License as published by
5  *   the Free Software Foundation; either version 2 of the License, or
6  *   (at your option) any later version.
7  *
8  *   This program is distributed in the hope that it will be useful,
9  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
10  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  *   GNU General Public License for more details.
12  */
13 
14 #ifndef __UAPI_SOUND_TLV_H
15 #define __UAPI_SOUND_TLV_H
16 
17 #define SNDRV_CTL_TLVT_CONTAINER 0	/* one level down - group of TLVs */
18 #define SNDRV_CTL_TLVT_DB_SCALE	1       /* dB scale */
19 #define SNDRV_CTL_TLVT_DB_LINEAR 2	/* linear volume */
20 #define SNDRV_CTL_TLVT_DB_RANGE 3	/* dB range container */
21 #define SNDRV_CTL_TLVT_DB_MINMAX 4	/* dB scale with min/max */
22 #define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5	/* dB scale with min/max with mute */
23 
24 /*
25  * channel-mapping TLV items
26  *  TLV length must match with num_channels
27  */
28 #define SNDRV_CTL_TLVT_CHMAP_FIXED	0x101	/* fixed channel position */
29 #define SNDRV_CTL_TLVT_CHMAP_VAR	0x102	/* channels freely swappable */
30 #define SNDRV_CTL_TLVT_CHMAP_PAIRED	0x103	/* pair-wise swappable */
31 
32 /*
33  * TLV structure is right behind the struct snd_ctl_tlv:
34  *   unsigned int type  	- see SNDRV_CTL_TLVT_*
35  *   unsigned int length
36  *   .... data aligned to sizeof(unsigned int), use
37  *        block_length = (length + (sizeof(unsigned int) - 1)) &
38  *                       ~(sizeof(unsigned int) - 1)) ....
39  */
40 #define SNDRV_CTL_TLVD_ITEM(type, ...) \
41 	(type), SNDRV_CTL_TLVD_LENGTH(__VA_ARGS__), __VA_ARGS__
42 #define SNDRV_CTL_TLVD_LENGTH(...) \
43 	((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))
44 
45 #define SNDRV_CTL_TLVD_CONTAINER_ITEM(...) \
46 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
47 #define SNDRV_CTL_TLVD_DECLARE_CONTAINER(name, ...) \
48 	unsigned int name[] = { \
49 		SNDRV_CTL_TLVD_CONTAINER_ITEM(__VA_ARGS__) \
50 	}
51 
52 #define SNDRV_CTL_TLVD_DB_SCALE_MASK	0xffff
53 #define SNDRV_CTL_TLVD_DB_SCALE_MUTE	0x10000
54 #define SNDRV_CTL_TLVD_DB_SCALE_ITEM(min, step, mute) \
55 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_SCALE, \
56 			    (min), \
57 			    ((step) & SNDRV_CTL_TLVD_DB_SCALE_MASK) | \
58 			     ((mute) ? SNDRV_CTL_TLVD_DB_SCALE_MUTE : 0))
59 #define SNDRV_CTL_TLVD_DECLARE_DB_SCALE(name, min, step, mute) \
60 	unsigned int name[] = { \
61 		SNDRV_CTL_TLVD_DB_SCALE_ITEM(min, step, mute) \
62 	}
63 
64 /* dB scale specified with min/max values instead of step */
65 #define SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
66 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
67 #define SNDRV_CTL_TLVD_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
68 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
69 #define SNDRV_CTL_TLVD_DECLARE_DB_MINMAX(name, min_dB, max_dB) \
70 	unsigned int name[] = { \
71 		SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
72 	}
73 #define SNDRV_CTL_TLVD_DECLARE_DB_MINMAX_MUTE(name, min_dB, max_dB) \
74 	unsigned int name[] = { \
75 		SNDRV_CTL_TLVD_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
76 	}
77 
78 /* linear volume between min_dB and max_dB (.01dB unit) */
79 #define SNDRV_CTL_TLVD_DB_LINEAR_ITEM(min_dB, max_dB) \
80 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
81 #define SNDRV_CTL_TLVD_DECLARE_DB_LINEAR(name, min_dB, max_dB) \
82 	unsigned int name[] = { \
83 		SNDRV_CTL_TLVD_DB_LINEAR_ITEM(min_dB, max_dB) \
84 	}
85 
86 /* dB range container:
87  * Items in dB range container must be ordered by their values and by their
88  * dB values. This implies that larger values must correspond with larger
89  * dB values (which is also required for all other mixer controls).
90  */
91 /* Each item is: <min> <max> <TLV> */
92 #define SNDRV_CTL_TLVD_DB_RANGE_ITEM(...) \
93 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
94 #define SNDRV_CTL_TLVD_DECLARE_DB_RANGE(name, ...) \
95 	unsigned int name[] = { \
96 		SNDRV_CTL_TLVD_DB_RANGE_ITEM(__VA_ARGS__) \
97 	}
98 
99 #define SNDRV_CTL_TLVD_DB_GAIN_MUTE	-9999999
100 
101 #endif
102