jpayne@69: /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
jpayne@69: /*
jpayne@69:  *   This program is free software; you can redistribute it and/or modify
jpayne@69:  *   it under the terms of the GNU General Public License as published by
jpayne@69:  *   the Free Software Foundation; either version 2 of the License, or
jpayne@69:  *   (at your option) any later version.
jpayne@69:  *
jpayne@69:  *   This program is distributed in the hope that it will be useful,
jpayne@69:  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
jpayne@69:  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jpayne@69:  *   GNU General Public License for more details.
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef __UAPI_SOUND_TLV_H
jpayne@69: #define __UAPI_SOUND_TLV_H
jpayne@69: 
jpayne@69: #define SNDRV_CTL_TLVT_CONTAINER 0	/* one level down - group of TLVs */
jpayne@69: #define SNDRV_CTL_TLVT_DB_SCALE	1       /* dB scale */
jpayne@69: #define SNDRV_CTL_TLVT_DB_LINEAR 2	/* linear volume */
jpayne@69: #define SNDRV_CTL_TLVT_DB_RANGE 3	/* dB range container */
jpayne@69: #define SNDRV_CTL_TLVT_DB_MINMAX 4	/* dB scale with min/max */
jpayne@69: #define SNDRV_CTL_TLVT_DB_MINMAX_MUTE 5	/* dB scale with min/max with mute */
jpayne@69: 
jpayne@69: /*
jpayne@69:  * channel-mapping TLV items
jpayne@69:  *  TLV length must match with num_channels
jpayne@69:  */
jpayne@69: #define SNDRV_CTL_TLVT_CHMAP_FIXED	0x101	/* fixed channel position */
jpayne@69: #define SNDRV_CTL_TLVT_CHMAP_VAR	0x102	/* channels freely swappable */
jpayne@69: #define SNDRV_CTL_TLVT_CHMAP_PAIRED	0x103	/* pair-wise swappable */
jpayne@69: 
jpayne@69: /*
jpayne@69:  * TLV structure is right behind the struct snd_ctl_tlv:
jpayne@69:  *   unsigned int type  	- see SNDRV_CTL_TLVT_*
jpayne@69:  *   unsigned int length
jpayne@69:  *   .... data aligned to sizeof(unsigned int), use
jpayne@69:  *        block_length = (length + (sizeof(unsigned int) - 1)) &
jpayne@69:  *                       ~(sizeof(unsigned int) - 1)) ....
jpayne@69:  */
jpayne@69: #define SNDRV_CTL_TLVD_ITEM(type, ...) \
jpayne@69: 	(type), SNDRV_CTL_TLVD_LENGTH(__VA_ARGS__), __VA_ARGS__
jpayne@69: #define SNDRV_CTL_TLVD_LENGTH(...) \
jpayne@69: 	((unsigned int)sizeof((const unsigned int[]) { __VA_ARGS__ }))
jpayne@69: 
jpayne@69: /* Accessor offsets for TLV data items */
jpayne@69: #define SNDRV_CTL_TLVO_TYPE		0
jpayne@69: #define SNDRV_CTL_TLVO_LEN		1
jpayne@69: 
jpayne@69: #define SNDRV_CTL_TLVD_CONTAINER_ITEM(...) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_CONTAINER, __VA_ARGS__)
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_CONTAINER(name, ...) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_CONTAINER_ITEM(__VA_ARGS__) \
jpayne@69: 	}
jpayne@69: 
jpayne@69: #define SNDRV_CTL_TLVD_DB_SCALE_MASK	0xffff
jpayne@69: #define SNDRV_CTL_TLVD_DB_SCALE_MUTE	0x10000
jpayne@69: #define SNDRV_CTL_TLVD_DB_SCALE_ITEM(min, step, mute) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_SCALE, \
jpayne@69: 			    (min), \
jpayne@69: 			    ((step) & SNDRV_CTL_TLVD_DB_SCALE_MASK) | \
jpayne@69: 			     ((mute) ? SNDRV_CTL_TLVD_DB_SCALE_MUTE : 0))
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_DB_SCALE(name, min, step, mute) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_DB_SCALE_ITEM(min, step, mute) \
jpayne@69: 	}
jpayne@69: 
jpayne@69: /* Accessor offsets for min, mute and step items in dB scale type TLV */
jpayne@69: #define SNDRV_CTL_TLVO_DB_SCALE_MIN		2
jpayne@69: #define SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP	3
jpayne@69: 
jpayne@69: /* dB scale specified with min/max values instead of step */
jpayne@69: #define SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_MINMAX, (min_dB), (max_dB))
jpayne@69: #define SNDRV_CTL_TLVD_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_MINMAX_MUTE, (min_dB), (max_dB))
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_DB_MINMAX(name, min_dB, max_dB) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_DB_MINMAX_ITEM(min_dB, max_dB) \
jpayne@69: 	}
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_DB_MINMAX_MUTE(name, min_dB, max_dB) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) \
jpayne@69: 	}
jpayne@69: 
jpayne@69: /* Accessor offsets for min, max items in db-minmax types of TLV. */
jpayne@69: #define SNDRV_CTL_TLVO_DB_MINMAX_MIN	2
jpayne@69: #define SNDRV_CTL_TLVO_DB_MINMAX_MAX	3
jpayne@69: 
jpayne@69: /* linear volume between min_dB and max_dB (.01dB unit) */
jpayne@69: #define SNDRV_CTL_TLVD_DB_LINEAR_ITEM(min_dB, max_dB) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_LINEAR, (min_dB), (max_dB))
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_DB_LINEAR(name, min_dB, max_dB) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_DB_LINEAR_ITEM(min_dB, max_dB) \
jpayne@69: 	}
jpayne@69: 
jpayne@69: /* Accessor offsets for min, max items in db-linear type of TLV. */
jpayne@69: #define SNDRV_CTL_TLVO_DB_LINEAR_MIN	2
jpayne@69: #define SNDRV_CTL_TLVO_DB_LINEAR_MAX	3
jpayne@69: 
jpayne@69: /* dB range container:
jpayne@69:  * Items in dB range container must be ordered by their values and by their
jpayne@69:  * dB values. This implies that larger values must correspond with larger
jpayne@69:  * dB values (which is also required for all other mixer controls).
jpayne@69:  */
jpayne@69: /* Each item is: <min> <max> <TLV> */
jpayne@69: #define SNDRV_CTL_TLVD_DB_RANGE_ITEM(...) \
jpayne@69: 	SNDRV_CTL_TLVD_ITEM(SNDRV_CTL_TLVT_DB_RANGE, __VA_ARGS__)
jpayne@69: #define SNDRV_CTL_TLVD_DECLARE_DB_RANGE(name, ...) \
jpayne@69: 	unsigned int name[] = { \
jpayne@69: 		SNDRV_CTL_TLVD_DB_RANGE_ITEM(__VA_ARGS__) \
jpayne@69: 	}
jpayne@69: 
jpayne@69: #define SNDRV_CTL_TLVD_DB_GAIN_MUTE	-9999999
jpayne@69: 
jpayne@69: #endif