Quelle  bytcr_rt5651.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  bytcr_rt5651.c - ASoc Machine driver for Intel Byt CR platform
 *  (derived from bytcr_rt5640.c)
 *
 *  Copyright (C) 2015 Intel Corp
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#include <linux/init.h>
#include <linux/i2c.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/property.h>
#include <linux/acpi.h>
#include <linux/clk.h>
#include <linux/device.h>
#include <linux/dmi.h>
#include <linux/input.h>
#include <linux/gpio/consumer.h>
#include <linux/gpio/machine.h>
#include <linux/slab.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/jack.h>
#include <sound/soc-acpi.h>
#include "../../codecs/rt5651.h"
#include "../atom/sst-atom-controls.h"
#include "../common/soc-intel-quirks.h"

enum {
 BYT_RT5651_DMIC_MAP,
 BYT_RT5651_IN1_MAP,
 BYT_RT5651_IN2_MAP,
 BYT_RT5651_IN1_IN2_MAP,
};

enum {
 BYT_RT5651_JD_NULL = (RT5651_JD_NULL << 4),
 BYT_RT5651_JD1_1 = (RT5651_JD1_1 << 4),
 BYT_RT5651_JD1_2 = (RT5651_JD1_2 << 4),
 BYT_RT5651_JD2  = (RT5651_JD2 << 4),
};

enum {
 BYT_RT5651_OVCD_TH_600UA  = (6 << 8),
 BYT_RT5651_OVCD_TH_1500UA = (15 << 8),
 BYT_RT5651_OVCD_TH_2000UA = (20 << 8),
};

enum {
 BYT_RT5651_OVCD_SF_0P5 = (RT5651_OVCD_SF_0P5 << 13),
 BYT_RT5651_OVCD_SF_0P75 = (RT5651_OVCD_SF_0P75 << 13),
 BYT_RT5651_OVCD_SF_1P0 = (RT5651_OVCD_SF_1P0 << 13),
 BYT_RT5651_OVCD_SF_1P5 = (RT5651_OVCD_SF_1P5 << 13),
};

#define BYT_RT5651_MAP_MASK  GENMASK(3, 0)
#define BYT_RT5651_MAP(quirk)  ((quirk) & BYT_RT5651_MAP_MASK)
#define BYT_RT5651_JDSRC(quirk)  (((quirk) & GENMASK(7, 4)) >> 4)
#define BYT_RT5651_OVCD_TH(quirk) (((quirk) & GENMASK(12, 8)) >> 8)
#define BYT_RT5651_OVCD_SF(quirk) (((quirk) & GENMASK(14, 13)) >> 13)
#define BYT_RT5651_DMIC_EN  BIT(16)
#define BYT_RT5651_MCLK_EN  BIT(17)
#define BYT_RT5651_MCLK_25MHZ  BIT(18)
#define BYT_RT5651_SSP2_AIF2  BIT(19) /* default is using AIF1  */
#define BYT_RT5651_SSP0_AIF1  BIT(20)
#define BYT_RT5651_SSP0_AIF2  BIT(21)
#define BYT_RT5651_HP_LR_SWAPPED BIT(22)
#define BYT_RT5651_MONO_SPEAKER  BIT(23)
#define BYT_RT5651_JD_NOT_INV  BIT(24)

#define BYT_RT5651_DEFAULT_QUIRKS (BYT_RT5651_MCLK_EN | \
      BYT_RT5651_JD1_1   | \
      BYT_RT5651_OVCD_TH_2000UA | \
      BYT_RT5651_OVCD_SF_0P75)

/* jack-detect-source + inv + dmic-en + ovcd-th + -sf + terminating entry */
#define MAX_NO_PROPS 6

struct byt_rt5651_private {
 struct clk *mclk;
 struct gpio_desc *ext_amp_gpio;
 struct gpio_desc *hp_detect;
 struct snd_soc_jack jack;
 struct device *codec_dev;
};

static const struct acpi_gpio_mapping *byt_rt5651_gpios;

/* Default: jack-detect on JD1_1, internal mic on in2, headsetmic on in3 */
static unsigned long byt_rt5651_quirk = BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP;

static int quirk_override = -1;
module_param_named(quirk, quirk_override, int, 0444);
MODULE_PARM_DESC(quirk, "Board-specific quirk override");

