sn95031.c

Go to the documentation of this file.

/*
 *  sn95031.c -  TI sn95031 Codec driver
 *
 *  Copyright (C) 2010 Intel Corp
 *  Author: Vinod Koul <[email protected]>
 *  Author: Harsha Priya <[email protected]>
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *
 */
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/platform_device.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/module.h>

#include <asm/intel_scu_ipc.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/soc-dapm.h>
#include <sound/initval.h>
#include <sound/tlv.h>
#include <sound/jack.h>
#include "sn95031.h"

#define SN95031_RATES (SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_44100)
#define SN95031_FORMATS (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)

/* adc helper functions */

/* enables mic bias voltage */
static void sn95031_enable_mic_bias(struct snd_soc_codec *codec)
{
    snd_soc_write(codec, SN95031_VAUD, BIT(2)|BIT(1)|BIT(0));
    snd_soc_update_bits(codec, SN95031_MICBIAS, BIT(2), BIT(2));
}

/* Enable/Disable the ADC depending on the argument */
static void configure_adc(struct snd_soc_codec *sn95031_codec, int val)
{
    int value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1);

    if (val) {
        /* Enable and start the ADC */
        value |= (SN95031_ADC_ENBL | SN95031_ADC_START);
        value &= (~SN95031_ADC_NO_LOOP);
    } else {
        /* Just stop the ADC */
        value &= (~SN95031_ADC_START);
    }
    snd_soc_write(sn95031_codec, SN95031_ADC1CNTL1, value);
}

/*
 * finds an empty channel for conversion
 * If the ADC is not enabled then start using 0th channel
 * itself. Otherwise find an empty channel by looking for a
 * channel in which the stopbit is set to 1. returns the index
 * of the first free channel if succeeds or an error code.
 *
 * Context: can sleep
 *
 */
static int find_free_channel(struct snd_soc_codec *sn95031_codec)
{
    int i, value;

    /* check whether ADC is enabled */
    value = snd_soc_read(sn95031_codec, SN95031_ADC1CNTL1);

    if ((value & SN95031_ADC_ENBL) == 0)
        return 0;

    /* ADC is already enabled; Looking for an empty channel */
    for (i = 0; i < SN95031_ADC_CHANLS_MAX; i++) {
        value = snd_soc_read(sn95031_codec,
                SN95031_ADC_CHNL_START_ADDR + i);
        if (value & SN95031_STOPBIT_MASK)
            break;
    }
    return (i == SN95031_ADC_CHANLS_MAX) ? (-EINVAL) : i;
}

/* Initialize the ADC for reading micbias values. Can sleep. */
static int sn95031_initialize_adc(struct snd_soc_codec *sn95031_codec)
{
    int base_addr, chnl_addr;
    int value;
    int channel_index;

    /* Index of the first channel in which the stop bit is set */
    channel_index = find_free_channel(sn95031_codec);
    if (channel_index < 0) {
        pr_err("No free ADC channels");
        return channel_index;
    }

    base_addr = SN95031_ADC_CHNL_START_ADDR + channel_index;

    if (!(channel_index == 0 || channel_index ==  SN95031_ADC_LOOP_MAX)) {
        /* Reset stop bit for channels other than 0 and 12 */
        value = snd_soc_read(sn95031_codec, base_addr);
        /* Set the stop bit to zero */
        snd_soc_write(sn95031_codec, base_addr, value & 0xEF);
        /* Index of the first free channel */
        base_addr++;
        channel_index++;
    }

    /* Since this is the last channel, set the stop bit
       to 1 by ORing the DIE_SENSOR_CODE with 0x10 */
    snd_soc_write(sn95031_codec, base_addr,
                SN95031_AUDIO_DETECT_CODE | 0x10);

    chnl_addr = SN95031_ADC_DATA_START_ADDR + 2 * channel_index;
    pr_debug("mid_initialize : %x", chnl_addr);
    configure_adc(sn95031_codec, 1);
    return chnl_addr;
}


/* reads the ADC registers and gets the mic bias value in mV. */
static unsigned int sn95031_get_mic_bias(struct snd_soc_codec *codec)
{
    u16 adc_adr = sn95031_initialize_adc(codec);
    u16 adc_val1, adc_val2;
    unsigned int mic_bias;

    sn95031_enable_mic_bias(codec);

    /* Enable the sound card for conversion before reading */
    snd_soc_write(codec, SN95031_ADC1CNTL3, 0x05);
    /* Re-toggle the RRDATARD bit */
    snd_soc_write(codec, SN95031_ADC1CNTL3, 0x04);

    /* Read the higher bits of data */
    msleep(1000);
    adc_val1 = snd_soc_read(codec, adc_adr);
    adc_adr++;
    adc_val2 = snd_soc_read(codec, adc_adr);

    /* Adding lower two bits to the higher bits */
    mic_bias = (adc_val1 << 2) + (adc_val2 & 3);
    mic_bias = (mic_bias * SN95031_ADC_ONE_LSB_MULTIPLIER) / 1000;
    pr_debug("mic bias = %dmV\n", mic_bias);
    return mic_bias;
}
/*end - adc helper functions */

