sound/soc/intel/boards/bytcht_es8316.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  bytcht_es8316.c - ASoc Machine driver for Intel Baytrail/Cherrytrail
   4  *                    platforms with Everest ES8316 SoC
   5  *
   6  *  Copyright (C) 2017 Endless Mobile, Inc.
   7  *  Authors: David Yang <yangxiaohua@everest-semi.com>,
   8  *           Daniel Drake <drake@endlessm.com>
   9  *
  10  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11  *
  12  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  13  */
  14 #include <linux/acpi.h>
  15 #include <linux/clk.h>
  16 #include <linux/device.h>
  17 #include <linux/dmi.h>
  18 #include <linux/gpio/consumer.h>
  19 #include <linux/i2c.h>
  20 #include <linux/init.h>
  21 #include <linux/input.h>
  22 #include <linux/module.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/slab.h>
  25 #include <sound/jack.h>
  26 #include <sound/pcm.h>
  27 #include <sound/pcm_params.h>
  28 #include <sound/soc.h>
  29 #include <sound/soc-acpi.h>
  30 #include "../atom/sst-atom-controls.h"
  31 #include "../common/soc-intel-quirks.h"
  32
  33 /* jd-inv + terminating entry */
  34 #define MAX_NO_PROPS 2
  35
  36 struct byt_cht_es8316_private {
  37         struct clk *mclk;
  38         struct snd_soc_jack jack;
  39         struct gpio_desc *speaker_en_gpio;
  40         bool speaker_en;
  41 };
  42
  43 enum {
  44         BYT_CHT_ES8316_INTMIC_IN1_MAP,
  45         BYT_CHT_ES8316_INTMIC_IN2_MAP,
  46 };
  47
  48 #define BYT_CHT_ES8316_MAP(quirk)               ((quirk) & GENMASK(3, 0))
  49 #define BYT_CHT_ES8316_SSP0                     BIT(16)
  50 #define BYT_CHT_ES8316_MONO_SPEAKER             BIT(17)
  51 #define BYT_CHT_ES8316_JD_INVERTED              BIT(18)
  52
  53 static unsigned long quirk;
  54
  55 static int quirk_override = -1;
  56 module_param_named(quirk, quirk_override, int, 0444);
  57 MODULE_PARM_DESC(quirk, "Board-specific quirk override");
  58
  59 static void log_quirks(struct device *dev)
  60 {
  61         if (BYT_CHT_ES8316_MAP(quirk) == BYT_CHT_ES8316_INTMIC_IN1_MAP)
  62                 dev_info(dev, "quirk IN1_MAP enabled");
  63         if (BYT_CHT_ES8316_MAP(quirk) == BYT_CHT_ES8316_INTMIC_IN2_MAP)
  64                 dev_info(dev, "quirk IN2_MAP enabled");
  65         if (quirk & BYT_CHT_ES8316_SSP0)
  66                 dev_info(dev, "quirk SSP0 enabled");
  67         if (quirk & BYT_CHT_ES8316_MONO_SPEAKER)
  68                 dev_info(dev, "quirk MONO_SPEAKER enabled\n");
  69         if (quirk & BYT_CHT_ES8316_JD_INVERTED)
  70                 dev_info(dev, "quirk JD_INVERTED enabled\n");
  71 }
  72
  73 static int byt_cht_es8316_speaker_power_event(struct snd_soc_dapm_widget *w,
  74         struct snd_kcontrol *kcontrol, int event)
  75 {
  76         struct snd_soc_card *card = w->dapm->card;
  77         struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
  78
  79         if (SND_SOC_DAPM_EVENT_ON(event))
  80                 priv->speaker_en = true;
  81         else
  82                 priv->speaker_en = false;
  83
  84         gpiod_set_value_cansleep(priv->speaker_en_gpio, priv->speaker_en);
  85
  86         return 0;
  87 }
  88
  89 static const struct snd_soc_dapm_widget byt_cht_es8316_widgets[] = {
  90         SND_SOC_DAPM_SPK("Speaker", NULL),
  91         SND_SOC_DAPM_HP("Headphone", NULL),
  92         SND_SOC_DAPM_MIC("Headset Mic", NULL),
  93         SND_SOC_DAPM_MIC("Internal Mic", NULL),
  94
  95         SND_SOC_DAPM_SUPPLY("Speaker Power", SND_SOC_NOPM, 0, 0,
  96                             byt_cht_es8316_speaker_power_event,
  97                             SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
  98 };
  99
 100 static const struct snd_soc_dapm_route byt_cht_es8316_audio_map[] = {
 101         {"Headphone", NULL, "HPOL"},
 102         {"Headphone", NULL, "HPOR"},
 103
 104         /*
 105          * There is no separate speaker output instead the speakers are muxed to
 106          * the HP outputs. The mux is controlled by the "Speaker Power" supply.
 107          */
 108         {"Speaker", NULL, "HPOL"},
 109         {"Speaker", NULL, "HPOR"},
 110         {"Speaker", NULL, "Speaker Power"},
 111 };
 112
 113 static const struct snd_soc_dapm_route byt_cht_es8316_intmic_in1_map[] = {
 114         {"MIC1", NULL, "Internal Mic"},
 115         {"MIC2", NULL, "Headset Mic"},
 116 };
 117
 118 static const struct snd_soc_dapm_route byt_cht_es8316_intmic_in2_map[] = {
 119         {"MIC2", NULL, "Internal Mic"},
 120         {"MIC1", NULL, "Headset Mic"},
 121 };
 122
 123 static const struct snd_soc_dapm_route byt_cht_es8316_ssp0_map[] = {
 124         {"Playback", NULL, "ssp0 Tx"},
 125         {"ssp0 Tx", NULL, "modem_out"},
 126         {"modem_in", NULL, "ssp0 Rx"},
 127         {"ssp0 Rx", NULL, "Capture"},
 128 };
 129
 130 static const struct snd_soc_dapm_route byt_cht_es8316_ssp2_map[] = {
 131         {"Playback", NULL, "ssp2 Tx"},
 132         {"ssp2 Tx", NULL, "codec_out0"},
 133         {"ssp2 Tx", NULL, "codec_out1"},
 134         {"codec_in0", NULL, "ssp2 Rx" },
 135         {"codec_in1", NULL, "ssp2 Rx" },
 136         {"ssp2 Rx", NULL, "Capture"},
 137 };
 138
 139 static const struct snd_kcontrol_new byt_cht_es8316_controls[] = {
 140         SOC_DAPM_PIN_SWITCH("Speaker"),
 141         SOC_DAPM_PIN_SWITCH("Headphone"),
 142         SOC_DAPM_PIN_SWITCH("Headset Mic"),
 143         SOC_DAPM_PIN_SWITCH("Internal Mic"),
 144 };
 145
 146 static struct snd_soc_jack_pin byt_cht_es8316_jack_pins[] = {
 147         {
 148                 .pin    = "Headphone",
 149                 .mask   = SND_JACK_HEADPHONE,
 150         },
 151         {
 152                 .pin    = "Headset Mic",
 153                 .mask   = SND_JACK_MICROPHONE,
 154         },
 155 };
 156
 157 static int byt_cht_es8316_init(struct snd_soc_pcm_runtime *runtime)
 158 {
 159         struct snd_soc_component *codec = asoc_rtd_to_codec(runtime, 0)->component;
 160         struct snd_soc_card *card = runtime->card;
 161         struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
 162         const struct snd_soc_dapm_route *custom_map;
 163         int num_routes;
 164         int ret;
 165
 166         card->dapm.idle_bias_off = true;
 167
 168         switch (BYT_CHT_ES8316_MAP(quirk)) {
 169         case BYT_CHT_ES8316_INTMIC_IN1_MAP:
 170         default:
 171                 custom_map = byt_cht_es8316_intmic_in1_map;
 172                 num_routes = ARRAY_SIZE(byt_cht_es8316_intmic_in1_map);
 173                 break;
 174         case BYT_CHT_ES8316_INTMIC_IN2_MAP:
 175                 custom_map = byt_cht_es8316_intmic_in2_map;
 176                 num_routes = ARRAY_SIZE(byt_cht_es8316_intmic_in2_map);
 177                 break;
 178         }
 179         ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
 180         if (ret)
 181                 return ret;
 182
 183         if (quirk & BYT_CHT_ES8316_SSP0) {
 184                 custom_map = byt_cht_es8316_ssp0_map;
 185                 num_routes = ARRAY_SIZE(byt_cht_es8316_ssp0_map);
 186         } else {
 187                 custom_map = byt_cht_es8316_ssp2_map;
 188                 num_routes = ARRAY_SIZE(byt_cht_es8316_ssp2_map);
 189         }
 190         ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
 191         if (ret)
 192                 return ret;
 193
 194         /*
 195          * The firmware might enable the clock at boot (this information
 196          * may or may not be reflected in the enable clock register).
 197          * To change the rate we must disable the clock first to cover these
 198          * cases. Due to common clock framework restrictions that do not allow
 199          * to disable a clock that has not been enabled, we need to enable
 200          * the clock first.
 201          */
 202         ret = clk_prepare_enable(priv->mclk);
 203         if (!ret)
 204                 clk_disable_unprepare(priv->mclk);
 205
 206         ret = clk_set_rate(priv->mclk, 19200000);
 207         if (ret)
 208                 dev_err(card->dev, "unable to set MCLK rate\n");
 209
 210         ret = clk_prepare_enable(priv->mclk);
 211         if (ret)
 212                 dev_err(card->dev, "unable to enable MCLK\n");
 213
 214         ret = snd_soc_dai_set_sysclk(asoc_rtd_to_codec(runtime, 0), 0, 19200000,
 215                                      SND_SOC_CLOCK_IN);
 216         if (ret < 0) {
 217                 dev_err(card->dev, "can't set codec clock %d\n", ret);
 218                 return ret;
 219         }
 220
 221         ret = snd_soc_card_jack_new(card, "Headset",
 222                                     SND_JACK_HEADSET | SND_JACK_BTN_0,
 223                                     &priv->jack, byt_cht_es8316_jack_pins,
 224                                     ARRAY_SIZE(byt_cht_es8316_jack_pins));
 225         if (ret) {
 226                 dev_err(card->dev, "jack creation failed %d\n", ret);
 227                 return ret;
 228         }
 229
 230         snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
 231         snd_soc_component_set_jack(codec, &priv->jack, NULL);
 232
 233         return 0;
 234 }
 235
 236 static int byt_cht_es8316_codec_fixup(struct snd_soc_pcm_runtime *rtd,
 237                             struct snd_pcm_hw_params *params)
 238 {
 239         struct snd_interval *rate = hw_param_interval(params,
 240                         SNDRV_PCM_HW_PARAM_RATE);
 241         struct snd_interval *channels = hw_param_interval(params,
 242                                                 SNDRV_PCM_HW_PARAM_CHANNELS);
 243         int ret, bits;
 244
 245         /* The DSP will covert the FE rate to 48k, stereo */
 246         rate->min = rate->max = 48000;
 247         channels->min = channels->max = 2;
 248
 249         if (quirk & BYT_CHT_ES8316_SSP0) {
 250                 /* set SSP0 to 16-bit */
 251                 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
 252                 bits = 16;
 253         } else {
 254                 /* set SSP2 to 24-bit */
 255                 params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
 256                 bits = 24;
 257         }
 258
 259         /*
 260          * Default mode for SSP configuration is TDM 4 slot, override config
 261          * with explicit setting to I2S 2ch 24-bit. The word length is set with
 262          * dai_set_tdm_slot() since there is no other API exposed
 263          */
 264         ret = snd_soc_dai_set_fmt(asoc_rtd_to_cpu(rtd, 0),
 265                                 SND_SOC_DAIFMT_I2S     |
 266                                 SND_SOC_DAIFMT_NB_NF   |
 267                                 SND_SOC_DAIFMT_CBS_CFS
 268                 );
 269         if (ret < 0) {
 270                 dev_err(rtd->dev, "can't set format to I2S, err %d\n", ret);
 271                 return ret;
 272         }
 273
 274         ret = snd_soc_dai_set_tdm_slot(asoc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
 275         if (ret < 0) {
 276                 dev_err(rtd->dev, "can't set I2S config, err %d\n", ret);
 277                 return ret;
 278         }
 279
 280         return 0;
 281 }
 282
 283 static int byt_cht_es8316_aif1_startup(struct snd_pcm_substream *substream)
 284 {
 285         return snd_pcm_hw_constraint_single(substream->runtime,
 286                         SNDRV_PCM_HW_PARAM_RATE, 48000);
 287 }
 288
 289 static const struct snd_soc_ops byt_cht_es8316_aif1_ops = {
 290         .startup = byt_cht_es8316_aif1_startup,
 291 };
 292
 293 SND_SOC_DAILINK_DEF(dummy,
 294         DAILINK_COMP_ARRAY(COMP_DUMMY()));
 295
 296 SND_SOC_DAILINK_DEF(media,
 297         DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
 298
 299 SND_SOC_DAILINK_DEF(deepbuffer,
 300         DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
 301
 302 SND_SOC_DAILINK_DEF(ssp2_port,
 303         DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
 304 SND_SOC_DAILINK_DEF(ssp2_codec,
 305         DAILINK_COMP_ARRAY(COMP_CODEC("i2c-ESSX8316:00", "ES8316 HiFi")));
 306
 307 SND_SOC_DAILINK_DEF(platform,
 308         DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
 309
 310 static struct snd_soc_dai_link byt_cht_es8316_dais[] = {
 311         [MERR_DPCM_AUDIO] = {
 312                 .name = "Audio Port",
 313                 .stream_name = "Audio",
 314                 .nonatomic = true,
 315                 .dynamic = 1,
 316                 .dpcm_playback = 1,
 317                 .dpcm_capture = 1,
 318                 .ops = &byt_cht_es8316_aif1_ops,
 319                 SND_SOC_DAILINK_REG(media, dummy, platform),
 320         },
 321
 322         [MERR_DPCM_DEEP_BUFFER] = {
 323                 .name = "Deep-Buffer Audio Port",
 324                 .stream_name = "Deep-Buffer Audio",
 325                 .nonatomic = true,
 326                 .dynamic = 1,
 327                 .dpcm_playback = 1,
 328                 .ops = &byt_cht_es8316_aif1_ops,
 329                 SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
 330         },
 331
 332                 /* back ends */
 333         {
 334                 .name = "SSP2-Codec",
 335                 .id = 0,
 336                 .no_pcm = 1,
 337                 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
 338                                                 | SND_SOC_DAIFMT_CBS_CFS,
 339                 .be_hw_params_fixup = byt_cht_es8316_codec_fixup,
 340                 .dpcm_playback = 1,
 341                 .dpcm_capture = 1,
 342                 .init = byt_cht_es8316_init,
 343                 SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
 344         },
 345 };
 346
 347
 348 /* SoC card */
 349 static char codec_name[SND_ACPI_I2C_ID_LEN];
 350 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
 351 static char long_name[50]; /* = "bytcht-es8316-*-spk-*-mic" */
 352 #endif
 353 static char components_string[32]; /* = "cfg-spk:* cfg-mic:* */
 354
 355 static int byt_cht_es8316_suspend(struct snd_soc_card *card)
 356 {
 357         struct snd_soc_component *component;
 358
 359         for_each_card_components(card, component) {
 360                 if (!strcmp(component->name, codec_name)) {
 361                         dev_dbg(component->dev, "disabling jack detect before suspend\n");
 362                         snd_soc_component_set_jack(component, NULL, NULL);
 363                         break;
 364                 }
 365         }
 366
 367         return 0;
 368 }
 369
 370 static int byt_cht_es8316_resume(struct snd_soc_card *card)
 371 {
 372         struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
 373         struct snd_soc_component *component;
 374
 375         for_each_card_components(card, component) {
 376                 if (!strcmp(component->name, codec_name)) {
 377                         dev_dbg(component->dev, "re-enabling jack detect after resume\n");
 378                         snd_soc_component_set_jack(component, &priv->jack, NULL);
 379                         break;
 380                 }
 381         }
 382
 383         /*
 384          * Some Cherry Trail boards with an ES8316 codec have a bug in their
 385          * ACPI tables where the MSSL1680 touchscreen's _PS0 and _PS3 methods
 386          * wrongly also set the speaker-enable GPIO to 1/0. Testing has shown
 387          * that this really is a bug and the GPIO has no influence on the
 388          * touchscreen at all.
 389          *
 390          * The silead.c touchscreen driver does not support runtime suspend, so
 391          * the GPIO can only be changed underneath us during a system suspend.
 392          * This resume() function runs from a pm complete() callback, and thus
 393          * is guaranteed to run after the touchscreen driver/ACPI-subsys has
 394          * brought the touchscreen back up again (and thus changed the GPIO).
 395          *
 396          * So to work around this we pass GPIOD_FLAGS_BIT_NONEXCLUSIVE when
 397          * requesting the GPIO and we set its value here to undo any changes
 398          * done by the touchscreen's broken _PS0 ACPI method.
 399          */
 400         gpiod_set_value_cansleep(priv->speaker_en_gpio, priv->speaker_en);
 401
 402         return 0;
 403 }
 404
 405 /* use space before codec name to simplify card ID, and simplify driver name */
 406 #define SOF_CARD_NAME "bytcht es8316" /* card name will be 'sof-bytcht es8316' */
 407 #define SOF_DRIVER_NAME "SOF"
 408
 409 #define CARD_NAME "bytcht-es8316"
 410 #define DRIVER_NAME NULL /* card name will be used for driver name */
 411
 412 static struct snd_soc_card byt_cht_es8316_card = {
 413         .owner = THIS_MODULE,
 414         .dai_link = byt_cht_es8316_dais,
 415         .num_links = ARRAY_SIZE(byt_cht_es8316_dais),
 416         .dapm_widgets = byt_cht_es8316_widgets,
 417         .num_dapm_widgets = ARRAY_SIZE(byt_cht_es8316_widgets),
 418         .dapm_routes = byt_cht_es8316_audio_map,
 419         .num_dapm_routes = ARRAY_SIZE(byt_cht_es8316_audio_map),
 420         .controls = byt_cht_es8316_controls,
 421         .num_controls = ARRAY_SIZE(byt_cht_es8316_controls),
 422         .fully_routed = true,
 423         .suspend_pre = byt_cht_es8316_suspend,
 424         .resume_post = byt_cht_es8316_resume,
 425 };
 426
 427 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
 428
 429 static const struct acpi_gpio_mapping byt_cht_es8316_gpios[] = {
 430         { "speaker-enable-gpios", &first_gpio, 1 },
 431         { },
 432 };
 433
 434 /* Please keep this list alphabetically sorted */
 435 static const struct dmi_system_id byt_cht_es8316_quirk_table[] = {
 436         {       /* Irbis NB41 */
 437                 .matches = {
 438                         DMI_MATCH(DMI_SYS_VENDOR, "IRBIS"),
 439                         DMI_MATCH(DMI_PRODUCT_NAME, "NB41"),
 440                 },
 441                 .driver_data = (void *)(BYT_CHT_ES8316_SSP0
 442                                         | BYT_CHT_ES8316_INTMIC_IN2_MAP
 443                                         | BYT_CHT_ES8316_JD_INVERTED),
 444         },
 445         {       /* Teclast X98 Plus II */
 446                 .matches = {
 447                         DMI_MATCH(DMI_SYS_VENDOR, "TECLAST"),
 448                         DMI_MATCH(DMI_PRODUCT_NAME, "X98 Plus II"),
 449                 },
 450                 .driver_data = (void *)(BYT_CHT_ES8316_INTMIC_IN1_MAP
 451                                         | BYT_CHT_ES8316_JD_INVERTED),
 452         },
 453         {}
 454 };
 455
 456 static int snd_byt_cht_es8316_mc_probe(struct platform_device *pdev)
 457 {
 458         static const char * const mic_name[] = { "in1", "in2" };
 459         struct property_entry props[MAX_NO_PROPS] = {};
 460         struct byt_cht_es8316_private *priv;
 461         const struct dmi_system_id *dmi_id;
 462         struct device *dev = &pdev->dev;
 463         struct snd_soc_acpi_mach *mach;
 464         const char *platform_name;
 465         struct acpi_device *adev;
 466         struct device *codec_dev;
 467         bool sof_parent;
 468         unsigned int cnt = 0;
 469         int dai_index = 0;
 470         int i;
 471         int ret = 0;
 472
 473         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 474         if (!priv)
 475                 return -ENOMEM;
 476
 477         mach = dev->platform_data;
 478         /* fix index of codec dai */
 479         for (i = 0; i < ARRAY_SIZE(byt_cht_es8316_dais); i++) {
 480                 if (!strcmp(byt_cht_es8316_dais[i].codecs->name,
 481                             "i2c-ESSX8316:00")) {
 482                         dai_index = i;
 483                         break;
 484                 }
 485         }
 486
 487         /* fixup codec name based on HID */
 488         adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
 489         if (adev) {
 490                 snprintf(codec_name, sizeof(codec_name),
 491                          "i2c-%s", acpi_dev_name(adev));
 492                 put_device(&adev->dev);
 493                 byt_cht_es8316_dais[dai_index].codecs->name = codec_name;
 494         }
 495
 496         /* override plaform name, if required */
 497         byt_cht_es8316_card.dev = dev;
 498         platform_name = mach->mach_params.platform;
 499
 500         ret = snd_soc_fixup_dai_links_platform_name(&byt_cht_es8316_card,
 501                                                     platform_name);
 502         if (ret)
 503                 return ret;
 504
 505         /* Check for BYTCR or other platform and setup quirks */
 506         dmi_id = dmi_first_match(byt_cht_es8316_quirk_table);
 507         if (dmi_id) {
 508                 quirk = (unsigned long)dmi_id->driver_data;
 509         } else if (soc_intel_is_byt() &&
 510                    mach->mach_params.acpi_ipc_irq_index == 0) {
 511                 /* On BYTCR default to SSP0, internal-mic-in2-map, mono-spk */
 512                 quirk = BYT_CHT_ES8316_SSP0 | BYT_CHT_ES8316_INTMIC_IN2_MAP |
 513                         BYT_CHT_ES8316_MONO_SPEAKER;
 514         } else {
 515                 /* Others default to internal-mic-in1-map, mono-speaker */
 516                 quirk = BYT_CHT_ES8316_INTMIC_IN1_MAP |
 517                         BYT_CHT_ES8316_MONO_SPEAKER;
 518         }
 519         if (quirk_override != -1) {
 520                 dev_info(dev, "Overriding quirk 0x%lx => 0x%x\n",
 521                          quirk, quirk_override);
 522                 quirk = quirk_override;
 523         }
 524         log_quirks(dev);
 525
 526         if (quirk & BYT_CHT_ES8316_SSP0)
 527                 byt_cht_es8316_dais[dai_index].cpus->dai_name = "ssp0-port";
 528
 529         /* get the clock */
 530         priv->mclk = devm_clk_get(dev, "pmc_plt_clk_3");
 531         if (IS_ERR(priv->mclk)) {
 532                 ret = PTR_ERR(priv->mclk);
 533                 dev_err(dev, "clk_get pmc_plt_clk_3 failed: %d\n", ret);
 534                 return ret;
 535         }
 536
 537         /* get speaker enable GPIO */
 538         codec_dev = bus_find_device_by_name(&i2c_bus_type, NULL, codec_name);
 539         if (!codec_dev)
 540                 return -EPROBE_DEFER;
 541
 542         if (quirk & BYT_CHT_ES8316_JD_INVERTED)
 543                 props[cnt++] = PROPERTY_ENTRY_BOOL("everest,jack-detect-inverted");
 544
 545         if (cnt) {
 546                 ret = device_add_properties(codec_dev, props);
 547                 if (ret) {
 548                         put_device(codec_dev);
 549                         return ret;
 550                 }
 551         }
 552
 553         devm_acpi_dev_add_driver_gpios(codec_dev, byt_cht_es8316_gpios);
 554         priv->speaker_en_gpio =
 555                 gpiod_get_index(codec_dev, "speaker-enable", 0,
 556                                 /* see comment in byt_cht_es8316_resume */
 557                                 GPIOD_OUT_LOW | GPIOD_FLAGS_BIT_NONEXCLUSIVE);
 558         put_device(codec_dev);
 559
 560         if (IS_ERR(priv->speaker_en_gpio)) {
 561                 ret = PTR_ERR(priv->speaker_en_gpio);
 562                 switch (ret) {
 563                 case -ENOENT:
 564                         priv->speaker_en_gpio = NULL;
 565                         break;
 566                 default:
 567                         dev_err(dev, "get speaker GPIO failed: %d\n", ret);
 568                         fallthrough;
 569                 case -EPROBE_DEFER:
 570                         return ret;
 571                 }
 572         }
 573
 574         snprintf(components_string, sizeof(components_string),
 575                  "cfg-spk:%s cfg-mic:%s",
 576                  (quirk & BYT_CHT_ES8316_MONO_SPEAKER) ? "1" : "2",
 577                  mic_name[BYT_CHT_ES8316_MAP(quirk)]);
 578         byt_cht_es8316_card.components = components_string;
 579 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
 580         snprintf(long_name, sizeof(long_name), "bytcht-es8316-%s-spk-%s-mic",
 581                  (quirk & BYT_CHT_ES8316_MONO_SPEAKER) ? "mono" : "stereo",
 582                  mic_name[BYT_CHT_ES8316_MAP(quirk)]);
 583         byt_cht_es8316_card.long_name = long_name;
 584 #endif
 585
 586         sof_parent = snd_soc_acpi_sof_parent(&pdev->dev);
 587
 588         /* set card and driver name */
 589         if (sof_parent) {
 590                 byt_cht_es8316_card.name = SOF_CARD_NAME;
 591                 byt_cht_es8316_card.driver_name = SOF_DRIVER_NAME;
 592         } else {
 593                 byt_cht_es8316_card.name = CARD_NAME;
 594                 byt_cht_es8316_card.driver_name = DRIVER_NAME;
 595         }
 596
 597         /* set pm ops */
 598         if (sof_parent)
 599                 dev->driver->pm = &snd_soc_pm_ops;
 600
 601         /* register the soc card */
 602         snd_soc_card_set_drvdata(&byt_cht_es8316_card, priv);
 603
 604         ret = devm_snd_soc_register_card(dev, &byt_cht_es8316_card);
 605         if (ret) {
 606                 gpiod_put(priv->speaker_en_gpio);
 607                 dev_err(dev, "snd_soc_register_card failed: %d\n", ret);
 608                 return ret;
 609         }
 610         platform_set_drvdata(pdev, &byt_cht_es8316_card);
 611         return 0;
 612 }
 613
 614 static int snd_byt_cht_es8316_mc_remove(struct platform_device *pdev)
 615 {
 616         struct snd_soc_card *card = platform_get_drvdata(pdev);
 617         struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
 618
 619         gpiod_put(priv->speaker_en_gpio);
 620         return 0;
 621 }
 622
 623 static struct platform_driver snd_byt_cht_es8316_mc_driver = {
 624         .driver = {
 625                 .name = "bytcht_es8316",
 626         },
 627         .probe = snd_byt_cht_es8316_mc_probe,
 628         .remove = snd_byt_cht_es8316_mc_remove,
 629 };
 630
 631 module_platform_driver(snd_byt_cht_es8316_mc_driver);
 632 MODULE_DESCRIPTION("ASoC Intel(R) Baytrail/Cherrytrail Machine driver");
 633 MODULE_AUTHOR("David Yang <yangxiaohua@everest-semi.com>");
 634 MODULE_LICENSE("GPL v2");
 635 MODULE_ALIAS("platform:bytcht_es8316");