static void log_quirks(struct device *dev)
{
 int map;

 map = BYT_RT5651_MAP(byt_rt5651_quirk);
 switch (map) {
 case BYT_RT5651_DMIC_MAP:
  dev_info(dev, "quirk DMIC_MAP enabled");
  break;
 case BYT_RT5651_IN1_MAP:
  dev_info(dev, "quirk IN1_MAP enabled");
  break;
 case BYT_RT5651_IN2_MAP:
  dev_info(dev, "quirk IN2_MAP enabled");
  break;
 case BYT_RT5651_IN1_IN2_MAP:
  dev_info(dev, "quirk IN1_IN2_MAP enabled");
  break;
 default:
  dev_warn_once(dev, "quirk sets invalid input map: 0x%x, default to DMIC_MAP\n", map);
  byt_rt5651_quirk &= ~BYT_RT5651_MAP_MASK;
  byt_rt5651_quirk |= BYT_RT5651_DMIC_MAP;
  break;
 }

 if (BYT_RT5651_JDSRC(byt_rt5651_quirk)) {
  dev_info(dev, "quirk realtek,jack-detect-source %ld\n",
    BYT_RT5651_JDSRC(byt_rt5651_quirk));
  dev_info(dev, "quirk realtek,over-current-threshold-microamp %ld\n",
    BYT_RT5651_OVCD_TH(byt_rt5651_quirk) * 100);
  dev_info(dev, "quirk realtek,over-current-scale-factor %ld\n",
    BYT_RT5651_OVCD_SF(byt_rt5651_quirk));
 }
 if (byt_rt5651_quirk & BYT_RT5651_DMIC_EN)
  dev_info(dev, "quirk DMIC enabled");
 if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN)
  dev_info(dev, "quirk MCLK_EN enabled");
 if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
  dev_info(dev, "quirk MCLK_25MHZ enabled");
 if (byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2)
  dev_info(dev, "quirk SSP2_AIF2 enabled\n");
 if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1)
  dev_info(dev, "quirk SSP0_AIF1 enabled\n");
 if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2)
  dev_info(dev, "quirk SSP0_AIF2 enabled\n");
 if (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER)
  dev_info(dev, "quirk MONO_SPEAKER enabled\n");
 if (byt_rt5651_quirk & BYT_RT5651_JD_NOT_INV)
  dev_info(dev, "quirk JD_NOT_INV enabled\n");
}

#define BYT_CODEC_DAI1 "rt5651-aif1"
#define BYT_CODEC_DAI2 "rt5651-aif2"

static int byt_rt5651_prepare_and_enable_pll1(struct snd_soc_dai *codec_dai,
           int rate, int bclk_ratio)
{
 int clk_id, clk_freq, ret;

 /* Configure the PLL before selecting it */
 if (!(byt_rt5651_quirk & BYT_RT5651_MCLK_EN)) {
  clk_id = RT5651_PLL1_S_BCLK1;
  clk_freq = rate * bclk_ratio;
 } else {
  clk_id = RT5651_PLL1_S_MCLK;
  if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
   clk_freq = 25000000;
  else
   clk_freq = 19200000;
 }
 ret = snd_soc_dai_set_pll(codec_dai, 0, clk_id, clk_freq, rate * 512);
 if (ret < 0) {
  dev_err(codec_dai->component->dev, "can't set pll: %d\n", ret);
  return ret;
 }

 ret = snd_soc_dai_set_sysclk(codec_dai, RT5651_SCLK_S_PLL1,
         rate * 512, SND_SOC_CLOCK_IN);
 if (ret < 0) {
  dev_err(codec_dai->component->dev, "can't set clock %d\n", ret);
  return ret;
 }

 return 0;
}

static int platform_clock_control(struct snd_soc_dapm_widget *w,
      struct snd_kcontrol *k, int  event)
{
 struct snd_soc_dapm_context *dapm = w->dapm;
 struct snd_soc_card *card = dapm->card;
 struct snd_soc_dai *codec_dai;
 struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 int ret;

 codec_dai = snd_soc_card_get_codec_dai(card, BYT_CODEC_DAI1);
 if (!codec_dai)
  codec_dai = snd_soc_card_get_codec_dai(card, BYT_CODEC_DAI2);
 if (!codec_dai) {
  dev_err(card->dev,
   "Codec dai not found; Unable to set platform clock\n");
  return -EIO;
 }

 if (SND_SOC_DAPM_EVENT_ON(event)) {
  ret = clk_prepare_enable(priv->mclk);
  if (ret < 0) {
   dev_err(card->dev, "could not configure MCLK state");
   return ret;
  }
  ret = byt_rt5651_prepare_and_enable_pll1(codec_dai, 48000, 50);
 } else {
  /*
 * Set codec clock source to internal clock before
 * turning off the platform clock. Codec needs clock
 * for Jack detection and button press
 */
  ret = snd_soc_dai_set_sysclk(codec_dai, RT5651_SCLK_S_RCCLK,
          48000 * 512,
          SND_SOC_CLOCK_IN);
  if (!ret)
   clk_disable_unprepare(priv->mclk);
 }

 if (ret < 0) {
  dev_err(card->dev, "can't set codec sysclk: %d\n", ret);
  return ret;
 }

 return 0;
}

static int rt5651_ext_amp_power_event(struct snd_soc_dapm_widget *w,
 struct snd_kcontrol *kcontrol, int event)
{
 struct snd_soc_card *card = w->dapm->card;
 struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);

 if (SND_SOC_DAPM_EVENT_ON(event))
  gpiod_set_value_cansleep(priv->ext_amp_gpio, 1);
 else
  gpiod_set_value_cansleep(priv->ext_amp_gpio, 0);

 return 0;
}

static const struct snd_soc_dapm_widget byt_rt5651_widgets[] = {
 SND_SOC_DAPM_HP("Headphone", NULL),
 SND_SOC_DAPM_MIC("Headset Mic", NULL),
 SND_SOC_DAPM_MIC("Internal Mic", NULL),
 SND_SOC_DAPM_SPK("Speaker", NULL),
 SND_SOC_DAPM_LINE("Line In", NULL),
 SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
       platform_clock_control, SND_SOC_DAPM_PRE_PMU |
       SND_SOC_DAPM_POST_PMD),
 SND_SOC_DAPM_SUPPLY("Ext Amp Power", SND_SOC_NOPM, 0, 0,
       rt5651_ext_amp_power_event,
       SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
};