static inline unsigned int sn95031_read(struct snd_soc_codec *codec,
            unsigned int reg)
{
    u8 value = 0;
    int ret;

    ret = intel_scu_ipc_ioread8(reg, &value);
    if (ret)
        pr_err("read of %x failed, err %d\n", reg, ret);
    return value;

}

static inline int sn95031_write(struct snd_soc_codec *codec,
            unsigned int reg, unsigned int value)
{
    int ret;

    ret = intel_scu_ipc_iowrite8(reg, value);
    if (ret)
        pr_err("write of %x failed, err %d\n", reg, ret);
    return ret;
}

static int sn95031_set_vaud_bias(struct snd_soc_codec *codec,
        enum snd_soc_bias_level level)
{
    switch (level) {
    case SND_SOC_BIAS_ON:
        break;

    case SND_SOC_BIAS_PREPARE:
        if (codec->dapm.bias_level == SND_SOC_BIAS_STANDBY) {
            pr_debug("vaud_bias powering up pll\n");
            /* power up the pll */
            snd_soc_write(codec, SN95031_AUDPLLCTRL, BIT(5));
            /* enable pcm 2 */
            snd_soc_update_bits(codec, SN95031_PCM2C2,
                    BIT(0), BIT(0));
        }
        break;

    case SND_SOC_BIAS_STANDBY:
        if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
            pr_debug("vaud_bias power up rail\n");
            /* power up the rail */
            snd_soc_write(codec, SN95031_VAUD,
                    BIT(2)|BIT(1)|BIT(0));
            msleep(1);
        } else if (codec->dapm.bias_level == SND_SOC_BIAS_PREPARE) {
            /* turn off pcm */
            pr_debug("vaud_bias power dn pcm\n");
            snd_soc_update_bits(codec, SN95031_PCM2C2, BIT(0), 0);
            snd_soc_write(codec, SN95031_AUDPLLCTRL, 0);
        }
        break;


    case SND_SOC_BIAS_OFF:
        pr_debug("vaud_bias _OFF doing rail shutdown\n");
        snd_soc_write(codec, SN95031_VAUD, BIT(3));
        break;
    }

    codec->dapm.bias_level = level;
    return 0;
}

static int sn95031_vhs_event(struct snd_soc_dapm_widget *w,
            struct snd_kcontrol *kcontrol, int event)
{
    if (SND_SOC_DAPM_EVENT_ON(event)) {
        pr_debug("VHS SND_SOC_DAPM_EVENT_ON doing rail startup now\n");
        /* power up the rail */
        snd_soc_write(w->codec, SN95031_VHSP, 0x3D);
        snd_soc_write(w->codec, SN95031_VHSN, 0x3F);
        msleep(1);
    } else if (SND_SOC_DAPM_EVENT_OFF(event)) {
        pr_debug("VHS SND_SOC_DAPM_EVENT_OFF doing rail shutdown\n");
        snd_soc_write(w->codec, SN95031_VHSP, 0xC4);
        snd_soc_write(w->codec, SN95031_VHSN, 0x04);
    }
    return 0;
}

static int sn95031_vihf_event(struct snd_soc_dapm_widget *w,
            struct snd_kcontrol *kcontrol, int event)
{
    if (SND_SOC_DAPM_EVENT_ON(event)) {
        pr_debug("VIHF SND_SOC_DAPM_EVENT_ON doing rail startup now\n");
        /* power up the rail */
        snd_soc_write(w->codec, SN95031_VIHF, 0x27);
        msleep(1);
    } else if (SND_SOC_DAPM_EVENT_OFF(event)) {
        pr_debug("VIHF SND_SOC_DAPM_EVENT_OFF doing rail shutdown\n");
        snd_soc_write(w->codec, SN95031_VIHF, 0x24);
    }
    return 0;
}

static int sn95031_dmic12_event(struct snd_soc_dapm_widget *w,
            struct snd_kcontrol *k, int event)
{
    unsigned int ldo = 0, clk_dir = 0, data_dir = 0;

    if (SND_SOC_DAPM_EVENT_ON(event)) {
        ldo = BIT(5)|BIT(4);
        clk_dir = BIT(0);
        data_dir = BIT(7);
    }
    /* program DMIC LDO, clock and set clock */
    snd_soc_update_bits(w->codec, SN95031_MICBIAS, BIT(5)|BIT(4), ldo);
    snd_soc_update_bits(w->codec, SN95031_DMICBUF0123, BIT(0), clk_dir);
    snd_soc_update_bits(w->codec, SN95031_DMICBUF0123, BIT(7), data_dir);
    return 0;
}

static int sn95031_dmic34_event(struct snd_soc_dapm_widget *w,
            struct snd_kcontrol *k, int event)
{
    unsigned int ldo = 0, clk_dir = 0, data_dir = 0;

