firmware/drivers/audio/wm8978.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2008 by Michael Sevakis
  11  *
  12  * Driver for WM8978 audio codec
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  20  * KIND, either express or implied.
  21  *
  22  ****************************************************************************/
  23 #include "config.h"
  24 #include "system.h"
  25 #include "audiohw.h"
  26 #include "wmcodec.h"
  27 #include "audio.h"
  28 //#define LOGF_ENABLE
  29 #include "logf.h"
  30
  31 /* #define to help adjust lower volume limit */
  32 #define HW_VOL_MIN                0
  33 #define HW_VOL_MUTE               0
  34 #define HW_VOL_MAX               96
  35 #define HW_VOL_ANA_MIN            0
  36 #define HW_VOL_ANA_MAX           63
  37 #define HW_VOL_DIG_MAX          255
  38 #define HW_VOL_DIG_THRESHOLD    (HW_VOL_MAX - HW_VOL_ANA_MAX)
  39 #define HW_VOL_DIG_MIN          (HW_VOL_DIG_MAX - 2*HW_VOL_DIG_THRESHOLD)
  40
  41 /* TODO: Define/refine an API for special hardware steps outside the
  42  * main codec driver such as special GPIO handling. */
  43 extern void audiohw_enable_headphone_jack(bool enable);
  44
  45 const struct sound_settings_info audiohw_settings[] =
  46 {
  47     [SOUND_VOLUME]        = {"dB", 0,  1, -90,   6, -25},
  48     [SOUND_BASS]          = {"dB", 0,  1, -12,  12,   0},
  49     [SOUND_TREBLE]        = {"dB", 0,  1, -12,  12,   0},
  50     [SOUND_BALANCE]       = {"%",  0,  1,-100, 100,   0},
  51     [SOUND_CHANNELS]      = {"",   0,  1,   0,   5,   0},
  52     [SOUND_STEREO_WIDTH]  = {"%",  0,  5,   0, 250, 100},
  53 #ifdef HAVE_RECORDING
  54     [SOUND_LEFT_GAIN]     = {"dB", 1,  1,-128,  96,   0},
  55     [SOUND_RIGHT_GAIN]    = {"dB", 1,  1,-128,  96,   0},
  56 #if 0
  57     [SOUND_MIC_GAIN]      = {"dB", 1,  1,-128, 108,  16},
  58 #endif
  59 #endif
  60 #if 0
  61     [SOUND_BASS_CUTOFF]   = {"",   0,  1,   1,   4,   1},
  62     [SOUND_TREBLE_CUTOFF] = {"",   0,  1,   1,   4,   1},
  63 #endif
  64 };
  65
  66 static uint16_t wmc_regs[WMC_NUM_REGISTERS] =
  67 {
  68     /* Initialized with post-reset default values - the 2-wire interface
  69      * cannot be read. Or-in additional bits desired for some registers. */
  70     [0 ... WMC_NUM_REGISTERS-1]   = 0x8000, /* To ID invalids in gaps */
  71     [WMC_SOFTWARE_RESET]          = 0x000,
  72     [WMC_POWER_MANAGEMENT1]       = 0x000,
  73     [WMC_POWER_MANAGEMENT2]       = 0x000,
  74     [WMC_POWER_MANAGEMENT3]       = 0x000,
  75     [WMC_AUDIO_INTERFACE]         = 0x050,
  76     [WMC_COMPANDING_CTRL]         = 0x000,
  77     [WMC_CLOCK_GEN_CTRL]          = 0x140,
  78     [WMC_ADDITIONAL_CTRL]         = 0x000,
  79     [WMC_GPIO]                    = 0x000,
  80     [WMC_JACK_DETECT_CONTROL1]    = 0x000,
  81     [WMC_DAC_CONTROL]             = 0x000,
  82     [WMC_LEFT_DAC_DIGITAL_VOL]    = 0x0ff | WMC_VU,
  83     [WMC_RIGHT_DAC_DIGITAL_VOL]   = 0x0ff | WMC_VU,
  84     [WMC_JACK_DETECT_CONTROL2]    = 0x000,
  85     [WMC_ADC_CONTROL]             = 0x100,
  86     [WMC_LEFT_ADC_DIGITAL_VOL]    = 0x0ff | WMC_VU,
  87     [WMC_RIGHT_ADC_DIGITAL_VOL]   = 0x0ff | WMC_VU,
  88     [WMC_EQ1_LOW_SHELF]           = 0x12c,
  89     [WMC_EQ2_PEAK1]               = 0x02c,
  90     [WMC_EQ3_PEAK2]               = 0x02c,
  91     [WMC_EQ4_PEAK3]               = 0x02c,
  92     [WMC_EQ5_HIGH_SHELF]          = 0x02c,
  93     [WMC_DAC_LIMITER1]            = 0x032,
  94     [WMC_DAC_LIMITER2]            = 0x000,
  95     [WMC_NOTCH_FILTER1]           = 0x000,
  96     [WMC_NOTCH_FILTER2]           = 0x000,
  97     [WMC_NOTCH_FILTER3]           = 0x000,
  98     [WMC_NOTCH_FILTER4]           = 0x000,
  99     [WMC_ALC_CONTROL1]            = 0x038,
 100     [WMC_ALC_CONTROL2]            = 0x00b,
 101     [WMC_ALC_CONTROL3]            = 0x032,
 102     [WMC_NOISE_GATE]              = 0x000,
 103     [WMC_PLL_N]                   = 0x008,
 104     [WMC_PLL_K1]                  = 0x00c,
 105     [WMC_PLL_K2]                  = 0x093,
 106     [WMC_PLL_K3]                  = 0x0e9,
 107     [WMC_3D_CONTROL]              = 0x000,
 108     [WMC_BEEP_CONTROL]            = 0x000,
 109     [WMC_INPUT_CTRL]              = 0x033,
 110     [WMC_LEFT_INP_PGA_GAIN_CTRL]  = 0x010,
 111     [WMC_RIGHT_INP_PGA_GAIN_CTRL] = 0x010,
 112     [WMC_LEFT_ADC_BOOST_CTRL]     = 0x100,
 113     [WMC_RIGHT_ADC_BOOST_CTRL]    = 0x100,
 114     [WMC_OUTPUT_CTRL]             = 0x002,
 115     [WMC_LEFT_MIXER_CTRL]         = 0x001,
 116     [WMC_RIGHT_MIXER_CTRL]        = 0x001,
 117     [WMC_LOUT1_HP_VOLUME_CTRL]    = 0x039 | WMC_VU | WMC_ZC,
 118     [WMC_ROUT1_HP_VOLUME_CTRL]    = 0x039 | WMC_VU | WMC_ZC,
 119     [WMC_LOUT2_SPK_VOLUME_CTRL]   = 0x039 | WMC_VU | WMC_ZC,
 120     [WMC_ROUT2_SPK_VOLUME_CTRL]   = 0x039 | WMC_VU | WMC_ZC,
 121     [WMC_OUT3_MIXER_CTRL]         = 0x001,
 122     [WMC_OUT4_MONO_MIXER_CTRL]    = 0x001,
 123 };
 124
 125 struct
 126 {
 127     int vol_l;
 128     int vol_r;
 129     bool ahw_mute;
 130 } wmc_vol =
 131 {
 132     HW_VOL_MUTE, HW_VOL_MUTE, false
 133 };
 134
 135 static void wmc_write(unsigned int reg, unsigned int val)
 136 {
 137     if (reg >= WMC_NUM_REGISTERS || (wmc_regs[reg] & 0x8000))
 138     {
 139         logf("wm8978 invalid register: %d", reg);
 140         return;
 141     }
 142
 143     wmc_regs[reg] = val & ~0x8000;
 144     wmcodec_write(reg, val);
 145 }
 146
 147 static void wmc_set(unsigned int reg, unsigned int bits)
 148 {
 149     wmc_write(reg, wmc_regs[reg] | bits);
 150 }
 151
 152 static void wmc_clear(unsigned int reg, unsigned int bits)
 153 {
 154     wmc_write(reg, wmc_regs[reg] & ~bits);
 155 }
 156
 157 static void wmc_write_masked(unsigned int reg, unsigned int bits,
 158                              unsigned int mask)
 159 {
 160     wmc_write(reg, (wmc_regs[reg] & ~mask) | (bits & mask));
 161 }
 162
 163 /* convert tenth of dB volume (-890..60) to master volume register value
 164  * (000000...111111) */
 165 int tenthdb2master(int db)
 166 {
 167     /* -90dB to +6dB 1dB steps (96 levels) 7bits */
 168     /* 1100000 ==  +6dB  (0x60,96)               */
 169     /* 1101010 ==   0dB  (0x5a,90)               */
 170     /* 1000001 == -57dB  (0x21,33,DAC)           */
 171     /* 0000001 == -89dB  (0x01,01)               */
 172     /* 0000000 == -90dB  (0x00,00,Mute)          */
 173     if (db <= VOLUME_MIN)
 174     {
 175         return 0x0;
 176     }
 177     else
 178     {
 179         return (db - VOLUME_MIN) / 10;
 180     }
 181 }
 182
 183 void audiohw_preinit(void)
 184 {
 185     /* 1. Turn on external power supplies. Wait for supply voltage to settle. */
 186
 187     /* Step 1 should be completed already. Reset and return all registers to
 188      * defaults */
 189     wmcodec_write(WMC_SOFTWARE_RESET, 0xff);
 190     sleep(HZ/10);
 191
 192     /* 2. Mute all analogue outputs */
 193     wmc_set(WMC_LOUT1_HP_VOLUME_CTRL, WMC_MUTE | HW_VOL_ANA_MIN);
 194     wmc_set(WMC_ROUT1_HP_VOLUME_CTRL, WMC_MUTE | HW_VOL_ANA_MIN);
 195     wmc_set(WMC_LOUT2_SPK_VOLUME_CTRL, WMC_MUTE);
 196     wmc_set(WMC_ROUT2_SPK_VOLUME_CTRL, WMC_MUTE);
 197     wmc_set(WMC_OUT3_MIXER_CTRL, WMC_MUTE);
 198     wmc_set(WMC_OUT4_MONO_MIXER_CTRL, WMC_MUTE);
 199     wmc_set(WMC_INPUT_CTRL, 0x000);
 200
 201     /* 3. Set L/RMIXEN = 1 and DACENL/R = 1 in register R3. */
 202     wmc_write(WMC_POWER_MANAGEMENT3,
 203               WMC_RMIXEN | WMC_LMIXEN | WMC_DACENR | WMC_DACENL);
 204
 205     /* 4. Set BUFIOEN = 1 and VMIDSEL[1:0] to required value in register
 206      *    R1. Wait for VMID supply to settle */
 207     wmc_write(WMC_POWER_MANAGEMENT1, WMC_BUFIOEN | WMC_VMIDSEL_300K);
 208     sleep(HZ/10);
 209
 210     /* 5. Set BIASEN = 1 in register R1. */
 211     wmc_set(WMC_POWER_MANAGEMENT1, WMC_BIASEN);
 212 }
 213
 214 void audiohw_postinit(void)
 215 {
 216     sleep(HZ);
 217
 218     /* 6. Set L/ROUTEN = 1 in register R2. */
 219     wmc_write(WMC_POWER_MANAGEMENT2, WMC_LOUT1EN | WMC_ROUT1EN);
 220
 221     /* 7. Enable other mixers as required */
 222
 223     /* 8. Enable other outputs as required */
 224
 225     /* 9. Set remaining registers */
 226     wmc_write(WMC_AUDIO_INTERFACE, WMC_WL_16 | WMC_FMT_I2S
 227                                    | WMC_DACLRSWAP | WMC_ADCLRSWAP);
 228     wmc_write(WMC_DAC_CONTROL, WMC_DACOSR_128 | WMC_AMUTE);
 229
 230     /* Specific to HW clocking */
 231     wmc_write(WMC_CLOCK_GEN_CTRL, WMC_MCLKDIV_1_5 | WMC_BCLKDIV_8 | WMC_MS);
 232     wmc_write(WMC_ADDITIONAL_CTRL, WMC_SR_48KHZ); /* 44.1 */
 233
 234     /* ADC silenced */
 235     wmc_write_masked(WMC_LEFT_ADC_DIGITAL_VOL, 0x00, WMC_DVOL);
 236     wmc_write_masked(WMC_RIGHT_ADC_DIGITAL_VOL, 0x00, WMC_DVOL);
 237
 238     audiohw_enable_headphone_jack(true);
 239 }
 240
 241 void audiohw_set_headphone_vol(int vol_l, int vol_r)
 242 {
 243     int prev_l = wmc_vol.vol_l;
 244     int prev_r = wmc_vol.vol_r;
 245     int dac_l, dac_r;
 246
 247     wmc_vol.vol_l = vol_l;
 248     wmc_vol.vol_r = vol_r;
 249
 250     /* When analogue volume falls below -57dB (0x00) start attenuating the
 251      * DAC volume */
 252     if (vol_l >= HW_VOL_DIG_THRESHOLD)
 253     {
 254         if (vol_l > HW_VOL_MAX)
 255             vol_l = HW_VOL_MAX;
 256
 257         dac_l = HW_VOL_DIG_MAX;
 258         vol_l -= HW_VOL_DIG_THRESHOLD;
 259     }
 260     else
 261     {
 262         if (vol_l < HW_VOL_MIN)
 263             vol_l = HW_VOL_MIN;
 264
 265         dac_l = 2*vol_l + HW_VOL_DIG_MIN;
 266         vol_l = HW_VOL_ANA_MIN;
 267     }
 268
 269     if (vol_r >= HW_VOL_DIG_THRESHOLD)
 270     {
 271         if (vol_r > HW_VOL_MAX)
 272             vol_r = HW_VOL_MAX;
 273
 274         dac_r = HW_VOL_DIG_MAX;
 275         vol_r -= HW_VOL_DIG_THRESHOLD;
 276     }
 277     else
 278     {
 279         if (vol_r < HW_VOL_MIN)
 280             vol_r = HW_VOL_MIN;
 281
 282         dac_r = 2*vol_r + HW_VOL_DIG_MIN;
 283         vol_r = HW_VOL_ANA_MIN;
 284     }
 285
 286     /* Have to write both channels always to have the latching work */
 287     wmc_write_masked(WMC_LEFT_DAC_DIGITAL_VOL, dac_l, WMC_DVOL);
 288     wmc_write_masked(WMC_LOUT1_HP_VOLUME_CTRL, vol_l, WMC_AVOL);
 289     wmc_write_masked(WMC_RIGHT_DAC_DIGITAL_VOL, dac_r, WMC_DVOL);
 290     wmc_write_masked(WMC_ROUT1_HP_VOLUME_CTRL, vol_r, WMC_AVOL);
 291
 292     if (wmc_vol.vol_l > HW_VOL_MUTE)
 293     {
 294         /* Not muted and going up from mute level? */
 295         if (prev_l <= HW_VOL_MUTE && !wmc_vol.ahw_mute)
 296             wmc_clear(WMC_LOUT1_HP_VOLUME_CTRL, WMC_MUTE);
 297     }
 298     else
 299     {
 300         /* Going to mute level? */
 301         if (prev_l > HW_VOL_MUTE)
 302             wmc_set(WMC_LOUT1_HP_VOLUME_CTRL, WMC_MUTE);
 303     }
 304
 305     if (wmc_vol.vol_r > HW_VOL_MUTE)
 306     {
 307         /* Not muted and going up from mute level? */
 308         if (prev_r <= HW_VOL_MIN && !wmc_vol.ahw_mute)
 309             wmc_clear(WMC_ROUT1_HP_VOLUME_CTRL, WMC_MUTE);
 310     }
 311     else
 312     {
 313         /* Going to mute level? */
 314         if (prev_r > HW_VOL_MUTE)
 315             wmc_set(WMC_ROUT1_HP_VOLUME_CTRL, WMC_MUTE);
 316     }
 317 }
 318
 319 void audiohw_close(void)
 320 {
 321     /* 1. Mute all analogue outputs */
 322     audiohw_mute(true);
 323     audiohw_enable_headphone_jack(false);
 324
 325     /* 2. Disable power management register 1. R1 = 00 */
 326     wmc_write(WMC_POWER_MANAGEMENT1, 0x000);
 327
 328     /* 3. Disable power management register 2. R2 = 00 */
 329     wmc_write(WMC_POWER_MANAGEMENT2, 0x000);
 330
 331     /* 4. Disable power management register 3. R3 = 00 */
 332     wmc_write(WMC_POWER_MANAGEMENT3, 0x000);
 333
 334     /* 5. Remove external power supplies. */
 335 }
 336
 337 void audiohw_mute(bool mute)
 338 {
 339     wmc_vol.ahw_mute = mute;
 340
 341     /* No DAC mute here, please - take care of each enabled output. */
 342     if (mute)
 343     {
 344         wmc_set(WMC_LOUT1_HP_VOLUME_CTRL, WMC_MUTE);
 345         wmc_set(WMC_ROUT1_HP_VOLUME_CTRL, WMC_MUTE);
 346     }
 347     else
 348     {
 349         /* Unmute outputs not at mute level */
 350         if (wmc_vol.vol_l > HW_VOL_MUTE)
 351             wmc_clear(WMC_LOUT1_HP_VOLUME_CTRL, WMC_MUTE);
 352
 353         if (wmc_vol.vol_r > HW_VOL_MUTE)
 354             wmc_clear(WMC_ROUT1_HP_VOLUME_CTRL, WMC_MUTE);
 355     }
 356 }
 357
 358
 359 #ifdef HAVE_RECORDING
 360 /* TODO */
 361 void audiohw_set_recvol(int left, int right, int type)
 362 {
 363     (void)left; (void)right; (void)type;
 364 }
 365 #endif