static const struct snd_soc_dapm_route byt_rt5651_audio_map[] = {
 {"Headphone", NULL, "Platform Clock"},
 {"Headset Mic", NULL, "Platform Clock"},
 {"Internal Mic", NULL, "Platform Clock"},
 {"Speaker", NULL, "Platform Clock"},
 {"Speaker", NULL, "Ext Amp Power"},
 {"Line In", NULL, "Platform Clock"},

 {"Headset Mic", NULL, "micbias1"}, /* lowercase for rt5651 */
 {"Headphone", NULL, "HPOL"},
 {"Headphone", NULL, "HPOR"},
 {"Speaker", NULL, "LOUTL"},
 {"Speaker", NULL, "LOUTR"},
 {"IN2P", NULL, "Line In"},
 {"IN2N", NULL, "Line In"},

};

static const struct snd_soc_dapm_route byt_rt5651_intmic_dmic_map[] = {
 {"DMIC L1", NULL, "Internal Mic"},
 {"DMIC R1", NULL, "Internal Mic"},
 {"IN2P", NULL, "Headset Mic"},
};

static const struct snd_soc_dapm_route byt_rt5651_intmic_in1_map[] = {
 {"Internal Mic", NULL, "micbias1"},
 {"IN1P", NULL, "Internal Mic"},
 {"IN3P", NULL, "Headset Mic"},
};

static const struct snd_soc_dapm_route byt_rt5651_intmic_in2_map[] = {
 {"Internal Mic", NULL, "micbias1"},
 {"IN2P", NULL, "Internal Mic"},
 {"IN3P", NULL, "Headset Mic"},
};

static const struct snd_soc_dapm_route byt_rt5651_intmic_in1_in2_map[] = {
 {"Internal Mic", NULL, "micbias1"},
 {"IN1P", NULL, "Internal Mic"},
 {"IN2P", NULL, "Internal Mic"},
 {"IN3P", NULL, "Headset Mic"},
};

static const struct snd_soc_dapm_route byt_rt5651_ssp0_aif1_map[] = {
 {"ssp0 Tx", NULL, "modem_out"},
 {"modem_in", NULL, "ssp0 Rx"},

 {"AIF1 Playback", NULL, "ssp0 Tx"},
 {"ssp0 Rx", NULL, "AIF1 Capture"},
};

static const struct snd_soc_dapm_route byt_rt5651_ssp0_aif2_map[] = {
 {"ssp0 Tx", NULL, "modem_out"},
 {"modem_in", NULL, "ssp0 Rx"},

 {"AIF2 Playback", NULL, "ssp0 Tx"},
 {"ssp0 Rx", NULL, "AIF2 Capture"},
};

static const struct snd_soc_dapm_route byt_rt5651_ssp2_aif1_map[] = {
 {"ssp2 Tx", NULL, "codec_out0"},
 {"ssp2 Tx", NULL, "codec_out1"},
 {"codec_in0", NULL, "ssp2 Rx"},
 {"codec_in1", NULL, "ssp2 Rx"},

 {"AIF1 Playback", NULL, "ssp2 Tx"},
 {"ssp2 Rx", NULL, "AIF1 Capture"},
};

static const struct snd_soc_dapm_route byt_rt5651_ssp2_aif2_map[] = {
 {"ssp2 Tx", NULL, "codec_out0"},
 {"ssp2 Tx", NULL, "codec_out1"},
 {"codec_in0", NULL, "ssp2 Rx"},
 {"codec_in1", NULL, "ssp2 Rx"},

 {"AIF2 Playback", NULL, "ssp2 Tx"},
 {"ssp2 Rx", NULL, "AIF2 Capture"},
};

static const struct snd_kcontrol_new byt_rt5651_controls[] = {
 SOC_DAPM_PIN_SWITCH("Headphone"),
 SOC_DAPM_PIN_SWITCH("Headset Mic"),
 SOC_DAPM_PIN_SWITCH("Internal Mic"),
 SOC_DAPM_PIN_SWITCH("Speaker"),
 SOC_DAPM_PIN_SWITCH("Line In"),
};

static struct snd_soc_jack_pin bytcr_jack_pins[] = {
 {
  .pin = "Headphone",
  .mask = SND_JACK_HEADPHONE,
 },
 {
  .pin = "Headset Mic",
  .mask = SND_JACK_MICROPHONE,
 },
};

static int byt_rt5651_aif1_hw_params(struct snd_pcm_substream *substream,
     struct snd_pcm_hw_params *params)
{
 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
 snd_pcm_format_t format = params_format(params);
 int rate = params_rate(params);
 int bclk_ratio;

 if (format == SNDRV_PCM_FORMAT_S16_LE)
  bclk_ratio = 32;
 else
  bclk_ratio = 50;

 return byt_rt5651_prepare_and_enable_pll1(codec_dai, rate, bclk_ratio);
}

static const struct acpi_gpio_params pov_p1006w_hp_detect = { 1, 0, false };
static const struct acpi_gpio_params pov_p1006w_ext_amp_en = { 2, 0, true };

static const struct acpi_gpio_mapping byt_rt5651_pov_p1006w_gpios[] = {
 { "hp-detect-gpios", &pov_p1006w_hp_detect, 1, },
 { "ext-amp-enable-gpios", &pov_p1006w_ext_amp_en, 1, },
 { },
};

static int byt_rt5651_pov_p1006w_quirk_cb(const struct dmi_system_id *id)
{
 byt_rt5651_quirk = (unsigned long)id->driver_data;
 byt_rt5651_gpios = byt_rt5651_pov_p1006w_gpios;
 return 1;
}