    if (SND_SOC_DAPM_EVENT_ON(event)) {
        ldo = BIT(5)|BIT(4);
        clk_dir = BIT(2);
        data_dir = BIT(1);
    }
    /* program DMIC LDO, clock and set clock */
    snd_soc_update_bits(w->codec, SN95031_MICBIAS, BIT(5)|BIT(4), ldo);
    snd_soc_update_bits(w->codec, SN95031_DMICBUF0123, BIT(2), clk_dir);
    snd_soc_update_bits(w->codec, SN95031_DMICBUF45, BIT(1), data_dir);
    return 0;
}

static int sn95031_dmic56_event(struct snd_soc_dapm_widget *w,
            struct snd_kcontrol *k, int event)
{
    unsigned int ldo = 0;

    if (SND_SOC_DAPM_EVENT_ON(event))
        ldo = BIT(7)|BIT(6);

    /* program DMIC LDO */
    snd_soc_update_bits(w->codec, SN95031_MICBIAS, BIT(7)|BIT(6), ldo);
    return 0;
}

/* mux controls */
static const char *sn95031_mic_texts[] = { "AMIC", "LineIn" };

static const struct soc_enum sn95031_micl_enum =
    SOC_ENUM_SINGLE(SN95031_ADCCONFIG, 1, 2, sn95031_mic_texts);

static const struct snd_kcontrol_new sn95031_micl_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_micl_enum);

static const struct soc_enum sn95031_micr_enum =
    SOC_ENUM_SINGLE(SN95031_ADCCONFIG, 3, 2, sn95031_mic_texts);

static const struct snd_kcontrol_new sn95031_micr_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_micr_enum);

static const char *sn95031_input_texts[] = {    "DMIC1", "DMIC2", "DMIC3",
                        "DMIC4", "DMIC5", "DMIC6",
                        "ADC Left", "ADC Right" };

static const struct soc_enum sn95031_input1_enum =
    SOC_ENUM_SINGLE(SN95031_AUDIOMUX12, 0, 8, sn95031_input_texts);

static const struct snd_kcontrol_new sn95031_input1_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_input1_enum);

static const struct soc_enum sn95031_input2_enum =
    SOC_ENUM_SINGLE(SN95031_AUDIOMUX12, 4, 8, sn95031_input_texts);

static const struct snd_kcontrol_new sn95031_input2_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_input2_enum);

static const struct soc_enum sn95031_input3_enum =
    SOC_ENUM_SINGLE(SN95031_AUDIOMUX34, 0, 8, sn95031_input_texts);

static const struct snd_kcontrol_new sn95031_input3_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_input3_enum);

static const struct soc_enum sn95031_input4_enum =
    SOC_ENUM_SINGLE(SN95031_AUDIOMUX34, 4, 8, sn95031_input_texts);

static const struct snd_kcontrol_new sn95031_input4_mux_control =
    SOC_DAPM_ENUM("Route", sn95031_input4_enum);

/* capture path controls */

static const char *sn95031_micmode_text[] = {"Single Ended", "Differential"};

/* 0dB to 30dB in 10dB steps */
static const DECLARE_TLV_DB_SCALE(mic_tlv, 0, 10, 0);

static const struct soc_enum sn95031_micmode1_enum =
    SOC_ENUM_SINGLE(SN95031_MICAMP1, 1, 2, sn95031_micmode_text);
static const struct soc_enum sn95031_micmode2_enum =
    SOC_ENUM_SINGLE(SN95031_MICAMP2, 1, 2, sn95031_micmode_text);

static const char *sn95031_dmic_cfg_text[] = {"GPO", "DMIC"};

static const struct soc_enum sn95031_dmic12_cfg_enum =
    SOC_ENUM_SINGLE(SN95031_DMICMUX, 0, 2, sn95031_dmic_cfg_text);
static const struct soc_enum sn95031_dmic34_cfg_enum =
    SOC_ENUM_SINGLE(SN95031_DMICMUX, 1, 2, sn95031_dmic_cfg_text);
static const struct soc_enum sn95031_dmic56_cfg_enum =
    SOC_ENUM_SINGLE(SN95031_DMICMUX, 2, 2, sn95031_dmic_cfg_text);

static const struct snd_kcontrol_new sn95031_snd_controls[] = {
    SOC_ENUM("Mic1Mode Capture Route", sn95031_micmode1_enum),
    SOC_ENUM("Mic2Mode Capture Route", sn95031_micmode2_enum),
    SOC_ENUM("DMIC12 Capture Route", sn95031_dmic12_cfg_enum),
    SOC_ENUM("DMIC34 Capture Route", sn95031_dmic34_cfg_enum),
    SOC_ENUM("DMIC56 Capture Route", sn95031_dmic56_cfg_enum),
    SOC_SINGLE_TLV("Mic1 Capture Volume", SN95031_MICAMP1,
            2, 4, 0, mic_tlv),
    SOC_SINGLE_TLV("Mic2 Capture Volume", SN95031_MICAMP2,
            2, 4, 0, mic_tlv),
};

