1 // SPDX-License-Identifier: GPL-2.0-only
3 * bytcht_es8316.c - ASoc Machine driver for Intel Baytrail/Cherrytrail
4 * platforms with Everest ES8316 SoC
6 * Copyright (C) 2017 Endless Mobile, Inc.
7 * Authors: David Yang <yangxiaohua@everest-semi.com>,
8 * Daniel Drake <drake@endlessm.com>
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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/sst-dsp.h"
32 #include "../common/soc-intel-quirks.h"
34 /* jd-inv + terminating entry */
35 #define MAX_NO_PROPS 2
37 struct byt_cht_es8316_private {
39 struct snd_soc_jack jack;
40 struct gpio_desc *speaker_en_gpio;
45 BYT_CHT_ES8316_INTMIC_IN1_MAP,
46 BYT_CHT_ES8316_INTMIC_IN2_MAP,
49 #define BYT_CHT_ES8316_MAP(quirk) ((quirk) & GENMASK(3, 0))
50 #define BYT_CHT_ES8316_SSP0 BIT(16)
51 #define BYT_CHT_ES8316_MONO_SPEAKER BIT(17)
52 #define BYT_CHT_ES8316_JD_INVERTED BIT(18)
54 static unsigned long quirk;
56 static int quirk_override = -1;
57 module_param_named(quirk, quirk_override, int, 0444);
58 MODULE_PARM_DESC(quirk, "Board-specific quirk override");
60 static void log_quirks(struct device *dev)
62 if (BYT_CHT_ES8316_MAP(quirk) == BYT_CHT_ES8316_INTMIC_IN1_MAP)
63 dev_info(dev, "quirk IN1_MAP enabled");
64 if (BYT_CHT_ES8316_MAP(quirk) == BYT_CHT_ES8316_INTMIC_IN2_MAP)
65 dev_info(dev, "quirk IN2_MAP enabled");
66 if (quirk & BYT_CHT_ES8316_SSP0)
67 dev_info(dev, "quirk SSP0 enabled");
68 if (quirk & BYT_CHT_ES8316_MONO_SPEAKER)
69 dev_info(dev, "quirk MONO_SPEAKER enabled\n");
70 if (quirk & BYT_CHT_ES8316_JD_INVERTED)
71 dev_info(dev, "quirk JD_INVERTED enabled\n");
74 static int byt_cht_es8316_speaker_power_event(struct snd_soc_dapm_widget *w,
75 struct snd_kcontrol *kcontrol, int event)
77 struct snd_soc_card *card = w->dapm->card;
78 struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
80 if (SND_SOC_DAPM_EVENT_ON(event))
81 priv->speaker_en = true;
83 priv->speaker_en = false;
85 gpiod_set_value_cansleep(priv->speaker_en_gpio, priv->speaker_en);
90 static const struct snd_soc_dapm_widget byt_cht_es8316_widgets[] = {
91 SND_SOC_DAPM_SPK("Speaker", NULL),
92 SND_SOC_DAPM_HP("Headphone", NULL),
93 SND_SOC_DAPM_MIC("Headset Mic", NULL),
94 SND_SOC_DAPM_MIC("Internal Mic", NULL),
96 SND_SOC_DAPM_SUPPLY("Speaker Power", SND_SOC_NOPM, 0, 0,
97 byt_cht_es8316_speaker_power_event,
98 SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
101 static const struct snd_soc_dapm_route byt_cht_es8316_audio_map[] = {
102 {"Headphone", NULL, "HPOL"},
103 {"Headphone", NULL, "HPOR"},
106 * There is no separate speaker output instead the speakers are muxed to
107 * the HP outputs. The mux is controlled by the "Speaker Power" supply.
109 {"Speaker", NULL, "HPOL"},
110 {"Speaker", NULL, "HPOR"},
111 {"Speaker", NULL, "Speaker Power"},
114 static const struct snd_soc_dapm_route byt_cht_es8316_intmic_in1_map[] = {
115 {"MIC1", NULL, "Internal Mic"},
116 {"MIC2", NULL, "Headset Mic"},
119 static const struct snd_soc_dapm_route byt_cht_es8316_intmic_in2_map[] = {
120 {"MIC2", NULL, "Internal Mic"},
121 {"MIC1", NULL, "Headset Mic"},
124 static const struct snd_soc_dapm_route byt_cht_es8316_ssp0_map[] = {
125 {"Playback", NULL, "ssp0 Tx"},
126 {"ssp0 Tx", NULL, "modem_out"},
127 {"modem_in", NULL, "ssp0 Rx"},
128 {"ssp0 Rx", NULL, "Capture"},
131 static const struct snd_soc_dapm_route byt_cht_es8316_ssp2_map[] = {
132 {"Playback", NULL, "ssp2 Tx"},
133 {"ssp2 Tx", NULL, "codec_out0"},
134 {"ssp2 Tx", NULL, "codec_out1"},
135 {"codec_in0", NULL, "ssp2 Rx" },
136 {"codec_in1", NULL, "ssp2 Rx" },
137 {"ssp2 Rx", NULL, "Capture"},
140 static const struct snd_kcontrol_new byt_cht_es8316_controls[] = {
141 SOC_DAPM_PIN_SWITCH("Speaker"),
142 SOC_DAPM_PIN_SWITCH("Headphone"),
143 SOC_DAPM_PIN_SWITCH("Headset Mic"),
144 SOC_DAPM_PIN_SWITCH("Internal Mic"),
147 static struct snd_soc_jack_pin byt_cht_es8316_jack_pins[] = {
150 .mask = SND_JACK_HEADPHONE,
153 .pin = "Headset Mic",
154 .mask = SND_JACK_MICROPHONE,
158 static int byt_cht_es8316_init(struct snd_soc_pcm_runtime *runtime)
160 struct snd_soc_component *codec = asoc_rtd_to_codec(runtime, 0)->component;
161 struct snd_soc_card *card = runtime->card;
162 struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
163 const struct snd_soc_dapm_route *custom_map;
167 card->dapm.idle_bias_off = true;
169 switch (BYT_CHT_ES8316_MAP(quirk)) {
170 case BYT_CHT_ES8316_INTMIC_IN1_MAP:
172 custom_map = byt_cht_es8316_intmic_in1_map;
173 num_routes = ARRAY_SIZE(byt_cht_es8316_intmic_in1_map);
175 case BYT_CHT_ES8316_INTMIC_IN2_MAP:
176 custom_map = byt_cht_es8316_intmic_in2_map;
177 num_routes = ARRAY_SIZE(byt_cht_es8316_intmic_in2_map);
180 ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
184 if (quirk & BYT_CHT_ES8316_SSP0) {
185 custom_map = byt_cht_es8316_ssp0_map;
186 num_routes = ARRAY_SIZE(byt_cht_es8316_ssp0_map);
188 custom_map = byt_cht_es8316_ssp2_map;
189 num_routes = ARRAY_SIZE(byt_cht_es8316_ssp2_map);
191 ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
196 * The firmware might enable the clock at boot (this information
197 * may or may not be reflected in the enable clock register).
198 * To change the rate we must disable the clock first to cover these
199 * cases. Due to common clock framework restrictions that do not allow
200 * to disable a clock that has not been enabled, we need to enable
203 ret = clk_prepare_enable(priv->mclk);
205 clk_disable_unprepare(priv->mclk);
207 ret = clk_set_rate(priv->mclk, 19200000);
209 dev_err(card->dev, "unable to set MCLK rate\n");
211 ret = clk_prepare_enable(priv->mclk);
213 dev_err(card->dev, "unable to enable MCLK\n");
215 ret = snd_soc_dai_set_sysclk(asoc_rtd_to_codec(runtime, 0), 0, 19200000,
218 dev_err(card->dev, "can't set codec clock %d\n", ret);
222 ret = snd_soc_card_jack_new(card, "Headset",
223 SND_JACK_HEADSET | SND_JACK_BTN_0,
224 &priv->jack, byt_cht_es8316_jack_pins,
225 ARRAY_SIZE(byt_cht_es8316_jack_pins));
227 dev_err(card->dev, "jack creation failed %d\n", ret);
231 snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
232 snd_soc_component_set_jack(codec, &priv->jack, NULL);
237 static int byt_cht_es8316_codec_fixup(struct snd_soc_pcm_runtime *rtd,
238 struct snd_pcm_hw_params *params)
240 struct snd_interval *rate = hw_param_interval(params,
241 SNDRV_PCM_HW_PARAM_RATE);
242 struct snd_interval *channels = hw_param_interval(params,
243 SNDRV_PCM_HW_PARAM_CHANNELS);
246 /* The DSP will covert the FE rate to 48k, stereo */
247 rate->min = rate->max = 48000;
248 channels->min = channels->max = 2;
250 if (quirk & BYT_CHT_ES8316_SSP0) {
251 /* set SSP0 to 16-bit */
252 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
255 /* set SSP2 to 24-bit */
256 params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
261 * Default mode for SSP configuration is TDM 4 slot, override config
262 * with explicit setting to I2S 2ch 24-bit. The word length is set with
263 * dai_set_tdm_slot() since there is no other API exposed
265 ret = snd_soc_dai_set_fmt(asoc_rtd_to_cpu(rtd, 0),
267 SND_SOC_DAIFMT_NB_NF |
268 SND_SOC_DAIFMT_CBS_CFS
271 dev_err(rtd->dev, "can't set format to I2S, err %d\n", ret);
275 ret = snd_soc_dai_set_tdm_slot(asoc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
277 dev_err(rtd->dev, "can't set I2S config, err %d\n", ret);
284 static int byt_cht_es8316_aif1_startup(struct snd_pcm_substream *substream)
286 return snd_pcm_hw_constraint_single(substream->runtime,
287 SNDRV_PCM_HW_PARAM_RATE, 48000);
290 static const struct snd_soc_ops byt_cht_es8316_aif1_ops = {
291 .startup = byt_cht_es8316_aif1_startup,
294 SND_SOC_DAILINK_DEF(dummy,
295 DAILINK_COMP_ARRAY(COMP_DUMMY()));
297 SND_SOC_DAILINK_DEF(media,
298 DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
300 SND_SOC_DAILINK_DEF(deepbuffer,
301 DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
303 SND_SOC_DAILINK_DEF(ssp2_port,
304 DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
305 SND_SOC_DAILINK_DEF(ssp2_codec,
306 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-ESSX8316:00", "ES8316 HiFi")));
308 SND_SOC_DAILINK_DEF(platform,
309 DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
311 static struct snd_soc_dai_link byt_cht_es8316_dais[] = {
312 [MERR_DPCM_AUDIO] = {
313 .name = "Audio Port",
314 .stream_name = "Audio",
319 .ops = &byt_cht_es8316_aif1_ops,
320 SND_SOC_DAILINK_REG(media, dummy, platform),
323 [MERR_DPCM_DEEP_BUFFER] = {
324 .name = "Deep-Buffer Audio Port",
325 .stream_name = "Deep-Buffer Audio",
329 .ops = &byt_cht_es8316_aif1_ops,
330 SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
335 /* Only SSP2 has been tested here, so BYT-CR platforms that
336 * require SSP0 will not work.
338 .name = "SSP2-Codec",
341 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
342 | SND_SOC_DAIFMT_CBS_CFS,
343 .be_hw_params_fixup = byt_cht_es8316_codec_fixup,
347 .init = byt_cht_es8316_init,
348 SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
354 static char codec_name[SND_ACPI_I2C_ID_LEN];
355 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
356 static char long_name[50]; /* = "bytcht-es8316-*-spk-*-mic" */
358 static char components_string[32]; /* = "cfg-spk:* cfg-mic:* */
360 static int byt_cht_es8316_suspend(struct snd_soc_card *card)
362 struct snd_soc_component *component;
364 for_each_card_components(card, component) {
365 if (!strcmp(component->name, codec_name)) {
366 dev_dbg(component->dev, "disabling jack detect before suspend\n");
367 snd_soc_component_set_jack(component, NULL, NULL);
375 static int byt_cht_es8316_resume(struct snd_soc_card *card)
377 struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
378 struct snd_soc_component *component;
380 for_each_card_components(card, component) {
381 if (!strcmp(component->name, codec_name)) {
382 dev_dbg(component->dev, "re-enabling jack detect after resume\n");
383 snd_soc_component_set_jack(component, &priv->jack, NULL);
389 * Some Cherry Trail boards with an ES8316 codec have a bug in their
390 * ACPI tables where the MSSL1680 touchscreen's _PS0 and _PS3 methods
391 * wrongly also set the speaker-enable GPIO to 1/0. Testing has shown
392 * that this really is a bug and the GPIO has no influence on the
393 * touchscreen at all.
395 * The silead.c touchscreen driver does not support runtime suspend, so
396 * the GPIO can only be changed underneath us during a system suspend.
397 * This resume() function runs from a pm complete() callback, and thus
398 * is guaranteed to run after the touchscreen driver/ACPI-subsys has
399 * brought the touchscreen back up again (and thus changed the GPIO).
401 * So to work around this we pass GPIOD_FLAGS_BIT_NONEXCLUSIVE when
402 * requesting the GPIO and we set its value here to undo any changes
403 * done by the touchscreen's broken _PS0 ACPI method.
405 gpiod_set_value_cansleep(priv->speaker_en_gpio, priv->speaker_en);
410 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
411 /* use space before codec name to simplify card ID, and simplify driver name */
412 #define CARD_NAME "bytcht es8316" /* card name will be 'sof-bytcht es8316' */
413 #define DRIVER_NAME "SOF"
415 #define CARD_NAME "bytcht-es8316"
416 #define DRIVER_NAME NULL /* card name will be used for driver name */
419 static struct snd_soc_card byt_cht_es8316_card = {
421 .driver_name = DRIVER_NAME,
422 .owner = THIS_MODULE,
423 .dai_link = byt_cht_es8316_dais,
424 .num_links = ARRAY_SIZE(byt_cht_es8316_dais),
425 .dapm_widgets = byt_cht_es8316_widgets,
426 .num_dapm_widgets = ARRAY_SIZE(byt_cht_es8316_widgets),
427 .dapm_routes = byt_cht_es8316_audio_map,
428 .num_dapm_routes = ARRAY_SIZE(byt_cht_es8316_audio_map),
429 .controls = byt_cht_es8316_controls,
430 .num_controls = ARRAY_SIZE(byt_cht_es8316_controls),
431 .fully_routed = true,
432 .suspend_pre = byt_cht_es8316_suspend,
433 .resume_post = byt_cht_es8316_resume,
436 static const struct acpi_gpio_params first_gpio = { 0, 0, false };
438 static const struct acpi_gpio_mapping byt_cht_es8316_gpios[] = {
439 { "speaker-enable-gpios", &first_gpio, 1 },
443 /* Please keep this list alphabetically sorted */
444 static const struct dmi_system_id byt_cht_es8316_quirk_table[] = {
447 DMI_MATCH(DMI_SYS_VENDOR, "IRBIS"),
448 DMI_MATCH(DMI_PRODUCT_NAME, "NB41"),
450 .driver_data = (void *)(BYT_CHT_ES8316_SSP0
451 | BYT_CHT_ES8316_INTMIC_IN2_MAP
452 | BYT_CHT_ES8316_JD_INVERTED),
454 { /* Teclast X98 Plus II */
456 DMI_MATCH(DMI_SYS_VENDOR, "TECLAST"),
457 DMI_MATCH(DMI_PRODUCT_NAME, "X98 Plus II"),
459 .driver_data = (void *)(BYT_CHT_ES8316_INTMIC_IN1_MAP
460 | BYT_CHT_ES8316_JD_INVERTED),
465 static int snd_byt_cht_es8316_mc_probe(struct platform_device *pdev)
467 static const char * const mic_name[] = { "in1", "in2" };
468 struct property_entry props[MAX_NO_PROPS] = {};
469 struct byt_cht_es8316_private *priv;
470 const struct dmi_system_id *dmi_id;
471 struct device *dev = &pdev->dev;
472 struct snd_soc_acpi_mach *mach;
473 const char *platform_name;
474 struct acpi_device *adev;
475 struct device *codec_dev;
476 unsigned int cnt = 0;
481 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
485 mach = dev->platform_data;
486 /* fix index of codec dai */
487 for (i = 0; i < ARRAY_SIZE(byt_cht_es8316_dais); i++) {
488 if (!strcmp(byt_cht_es8316_dais[i].codecs->name,
489 "i2c-ESSX8316:00")) {
495 /* fixup codec name based on HID */
496 adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
498 snprintf(codec_name, sizeof(codec_name),
499 "i2c-%s", acpi_dev_name(adev));
500 put_device(&adev->dev);
501 byt_cht_es8316_dais[dai_index].codecs->name = codec_name;
504 /* override plaform name, if required */
505 byt_cht_es8316_card.dev = dev;
506 platform_name = mach->mach_params.platform;
508 ret = snd_soc_fixup_dai_links_platform_name(&byt_cht_es8316_card,
513 /* Check for BYTCR or other platform and setup quirks */
514 dmi_id = dmi_first_match(byt_cht_es8316_quirk_table);
516 quirk = (unsigned long)dmi_id->driver_data;
517 } else if (soc_intel_is_byt() &&
518 mach->mach_params.acpi_ipc_irq_index == 0) {
519 /* On BYTCR default to SSP0, internal-mic-in2-map, mono-spk */
520 quirk = BYT_CHT_ES8316_SSP0 | BYT_CHT_ES8316_INTMIC_IN2_MAP |
521 BYT_CHT_ES8316_MONO_SPEAKER;
523 /* Others default to internal-mic-in1-map, mono-speaker */
524 quirk = BYT_CHT_ES8316_INTMIC_IN1_MAP |
525 BYT_CHT_ES8316_MONO_SPEAKER;
527 if (quirk_override != -1) {
528 dev_info(dev, "Overriding quirk 0x%lx => 0x%x\n",
529 quirk, quirk_override);
530 quirk = quirk_override;
534 if (quirk & BYT_CHT_ES8316_SSP0)
535 byt_cht_es8316_dais[dai_index].cpus->dai_name = "ssp0-port";
538 priv->mclk = devm_clk_get(dev, "pmc_plt_clk_3");
539 if (IS_ERR(priv->mclk)) {
540 ret = PTR_ERR(priv->mclk);
541 dev_err(dev, "clk_get pmc_plt_clk_3 failed: %d\n", ret);
545 /* get speaker enable GPIO */
546 codec_dev = bus_find_device_by_name(&i2c_bus_type, NULL, codec_name);
548 return -EPROBE_DEFER;
550 if (quirk & BYT_CHT_ES8316_JD_INVERTED)
551 props[cnt++] = PROPERTY_ENTRY_BOOL("everest,jack-detect-inverted");
554 ret = device_add_properties(codec_dev, props);
556 put_device(codec_dev);
561 devm_acpi_dev_add_driver_gpios(codec_dev, byt_cht_es8316_gpios);
562 priv->speaker_en_gpio =
563 gpiod_get_index(codec_dev, "speaker-enable", 0,
564 /* see comment in byt_cht_es8316_resume */
565 GPIOD_OUT_LOW | GPIOD_FLAGS_BIT_NONEXCLUSIVE);
566 put_device(codec_dev);
568 if (IS_ERR(priv->speaker_en_gpio)) {
569 ret = PTR_ERR(priv->speaker_en_gpio);
572 priv->speaker_en_gpio = NULL;
575 dev_err(dev, "get speaker GPIO failed: %d\n", ret);
582 snprintf(components_string, sizeof(components_string),
583 "cfg-spk:%s cfg-mic:%s",
584 (quirk & BYT_CHT_ES8316_MONO_SPEAKER) ? "1" : "2",
585 mic_name[BYT_CHT_ES8316_MAP(quirk)]);
586 byt_cht_es8316_card.components = components_string;
587 #if !IS_ENABLED(CONFIG_SND_SOC_INTEL_USER_FRIENDLY_LONG_NAMES)
588 snprintf(long_name, sizeof(long_name), "bytcht-es8316-%s-spk-%s-mic",
589 (quirk & BYT_CHT_ES8316_MONO_SPEAKER) ? "mono" : "stereo",
590 mic_name[BYT_CHT_ES8316_MAP(quirk)]);
591 byt_cht_es8316_card.long_name = long_name;
594 /* register the soc card */
595 snd_soc_card_set_drvdata(&byt_cht_es8316_card, priv);
597 ret = devm_snd_soc_register_card(dev, &byt_cht_es8316_card);
599 gpiod_put(priv->speaker_en_gpio);
600 dev_err(dev, "snd_soc_register_card failed: %d\n", ret);
603 platform_set_drvdata(pdev, &byt_cht_es8316_card);
607 static int snd_byt_cht_es8316_mc_remove(struct platform_device *pdev)
609 struct snd_soc_card *card = platform_get_drvdata(pdev);
610 struct byt_cht_es8316_private *priv = snd_soc_card_get_drvdata(card);
612 gpiod_put(priv->speaker_en_gpio);
616 static struct platform_driver snd_byt_cht_es8316_mc_driver = {
618 .name = "bytcht_es8316",
619 #if IS_ENABLED(CONFIG_SND_SOC_SOF_BAYTRAIL)
620 .pm = &snd_soc_pm_ops,
623 .probe = snd_byt_cht_es8316_mc_probe,
624 .remove = snd_byt_cht_es8316_mc_remove,
627 module_platform_driver(snd_byt_cht_es8316_mc_driver);
628 MODULE_DESCRIPTION("ASoC Intel(R) Baytrail/Cherrytrail Machine driver");
629 MODULE_AUTHOR("David Yang <yangxiaohua@everest-semi.com>");
630 MODULE_LICENSE("GPL v2");
631 MODULE_ALIAS("platform:bytcht_es8316");