static int byt_rt5651_quirk_cb(const struct dmi_system_id *id)
{
 byt_rt5651_quirk = (unsigned long)id->driver_data;
 return 1;
}

static const struct dmi_system_id byt_rt5651_quirk_table[] = {
 {
  /* Chuwi Hi8 Pro (CWI513) */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "Hampoo"),
   DMI_MATCH(DMI_PRODUCT_NAME, "X1D3_C806N"),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_HP_LR_SWAPPED |
     BYT_RT5651_MONO_SPEAKER),
 },
 {
  /* Chuwi Vi8 Plus (CWI519) */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "Hampoo"),
   DMI_MATCH(DMI_PRODUCT_NAME, "D2D3_Vi8A1"),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_HP_LR_SWAPPED |
     BYT_RT5651_MONO_SPEAKER),
 },
 {
  /* Complet Electro Serv MY8307 */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "Complet Electro Serv"),
   DMI_MATCH(DMI_PRODUCT_NAME, "MY8307"),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_MONO_SPEAKER |
     BYT_RT5651_JD_NOT_INV),
 },
 {
  /* I.T.Works TW701, Ployer Momo7w and Trekstor ST70416-6
 * (these all use the same mainboard) */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_BIOS_VENDOR, "INSYDE Corp."),
   /* Partial match for all of itWORKS.G.WI71C.JGBMRBA,
 * TREK.G.WI71C.JGBMRBA0x and MOMO.G.WI71C.MABMRBA02 */
   DMI_MATCH(DMI_BIOS_VERSION, ".G.WI71C."),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_SSP0_AIF1 |
     BYT_RT5651_MONO_SPEAKER),
 },
 {
  /* Jumper EZpad 7 */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "Jumper"),
   DMI_MATCH(DMI_PRODUCT_NAME, "EZpad"),
   /* Jumper12x.WJ2012.bsBKRCP05 with the version dropped */
   DMI_MATCH(DMI_BIOS_VERSION, "Jumper12x.WJ2012.bsBKRCP"),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_JD_NOT_INV),
 },
 {
  /* KIANO SlimNote 14.2 */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "KIANO"),
   DMI_MATCH(DMI_PRODUCT_NAME, "KIANO SlimNote 14.2"),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN1_IN2_MAP),
 },
 {
  /* Minnowboard Max B3 */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "Circuitco"),
   DMI_MATCH(DMI_PRODUCT_NAME, "Minnowboard Max B3 PLATFORM"),
  },
  .driver_data = (void *)(BYT_RT5651_IN1_MAP),
 },
 {
  /* Minnowboard Turbot */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "ADI"),
   DMI_MATCH(DMI_PRODUCT_NAME, "Minnowboard Turbot"),
  },
  .driver_data = (void *)(BYT_RT5651_MCLK_EN |
     BYT_RT5651_IN1_MAP),
 },
 {
  /* Point of View mobii wintab p1006w (v1.0) */
  .callback = byt_rt5651_pov_p1006w_quirk_cb,
  .matches = {
   DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Insyde"),
   DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "BayTrail"),
   /* Note 105b is Foxcon's USB/PCI vendor id */
   DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "105B"),
   DMI_EXACT_MATCH(DMI_BOARD_NAME, "0E57"),
  },
  .driver_data = (void *)(BYT_RT5651_DMIC_MAP |
     BYT_RT5651_OVCD_TH_2000UA |
     BYT_RT5651_OVCD_SF_0P75 |
     BYT_RT5651_DMIC_EN |
     BYT_RT5651_MCLK_EN |
     BYT_RT5651_SSP0_AIF1),
 },
 {
  /* VIOS LTH17 */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_SYS_VENDOR, "VIOS"),
   DMI_MATCH(DMI_PRODUCT_NAME, "LTH17"),
  },
  .driver_data = (void *)(BYT_RT5651_IN1_IN2_MAP |
     BYT_RT5651_JD1_1 |
     BYT_RT5651_OVCD_TH_2000UA |
     BYT_RT5651_OVCD_SF_1P0 |
     BYT_RT5651_MCLK_EN),
 },
 {
  /* Yours Y8W81 (and others using the same mainboard) */
  .callback = byt_rt5651_quirk_cb,
  .matches = {
   DMI_MATCH(DMI_BIOS_VENDOR, "INSYDE Corp."),
   /* Partial match for all devs with a W86C mainboard */
   DMI_MATCH(DMI_BIOS_VERSION, ".F.W86C."),
  },
  .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
     BYT_RT5651_IN2_MAP |
     BYT_RT5651_SSP0_AIF1 |
     BYT_RT5651_MONO_SPEAKER),
 },
 {}
};

/*
 * Note this MUST be called before snd_soc_register_card(), so that the props
 * are in place before the codec component driver's probe function parses them.
 */
static int byt_rt5651_add_codec_device_props(struct device *i2c_dev,
          struct byt_rt5651_private *priv)
{
 struct property_entry props[MAX_NO_PROPS] = {};
 struct fwnode_handle *fwnode;
 int cnt = 0;
 int ret;

 props[cnt++] = PROPERTY_ENTRY_U32("realtek,jack-detect-source",
    BYT_RT5651_JDSRC(byt_rt5651_quirk));

 props[cnt++] = PROPERTY_ENTRY_U32("realtek,over-current-threshold-microamp",
    BYT_RT5651_OVCD_TH(byt_rt5651_quirk) * 100);

