LXR linux/include/sound/tlv.h

   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#define SNDRV_CTL_TLVT_CONTAINER 0      /* one level down - group of TLVs */
  35#define SNDRV_CTL_TLVT_DB_SCALE 1       /* dB scale */
  36#define SNDRV_CTL_TLVT_DB_LINEAR 2      /* linear volume */
  37#define SNDRV_CTL_TLVT_DB_RANGE 3       /* dB range container */
  38#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 */
  40
  41#define TLV_DB_SCALE_ITEM(min, step, mute)                      \
  42        SNDRV_CTL_TLVT_DB_SCALE, 2 * sizeof(unsigned int),      \
  43        (min), ((step) & 0xffff) | ((mute) ? 0x10000 : 0)
  44#define DECLARE_TLV_DB_SCALE(name, min, step, mute) \
  45        unsigned int name[] = { TLV_DB_SCALE_ITEM(min, step, mute) }
  46
  47/* dB scale specified with min/max values instead of step */
  48#define TLV_DB_MINMAX_ITEM(min_dB, max_dB)                      \
  49        SNDRV_CTL_TLVT_DB_MINMAX, 2 * sizeof(unsigned int),     \
  50        (min_dB), (max_dB)
  51#define TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB)                 \
  52        SNDRV_CTL_TLVT_DB_MINMAX_MUTE, 2 * sizeof(unsigned int),        \
  53        (min_dB), (max_dB)
  54#define DECLARE_TLV_DB_MINMAX(name, min_dB, max_dB) \
  55        unsigned int name[] = { TLV_DB_MINMAX_ITEM(min_dB, max_dB) }
  56#define DECLARE_TLV_DB_MINMAX_MUTE(name, min_dB, max_dB) \
  57        unsigned int name[] = { TLV_DB_MINMAX_MUTE_ITEM(min_dB, max_dB) }
  58
  59/* linear volume between min_dB and max_dB (.01dB unit) */
  60#define TLV_DB_LINEAR_ITEM(min_dB, max_dB)                  \
  61        SNDRV_CTL_TLVT_DB_LINEAR, 2 * sizeof(unsigned int), \
  62        (min_dB), (max_dB)
  63#define DECLARE_TLV_DB_LINEAR(name, min_dB, max_dB)     \
  64        unsigned int name[] = { TLV_DB_LINEAR_ITEM(min_dB, max_dB) }
  65
  66/* dB range container */
  67/* Each item is: <min> <max> <TLV> */
  68/* The below assumes that each item TLV is 4 words like DB_SCALE or LINEAR */
  69#define TLV_DB_RANGE_HEAD(num)                  \
  70        SNDRV_CTL_TLVT_DB_RANGE, 6 * (num) * sizeof(unsigned int)
  71
  72#define TLV_DB_GAIN_MUTE        -9999999
  73
  74#endif /* __SOUND_TLV_H */
  75