sound/soc/intel/boards/bytcr_rt5651.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  bytcr_rt5651.c - ASoc Machine driver for Intel Byt CR platform
   4  *  (derived from bytcr_rt5640.c)
   5  *
   6  *  Copyright (C) 2015 Intel Corp
   7  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *
   9  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10  */
  11
  12 #include <linux/init.h>
  13 #include <linux/i2c.h>
  14 #include <linux/module.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/property.h>
  17 #include <linux/acpi.h>
  18 #include <linux/clk.h>
  19 #include <linux/device.h>
  20 #include <linux/dmi.h>
  21 #include <linux/input.h>
  22 #include <linux/gpio/consumer.h>
  23 #include <linux/gpio/machine.h>
  24 #include <linux/slab.h>
  25 #include <sound/pcm.h>
  26 #include <sound/pcm_params.h>
  27 #include <sound/soc.h>
  28 #include <sound/jack.h>
  29 #include <sound/soc-acpi.h>
  30 #include "../../codecs/rt5651.h"
  31 #include "../atom/sst-atom-controls.h"
  32 #include "../common/soc-intel-quirks.h"
  33
  34 enum {
  35         BYT_RT5651_DMIC_MAP,
  36         BYT_RT5651_IN1_MAP,
  37         BYT_RT5651_IN2_MAP,
  38         BYT_RT5651_IN1_IN2_MAP,
  39 };
  40
  41 enum {
  42         BYT_RT5651_JD_NULL      = (RT5651_JD_NULL << 4),
  43         BYT_RT5651_JD1_1        = (RT5651_JD1_1 << 4),
  44         BYT_RT5651_JD1_2        = (RT5651_JD1_2 << 4),
  45         BYT_RT5651_JD2          = (RT5651_JD2 << 4),
  46 };
  47
  48 enum {
  49         BYT_RT5651_OVCD_TH_600UA  = (6 << 8),
  50         BYT_RT5651_OVCD_TH_1500UA = (15 << 8),
  51         BYT_RT5651_OVCD_TH_2000UA = (20 << 8),
  52 };
  53
  54 enum {
  55         BYT_RT5651_OVCD_SF_0P5  = (RT5651_OVCD_SF_0P5 << 13),
  56         BYT_RT5651_OVCD_SF_0P75 = (RT5651_OVCD_SF_0P75 << 13),
  57         BYT_RT5651_OVCD_SF_1P0  = (RT5651_OVCD_SF_1P0 << 13),
  58         BYT_RT5651_OVCD_SF_1P5  = (RT5651_OVCD_SF_1P5 << 13),
  59 };
  60
  61 #define BYT_RT5651_MAP(quirk)           ((quirk) & GENMASK(3, 0))
  62 #define BYT_RT5651_JDSRC(quirk)         (((quirk) & GENMASK(7, 4)) >> 4)
  63 #define BYT_RT5651_OVCD_TH(quirk)       (((quirk) & GENMASK(12, 8)) >> 8)
  64 #define BYT_RT5651_OVCD_SF(quirk)       (((quirk) & GENMASK(14, 13)) >> 13)
  65 #define BYT_RT5651_DMIC_EN              BIT(16)
  66 #define BYT_RT5651_MCLK_EN              BIT(17)
  67 #define BYT_RT5651_MCLK_25MHZ           BIT(18)
  68 #define BYT_RT5651_SSP2_AIF2            BIT(19) /* default is using AIF1  */
  69 #define BYT_RT5651_SSP0_AIF1            BIT(20)
  70 #define BYT_RT5651_SSP0_AIF2            BIT(21)
  71 #define BYT_RT5651_HP_LR_SWAPPED        BIT(22)
  72 #define BYT_RT5651_MONO_SPEAKER         BIT(23)
  73 #define BYT_RT5651_JD_NOT_INV           BIT(24)
  74
  75 #define BYT_RT5651_DEFAULT_QUIRKS       (BYT_RT5651_MCLK_EN | \
  76                                          BYT_RT5651_JD1_1   | \
  77                                          BYT_RT5651_OVCD_TH_2000UA | \
  78                                          BYT_RT5651_OVCD_SF_0P75)
  79
  80 /* jack-detect-source + inv + dmic-en + ovcd-th + -sf + terminating entry */
  81 #define MAX_NO_PROPS 6
  82
  83 struct byt_rt5651_private {
  84         struct clk *mclk;
  85         struct gpio_desc *ext_amp_gpio;
  86         struct gpio_desc *hp_detect;
  87         struct snd_soc_jack jack;
  88         struct device *codec_dev;
  89 };
  90
  91 static const struct acpi_gpio_mapping *byt_rt5651_gpios;
  92
  93 /* Default: jack-detect on JD1_1, internal mic on in2, headsetmic on in3 */
  94 static unsigned long byt_rt5651_quirk = BYT_RT5651_DEFAULT_QUIRKS |
  95                                         BYT_RT5651_IN2_MAP;
  96
  97 static int quirk_override = -1;
  98 module_param_named(quirk, quirk_override, int, 0444);
  99 MODULE_PARM_DESC(quirk, "Board-specific quirk override");
 100
 101 static void log_quirks(struct device *dev)
 102 {
 103         if (BYT_RT5651_MAP(byt_rt5651_quirk) == BYT_RT5651_DMIC_MAP)
 104                 dev_info(dev, "quirk DMIC_MAP enabled");
 105         if (BYT_RT5651_MAP(byt_rt5651_quirk) == BYT_RT5651_IN1_MAP)
 106                 dev_info(dev, "quirk IN1_MAP enabled");
 107         if (BYT_RT5651_MAP(byt_rt5651_quirk) == BYT_RT5651_IN2_MAP)
 108                 dev_info(dev, "quirk IN2_MAP enabled");
 109         if (BYT_RT5651_MAP(byt_rt5651_quirk) == BYT_RT5651_IN1_IN2_MAP)
 110                 dev_info(dev, "quirk IN1_IN2_MAP enabled");
 111         if (BYT_RT5651_JDSRC(byt_rt5651_quirk)) {
 112                 dev_info(dev, "quirk realtek,jack-detect-source %ld\n",
 113                          BYT_RT5651_JDSRC(byt_rt5651_quirk));
 114                 dev_info(dev, "quirk realtek,over-current-threshold-microamp %ld\n",
 115                          BYT_RT5651_OVCD_TH(byt_rt5651_quirk) * 100);
 116                 dev_info(dev, "quirk realtek,over-current-scale-factor %ld\n",
 117                          BYT_RT5651_OVCD_SF(byt_rt5651_quirk));
 118         }
 119         if (byt_rt5651_quirk & BYT_RT5651_DMIC_EN)
 120                 dev_info(dev, "quirk DMIC enabled");
 121         if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN)
 122                 dev_info(dev, "quirk MCLK_EN enabled");
 123         if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
 124                 dev_info(dev, "quirk MCLK_25MHZ enabled");
 125         if (byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2)
 126                 dev_info(dev, "quirk SSP2_AIF2 enabled\n");
 127         if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1)
 128                 dev_info(dev, "quirk SSP0_AIF1 enabled\n");
 129         if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2)
 130                 dev_info(dev, "quirk SSP0_AIF2 enabled\n");
 131         if (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER)
 132                 dev_info(dev, "quirk MONO_SPEAKER enabled\n");
 133         if (byt_rt5651_quirk & BYT_RT5651_JD_NOT_INV)
 134                 dev_info(dev, "quirk JD_NOT_INV enabled\n");
 135 }
 136
 137 #define BYT_CODEC_DAI1  "rt5651-aif1"
 138 #define BYT_CODEC_DAI2  "rt5651-aif2"
 139
 140 static int byt_rt5651_prepare_and_enable_pll1(struct snd_soc_dai *codec_dai,
 141                                               int rate, int bclk_ratio)
 142 {
 143         int clk_id, clk_freq, ret;
 144
 145         /* Configure the PLL before selecting it */
 146         if (!(byt_rt5651_quirk & BYT_RT5651_MCLK_EN)) {
 147                 clk_id = RT5651_PLL1_S_BCLK1;
 148                 clk_freq = rate * bclk_ratio;
 149         } else {
 150                 clk_id = RT5651_PLL1_S_MCLK;
 151                 if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
 152                         clk_freq = 25000000;
 153                 else
 154                         clk_freq = 19200000;
 155         }
 156         ret = snd_soc_dai_set_pll(codec_dai, 0, clk_id, clk_freq, rate * 512);
 157         if (ret < 0) {
 158                 dev_err(codec_dai->component->dev, "can't set pll: %d\n", ret);
 159                 return ret;
 160         }
 161
 162         ret = snd_soc_dai_set_sysclk(codec_dai, RT5651_SCLK_S_PLL1,
 163                                      rate * 512, SND_SOC_CLOCK_IN);
 164         if (ret < 0) {
 165                 dev_err(codec_dai->component->dev, "can't set clock %d\n", ret);
 166                 return ret;
 167         }
 168
 169         return 0;
 170 }
 171
 172 static int platform_clock_control(struct snd_soc_dapm_widget *w,
 173                                   struct snd_kcontrol *k, int  event)
 174 {
 175         struct snd_soc_dapm_context *dapm = w->dapm;
 176         struct snd_soc_card *card = dapm->card;
 177         struct snd_soc_dai *codec_dai;
 178         struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 179         int ret;
 180
 181         codec_dai = snd_soc_card_get_codec_dai(card, BYT_CODEC_DAI1);
 182         if (!codec_dai)
 183                 codec_dai = snd_soc_card_get_codec_dai(card, BYT_CODEC_DAI2);
 184         if (!codec_dai) {
 185                 dev_err(card->dev,
 186                         "Codec dai not found; Unable to set platform clock\n");
 187                 return -EIO;
 188         }
 189
 190         if (SND_SOC_DAPM_EVENT_ON(event)) {
 191                 ret = clk_prepare_enable(priv->mclk);
 192                 if (ret < 0) {
 193                         dev_err(card->dev, "could not configure MCLK state");
 194                         return ret;
 195                 }
 196                 ret = byt_rt5651_prepare_and_enable_pll1(codec_dai, 48000, 50);
 197         } else {
 198                 /*
 199                  * Set codec clock source to internal clock before
 200                  * turning off the platform clock. Codec needs clock
 201                  * for Jack detection and button press
 202                  */
 203                 ret = snd_soc_dai_set_sysclk(codec_dai, RT5651_SCLK_S_RCCLK,
 204                                              48000 * 512,
 205                                              SND_SOC_CLOCK_IN);
 206                 if (!ret)
 207                         clk_disable_unprepare(priv->mclk);
 208         }
 209
 210         if (ret < 0) {
 211                 dev_err(card->dev, "can't set codec sysclk: %d\n", ret);
 212                 return ret;
 213         }
 214
 215         return 0;
 216 }
 217
 218 static int rt5651_ext_amp_power_event(struct snd_soc_dapm_widget *w,
 219         struct snd_kcontrol *kcontrol, int event)
 220 {
 221         struct snd_soc_card *card = w->dapm->card;
 222         struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 223
 224         if (SND_SOC_DAPM_EVENT_ON(event))
 225                 gpiod_set_value_cansleep(priv->ext_amp_gpio, 1);
 226         else
 227                 gpiod_set_value_cansleep(priv->ext_amp_gpio, 0);
 228
 229         return 0;
 230 }
 231
 232 static const struct snd_soc_dapm_widget byt_rt5651_widgets[] = {
 233         SND_SOC_DAPM_HP("Headphone", NULL),
 234         SND_SOC_DAPM_MIC("Headset Mic", NULL),
 235         SND_SOC_DAPM_MIC("Internal Mic", NULL),
 236         SND_SOC_DAPM_SPK("Speaker", NULL),
 237         SND_SOC_DAPM_LINE("Line In", NULL),
 238         SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
 239                             platform_clock_control, SND_SOC_DAPM_PRE_PMU |
 240                             SND_SOC_DAPM_POST_PMD),
 241         SND_SOC_DAPM_SUPPLY("Ext Amp Power", SND_SOC_NOPM, 0, 0,
 242                             rt5651_ext_amp_power_event,
 243                             SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
 244 };
 245
 246 static const struct snd_soc_dapm_route byt_rt5651_audio_map[] = {
 247         {"Headphone", NULL, "Platform Clock"},
 248         {"Headset Mic", NULL, "Platform Clock"},
 249         {"Internal Mic", NULL, "Platform Clock"},
 250         {"Speaker", NULL, "Platform Clock"},
 251         {"Speaker", NULL, "Ext Amp Power"},
 252         {"Line In", NULL, "Platform Clock"},
 253
 254         {"Headset Mic", NULL, "micbias1"}, /* lowercase for rt5651 */
 255         {"Headphone", NULL, "HPOL"},
 256         {"Headphone", NULL, "HPOR"},
 257         {"Speaker", NULL, "LOUTL"},
 258         {"Speaker", NULL, "LOUTR"},
 259         {"IN2P", NULL, "Line In"},
 260         {"IN2N", NULL, "Line In"},
 261
 262 };
 263
 264 static const struct snd_soc_dapm_route byt_rt5651_intmic_dmic_map[] = {
 265         {"DMIC L1", NULL, "Internal Mic"},
 266         {"DMIC R1", NULL, "Internal Mic"},
 267         {"IN2P", NULL, "Headset Mic"},
 268 };
 269
 270 static const struct snd_soc_dapm_route byt_rt5651_intmic_in1_map[] = {
 271         {"Internal Mic", NULL, "micbias1"},
 272         {"IN1P", NULL, "Internal Mic"},
 273         {"IN3P", NULL, "Headset Mic"},
 274 };
 275
 276 static const struct snd_soc_dapm_route byt_rt5651_intmic_in2_map[] = {
 277         {"Internal Mic", NULL, "micbias1"},
 278         {"IN2P", NULL, "Internal Mic"},
 279         {"IN3P", NULL, "Headset Mic"},
 280 };
 281
 282 static const struct snd_soc_dapm_route byt_rt5651_intmic_in1_in2_map[] = {
 283         {"Internal Mic", NULL, "micbias1"},
 284         {"IN1P", NULL, "Internal Mic"},
 285         {"IN2P", NULL, "Internal Mic"},
 286         {"IN3P", NULL, "Headset Mic"},
 287 };
 288
 289 static const struct snd_soc_dapm_route byt_rt5651_ssp0_aif1_map[] = {
 290         {"ssp0 Tx", NULL, "modem_out"},
 291         {"modem_in", NULL, "ssp0 Rx"},
 292
 293         {"AIF1 Playback", NULL, "ssp0 Tx"},
 294         {"ssp0 Rx", NULL, "AIF1 Capture"},
 295 };
 296
 297 static const struct snd_soc_dapm_route byt_rt5651_ssp0_aif2_map[] = {
 298         {"ssp0 Tx", NULL, "modem_out"},
 299         {"modem_in", NULL, "ssp0 Rx"},
 300
 301         {"AIF2 Playback", NULL, "ssp0 Tx"},
 302         {"ssp0 Rx", NULL, "AIF2 Capture"},
 303 };
 304
 305 static const struct snd_soc_dapm_route byt_rt5651_ssp2_aif1_map[] = {
 306         {"ssp2 Tx", NULL, "codec_out0"},
 307         {"ssp2 Tx", NULL, "codec_out1"},
 308         {"codec_in0", NULL, "ssp2 Rx"},
 309         {"codec_in1", NULL, "ssp2 Rx"},
 310
 311         {"AIF1 Playback", NULL, "ssp2 Tx"},
 312         {"ssp2 Rx", NULL, "AIF1 Capture"},
 313 };
 314
 315 static const struct snd_soc_dapm_route byt_rt5651_ssp2_aif2_map[] = {
 316         {"ssp2 Tx", NULL, "codec_out0"},
 317         {"ssp2 Tx", NULL, "codec_out1"},
 318         {"codec_in0", NULL, "ssp2 Rx"},
 319         {"codec_in1", NULL, "ssp2 Rx"},
 320
 321         {"AIF2 Playback", NULL, "ssp2 Tx"},
 322         {"ssp2 Rx", NULL, "AIF2 Capture"},
 323 };
 324
 325 static const struct snd_kcontrol_new byt_rt5651_controls[] = {
 326         SOC_DAPM_PIN_SWITCH("Headphone"),
 327         SOC_DAPM_PIN_SWITCH("Headset Mic"),
 328         SOC_DAPM_PIN_SWITCH("Internal Mic"),
 329         SOC_DAPM_PIN_SWITCH("Speaker"),
 330         SOC_DAPM_PIN_SWITCH("Line In"),
 331 };
 332
 333 static struct snd_soc_jack_pin bytcr_jack_pins[] = {
 334         {
 335                 .pin    = "Headphone",
 336                 .mask   = SND_JACK_HEADPHONE,
 337         },
 338         {
 339                 .pin    = "Headset Mic",
 340                 .mask   = SND_JACK_MICROPHONE,
 341         },
 342 };
 343
 344 static int byt_rt5651_aif1_hw_params(struct snd_pcm_substream *substream,
 345                                         struct snd_pcm_hw_params *params)
 346 {
 347         struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
 348         struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
 349         snd_pcm_format_t format = params_format(params);
 350         int rate = params_rate(params);
 351         int bclk_ratio;
 352
 353         if (format == SNDRV_PCM_FORMAT_S16_LE)
 354                 bclk_ratio = 32;
 355         else
 356                 bclk_ratio = 50;
 357
 358         return byt_rt5651_prepare_and_enable_pll1(codec_dai, rate, bclk_ratio);
 359 }
 360
 361 static const struct acpi_gpio_params pov_p1006w_hp_detect = { 1, 0, false };
 362 static const struct acpi_gpio_params pov_p1006w_ext_amp_en = { 2, 0, true };
 363
 364 static const struct acpi_gpio_mapping byt_rt5651_pov_p1006w_gpios[] = {
 365         { "hp-detect-gpios", &pov_p1006w_hp_detect, 1, },
 366         { "ext-amp-enable-gpios", &pov_p1006w_ext_amp_en, 1, },
 367         { },
 368 };
 369
 370 static int byt_rt5651_pov_p1006w_quirk_cb(const struct dmi_system_id *id)
 371 {
 372         byt_rt5651_quirk = (unsigned long)id->driver_data;
 373         byt_rt5651_gpios = byt_rt5651_pov_p1006w_gpios;
 374         return 1;
 375 }
 376
 377 static int byt_rt5651_quirk_cb(const struct dmi_system_id *id)
 378 {
 379         byt_rt5651_quirk = (unsigned long)id->driver_data;
 380         return 1;
 381 }
 382
 383 static const struct dmi_system_id byt_rt5651_quirk_table[] = {
 384         {
 385                 /* Chuwi Hi8 Pro (CWI513) */
 386                 .callback = byt_rt5651_quirk_cb,
 387                 .matches = {
 388                         DMI_MATCH(DMI_SYS_VENDOR, "Hampoo"),
 389                         DMI_MATCH(DMI_PRODUCT_NAME, "X1D3_C806N"),
 390                 },
 391                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 392                                         BYT_RT5651_IN2_MAP |
 393                                         BYT_RT5651_HP_LR_SWAPPED |
 394                                         BYT_RT5651_MONO_SPEAKER),
 395         },
 396         {
 397                 /* Chuwi Vi8 Plus (CWI519) */
 398                 .callback = byt_rt5651_quirk_cb,
 399                 .matches = {
 400                         DMI_MATCH(DMI_SYS_VENDOR, "Hampoo"),
 401                         DMI_MATCH(DMI_PRODUCT_NAME, "D2D3_Vi8A1"),
 402                 },
 403                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 404                                         BYT_RT5651_IN2_MAP |
 405                                         BYT_RT5651_HP_LR_SWAPPED |
 406                                         BYT_RT5651_MONO_SPEAKER),
 407         },
 408         {
 409                 /* Complet Electro Serv MY8307 */
 410                 .callback = byt_rt5651_quirk_cb,
 411                 .matches = {
 412                         DMI_MATCH(DMI_SYS_VENDOR, "Complet Electro Serv"),
 413                         DMI_MATCH(DMI_PRODUCT_NAME, "MY8307"),
 414                 },
 415                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 416                                         BYT_RT5651_IN2_MAP |
 417                                         BYT_RT5651_MONO_SPEAKER |
 418                                         BYT_RT5651_JD_NOT_INV),
 419         },
 420         {
 421                 /* I.T.Works TW701, Ployer Momo7w and Trekstor ST70416-6
 422                  * (these all use the same mainboard) */
 423                 .callback = byt_rt5651_quirk_cb,
 424                 .matches = {
 425                         DMI_MATCH(DMI_BIOS_VENDOR, "INSYDE Corp."),
 426                         /* Partial match for all of itWORKS.G.WI71C.JGBMRBA,
 427                          * TREK.G.WI71C.JGBMRBA0x and MOMO.G.WI71C.MABMRBA02 */
 428                         DMI_MATCH(DMI_BIOS_VERSION, ".G.WI71C."),
 429                 },
 430                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 431                                         BYT_RT5651_IN2_MAP |
 432                                         BYT_RT5651_SSP0_AIF1 |
 433                                         BYT_RT5651_MONO_SPEAKER),
 434         },
 435         {
 436                 /* Jumper EZpad 7 */
 437                 .callback = byt_rt5651_quirk_cb,
 438                 .matches = {
 439                         DMI_MATCH(DMI_SYS_VENDOR, "Jumper"),
 440                         DMI_MATCH(DMI_PRODUCT_NAME, "EZpad"),
 441                         /* Jumper12x.WJ2012.bsBKRCP05 with the version dropped */
 442                         DMI_MATCH(DMI_BIOS_VERSION, "Jumper12x.WJ2012.bsBKRCP"),
 443                 },
 444                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 445                                         BYT_RT5651_IN2_MAP |
 446                                         BYT_RT5651_JD_NOT_INV),
 447         },
 448         {
 449                 /* KIANO SlimNote 14.2 */
 450                 .callback = byt_rt5651_quirk_cb,
 451                 .matches = {
 452                         DMI_MATCH(DMI_SYS_VENDOR, "KIANO"),
 453                         DMI_MATCH(DMI_PRODUCT_NAME, "KIANO SlimNote 14.2"),
 454                 },
 455                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 456                                         BYT_RT5651_IN1_IN2_MAP),
 457         },
 458         {
 459                 /* Minnowboard Max B3 */
 460                 .callback = byt_rt5651_quirk_cb,
 461                 .matches = {
 462                         DMI_MATCH(DMI_SYS_VENDOR, "Circuitco"),
 463                         DMI_MATCH(DMI_PRODUCT_NAME, "Minnowboard Max B3 PLATFORM"),
 464                 },
 465                 .driver_data = (void *)(BYT_RT5651_IN1_MAP),
 466         },
 467         {
 468                 /* Minnowboard Turbot */
 469                 .callback = byt_rt5651_quirk_cb,
 470                 .matches = {
 471                         DMI_MATCH(DMI_SYS_VENDOR, "ADI"),
 472                         DMI_MATCH(DMI_PRODUCT_NAME, "Minnowboard Turbot"),
 473                 },
 474                 .driver_data = (void *)(BYT_RT5651_MCLK_EN |
 475                                         BYT_RT5651_IN1_MAP),
 476         },
 477         {
 478                 /* Point of View mobii wintab p1006w (v1.0) */
 479                 .callback = byt_rt5651_pov_p1006w_quirk_cb,
 480                 .matches = {
 481                         DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Insyde"),
 482                         DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "BayTrail"),
 483                         /* Note 105b is Foxcon's USB/PCI vendor id */
 484                         DMI_EXACT_MATCH(DMI_BOARD_VENDOR, "105B"),
 485                         DMI_EXACT_MATCH(DMI_BOARD_NAME, "0E57"),
 486                 },
 487                 .driver_data = (void *)(BYT_RT5651_DMIC_MAP |
 488                                         BYT_RT5651_OVCD_TH_2000UA |
 489                                         BYT_RT5651_OVCD_SF_0P75 |
 490                                         BYT_RT5651_DMIC_EN |
 491                                         BYT_RT5651_MCLK_EN |
 492                                         BYT_RT5651_SSP0_AIF1),
 493         },
 494         {
 495                 /* VIOS LTH17 */
 496                 .callback = byt_rt5651_quirk_cb,
 497                 .matches = {
 498                         DMI_MATCH(DMI_SYS_VENDOR, "VIOS"),
 499                         DMI_MATCH(DMI_PRODUCT_NAME, "LTH17"),
 500                 },
 501                 .driver_data = (void *)(BYT_RT5651_IN1_IN2_MAP |
 502                                         BYT_RT5651_JD1_1 |
 503                                         BYT_RT5651_OVCD_TH_2000UA |
 504                                         BYT_RT5651_OVCD_SF_1P0 |
 505                                         BYT_RT5651_MCLK_EN),
 506         },
 507         {
 508                 /* Yours Y8W81 (and others using the same mainboard) */
 509                 .callback = byt_rt5651_quirk_cb,
 510                 .matches = {
 511                         DMI_MATCH(DMI_BIOS_VENDOR, "INSYDE Corp."),
 512                         /* Partial match for all devs with a W86C mainboard */
 513                         DMI_MATCH(DMI_BIOS_VERSION, ".F.W86C."),
 514                 },
 515                 .driver_data = (void *)(BYT_RT5651_DEFAULT_QUIRKS |
 516                                         BYT_RT5651_IN2_MAP |
 517                                         BYT_RT5651_SSP0_AIF1 |
 518                                         BYT_RT5651_MONO_SPEAKER),
 519         },
 520         {}
 521 };
 522
 523 /*
 524  * Note this MUST be called before snd_soc_register_card(), so that the props
 525  * are in place before the codec component driver's probe function parses them.
 526  */
 527 static int byt_rt5651_add_codec_device_props(struct device *i2c_dev,
 528                                              struct byt_rt5651_private *priv)
 529 {
 530         struct property_entry props[MAX_NO_PROPS] = {};
 531         struct fwnode_handle *fwnode;
 532         int cnt = 0;
 533         int ret;
 534
 535         props[cnt++] = PROPERTY_ENTRY_U32("realtek,jack-detect-source",
 536                                 BYT_RT5651_JDSRC(byt_rt5651_quirk));
 537
 538         props[cnt++] = PROPERTY_ENTRY_U32("realtek,over-current-threshold-microamp",
 539                                 BYT_RT5651_OVCD_TH(byt_rt5651_quirk) * 100);
 540
 541         props[cnt++] = PROPERTY_ENTRY_U32("realtek,over-current-scale-factor",
 542                                 BYT_RT5651_OVCD_SF(byt_rt5651_quirk));
 543
 544         if (byt_rt5651_quirk & BYT_RT5651_DMIC_EN)
 545                 props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,dmic-en");
 546
 547         if (byt_rt5651_quirk & BYT_RT5651_JD_NOT_INV)
 548                 props[cnt++] = PROPERTY_ENTRY_BOOL("realtek,jack-detect-not-inverted");
 549
 550         fwnode = fwnode_create_software_node(props, NULL);
 551         if (IS_ERR(fwnode)) {
 552                 /* put_device(i2c_dev) is handled in caller */
 553                 return PTR_ERR(fwnode);
 554         }
 555
 556         ret = device_add_software_node(i2c_dev, to_software_node(fwnode));
 557
 558         fwnode_handle_put(fwnode);
 559
 560         return ret;
 561 }
 562
 563 static int byt_rt5651_init(struct snd_soc_pcm_runtime *runtime)
 564 {
 565         struct snd_soc_card *card = runtime->card;
 566         struct snd_soc_component *codec = asoc_rtd_to_codec(runtime, 0)->component;
 567         struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 568         const struct snd_soc_dapm_route *custom_map;
 569         int num_routes;
 570         int report;
 571         int ret;
 572
 573         card->dapm.idle_bias_off = true;
 574
 575         /* Start with RC clk for jack-detect (we disable MCLK below) */
 576         if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN)
 577                 snd_soc_component_update_bits(codec, RT5651_GLB_CLK,
 578                         RT5651_SCLK_SRC_MASK, RT5651_SCLK_SRC_RCCLK);
 579
 580         switch (BYT_RT5651_MAP(byt_rt5651_quirk)) {
 581         case BYT_RT5651_IN1_MAP:
 582                 custom_map = byt_rt5651_intmic_in1_map;
 583                 num_routes = ARRAY_SIZE(byt_rt5651_intmic_in1_map);
 584                 break;
 585         case BYT_RT5651_IN2_MAP:
 586                 custom_map = byt_rt5651_intmic_in2_map;
 587                 num_routes = ARRAY_SIZE(byt_rt5651_intmic_in2_map);
 588                 break;
 589         case BYT_RT5651_IN1_IN2_MAP:
 590                 custom_map = byt_rt5651_intmic_in1_in2_map;
 591                 num_routes = ARRAY_SIZE(byt_rt5651_intmic_in1_in2_map);
 592                 break;
 593         default:
 594                 custom_map = byt_rt5651_intmic_dmic_map;
 595                 num_routes = ARRAY_SIZE(byt_rt5651_intmic_dmic_map);
 596         }
 597         ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
 598         if (ret)
 599                 return ret;
 600
 601         if (byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2) {
 602                 ret = snd_soc_dapm_add_routes(&card->dapm,
 603                                         byt_rt5651_ssp2_aif2_map,
 604                                         ARRAY_SIZE(byt_rt5651_ssp2_aif2_map));
 605         } else if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) {
 606                 ret = snd_soc_dapm_add_routes(&card->dapm,
 607                                         byt_rt5651_ssp0_aif1_map,
 608                                         ARRAY_SIZE(byt_rt5651_ssp0_aif1_map));
 609         } else if (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2) {
 610                 ret = snd_soc_dapm_add_routes(&card->dapm,
 611                                         byt_rt5651_ssp0_aif2_map,
 612                                         ARRAY_SIZE(byt_rt5651_ssp0_aif2_map));
 613         } else {
 614                 ret = snd_soc_dapm_add_routes(&card->dapm,
 615                                         byt_rt5651_ssp2_aif1_map,
 616                                         ARRAY_SIZE(byt_rt5651_ssp2_aif1_map));
 617         }
 618         if (ret)
 619                 return ret;
 620
 621         ret = snd_soc_add_card_controls(card, byt_rt5651_controls,
 622                                         ARRAY_SIZE(byt_rt5651_controls));
 623         if (ret) {
 624                 dev_err(card->dev, "unable to add card controls\n");
 625                 return ret;
 626         }
 627
 628         /*
 629          * The firmware might enable the clock at boot (this information
 630          * may or may not be reflected in the enable clock register).
 631          * To change the rate we must disable the clock first to cover
 632          * these cases. Due to common clock framework restrictions that
 633          * do not allow to disable a clock that has not been enabled,
 634          * we need to enable the clock first.
 635          */
 636         ret = clk_prepare_enable(priv->mclk);
 637         if (!ret)
 638                 clk_disable_unprepare(priv->mclk);
 639
 640         if (byt_rt5651_quirk & BYT_RT5651_MCLK_25MHZ)
 641                 ret = clk_set_rate(priv->mclk, 25000000);
 642         else
 643                 ret = clk_set_rate(priv->mclk, 19200000);
 644
 645         if (ret)
 646                 dev_err(card->dev, "unable to set MCLK rate\n");
 647
 648         report = 0;
 649         if (BYT_RT5651_JDSRC(byt_rt5651_quirk))
 650                 report = SND_JACK_HEADSET | SND_JACK_BTN_0;
 651         else if (priv->hp_detect)
 652                 report = SND_JACK_HEADSET;
 653
 654         if (report) {
 655                 ret = snd_soc_card_jack_new_pins(runtime->card, "Headset",
 656                                                  report, &priv->jack,
 657                                                  bytcr_jack_pins,
 658                                                  ARRAY_SIZE(bytcr_jack_pins));
 659                 if (ret) {
 660                         dev_err(runtime->dev, "jack creation failed %d\n", ret);
 661                         return ret;
 662                 }
 663
 664                 if (report & SND_JACK_BTN_0)
 665                         snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0,
 666                                          KEY_PLAYPAUSE);
 667
 668                 ret = snd_soc_component_set_jack(codec, &priv->jack,
 669                                                  priv->hp_detect);
 670                 if (ret)
 671                         return ret;
 672         }
 673
 674         return 0;
 675 }
 676
 677 static int byt_rt5651_codec_fixup(struct snd_soc_pcm_runtime *rtd,
 678                             struct snd_pcm_hw_params *params)
 679 {
 680         struct snd_interval *rate = hw_param_interval(params,
 681                         SNDRV_PCM_HW_PARAM_RATE);
 682         struct snd_interval *channels = hw_param_interval(params,
 683                                                 SNDRV_PCM_HW_PARAM_CHANNELS);
 684         int ret, bits;
 685
 686         /* The DSP will covert the FE rate to 48k, stereo */
 687         rate->min = rate->max = 48000;
 688         channels->min = channels->max = 2;
 689
 690         if ((byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) ||
 691             (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2)) {
 692                 /* set SSP0 to 16-bit */
 693                 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
 694                 bits = 16;
 695         } else {
 696                 /* set SSP2 to 24-bit */
 697                 params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
 698                 bits = 24;
 699         }
 700
 701         /*
 702          * Default mode for SSP configuration is TDM 4 slot, override config
 703          * with explicit setting to I2S 2ch. The word length is set with
 704          * dai_set_tdm_slot() since there is no other API exposed
 705          */
 706         ret = snd_soc_dai_set_fmt(asoc_rtd_to_cpu(rtd, 0),
 707                                   SND_SOC_DAIFMT_I2S     |
 708                                   SND_SOC_DAIFMT_NB_NF   |
 709                                   SND_SOC_DAIFMT_CBC_CFC
 710                                   );
 711
 712         if (ret < 0) {
 713                 dev_err(rtd->dev, "can't set format to I2S, err %d\n", ret);
 714                 return ret;
 715         }
 716
 717         ret = snd_soc_dai_set_tdm_slot(asoc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
 718         if (ret < 0) {
 719                 dev_err(rtd->dev, "can't set I2S config, err %d\n", ret);
 720                 return ret;
 721         }
 722
 723         return 0;
 724 }
 725
 726 static const unsigned int rates_48000[] = {
 727         48000,
 728 };
 729
 730 static const struct snd_pcm_hw_constraint_list constraints_48000 = {
 731         .count = ARRAY_SIZE(rates_48000),
 732         .list  = rates_48000,
 733 };
 734
 735 static int byt_rt5651_aif1_startup(struct snd_pcm_substream *substream)
 736 {
 737         return snd_pcm_hw_constraint_list(substream->runtime, 0,
 738                         SNDRV_PCM_HW_PARAM_RATE,
 739                         &constraints_48000);
 740 }
 741
 742 static const struct snd_soc_ops byt_rt5651_aif1_ops = {
 743         .startup = byt_rt5651_aif1_startup,
 744 };
 745
 746 static const struct snd_soc_ops byt_rt5651_be_ssp2_ops = {
 747         .hw_params = byt_rt5651_aif1_hw_params,
 748 };
 749
 750 SND_SOC_DAILINK_DEF(dummy,
 751         DAILINK_COMP_ARRAY(COMP_DUMMY()));
 752
 753 SND_SOC_DAILINK_DEF(media,
 754         DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
 755
 756 SND_SOC_DAILINK_DEF(deepbuffer,
 757         DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
 758
 759 SND_SOC_DAILINK_DEF(ssp2_port,
 760         DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
 761 SND_SOC_DAILINK_DEF(ssp2_codec,
 762         DAILINK_COMP_ARRAY(COMP_CODEC("i2c-10EC5651:00", "rt5651-aif1")));
 763
 764 SND_SOC_DAILINK_DEF(platform,
 765         DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
 766
 767 static struct snd_soc_dai_link byt_rt5651_dais[] = {
 768         [MERR_DPCM_AUDIO] = {
 769                 .name = "Audio Port",
 770                 .stream_name = "Audio",
 771                 .nonatomic = true,
 772                 .dynamic = 1,
 773                 .dpcm_playback = 1,
 774                 .dpcm_capture = 1,
 775                 .ops = &byt_rt5651_aif1_ops,
 776                 SND_SOC_DAILINK_REG(media, dummy, platform),
 777         },
 778         [MERR_DPCM_DEEP_BUFFER] = {
 779                 .name = "Deep-Buffer Audio Port",
 780                 .stream_name = "Deep-Buffer Audio",
 781                 .nonatomic = true,
 782                 .dynamic = 1,
 783                 .dpcm_playback = 1,
 784                 .ops = &byt_rt5651_aif1_ops,
 785                 SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
 786         },
 787         /* CODEC<->CODEC link */
 788         /* back ends */
 789         {
 790                 .name = "SSP2-Codec",
 791                 .id = 0,
 792                 .no_pcm = 1,
 793                 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
 794                                                 | SND_SOC_DAIFMT_CBC_CFC,
 795                 .be_hw_params_fixup = byt_rt5651_codec_fixup,
 796                 .dpcm_playback = 1,
 797                 .dpcm_capture = 1,
 798                 .init = byt_rt5651_init,
 799                 .ops = &byt_rt5651_be_ssp2_ops,
 800                 SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
 801         },
 802 };
 803
 804 /* SoC card */
 805 static char byt_rt5651_codec_name[SND_ACPI_I2C_ID_LEN];
 806 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
 807 static char byt_rt5651_long_name[50]; /* = "bytcr-rt5651-*-spk-*-mic[-swapped-hp]" */
 808 #endif
 809 static char byt_rt5651_components[50]; /* = "cfg-spk:* cfg-mic:*" */
 810
 811 static int byt_rt5651_suspend(struct snd_soc_card *card)
 812 {
 813         struct snd_soc_component *component;
 814
 815         if (!BYT_RT5651_JDSRC(byt_rt5651_quirk))
 816                 return 0;
 817
 818         for_each_card_components(card, component) {
 819                 if (!strcmp(component->name, byt_rt5651_codec_name)) {
 820                         dev_dbg(component->dev, "disabling jack detect before suspend\n");
 821                         snd_soc_component_set_jack(component, NULL, NULL);
 822                         break;
 823                 }
 824         }
 825
 826         return 0;
 827 }
 828
 829 static int byt_rt5651_resume(struct snd_soc_card *card)
 830 {
 831         struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
 832         struct snd_soc_component *component;
 833
 834         if (!BYT_RT5651_JDSRC(byt_rt5651_quirk))
 835                 return 0;
 836
 837         for_each_card_components(card, component) {
 838                 if (!strcmp(component->name, byt_rt5651_codec_name)) {
 839                         dev_dbg(component->dev, "re-enabling jack detect after resume\n");
 840                         snd_soc_component_set_jack(component, &priv->jack,
 841                                                    priv->hp_detect);
 842                         break;
 843                 }
 844         }
 845
 846         return 0;
 847 }
 848
 849 /* use space before codec name to simplify card ID, and simplify driver name */
 850 #define SOF_CARD_NAME "bytcht rt5651" /* card name will be 'sof-bytcht rt5651' */
 851 #define SOF_DRIVER_NAME "SOF"
 852
 853 #define CARD_NAME "bytcr-rt5651"
 854 #define DRIVER_NAME NULL /* card name will be used for driver name */
 855
 856 static struct snd_soc_card byt_rt5651_card = {
 857         .name = CARD_NAME,
 858         .driver_name = DRIVER_NAME,
 859         .owner = THIS_MODULE,
 860         .dai_link = byt_rt5651_dais,
 861         .num_links = ARRAY_SIZE(byt_rt5651_dais),
 862         .dapm_widgets = byt_rt5651_widgets,
 863         .num_dapm_widgets = ARRAY_SIZE(byt_rt5651_widgets),
 864         .dapm_routes = byt_rt5651_audio_map,
 865         .num_dapm_routes = ARRAY_SIZE(byt_rt5651_audio_map),
 866         .fully_routed = true,
 867         .suspend_pre = byt_rt5651_suspend,
 868         .resume_post = byt_rt5651_resume,
 869 };
 870
 871 static const struct acpi_gpio_params ext_amp_enable_gpios = { 0, 0, false };
 872
 873 static const struct acpi_gpio_mapping cht_rt5651_gpios[] = {
 874         /*
 875          * Some boards have I2cSerialBusV2, GpioIo, GpioInt as ACPI resources,
 876          * other boards may  have I2cSerialBusV2, GpioInt, GpioIo instead.
 877          * We want the GpioIo one for the ext-amp-enable-gpio.
 878          */
 879         { "ext-amp-enable-gpios", &ext_amp_enable_gpios, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
 880         { },
 881 };
 882
 883 struct acpi_chan_package {   /* ACPICA seems to require 64 bit integers */
 884         u64 aif_value;       /* 1: AIF1, 2: AIF2 */
 885         u64 mclock_value;    /* usually 25MHz (0x17d7940), ignored */
 886 };
 887
 888 static int snd_byt_rt5651_mc_probe(struct platform_device *pdev)
 889 {
 890         struct device *dev = &pdev->dev;
 891         static const char * const mic_name[] = { "dmic", "in1", "in2", "in12" };
 892         struct snd_soc_acpi_mach *mach = dev_get_platdata(dev);
 893         struct byt_rt5651_private *priv;
 894         const char *platform_name;
 895         struct acpi_device *adev;
 896         struct device *codec_dev;
 897         bool sof_parent;
 898         bool is_bytcr = false;
 899         int ret_val = 0;
 900         int dai_index = 0;
 901         int i;
 902
 903         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 904         if (!priv)
 905                 return -ENOMEM;
 906
 907         /* register the soc card */
 908         byt_rt5651_card.dev = dev;
 909         snd_soc_card_set_drvdata(&byt_rt5651_card, priv);
 910
 911         /* fix index of codec dai */
 912         for (i = 0; i < ARRAY_SIZE(byt_rt5651_dais); i++) {
 913                 if (!strcmp(byt_rt5651_dais[i].codecs->name,
 914                             "i2c-10EC5651:00")) {
 915                         dai_index = i;
 916                         break;
 917                 }
 918         }
 919
 920         /* fixup codec name based on HID */
 921         adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
 922         if (adev) {
 923                 snprintf(byt_rt5651_codec_name, sizeof(byt_rt5651_codec_name),
 924                          "i2c-%s", acpi_dev_name(adev));
 925                 put_device(&adev->dev);
 926                 byt_rt5651_dais[dai_index].codecs->name = byt_rt5651_codec_name;
 927         } else {
 928                 dev_err(dev, "Error cannot find '%s' dev\n", mach->id);
 929                 return -ENXIO;
 930         }
 931
 932         codec_dev = acpi_get_first_physical_node(adev);
 933         if (!codec_dev)
 934                 return -EPROBE_DEFER;
 935         priv->codec_dev = get_device(codec_dev);
 936
 937         /*
 938          * swap SSP0 if bytcr is detected
 939          * (will be overridden if DMI quirk is detected)
 940          */
 941         if (soc_intel_is_byt()) {
 942                 if (mach->mach_params.acpi_ipc_irq_index == 0)
 943                         is_bytcr = true;
 944         }
 945
 946         if (is_bytcr) {
 947                 /*
 948                  * Baytrail CR platforms may have CHAN package in BIOS, try
 949                  * to find relevant routing quirk based as done on Windows
 950                  * platforms. We have to read the information directly from the
 951                  * BIOS, at this stage the card is not created and the links
 952                  * with the codec driver/pdata are non-existent
 953                  */
 954
 955                 struct acpi_chan_package chan_package;
 956
 957                 /* format specified: 2 64-bit integers */
 958                 struct acpi_buffer format = {sizeof("NN"), "NN"};
 959                 struct acpi_buffer state = {0, NULL};
 960                 struct snd_soc_acpi_package_context pkg_ctx;
 961                 bool pkg_found = false;
 962
 963                 state.length = sizeof(chan_package);
 964                 state.pointer = &chan_package;
 965
 966                 pkg_ctx.name = "CHAN";
 967                 pkg_ctx.length = 2;
 968                 pkg_ctx.format = &format;
 969                 pkg_ctx.state = &state;
 970                 pkg_ctx.data_valid = false;
 971
 972                 pkg_found = snd_soc_acpi_find_package_from_hid(mach->id,
 973                                                                &pkg_ctx);
 974                 if (pkg_found) {
 975                         if (chan_package.aif_value == 1) {
 976                                 dev_info(dev, "BIOS Routing: AIF1 connected\n");
 977                                 byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF1;
 978                         } else  if (chan_package.aif_value == 2) {
 979                                 dev_info(dev, "BIOS Routing: AIF2 connected\n");
 980                                 byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF2;
 981                         } else {
 982                                 dev_info(dev, "BIOS Routing isn't valid, ignored\n");
 983                                 pkg_found = false;
 984                         }
 985                 }
 986
 987                 if (!pkg_found) {
 988                         /* no BIOS indications, assume SSP0-AIF2 connection */
 989                         byt_rt5651_quirk |= BYT_RT5651_SSP0_AIF2;
 990                 }
 991         }
 992
 993         /* check quirks before creating card */
 994         dmi_check_system(byt_rt5651_quirk_table);
 995
 996         if (quirk_override != -1) {
 997                 dev_info(dev, "Overriding quirk 0x%lx => 0x%x\n",
 998                          byt_rt5651_quirk, quirk_override);
 999                 byt_rt5651_quirk = quirk_override;
1000         }
1001
1002         /* Must be called before register_card, also see declaration comment. */
1003         ret_val = byt_rt5651_add_codec_device_props(codec_dev, priv);
1004         if (ret_val)
1005                 goto err_device;
1006
1007         /* Cherry Trail devices use an external amplifier enable gpio */
1008         if (soc_intel_is_cht() && !byt_rt5651_gpios)
1009                 byt_rt5651_gpios = cht_rt5651_gpios;
1010
1011         if (byt_rt5651_gpios) {
1012                 devm_acpi_dev_add_driver_gpios(codec_dev, byt_rt5651_gpios);
1013                 priv->ext_amp_gpio = devm_fwnode_gpiod_get(dev, codec_dev->fwnode,
1014                                                            "ext-amp-enable",
1015                                                            GPIOD_OUT_LOW,
1016                                                            "speaker-amp");
1017                 if (IS_ERR(priv->ext_amp_gpio)) {
1018                         ret_val = PTR_ERR(priv->ext_amp_gpio);
1019                         switch (ret_val) {
1020                         case -ENOENT:
1021                                 priv->ext_amp_gpio = NULL;
1022                                 break;
1023                         default:
1024                                 dev_err(dev, "Failed to get ext-amp-enable GPIO: %d\n", ret_val);
1025                                 fallthrough;
1026                         case -EPROBE_DEFER:
1027                                 goto err;
1028                         }
1029                 }
1030                 priv->hp_detect = devm_fwnode_gpiod_get(dev, codec_dev->fwnode,
1031                                                         "hp-detect",
1032                                                         GPIOD_IN,
1033                                                         "hp-detect");
1034                 if (IS_ERR(priv->hp_detect)) {
1035                         ret_val = PTR_ERR(priv->hp_detect);
1036                         switch (ret_val) {
1037                         case -ENOENT:
1038                                 priv->hp_detect = NULL;
1039                                 break;
1040                         default:
1041                                 dev_err(dev, "Failed to get hp-detect GPIO: %d\n", ret_val);
1042                                 fallthrough;
1043                         case -EPROBE_DEFER:
1044                                 goto err;
1045                         }
1046                 }
1047         }
1048
1049         log_quirks(dev);
1050
1051         if ((byt_rt5651_quirk & BYT_RT5651_SSP2_AIF2) ||
1052             (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2))
1053                 byt_rt5651_dais[dai_index].codecs->dai_name = "rt5651-aif2";
1054
1055         if ((byt_rt5651_quirk & BYT_RT5651_SSP0_AIF1) ||
1056             (byt_rt5651_quirk & BYT_RT5651_SSP0_AIF2))
1057                 byt_rt5651_dais[dai_index].cpus->dai_name = "ssp0-port";
1058
1059         if (byt_rt5651_quirk & BYT_RT5651_MCLK_EN) {
1060                 priv->mclk = devm_clk_get_optional(dev, "pmc_plt_clk_3");
1061                 if (IS_ERR(priv->mclk)) {
1062                         ret_val = dev_err_probe(dev, PTR_ERR(priv->mclk),
1063                                                 "Failed to get MCLK from pmc_plt_clk_3\n");
1064                         goto err;
1065                 }
1066                 /*
1067                  * Fall back to bit clock usage when clock is not
1068                  * available likely due to missing dependencies.
1069                  */
1070                 if (!priv->mclk)
1071                         byt_rt5651_quirk &= ~BYT_RT5651_MCLK_EN;
1072         }
1073
1074         snprintf(byt_rt5651_components, sizeof(byt_rt5651_components),
1075                  "cfg-spk:%s cfg-mic:%s%s",
1076                  (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER) ? "1" : "2",
1077                  mic_name[BYT_RT5651_MAP(byt_rt5651_quirk)],
1078                  (byt_rt5651_quirk & BYT_RT5651_HP_LR_SWAPPED) ?
1079                         " cfg-hp:lrswap" : "");
1080         byt_rt5651_card.components = byt_rt5651_components;
1081 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
1082         snprintf(byt_rt5651_long_name, sizeof(byt_rt5651_long_name),
1083                  "bytcr-rt5651-%s-spk-%s-mic%s",
1084                  (byt_rt5651_quirk & BYT_RT5651_MONO_SPEAKER) ?
1085                         "mono" : "stereo",
1086                  mic_name[BYT_RT5651_MAP(byt_rt5651_quirk)],
1087                  (byt_rt5651_quirk & BYT_RT5651_HP_LR_SWAPPED) ?
1088                         "-hp-swapped" : "");
1089         byt_rt5651_card.long_name = byt_rt5651_long_name;
1090 #endif
1091
1092         /* override platform name, if required */
1093         platform_name = mach->mach_params.platform;
1094
1095         ret_val = snd_soc_fixup_dai_links_platform_name(&byt_rt5651_card,
1096                                                         platform_name);
1097         if (ret_val)
1098                 goto err;
1099
1100         sof_parent = snd_soc_acpi_sof_parent(dev);
1101
1102         /* set card and driver name */
1103         if (sof_parent) {
1104                 byt_rt5651_card.name = SOF_CARD_NAME;
1105                 byt_rt5651_card.driver_name = SOF_DRIVER_NAME;
1106         } else {
1107                 byt_rt5651_card.name = CARD_NAME;
1108                 byt_rt5651_card.driver_name = DRIVER_NAME;
1109         }
1110
1111         /* set pm ops */
1112         if (sof_parent)
1113                 dev->driver->pm = &snd_soc_pm_ops;
1114
1115         ret_val = devm_snd_soc_register_card(dev, &byt_rt5651_card);
1116         if (ret_val) {
1117                 dev_err(dev, "devm_snd_soc_register_card failed %d\n", ret_val);
1118                 goto err;
1119         }
1120         platform_set_drvdata(pdev, &byt_rt5651_card);
1121         return ret_val;
1122
1123 err:
1124         device_remove_software_node(priv->codec_dev);
1125 err_device:
1126         put_device(priv->codec_dev);
1127         return ret_val;
1128 }
1129
1130 static int snd_byt_rt5651_mc_remove(struct platform_device *pdev)
1131 {
1132         struct snd_soc_card *card = platform_get_drvdata(pdev);
1133         struct byt_rt5651_private *priv = snd_soc_card_get_drvdata(card);
1134
1135         device_remove_software_node(priv->codec_dev);
1136         put_device(priv->codec_dev);
1137         return 0;
1138 }
1139
1140 static struct platform_driver snd_byt_rt5651_mc_driver = {
1141         .driver = {
1142                 .name = "bytcr_rt5651",
1143         },
1144         .probe = snd_byt_rt5651_mc_probe,
1145         .remove = snd_byt_rt5651_mc_remove,
1146 };
1147
1148 module_platform_driver(snd_byt_rt5651_mc_driver);
1149
1150 MODULE_DESCRIPTION("ASoC Intel(R) Baytrail CR Machine driver for RT5651");
1151 MODULE_AUTHOR("Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>");
1152 MODULE_LICENSE("GPL v2");
1153 MODULE_ALIAS("platform:bytcr_rt5651");