 props[cnt++] = PROPERTY_ENTRY_U32("realtek,over-current-scale-factor",
    BYT_RT5651_OVCD_SF(byt_rt5651_quirk));

 if (byt_rt5651_quirk & BYT_RT5651_DMIC_EN)
  props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,dmic-en");

 if (byt_rt5651_quirk & BYT_RT5651_JD_NOT_INV)
  props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,jack-detect-not-inverted");

 fwnode = fwnode_create_software_node(props, NULL);
 if (IS_ERR(fwnode)) {
  /* put_device(i2c_dev) is handled in caller */
  return PTR_ERR(fwnode);
 }

 ret = device_add_software_node(i2c_dev, to_software_node(fwnode));

 fwnode_handle_put(fwnode);

 return ret;
}

static int byt_rt5651_init(struct snd_soc_pcm_runtime *runtime)
{
 struct snd_soc_card *card = runtime->card;
 struct snd_soc_component *codec = snd_soc_rtd_to_codec(runtime, 0)->component;
 struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 const struct snd_soc_dapm_route *custom_map;
 int num_routes;
 int report;
 int ret;

 card->dapm.idle_bias_off = true;

 /* Start with RC clk for jack-detect (we disable MCLK below) */
 if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN)
  snd_soc_component_update_bits(codec, RT5651_GLB_CLK,
   RT5651_SCLK_SRC_MASK, RT5651_SCLK_SRC_RCCLK);

 switch (BYT_RT5651_MAP(byt_rt5651_quirk)) {
 case BYT_RT5651_IN1_MAP:
  custom_map = byt_rt5651_intmic_in1_map;
  num_routes = ARRAY_SIZE(byt_rt5651_intmic_in1_map);
  break;
 case BYT_RT5651_IN2_MAP:
  custom_map = byt_rt5651_intmic_in2_map;
  num_routes = ARRAY_SIZE(byt_rt5651_intmic_in2_map);
  break;
 case BYT_RT5651_IN1_IN2_MAP:
  custom_map = byt_rt5651_intmic_in1_in2_map;
  num_routes = ARRAY_SIZE(byt_rt5651_intmic_in1_in2_map);
  break;
 default:
  custom_map = byt_rt5651_intmic_dmic_map;
  num_routes = ARRAY_SIZE(byt_rt5651_intmic_dmic_map);
 }
 ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
 if (ret)
  return ret;

 if (byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2) {
  ret = snd_soc_dapm_add_routes(&card->dapm,
     byt_rt5651_ssp2_aif2_map,
     ARRAY_SIZE(byt_rt5651_ssp2_aif2_map));
 } else if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) {
  ret = snd_soc_dapm_add_routes(&card->dapm,
     byt_rt5651_ssp0_aif1_map,
     ARRAY_SIZE(byt_rt5651_ssp0_aif1_map));
 } else if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2) {
  ret = snd_soc_dapm_add_routes(&card->dapm,
     byt_rt5651_ssp0_aif2_map,
     ARRAY_SIZE(byt_rt5651_ssp0_aif2_map));
 } else {
  ret = snd_soc_dapm_add_routes(&card->dapm,
     byt_rt5651_ssp2_aif1_map,
     ARRAY_SIZE(byt_rt5651_ssp2_aif1_map));
 }
 if (ret)
  return ret;

 ret = snd_soc_add_card_controls(card, byt_rt5651_controls,
     ARRAY_SIZE(byt_rt5651_controls));
 if (ret) {
  dev_err(card->dev, "unable to add card controls\n");
  return ret;
 }

 /*
 * The firmware might enable the clock at boot (this information
 * may or may not be reflected in the enable clock register).
 * To change the rate we must disable the clock first to cover
 * these cases. Due to common clock framework restrictions that
 * do not allow to disable a clock that has not been enabled,
 * we need to enable the clock first.
 */
 ret = clk_prepare_enable(priv->mclk);
 if (!ret)
  clk_disable_unprepare(priv->mclk);

 if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
  ret = clk_set_rate(priv->mclk, 25000000);
 else
  ret = clk_set_rate(priv->mclk, 19200000);

 if (ret)
  dev_err(card->dev, "unable to set MCLK rate\n");

 report = 0;
 if (BYT_RT5651_JDSRC(byt_rt5651_quirk))
  report = SND_JACK_HEADSET | SND_JACK_BTN_0;
 else if (priv->hp_detect)
  report = SND_JACK_HEADSET;

 if (report) {
  ret = snd_soc_card_jack_new_pins(runtime->card, "Headset",
       report, &priv->jack,
       bytcr_jack_pins,
       ARRAY_SIZE(bytcr_jack_pins));
  if (ret) {
   dev_err(runtime->dev, "jack creation failed %d\n", ret);
   return ret;
  }

  if (report & SND_JACK_BTN_0)
   snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0,
      KEY_PLAYPAUSE);

  ret = snd_soc_component_set_jack(codec, &priv->jack,
       priv->hp_detect);
  if (ret)
   return ret;
 }

 return 0;
}

static int byt_rt5651_codec_fixup(struct snd_soc_pcm_runtime *rtd,
       struct snd_pcm_hw_params *params)
{
 struct snd_interval *rate = hw_param_interval(params,
   SNDRV_PCM_HW_PARAM_RATE);
 struct snd_interval *channels = hw_param_interval(params,
      SNDRV_PCM_HW_PARAM_CHANNELS);
 int ret, bits;

