firmware/export/audiohw.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 by Christian Gmeiner
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 #ifndef _AUDIOHW_H_
  23 #define _AUDIOHW_H_
  24
  25 #include "config.h"
  26 #include <stdbool.h>
  27
  28 /* define some audiohw caps */
  29 #define TREBLE_CAP          (1 << 0)
  30 #define BASS_CAP            (1 << 1)
  31 #define BALANCE_CAP         (1 << 2)
  32 #define CLIPPING_CAP        (1 << 3)
  33 #define PRESCALER_CAP       (1 << 4)
  34 #define BASS_CUTOFF_CAP     (1 << 5)
  35 #define TREBLE_CUTOFF_CAP   (1 << 6)
  36
  37 #ifdef HAVE_UDA1380
  38 #include "uda1380.h"
  39 #elif defined(HAVE_WM8751)
  40 #include "wm8751.h"
  41 #elif defined(HAVE_WM8978)
  42 #include "wm8978.h"
  43 #elif defined(HAVE_WM8975)
  44 #include "wm8975.h"
  45 #elif defined(HAVE_WM8985)
  46 #include "wm8985.h"
  47 #elif defined(HAVE_WM8758)
  48 #include "wm8758.h"
  49 #elif defined(HAVE_WM8711) || defined(HAVE_WM8721) || \
  50       defined(HAVE_WM8731)
  51 #include "wm8731.h"
  52 #elif defined(HAVE_TLV320)
  53 #include "tlv320.h"
  54 #elif defined(HAVE_AS3514)
  55 #include "as3514.h"
  56 #elif defined(HAVE_MAS35XX)
  57 #include "mas35xx.h"
  58 #elif defined(HAVE_TSC2100)
  59 #include "tsc2100.h"
  60 #elif defined(HAVE_JZ4740_CODEC)
  61 #include "jz4740-codec.h"
  62 #elif defined(HAVE_AK4537)
  63 #include "ak4537.h"
  64 #endif
  65
  66 /* convert caps into defines */
  67 #ifdef AUDIOHW_CAPS
  68 #if (AUDIOHW_CAPS & TREBLE_CAP)
  69 #define AUDIOHW_HAVE_TREBLE
  70 #endif
  71
  72 #if (AUDIOHW_CAPS & BASS_CAP)
  73 #define AUDIOHW_HAVE_BASS
  74 #endif
  75
  76 #if (AUDIOHW_CAPS & BALANCE_CAP)
  77 #define AUDIOHW_HAVE_BALANCE
  78 #endif
  79
  80 #if (AUDIOHW_CAPS & CLIPPING_CAP)
  81 #define AUDIOHW_HAVE_CLIPPING
  82 #endif
  83
  84 #if (AUDIOHW_CAPS & PRESCALER_CAP)
  85 #define AUDIOHW_HAVE_PRESCALER
  86 #endif
  87
  88 #if (AUDIOHW_CAPS & BASS_CUTOFF_CAP)
  89 #define AUDIOHW_HAVE_BASS_CUTOFF
  90 #endif
  91
  92 #if (AUDIOHW_CAPS & TREBLE_CUTOFF_CAP)
  93 #define AUDIOHW_HAVE_TREBLE_CUTOFF
  94 #endif
  95 #endif /* AUDIOHW_CAPS */
  96
  97 enum {
  98     SOUND_VOLUME = 0,
  99     SOUND_BASS,
 100     SOUND_TREBLE,
 101     SOUND_BALANCE,
 102     SOUND_CHANNELS,
 103     SOUND_STEREO_WIDTH,
 104 #if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
 105     SOUND_LOUDNESS,
 106     SOUND_AVC,
 107     SOUND_MDB_STRENGTH,
 108     SOUND_MDB_HARMONICS,
 109     SOUND_MDB_CENTER,
 110     SOUND_MDB_SHAPE,
 111     SOUND_MDB_ENABLE,
 112     SOUND_SUPERBASS,
 113 #endif
 114 #if defined(HAVE_RECORDING)
 115     SOUND_LEFT_GAIN,
 116     SOUND_RIGHT_GAIN,
 117     SOUND_MIC_GAIN,
 118 #endif
 119 #if defined(AUDIOHW_HAVE_BASS_CUTOFF)
 120     SOUND_BASS_CUTOFF,
 121 #endif
 122 #if defined(AUDIOHW_HAVE_TREBLE_CUTOFF)
 123     SOUND_TREBLE_CUTOFF,
 124 #endif
 125     SOUND_LAST_SETTING, /* Keep this last */
 126 };
 127
 128 enum Channel {
 129     SOUND_CHAN_STEREO,
 130     SOUND_CHAN_MONO,
 131     SOUND_CHAN_CUSTOM,
 132     SOUND_CHAN_MONO_LEFT,
 133     SOUND_CHAN_MONO_RIGHT,
 134     SOUND_CHAN_KARAOKE,
 135     SOUND_CHAN_NUM_MODES,
 136 };
 137
 138 struct sound_settings_info {
 139     const char *unit;
 140     char numdecimals;
 141     char steps;
 142     short minval;
 143     short maxval;
 144     short defaultval;
 145 };
 146
 147 /* This struct is used by every driver to export its min/max/default values for
 148  * its audio settings. Keep in mind that the order must be correct! */
 149 extern const struct sound_settings_info audiohw_settings[];
 150
 151 /* All usable functions implemented by a audio codec drivers. Most of
 152  * the function in sound settings are only called, when in audio codecs
 153  * .h file suitable defines are added.
 154  */
 155
 156 /**
 157  * Initialize audio codec to a well defined state. Includes SoC-specific
 158  * setup.
 159  */
 160 void audiohw_init(void);
 161
 162 /**
 163  * Do initial audio codec setup. Usually called from audiohw_init.
 164  */
 165 void audiohw_preinit(void);
 166
 167 /**
 168  * Do some stuff (codec related) after audiohw_init that needs to be
 169  * delayed such as enabling outputs to prevent popping. This lets
 170  * other inits in the system complete in the meantime.
 171  */
 172 void audiohw_postinit(void);
 173
 174 /**
 175  * Close audio codec.
 176  */
 177 void audiohw_close(void);
 178
 179 #ifdef AUDIOHW_HAVE_CLIPPING
 180  /**
 181  * Set new volume value
 182  * @param val to set.
 183  * NOTE: AUDIOHW_CAPS need to contain
 184  *          CLIPPING_CAP
 185  */
 186 void audiohw_set_volume(int val);
 187 #endif
 188
 189 #ifdef AUDIOHW_HAVE_PRESCALER
 190 /**
 191  * Set new prescaler value.
 192  * @param val to set.
 193  * NOTE: AUDIOHW_CAPS need to contain
 194  *          PRESCALER_CAP
 195  */
 196 void audiohw_set_prescaler(int val);
 197 #endif
 198
 199 #ifdef AUDIOHW_HAVE_BALANCE
 200 /**
 201  * Set new balance value
 202  * @param val to set.
 203  * NOTE: AUDIOHW_CAPS need to contain
 204  *          BALANCE_CAP
 205  */
 206 void audiohw_set_balance(int val);
 207 #endif
 208
 209 /**
 210  * Mute or enable sound.
 211  * @param mute true or false.
 212  */
 213 void audiohw_mute(bool mute);
 214
 215 #ifdef AUDIOHW_HAVE_TREBLE
 216 /**
 217  * Set new treble value.
 218  * @param val to set.
 219  * NOTE: AUDIOHW_CAPS need to contain
 220  *          TREBLE_CAP
 221  */
 222 void audiohw_set_treble(int val);
 223 #endif
 224
 225 #ifdef AUDIOHW_HAVE_BASS
 226 /**
 227  * Set new bass value.
 228  * @param val to set.
 229  * NOTE: AUDIOHW_CAPS need to contain
 230  *          BASS_CAP
 231  */
 232 void audiohw_set_bass(int val);
 233 #endif
 234
 235 #ifdef AUDIOHW_HAVE_BASS_CUTOFF
 236 /**
 237  * Set new bass cut off value.
 238  * @param val to set.
 239  * NOTE: AUDIOHW_CAPS need to contain
 240  *          BASS_CUTOFF_CAP
 241  */
 242 void audiohw_set_bass_cutoff(int val);
 243 #endif
 244
 245 #ifdef AUDIOHW_HAVE_TREBLE_CUTOFF
 246 /**
 247  * Set new treble cut off value.
 248  * @param val to set.
 249  * NOTE: AUDIOHW_CAPS need to contain
 250  *          TREBLE_CUTOFF_CAP
 251  */
 252 void audiohw_set_treble_cutoff(int val);
 253 #endif
 254
 255 void audiohw_set_frequency(int fsel);
 256
 257 #ifdef HAVE_RECORDING
 258
 259 /**
 260  * Enable recording.
 261  * @param source_mic if this is true, we want to record from microphone,
 262  *                   else we want to record FM/LineIn.
 263  */
 264 void audiohw_enable_recording(bool source_mic);
 265
 266 /**
 267  * Disable recording.
 268  */
 269 void audiohw_disable_recording(void);
 270
 271 /**
 272  * Set gain of recording source.
 273  * @param left gain value.
 274  * @param right will not be used if recording from micophone (mono).
 275  * @param type AUDIO_GAIN_MIC, AUDIO_GAIN_LINEIN.
 276  */
 277 void audiohw_set_recvol(int left, int right, int type);
 278
 279 #endif /*HAVE_RECORDING*/
 280
 281 #if defined(HAVE_RECORDING) || defined(HAVE_FMRADIO_IN)
 282
 283 /**
 284  * Enable or disable recording monitor.
 285  * @param enable ture or false.
 286  */
 287 void audiohw_set_monitor(bool enable);
 288
 289 #endif /* HAVE_RECORDING || HAVE_FMRADIO_IN */
 290
 291 #if CONFIG_CODEC != SWCODEC
 292
 293 /* functions which are only used by mas35xx codecs, but are also
 294    aviable on SWCODECS through dsp */
 295
 296 /**
 297  * Set channel configuration.
 298  * @param val new channel value (see enum Channel).
 299  */
 300 void audiohw_set_channel(int val);
 301
 302 /**
 303  * Set stereo width.
 304  * @param val new stereo width value.
 305  */
 306 void audiohw_set_stereo_width(int val);
 307
 308 #endif /* CONFIG_CODEC != SWCODEC */
 309
 310 #ifdef HAVE_SPEAKER
 311
 312 void audiohw_enable_speaker(bool on);
 313
 314 #endif /* HAVE_SPEAKER */
 315
 316 #endif /* _AUDIOHW_H_ */