/* DAPM widgets */
static const struct snd_soc_dapm_widget sn95031_dapm_widgets[] = {

    /* all end points mic, hs etc */
    SND_SOC_DAPM_OUTPUT("HPOUTL"),
    SND_SOC_DAPM_OUTPUT("HPOUTR"),
    SND_SOC_DAPM_OUTPUT("EPOUT"),
    SND_SOC_DAPM_OUTPUT("IHFOUTL"),
    SND_SOC_DAPM_OUTPUT("IHFOUTR"),
    SND_SOC_DAPM_OUTPUT("LINEOUTL"),
    SND_SOC_DAPM_OUTPUT("LINEOUTR"),
    SND_SOC_DAPM_OUTPUT("VIB1OUT"),
    SND_SOC_DAPM_OUTPUT("VIB2OUT"),

    SND_SOC_DAPM_INPUT("AMIC1"), /* headset mic */
    SND_SOC_DAPM_INPUT("AMIC2"),
    SND_SOC_DAPM_INPUT("DMIC1"),
    SND_SOC_DAPM_INPUT("DMIC2"),
    SND_SOC_DAPM_INPUT("DMIC3"),
    SND_SOC_DAPM_INPUT("DMIC4"),
    SND_SOC_DAPM_INPUT("DMIC5"),
    SND_SOC_DAPM_INPUT("DMIC6"),
    SND_SOC_DAPM_INPUT("LINEINL"),
    SND_SOC_DAPM_INPUT("LINEINR"),

    SND_SOC_DAPM_MICBIAS("AMIC1Bias", SN95031_MICBIAS, 2, 0),
    SND_SOC_DAPM_MICBIAS("AMIC2Bias", SN95031_MICBIAS, 3, 0),
    SND_SOC_DAPM_MICBIAS("DMIC12Bias", SN95031_DMICMUX, 3, 0),
    SND_SOC_DAPM_MICBIAS("DMIC34Bias", SN95031_DMICMUX, 4, 0),
    SND_SOC_DAPM_MICBIAS("DMIC56Bias", SN95031_DMICMUX, 5, 0),

    SND_SOC_DAPM_SUPPLY("DMIC12supply", SN95031_DMICLK, 0, 0,
                sn95031_dmic12_event,
                SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
    SND_SOC_DAPM_SUPPLY("DMIC34supply", SN95031_DMICLK, 1, 0,
                sn95031_dmic34_event,
                SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
    SND_SOC_DAPM_SUPPLY("DMIC56supply", SN95031_DMICLK, 2, 0,
                sn95031_dmic56_event,
                SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),

    SND_SOC_DAPM_AIF_OUT("PCM_Out", "Capture", 0,
            SND_SOC_NOPM, 0, 0),

    SND_SOC_DAPM_SUPPLY("Headset Rail", SND_SOC_NOPM, 0, 0,
            sn95031_vhs_event,
            SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
    SND_SOC_DAPM_SUPPLY("Speaker Rail", SND_SOC_NOPM, 0, 0,
            sn95031_vihf_event,
            SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),

    /* playback path driver enables */
    SND_SOC_DAPM_PGA("Headset Left Playback",
            SN95031_DRIVEREN, 0, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Headset Right Playback",
            SN95031_DRIVEREN, 1, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Speaker Left Playback",
            SN95031_DRIVEREN, 2, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Speaker Right Playback",
            SN95031_DRIVEREN, 3, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Vibra1 Playback",
            SN95031_DRIVEREN, 4, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Vibra2 Playback",
            SN95031_DRIVEREN, 5, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Earpiece Playback",
            SN95031_DRIVEREN, 6, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Lineout Left Playback",
            SN95031_LOCTL, 0, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Lineout Right Playback",
            SN95031_LOCTL, 4, 0, NULL, 0),

    /* playback path filter enable */
    SND_SOC_DAPM_PGA("Headset Left Filter",
            SN95031_HSEPRXCTRL, 4, 0, NULL, 0),
    SND_SOC_DAPM_PGA("Headset Right Filter",
            SN95031_HSEPRXCTRL, 5, 0,  NULL, 0),
    SND_SOC_DAPM_PGA("Speaker Left Filter",
            SN95031_IHFRXCTRL, 0, 0,  NULL, 0),
    SND_SOC_DAPM_PGA("Speaker Right Filter",
            SN95031_IHFRXCTRL, 1, 0,  NULL, 0),

    /* DACs */
    SND_SOC_DAPM_DAC("HSDAC Left", "Headset",
            SN95031_DACCONFIG, 0, 0),
    SND_SOC_DAPM_DAC("HSDAC Right", "Headset",
            SN95031_DACCONFIG, 1, 0),
    SND_SOC_DAPM_DAC("IHFDAC Left", "Speaker",
            SN95031_DACCONFIG, 2, 0),
    SND_SOC_DAPM_DAC("IHFDAC Right", "Speaker",
            SN95031_DACCONFIG, 3, 0),
    SND_SOC_DAPM_DAC("Vibra1 DAC", "Vibra1",
            SN95031_VIB1C5, 1, 0),
    SND_SOC_DAPM_DAC("Vibra2 DAC", "Vibra2",
            SN95031_VIB2C5, 1, 0),

    /* capture widgets */
    SND_SOC_DAPM_PGA("LineIn Enable Left", SN95031_MICAMP1,
                7, 0, NULL, 0),
    SND_SOC_DAPM_PGA("LineIn Enable Right", SN95031_MICAMP2,
                7, 0, NULL, 0),

    SND_SOC_DAPM_PGA("MIC1 Enable", SN95031_MICAMP1, 0, 0, NULL, 0),
    SND_SOC_DAPM_PGA("MIC2 Enable", SN95031_MICAMP2, 0, 0, NULL, 0),
    SND_SOC_DAPM_PGA("TX1 Enable", SN95031_AUDIOTXEN, 2, 0, NULL, 0),
    SND_SOC_DAPM_PGA("TX2 Enable", SN95031_AUDIOTXEN, 3, 0, NULL, 0),
    SND_SOC_DAPM_PGA("TX3 Enable", SN95031_AUDIOTXEN, 4, 0, NULL, 0),
    SND_SOC_DAPM_PGA("TX4 Enable", SN95031_AUDIOTXEN, 5, 0, NULL, 0),

    /* ADC have null stream as they will be turned ON by TX path */
    SND_SOC_DAPM_ADC("ADC Left", NULL,
            SN95031_ADCCONFIG, 0, 0),
    SND_SOC_DAPM_ADC("ADC Right", NULL,
            SN95031_ADCCONFIG, 2, 0),

    SND_SOC_DAPM_MUX("Mic_InputL Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_micl_mux_control),
    SND_SOC_DAPM_MUX("Mic_InputR Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_micr_mux_control),

    SND_SOC_DAPM_MUX("Txpath1 Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_input1_mux_control),
    SND_SOC_DAPM_MUX("Txpath2 Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_input2_mux_control),
    SND_SOC_DAPM_MUX("Txpath3 Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_input3_mux_control),
    SND_SOC_DAPM_MUX("Txpath4 Capture Route",
            SND_SOC_NOPM, 0, 0, &sn95031_input4_mux_control),

};

static const struct snd_soc_dapm_route sn95031_audio_map[] = {
    /* headset and earpiece map */
    { "HPOUTL", NULL, "Headset Rail"},
    { "HPOUTR", NULL, "Headset Rail"},
    { "HPOUTL", NULL, "Headset Left Playback" },
    { "HPOUTR", NULL, "Headset Right Playback" },
    { "EPOUT", NULL, "Earpiece Playback" },
    { "Headset Left Playback", NULL, "Headset Left Filter"},
    { "Headset Right Playback", NULL, "Headset Right Filter"},
    { "Earpiece Playback", NULL, "Headset Left Filter"},
    { "Headset Left Filter", NULL, "HSDAC Left"},
    { "Headset Right Filter", NULL, "HSDAC Right"},

    /* speaker map */
    { "IHFOUTL", NULL, "Speaker Rail"},
    { "IHFOUTR", NULL, "Speaker Rail"},
    { "IHFOUTL", "NULL", "Speaker Left Playback"},
    { "IHFOUTR", "NULL", "Speaker Right Playback"},
    { "Speaker Left Playback", NULL, "Speaker Left Filter"},
    { "Speaker Right Playback", NULL, "Speaker Right Filter"},
    { "Speaker Left Filter", NULL, "IHFDAC Left"},
    { "Speaker Right Filter", NULL, "IHFDAC Right"},

    /* vibra map */
    { "VIB1OUT", NULL, "Vibra1 Playback"},
    { "Vibra1 Playback", NULL, "Vibra1 DAC"},

    { "VIB2OUT", NULL, "Vibra2 Playback"},
    { "Vibra2 Playback", NULL, "Vibra2 DAC"},

    /* lineout */
    { "LINEOUTL", NULL, "Lineout Left Playback"},
    { "LINEOUTR", NULL, "Lineout Right Playback"},
    { "Lineout Left Playback", NULL, "Headset Left Filter"},
    { "Lineout Left Playback", NULL, "Speaker Left Filter"},
    { "Lineout Left Playback", NULL, "Vibra1 DAC"},
    { "Lineout Right Playback", NULL, "Headset Right Filter"},
    { "Lineout Right Playback", NULL, "Speaker Right Filter"},
    { "Lineout Right Playback", NULL, "Vibra2 DAC"},

    /* Headset (AMIC1) mic */
    { "AMIC1Bias", NULL, "AMIC1"},
    { "MIC1 Enable", NULL, "AMIC1Bias"},
    { "Mic_InputL Capture Route", "AMIC", "MIC1 Enable"},

    /* AMIC2 */
    { "AMIC2Bias", NULL, "AMIC2"},
    { "MIC2 Enable", NULL, "AMIC2Bias"},
    { "Mic_InputR Capture Route", "AMIC", "MIC2 Enable"},


    /* Linein */
    { "LineIn Enable Left", NULL, "LINEINL"},
    { "LineIn Enable Right", NULL, "LINEINR"},
    { "Mic_InputL Capture Route", "LineIn", "LineIn Enable Left"},
    { "Mic_InputR Capture Route", "LineIn", "LineIn Enable Right"},

    /* ADC connection */
    { "ADC Left", NULL, "Mic_InputL Capture Route"},
    { "ADC Right", NULL, "Mic_InputR Capture Route"},

    /*DMIC connections */
    { "DMIC1", NULL, "DMIC12supply"},
    { "DMIC2", NULL, "DMIC12supply"},
    { "DMIC3", NULL, "DMIC34supply"},
    { "DMIC4", NULL, "DMIC34supply"},
    { "DMIC5", NULL, "DMIC56supply"},
    { "DMIC6", NULL, "DMIC56supply"},

    { "DMIC12Bias", NULL, "DMIC1"},
    { "DMIC12Bias", NULL, "DMIC2"},
    { "DMIC34Bias", NULL, "DMIC3"},
    { "DMIC34Bias", NULL, "DMIC4"},
    { "DMIC56Bias", NULL, "DMIC5"},
    { "DMIC56Bias", NULL, "DMIC6"},

    /*TX path inputs*/
    { "Txpath1 Capture Route", "ADC Left", "ADC Left"},
    { "Txpath2 Capture Route", "ADC Left", "ADC Left"},
    { "Txpath3 Capture Route", "ADC Left", "ADC Left"},
    { "Txpath4 Capture Route", "ADC Left", "ADC Left"},
    { "Txpath1 Capture Route", "ADC Right", "ADC Right"},
    { "Txpath2 Capture Route", "ADC Right", "ADC Right"},
    { "Txpath3 Capture Route", "ADC Right", "ADC Right"},
    { "Txpath4 Capture Route", "ADC Right", "ADC Right"},
    { "Txpath1 Capture Route", "DMIC1", "DMIC1"},
    { "Txpath2 Capture Route", "DMIC1", "DMIC1"},
    { "Txpath3 Capture Route", "DMIC1", "DMIC1"},
    { "Txpath4 Capture Route", "DMIC1", "DMIC1"},
    { "Txpath1 Capture Route", "DMIC2", "DMIC2"},
    { "Txpath2 Capture Route", "DMIC2", "DMIC2"},
    { "Txpath3 Capture Route", "DMIC2", "DMIC2"},
    { "Txpath4 Capture Route", "DMIC2", "DMIC2"},
    { "Txpath1 Capture Route", "DMIC3", "DMIC3"},
    { "Txpath2 Capture Route", "DMIC3", "DMIC3"},
    { "Txpath3 Capture Route", "DMIC3", "DMIC3"},
    { "Txpath4 Capture Route", "DMIC3", "DMIC3"},
    { "Txpath1 Capture Route", "DMIC4", "DMIC4"},
    { "Txpath2 Capture Route", "DMIC4", "DMIC4"},
    { "Txpath3 Capture Route", "DMIC4", "DMIC4"},
    { "Txpath4 Capture Route", "DMIC4", "DMIC4"},
    { "Txpath1 Capture Route", "DMIC5", "DMIC5"},
    { "Txpath2 Capture Route", "DMIC5", "DMIC5"},
    { "Txpath3 Capture Route", "DMIC5", "DMIC5"},
    { "Txpath4 Capture Route", "DMIC5", "DMIC5"},
    { "Txpath1 Capture Route", "DMIC6", "DMIC6"},
    { "Txpath2 Capture Route", "DMIC6", "DMIC6"},
    { "Txpath3 Capture Route", "DMIC6", "DMIC6"},
    { "Txpath4 Capture Route", "DMIC6", "DMIC6"},

    /* tx path */
    { "TX1 Enable", NULL, "Txpath1 Capture Route"},
    { "TX2 Enable", NULL, "Txpath2 Capture Route"},
    { "TX3 Enable", NULL, "Txpath3 Capture Route"},
    { "TX4 Enable", NULL, "Txpath4 Capture Route"},
    { "PCM_Out", NULL, "TX1 Enable"},
    { "PCM_Out", NULL, "TX2 Enable"},
    { "PCM_Out", NULL, "TX3 Enable"},
    { "PCM_Out", NULL, "TX4 Enable"},

};

/* speaker and headset mutes, for audio pops and clicks */
static int sn95031_pcm_hs_mute(struct snd_soc_dai *dai, int mute)
{
    snd_soc_update_bits(dai->codec,
            SN95031_HSLVOLCTRL, BIT(7), (!mute << 7));
    snd_soc_update_bits(dai->codec,
            SN95031_HSRVOLCTRL, BIT(7), (!mute << 7));
    return 0;
}

static int sn95031_pcm_spkr_mute(struct snd_soc_dai *dai, int mute)
{
    snd_soc_update_bits(dai->codec,
            SN95031_IHFLVOLCTRL, BIT(7), (!mute << 7));
    snd_soc_update_bits(dai->codec,
            SN95031_IHFRVOLCTRL, BIT(7), (!mute << 7));
    return 0;
}

static int sn95031_pcm_hw_params(struct snd_pcm_substream *substream,
        struct snd_pcm_hw_params *params, struct snd_soc_dai *dai)
{
    unsigned int format, rate;

    switch (params_format(params)) {
    case SNDRV_PCM_FORMAT_S16_LE:
        format = BIT(4)|BIT(5);
        break;

    case SNDRV_PCM_FORMAT_S24_LE:
        format = 0;
        break;
    default:
        return -EINVAL;
    }
    snd_soc_update_bits(dai->codec, SN95031_PCM2C2,
            BIT(4)|BIT(5), format);

    switch (params_rate(params)) {
    case 48000:
        pr_debug("RATE_48000\n");
        rate = 0;
        break;

    case 44100:
        pr_debug("RATE_44100\n");
        rate = BIT(7);
        break;

    default:
        pr_err("ERR rate %d\n", params_rate(params));
        return -EINVAL;
    }
    snd_soc_update_bits(dai->codec, SN95031_PCM1C1, BIT(7), rate);

    return 0;
}

/* Codec DAI section */
static const struct snd_soc_dai_ops sn95031_headset_dai_ops = {
    .digital_mute   = sn95031_pcm_hs_mute,
    .hw_params  = sn95031_pcm_hw_params,
};

static const struct snd_soc_dai_ops sn95031_speaker_dai_ops = {
    .digital_mute   = sn95031_pcm_spkr_mute,
    .hw_params  = sn95031_pcm_hw_params,
};

static const struct snd_soc_dai_ops sn95031_vib1_dai_ops = {
    .hw_params  = sn95031_pcm_hw_params,
};

static const struct snd_soc_dai_ops sn95031_vib2_dai_ops = {
    .hw_params  = sn95031_pcm_hw_params,
};

static struct snd_soc_dai_driver sn95031_dais[] = {
{
    .name = "SN95031 Headset",
    .playback = {
        .stream_name = "Headset",
        .channels_min = 2,
        .channels_max = 2,
        .rates = SN95031_RATES,
        .formats = SN95031_FORMATS,
    },
    .capture = {
        .stream_name = "Capture",
        .channels_min = 1,
        .channels_max = 5,
        .rates = SN95031_RATES,
        .formats = SN95031_FORMATS,
    },
    .ops = &sn95031_headset_dai_ops,
},
{   .name = "SN95031 Speaker",
    .playback = {
        .stream_name = "Speaker",
        .channels_min = 2,
        .channels_max = 2,
        .rates = SN95031_RATES,
        .formats = SN95031_FORMATS,
    },
    .ops = &sn95031_speaker_dai_ops,
},
{   .name = "SN95031 Vibra1",
    .playback = {
        .stream_name = "Vibra1",
        .channels_min = 1,
        .channels_max = 1,
        .rates = SN95031_RATES,
        .formats = SN95031_FORMATS,
    },
    .ops = &sn95031_vib1_dai_ops,
},
{   .name = "SN95031 Vibra2",
    .playback = {
        .stream_name = "Vibra2",
        .channels_min = 1,
        .channels_max = 1,
        .rates = SN95031_RATES,
        .formats = SN95031_FORMATS,
    },
    .ops = &sn95031_vib2_dai_ops,
},
};

static inline void sn95031_disable_jack_btn(struct snd_soc_codec *codec)
{
    snd_soc_write(codec, SN95031_BTNCTRL2, 0x00);
}

static inline void sn95031_enable_jack_btn(struct snd_soc_codec *codec)
{
    snd_soc_write(codec, SN95031_BTNCTRL1, 0x77);
    snd_soc_write(codec, SN95031_BTNCTRL2, 0x01);
}

static int sn95031_get_headset_state(struct snd_soc_jack *mfld_jack)
{
    int micbias = sn95031_get_mic_bias(mfld_jack->codec);

    int jack_type = snd_soc_jack_get_type(mfld_jack, micbias);

    pr_debug("jack type detected = %d\n", jack_type);
    if (jack_type == SND_JACK_HEADSET)
        sn95031_enable_jack_btn(mfld_jack->codec);
    return jack_type;
}

void sn95031_jack_detection(struct mfld_jack_data *jack_data)
{
    unsigned int status;
    unsigned int mask = SND_JACK_BTN_0 | SND_JACK_BTN_1 | SND_JACK_HEADSET;

    pr_debug("interrupt id read in sram = 0x%x\n", jack_data->intr_id);
    if (jack_data->intr_id & 0x1) {
        pr_debug("short_push detected\n");
        status = SND_JACK_HEADSET | SND_JACK_BTN_0;
    } else if (jack_data->intr_id & 0x2) {
        pr_debug("long_push detected\n");
        status = SND_JACK_HEADSET | SND_JACK_BTN_1;
    } else if (jack_data->intr_id & 0x4) {
        pr_debug("headset or headphones inserted\n");
        status = sn95031_get_headset_state(jack_data->mfld_jack);
    } else if (jack_data->intr_id & 0x8) {
        pr_debug("headset or headphones removed\n");
        status = 0;
        sn95031_disable_jack_btn(jack_data->mfld_jack->codec);
    } else {
        pr_err("unidentified interrupt\n");
        return;
    }

    snd_soc_jack_report(jack_data->mfld_jack, status, mask);
    /*button pressed and released so we send explicit button release */
    if ((status & SND_JACK_BTN_0) | (status & SND_JACK_BTN_1))
        snd_soc_jack_report(jack_data->mfld_jack,
                SND_JACK_HEADSET, mask);
}
EXPORT_SYMBOL_GPL(sn95031_jack_detection);

/* codec registration */
static int sn95031_codec_probe(struct snd_soc_codec *codec)
{
    pr_debug("codec_probe called\n");

    /* PCM interface config
     * This sets the pcm rx slot conguration to max 6 slots
     * for max 4 dais (2 stereo and 2 mono)
     */
    snd_soc_write(codec, SN95031_PCM2RXSLOT01, 0x10);
    snd_soc_write(codec, SN95031_PCM2RXSLOT23, 0x32);
    snd_soc_write(codec, SN95031_PCM2RXSLOT45, 0x54);
    snd_soc_write(codec, SN95031_PCM2TXSLOT01, 0x10);
    snd_soc_write(codec, SN95031_PCM2TXSLOT23, 0x32);
    /* pcm port setting
     * This sets the pcm port to slave and clock at 19.2Mhz which
     * can support 6slots, sampling rate set per stream in hw-params
     */
    snd_soc_write(codec, SN95031_PCM1C1, 0x00);
    snd_soc_write(codec, SN95031_PCM2C1, 0x01);
    snd_soc_write(codec, SN95031_PCM2C2, 0x0A);
    snd_soc_write(codec, SN95031_HSMIXER, BIT(0)|BIT(4));
    /* vendor vibra workround, the vibras are muted by
     * custom register so unmute them
     */
    snd_soc_write(codec, SN95031_SSR5, 0x80);
    snd_soc_write(codec, SN95031_SSR6, 0x80);
    snd_soc_write(codec, SN95031_VIB1C5, 0x00);
    snd_soc_write(codec, SN95031_VIB2C5, 0x00);
    /* configure vibras for pcm port */
    snd_soc_write(codec, SN95031_VIB1C3, 0x00);
    snd_soc_write(codec, SN95031_VIB2C3, 0x00);

    /* soft mute ramp time */
    snd_soc_write(codec, SN95031_SOFTMUTE, 0x3);
    /* fix the initial volume at 1dB,
     * default in +9dB,
     * 1dB give optimal swing on DAC, amps
     */
    snd_soc_write(codec, SN95031_HSLVOLCTRL, 0x08);
    snd_soc_write(codec, SN95031_HSRVOLCTRL, 0x08);
    snd_soc_write(codec, SN95031_IHFLVOLCTRL, 0x08);
    snd_soc_write(codec, SN95031_IHFRVOLCTRL, 0x08);
    /* dac mode and lineout workaround */
    snd_soc_write(codec, SN95031_SSR2, 0x10);
    snd_soc_write(codec, SN95031_SSR3, 0x40);

    snd_soc_add_codec_controls(codec, sn95031_snd_controls,
                 ARRAY_SIZE(sn95031_snd_controls));

    return 0;
}

static int sn95031_codec_remove(struct snd_soc_codec *codec)
{
    pr_debug("codec_remove called\n");
    sn95031_set_vaud_bias(codec, SND_SOC_BIAS_OFF);

    return 0;
}

struct snd_soc_codec_driver sn95031_codec = {
    .probe      = sn95031_codec_probe,
    .remove     = sn95031_codec_remove,
    .read       = sn95031_read,
    .write      = sn95031_write,
    .set_bias_level = sn95031_set_vaud_bias,
    .idle_bias_off  = true,
    .dapm_widgets   = sn95031_dapm_widgets,
    .num_dapm_widgets   = ARRAY_SIZE(sn95031_dapm_widgets),
    .dapm_routes    = sn95031_audio_map,
    .num_dapm_routes    = ARRAY_SIZE(sn95031_audio_map),
};

static int __devinit sn95031_device_probe(struct platform_device *pdev)
{
    pr_debug("codec device probe called for %s\n", dev_name(&pdev->dev));
    return snd_soc_register_codec(&pdev->dev, &sn95031_codec,
            sn95031_dais, ARRAY_SIZE(sn95031_dais));
}

static int __devexit sn95031_device_remove(struct platform_device *pdev)
{
    pr_debug("codec device remove called\n");
    snd_soc_unregister_codec(&pdev->dev);
    return 0;
}

static struct platform_driver sn95031_codec_driver = {
    .driver     = {
        .name       = "sn95031",
        .owner      = THIS_MODULE,
    },
    .probe      = sn95031_device_probe,
    .remove     = __devexit_p(sn95031_device_remove),
};

module_platform_driver(sn95031_codec_driver);

MODULE_DESCRIPTION("ASoC TI SN95031 codec driver");
MODULE_AUTHOR("Vinod Koul <[email protected]>");
MODULE_AUTHOR("Harsha Priya <[email protected]>");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:sn95031");