 /* The DSP will convert the FE rate to 48k, stereo */
 rate->min = rate->max = 48000;
 channels->min = channels->max = 2;

 if ((byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) ||
     (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2)) {
  /* set SSP0 to 16-bit */
  params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
  bits = 16;
 } else {
  /* set SSP2 to 24-bit */
  params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
  bits = 24;
 }

 /*
 * Default mode for SSP configuration is TDM 4 slot, override config
 * with explicit setting to I2S 2ch. The word length is set with
 * dai_set_tdm_slot() since there is no other API exposed
 */
 ret = snd_soc_dai_set_fmt(snd_soc_rtd_to_cpu(rtd, 0),
      SND_SOC_DAIFMT_I2S     |
      SND_SOC_DAIFMT_NB_NF   |
      SND_SOC_DAIFMT_BP_FP
      );

 if (ret < 0) {
  dev_err(rtd->dev, "can't set format to I2S, err %d\n", ret);
  return ret;
 }

 ret = snd_soc_dai_set_tdm_slot(snd_soc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
 if (ret < 0) {
  dev_err(rtd->dev, "can't set I2S config, err %d\n", ret);
  return ret;
 }

 return 0;
}

static const unsigned int rates_48000[] = {
 48000,
};

static const struct snd_pcm_hw_constraint_list constraints_48000 = {
 .count = ARRAY_SIZE(rates_48000),
 .list  = rates_48000,
};

static int byt_rt5651_aif1_startup(struct snd_pcm_substream *substream)
{
 return snd_pcm_hw_constraint_list(substream->runtime, 0,
   SNDRV_PCM_HW_PARAM_RATE,
   &constraints_48000);
}

static const struct snd_soc_ops byt_rt5651_aif1_ops = {
 .startup = byt_rt5651_aif1_startup,
};

static const struct snd_soc_ops byt_rt5651_be_ssp2_ops = {
 .hw_params = byt_rt5651_aif1_hw_params,
};

SND_SOC_DAILINK_DEF(dummy,
 DAILINK_COMP_ARRAY(COMP_DUMMY()));

SND_SOC_DAILINK_DEF(media,
 DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));

SND_SOC_DAILINK_DEF(deepbuffer,
 DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));

