blob: e11e179420a11fb07bce24e48e960bfdba9671a4 [file] [log] [blame]
Jaroslav Kysela42750b02006-06-01 18:34:01 +02001#ifndef __SOUND_TLV_H
2#define __SOUND_TLV_H
3
4/*
5 * Advanced Linux Sound Architecture - ALSA - Driver
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) 2006 by Jaroslav Kysela <perex@perex.cz>
Jaroslav Kysela42750b02006-06-01 18:34:01 +02007 *
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 */
Takashi Iwai063a40d2006-08-28 13:20:13 +020036#define SNDRV_CTL_TLVT_DB_LINEAR 2 /* linear volume */
Takashi Iwai55a29af2006-09-06 12:15:34 +020037#define SNDRV_CTL_TLVT_DB_RANGE 3 /* dB range container */
Takashi Iwai085f3062009-06-16 13:57:07 +020038#define SNDRV_CTL_TLVT_DB_MINMAX 4 /* dB scale with min/max */
39#define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5 /* dB scale with min/max with mute */
Jaroslav Kysela42750b02006-06-01 18:34:01 +020040
Clemens Ladischb5b9eb52011-11-20 16:22:24 +010041#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
Clemens Ladisch570aef52011-12-02 23:20:00 +010046#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
Takashi Iwaic08d9162010-10-17 10:40:53 +020051#define TLV_DB_SCALE_MASK 0xffff
52#define TLV_DB_SCALE_MUTE 0x10000
Takashi Iwai55a29af2006-09-06 12:15:34 +020053#define TLV_DB_SCALE_ITEM(min, step, mute) \
Clemens Ladischb5b9eb52011-11-20 16:22:24 +010054 TLV_ITEM(SNDRV_CTL_TLVT_DB_SCALE, \
55 (min), \
56 ((step) & TLV_DB_SCALE_MASK) | \
57 ((mute) ? TLV_DB_SCALE_MUTE : 0))
Jaroslav Kysela42750b02006-06-01 18:34:01 +020058#define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
Takashi Iwai55a29af2006-09-06 12:15:34 +020059 unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }
Jaroslav Kysela42750b02006-06-01 18:34:01 +020060
Takashi Iwai085f3062009-06-16 13:57:07 +020061/* dB scale specified with min/max values instead of step */
62#define TLV_DB_MINMAX_ITEM(min_dB, max_dB) \
Clemens Ladischb5b9eb52011-11-20 16:22:24 +010063 TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
Takashi Iwai085f3062009-06-16 13:57:07 +020064#define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
Clemens Ladischb5b9eb52011-11-20 16:22:24 +010065 TLV_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
Takashi Iwai085f3062009-06-16 13:57:07 +020066#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
Takashi Iwai063a40d2006-08-28 13:20:13 +020071/* linear volume between min_dB and max_dB (.01dB unit) */
Takashi Iwai55a29af2006-09-06 12:15:34 +020072#define TLV_DB_LINEAR_ITEM(min_dB, max_dB) \
Clemens Ladischb5b9eb52011-11-20 16:22:24 +010073 TLV_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
Takashi Iwai063a40d2006-08-28 13:20:13 +020074#define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB) \
Takashi Iwai55a29af2006-09-06 12:15:34 +020075 unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }
76
David Henningssond24f5a92013-05-08 15:33:11 +020077/* dB range container:
78 * Items in dB range container must be ordered by their values and by their
79 * dB values. This implies that larger values must correspond with larger
80 * dB values (which is also required for all other mixer controls).
81 */
Takashi Iwai55a29af2006-09-06 12:15:34 +020082/* Each item is: <min> <max> <TLV> */
Clemens Ladischbf1d1c92011-11-20 17:17:35 +010083#define TLV_DB_RANGE_ITEM(...) \
84 TLV_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
85#define DECLARE_TLV_DB_RANGE(name, ...) \
86 unsigned int name[] = { TLV_DB_RANGE_ITEM(__VA_ARGS__) }
Takashi Iwai55a29af2006-09-06 12:15:34 +020087/* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
88#define TLV_DB_RANGE_HEAD(num) \
89 SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)
Takashi Iwai063a40d2006-08-28 13:20:13 +020090
91#define TLV_DB_GAIN_MUTE -9999999
92
Takashi Iwai2d3391e2012-07-27 18:27:00 +020093/*
94 * channel-mapping TLV items
95 * TLV length must match with num_channels
96 */
97#define SNDRV_CTL_TLVT_CHMAP_FIXED 0x101 /* fixed channel position */
98#define SNDRV_CTL_TLVT_CHMAP_VAR 0x102 /* channels freely swappable */
99#define SNDRV_CTL_TLVT_CHMAP_PAIRED 0x103 /* pair-wise swappable */
100
Jaroslav Kysela42750b02006-06-01 18:34:01 +0200101#endif /* __SOUND_TLV_H */