SND_SOC_DAILINK_DEF(ssp2_port,
 DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
SND_SOC_DAILINK_DEF(ssp2_codec,
 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-10EC5651:00", "rt5651-aif1")));

SND_SOC_DAILINK_DEF(platform,
 DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));

static struct snd_soc_dai_link byt_rt5651_dais[] = {
 [MERR_DPCM_AUDIO] = {
  .name = "Audio Port",
  .stream_name = "Audio",
  .nonatomic = true,
  .dynamic = 1,
  .ops = &byt_rt5651_aif1_ops,
  SND_SOC_DAILINK_REG(media, dummy, platform),
 },
 [MERR_DPCM_DEEP_BUFFER] = {
  .name = "Deep-Buffer Audio Port",
  .stream_name = "Deep-Buffer Audio",
  .nonatomic = true,
  .dynamic = 1,
  .playback_only = 1,
  .ops = &byt_rt5651_aif1_ops,
  SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
 },
 /* CODEC<->CODEC link */
 /* back ends */
 {
  .name = "SSP2-Codec",
  .id = 0,
  .no_pcm = 1,
  .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
      | SND_SOC_DAIFMT_CBC_CFC,
  .be_hw_params_fixup = byt_rt5651_codec_fixup,
  .init = byt_rt5651_init,
  .ops = &byt_rt5651_be_ssp2_ops,
  SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
 },
};

/* SoC card */
static char byt_rt5651_codec_name[SND_ACPI_I2C_ID_LEN];
#if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
static char byt_rt5651_long_name[50]; /* = "bytcr-rt5651-*-spk-*-mic[-swapped-hp]" */
#endif
static char byt_rt5651_components[50]; /* = "cfg-spk:* cfg-mic:*" */

static int byt_rt5651_suspend(struct snd_soc_card *card)
{
 struct snd_soc_component *component;

 if (!BYT_RT5651_JDSRC(byt_rt5651_quirk))
  return 0;

 for_each_card_components(card, component) {
  if (!strcmp(component->name, byt_rt5651_codec_name)) {
   dev_dbg(component->dev, "disabling jack detect before suspend\n");
   snd_soc_component_set_jack(component, NULL, NULL);
   break;
  }
 }

 return 0;
}

static int byt_rt5651_resume(struct snd_soc_card *card)
{
 struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 struct snd_soc_component *component;

 if (!BYT_RT5651_JDSRC(byt_rt5651_quirk))
  return 0;

 for_each_card_components(card, component) {
  if (!strcmp(component->name, byt_rt5651_codec_name)) {
   dev_dbg(component->dev, "re-enabling jack detect after resume\n");
   snd_soc_component_set_jack(component, &priv->jack,
         priv->hp_detect);
   break;
  }
 }

 return 0;
}

/* use space before codec name to simplify card ID, and simplify driver name */
#define SOF_CARD_NAME "bytcht rt5651" /* card name will be 'sof-bytcht rt5651' */
#define SOF_DRIVER_NAME "SOF"

#define CARD_NAME "bytcr-rt5651"
#define DRIVER_NAME NULL /* card name will be used for driver name */

static struct snd_soc_card byt_rt5651_card = {
 .name = CARD_NAME,
 .driver_name = DRIVER_NAME,
 .owner = THIS_MODULE,
 .dai_link = byt_rt5651_dais,
 .num_links = ARRAY_SIZE(byt_rt5651_dais),
 .dapm_widgets = byt_rt5651_widgets,
 .num_dapm_widgets = ARRAY_SIZE(byt_rt5651_widgets),
 .dapm_routes = byt_rt5651_audio_map,
 .num_dapm_routes = ARRAY_SIZE(byt_rt5651_audio_map),
 .fully_routed = true,
 .suspend_pre = byt_rt5651_suspend,
 .resume_post = byt_rt5651_resume,
};

static const struct acpi_gpio_params ext_amp_enable_gpios = { 0, 0, false };

static const struct acpi_gpio_mapping cht_rt5651_gpios[] = {
 /*
 * Some boards have I2cSerialBusV2, GpioIo, GpioInt as ACPI resources,
 * other boards may  have I2cSerialBusV2, GpioInt, GpioIo instead.
 * We want the GpioIo one for the ext-amp-enable-gpio.
 */
 { "ext-amp-enable-gpios", &ext_amp_enable_gpios, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
 { },
};

struct acpi_chan_package {   /* ACPICA seems to require 64 bit integers */
 u64 aif_value;       /* 1: AIF1, 2: AIF2 */
 u64 mclock_value;    /* usually 25MHz (0x17d7940), ignored */
};

static int snd_byt_rt5651_mc_probe(struct platform_device *pdev)
{
 struct device *dev = &pdev->dev;
 static const char * const mic_name[] = { "dmic", "in1", "in2", "in12" };
 struct snd_soc_acpi_mach *mach = dev_get_platdata(dev);
 struct byt_rt5651_private *priv;
 const char *platform_name;
 struct acpi_device *adev;
 struct device *codec_dev;
 bool sof_parent;
 bool is_bytcr = false;
 int ret_val = 0;
 int dai_index = 0;
 int i;

 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 if (!priv)
  return -ENOMEM;

 /* register the soc card */
 byt_rt5651_card.dev = dev;
 snd_soc_card_set_drvdata(&byt_rt5651_card, priv);

 /* fix index of codec dai */
 for (i = 0; i < ARRAY_SIZE(byt_rt5651_dais); i++) {
  if (byt_rt5651_dais[i].num_codecs &&
      !strcmp(byt_rt5651_dais[i].codecs->name,
       "i2c-10EC5651:00")) {
   dai_index = i;
   break;
  }
 }

 /* fixup codec name based on HID */
 adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
 if (adev) {
  snprintf(byt_rt5651_codec_name, sizeof(byt_rt5651_codec_name),
    "i2c-%s", acpi_dev_name(adev));
  byt_rt5651_dais[dai_index].codecs->name = byt_rt5651_codec_name;
 } else {
  dev_err(dev, "Error cannot find '%s' dev\n", mach->id);
  return -ENOENT;
 }

 codec_dev = acpi_get_first_physical_node(adev);
 acpi_dev_put(adev);
 if (!codec_dev)
  return -EPROBE_DEFER;
 priv->codec_dev = get_device(codec_dev);

 /*
 * swap SSP0 if bytcr is detected
 * (will be overridden if DMI quirk is detected)
 */
 if (soc_intel_is_byt()) {
  if (mach->mach_params.acpi_ipc_irq_index == 0)
   is_bytcr = true;
 }

 if (is_bytcr) {
  /*
 * Baytrail CR platforms may have CHAN package in BIOS, try
 * to find relevant routing quirk based as done on Windows
 * platforms. We have to read the information directly from the
 * BIOS, at this stage the card is not created and the links
 * with the codec driver/pdata are non-existent
 */

  struct acpi_chan_package chan_package = { 0 };

  /* format specified: 2 64-bit integers */
  struct acpi_buffer format = {sizeof("NN"), "NN"};
  struct acpi_buffer state = {0, NULL};
  struct snd_soc_acpi_package_context pkg_ctx;
  bool pkg_found = false;

  state.length = sizeof(chan_package);
  state.pointer = &chan_package;

  pkg_ctx.name = "CHAN";
  pkg_ctx.length = 2;
  pkg_ctx.format = &format;
  pkg_ctx.state = &state;
  pkg_ctx.data_valid = false;

  pkg_found = snd_soc_acpi_find_package_from_hid(mach->id,
              &pkg_ctx);
  if (pkg_found) {
   if (chan_package.aif_value == 1) {
    dev_info(dev, "BIOS Routing: AIF1 connected\n");
    byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF1;
   } else  if (chan_package.aif_value == 2) {
    dev_info(dev, "BIOS Routing: AIF2 connected\n");
    byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF2;
   } else {
    dev_info(dev, "BIOS Routing isn't valid, ignored\n");
    pkg_found = false;
   }
  }

  if (!pkg_found) {
   /* no BIOS indications, assume SSP0-AIF2 connection */
   byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF2;
  }
 }

 /* check quirks before creating card */
 dmi_check_system(byt_rt5651_quirk_table);

 if (quirk_override != -1) {
  dev_info(dev, "Overriding quirk 0x%lx => 0x%x\n",
    byt_rt5651_quirk, quirk_override);
  byt_rt5651_quirk = quirk_override;
 }

 /* Must be called before register_card, also see declaration comment. */
 ret_val = byt_rt5651_add_codec_device_props(codec_dev, priv);
 if (ret_val)
  goto err_device;

 /* Cherry Trail devices use an external amplifier enable gpio */
 if (soc_intel_is_cht() && !byt_rt5651_gpios)
  byt_rt5651_gpios = cht_rt5651_gpios;

 if (byt_rt5651_gpios) {
  devm_acpi_dev_add_driver_gpios(codec_dev, byt_rt5651_gpios);
  priv->ext_amp_gpio = devm_fwnode_gpiod_get(dev, codec_dev->fwnode,
          "ext-amp-enable",
          GPIOD_OUT_LOW,
          "speaker-amp");
  if (IS_ERR(priv->ext_amp_gpio)) {
   ret_val = PTR_ERR(priv->ext_amp_gpio);
   switch (ret_val) {
   case -ENOENT:
    priv->ext_amp_gpio = NULL;
    break;
   default:
    dev_err(dev, "Failed to get ext-amp-enable GPIO: %d\n", ret_val);
    fallthrough;
   case -EPROBE_DEFER:
    goto err;
   }
  }
  priv->hp_detect = devm_fwnode_gpiod_get(dev, codec_dev->fwnode,
       "hp-detect",
       GPIOD_IN,
       "hp-detect");
  if (IS_ERR(priv->hp_detect)) {
   ret_val = PTR_ERR(priv->hp_detect);
   switch (ret_val) {
   case -ENOENT:
    priv->hp_detect = NULL;
    break;
   default:
    dev_err(dev, "Failed to get hp-detect GPIO: %d\n", ret_val);
    fallthrough;
   case -EPROBE_DEFER:
    goto err;
   }
  }
 }

 log_quirks(dev);

 if ((byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2) ||
     (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2))
  byt_rt5651_dais[dai_index].codecs->dai_name = "rt5651-aif2";

 if ((byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) ||
     (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2))
  byt_rt5651_dais[dai_index].cpus->dai_name = "ssp0-port";

 if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN) {
  priv->mclk = devm_clk_get_optional(dev, "pmc_plt_clk_3");
  if (IS_ERR(priv->mclk)) {
   ret_val = dev_err_probe(dev, PTR_ERR(priv->mclk),
      "Failed to get MCLK from pmc_plt_clk_3\n");
   goto err;
  }
  /*
 * Fall back to bit clock usage when clock is not
 * available likely due to missing dependencies.
 */
  if (!priv->mclk)
   byt_rt5651_quirk &= ~BYT_RT5651_MCLK_EN;
 }

 snprintf(byt_rt5651_components, sizeof(byt_rt5651_components),
   "cfg-spk:%s cfg-mic:%s%s",
   (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER) ? "1" : "2",
   mic_name[BYT_RT5651_MAP(byt_rt5651_quirk)],
   (byt_rt5651_quirk & BYT_RT5651_HP_LR_SWAPPED) ?
   " cfg-hp:lrswap" : "");
 byt_rt5651_card.components = byt_rt5651_components;
#if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
 snprintf(byt_rt5651_long_name, sizeof(byt_rt5651_long_name),
   "bytcr-rt5651-%s-spk-%s-mic%s",
   (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER) ?
   "mono" : "stereo",
   mic_name[BYT_RT5651_MAP(byt_rt5651_quirk)],
   (byt_rt5651_quirk & BYT_RT5651_HP_LR_SWAPPED) ?
   "-hp-swapped" : "");
 byt_rt5651_card.long_name = byt_rt5651_long_name;
#endif

 /* override platform name, if required */
 platform_name = mach->mach_params.platform;

 ret_val = snd_soc_fixup_dai_links_platform_name(&byt_rt5651_card,
       platform_name);
 if (ret_val)
  goto err;

 sof_parent = snd_soc_acpi_sof_parent(dev);

 /* set card and driver name */
 if (sof_parent) {
  byt_rt5651_card.name = SOF_CARD_NAME;
  byt_rt5651_card.driver_name = SOF_DRIVER_NAME;
 } else {
  byt_rt5651_card.name = CARD_NAME;
  byt_rt5651_card.driver_name = DRIVER_NAME;
 }

 /* set pm ops */
 if (sof_parent)
  dev->driver->pm = &snd_soc_pm_ops;

 ret_val = devm_snd_soc_register_card(dev, &byt_rt5651_card);
 if (ret_val) {
  dev_err(dev, "devm_snd_soc_register_card failed %d\n", ret_val);
  goto err;
 }
 platform_set_drvdata(pdev, &byt_rt5651_card);
 return ret_val;

err:
 device_remove_software_node(priv->codec_dev);
err_device:
 put_device(priv->codec_dev);
 return ret_val;
}

static void snd_byt_rt5651_mc_remove(struct platform_device *pdev)
{
 struct snd_soc_card *card = platform_get_drvdata(pdev);
 struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);

 device_remove_software_node(priv->codec_dev);
 put_device(priv->codec_dev);
}

static struct platform_driver snd_byt_rt5651_mc_driver = {
 .driver = {
  .name = "bytcr_rt5651",
 },
 .probe = snd_byt_rt5651_mc_probe,
 .remove = snd_byt_rt5651_mc_remove,
};

module_platform_driver(snd_byt_rt5651_mc_driver);

MODULE_DESCRIPTION("ASoC Intel(R) Baytrail CR Machine driver for RT5651");
MODULE_AUTHOR("Pierre-Louis Bossart ");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:bytcr_rt5651");