1 // SPDX-License-Identifier: GPL-2.0-only
3 * cht-bsw-max98090.c - ASoc Machine driver for Intel Cherryview-based
4 * platforms Cherrytrail and Braswell, with max98090 & TI codec.
6 * Copyright (C) 2015 Intel Corp
7 * Author: Fang, Yang A <yang.a.fang@intel.com>
8 * This file is modified from cht_bsw_rt5645.c
9 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 #include <linux/dmi.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <linux/slab.h>
19 #include <linux/acpi.h>
20 #include <linux/clk.h>
21 #include <sound/pcm.h>
22 #include <sound/pcm_params.h>
23 #include <sound/soc.h>
24 #include <sound/soc-acpi.h>
25 #include <sound/jack.h>
26 #include "../../codecs/max98090.h"
27 #include "../atom/sst-atom-controls.h"
28 #include "../../codecs/ts3a227e.h"
30 #define CHT_PLAT_CLK_3_HZ 19200000
31 #define CHT_CODEC_DAI "HiFi"
33 #define QUIRK_PMC_PLT_CLK_0 0x01
35 struct cht_mc_private {
37 struct snd_soc_jack jack;
38 bool ts3a227e_present;
42 static int platform_clock_control(struct snd_soc_dapm_widget *w,
43 struct snd_kcontrol *k, int event)
45 struct snd_soc_dapm_context *dapm = w->dapm;
46 struct snd_soc_card *card = dapm->card;
47 struct snd_soc_dai *codec_dai;
48 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
51 /* See the comment in snd_cht_mc_probe() */
52 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
55 codec_dai = snd_soc_card_get_codec_dai(card, CHT_CODEC_DAI);
57 dev_err(card->dev, "Codec dai not found; Unable to set platform clock\n");
61 if (SND_SOC_DAPM_EVENT_ON(event)) {
62 ret = clk_prepare_enable(ctx->mclk);
65 "could not configure MCLK state");
69 clk_disable_unprepare(ctx->mclk);
75 static const struct snd_soc_dapm_widget cht_dapm_widgets[] = {
76 SND_SOC_DAPM_HP("Headphone", NULL),
77 SND_SOC_DAPM_MIC("Headset Mic", NULL),
78 SND_SOC_DAPM_MIC("Int Mic", NULL),
79 SND_SOC_DAPM_SPK("Ext Spk", NULL),
80 SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
81 platform_clock_control, SND_SOC_DAPM_PRE_PMU |
82 SND_SOC_DAPM_POST_PMD),
85 static const struct snd_soc_dapm_route cht_audio_map[] = {
86 {"IN34", NULL, "Headset Mic"},
87 {"Headset Mic", NULL, "MICBIAS"},
88 {"DMICL", NULL, "Int Mic"},
89 {"Headphone", NULL, "HPL"},
90 {"Headphone", NULL, "HPR"},
91 {"Ext Spk", NULL, "SPKL"},
92 {"Ext Spk", NULL, "SPKR"},
93 {"HiFi Playback", NULL, "ssp2 Tx"},
94 {"ssp2 Tx", NULL, "codec_out0"},
95 {"ssp2 Tx", NULL, "codec_out1"},
96 {"codec_in0", NULL, "ssp2 Rx" },
97 {"codec_in1", NULL, "ssp2 Rx" },
98 {"ssp2 Rx", NULL, "HiFi Capture"},
99 {"Headphone", NULL, "Platform Clock"},
100 {"Headset Mic", NULL, "Platform Clock"},
101 {"Int Mic", NULL, "Platform Clock"},
102 {"Ext Spk", NULL, "Platform Clock"},
105 static const struct snd_kcontrol_new cht_mc_controls[] = {
106 SOC_DAPM_PIN_SWITCH("Headphone"),
107 SOC_DAPM_PIN_SWITCH("Headset Mic"),
108 SOC_DAPM_PIN_SWITCH("Int Mic"),
109 SOC_DAPM_PIN_SWITCH("Ext Spk"),
112 static int cht_aif1_hw_params(struct snd_pcm_substream *substream,
113 struct snd_pcm_hw_params *params)
115 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
116 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
119 ret = snd_soc_dai_set_sysclk(codec_dai, M98090_REG_SYSTEM_CLOCK,
120 CHT_PLAT_CLK_3_HZ, SND_SOC_CLOCK_IN);
122 dev_err(rtd->dev, "can't set codec sysclk: %d\n", ret);
129 static int cht_ti_jack_event(struct notifier_block *nb,
130 unsigned long event, void *data)
132 struct snd_soc_jack *jack = (struct snd_soc_jack *)data;
133 struct snd_soc_dapm_context *dapm = &jack->card->dapm;
135 if (event & SND_JACK_MICROPHONE) {
136 snd_soc_dapm_force_enable_pin(dapm, "SHDN");
137 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS");
138 snd_soc_dapm_sync(dapm);
140 snd_soc_dapm_disable_pin(dapm, "MICBIAS");
141 snd_soc_dapm_disable_pin(dapm, "SHDN");
142 snd_soc_dapm_sync(dapm);
148 static struct notifier_block cht_jack_nb = {
149 .notifier_call = cht_ti_jack_event,
152 static struct snd_soc_jack_pin hs_jack_pins[] = {
155 .mask = SND_JACK_HEADPHONE,
158 .pin = "Headset Mic",
159 .mask = SND_JACK_MICROPHONE,
163 static struct snd_soc_jack_gpio hs_jack_gpios[] = {
166 .report = SND_JACK_HEADPHONE | SND_JACK_LINEOUT,
167 .debounce_time = 200,
172 .report = SND_JACK_MICROPHONE,
173 .debounce_time = 200,
177 static const struct acpi_gpio_params hp_gpios = { 0, 0, false };
178 static const struct acpi_gpio_params mic_gpios = { 1, 0, false };
180 static const struct acpi_gpio_mapping acpi_max98090_gpios[] = {
181 { "hp-gpios", &hp_gpios, 1 },
182 { "mic-gpios", &mic_gpios, 1 },
186 static int cht_codec_init(struct snd_soc_pcm_runtime *runtime)
190 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(runtime->card);
191 struct snd_soc_jack *jack = &ctx->jack;
193 if (ctx->ts3a227e_present) {
195 * The jack has already been created in the
196 * cht_max98090_headset_init() function.
198 snd_soc_jack_notifier_register(jack, &cht_jack_nb);
202 jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE;
204 ret = snd_soc_card_jack_new_pins(runtime->card, "Headset Jack",
207 ARRAY_SIZE(hs_jack_pins));
209 dev_err(runtime->dev, "Headset Jack creation failed %d\n", ret);
213 ret = snd_soc_jack_add_gpiods(runtime->card->dev->parent, jack,
214 ARRAY_SIZE(hs_jack_gpios),
218 * flag error but don't bail if jack detect is broken
219 * due to platform issues or bad BIOS/configuration
221 dev_err(runtime->dev,
222 "jack detection gpios not added, error %d\n", ret);
225 /* See the comment in snd_cht_mc_probe() */
226 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
230 * The firmware might enable the clock at
231 * boot (this information may or may not
232 * be reflected in the enable clock register).
233 * To change the rate we must disable the clock
234 * first to cover these cases. Due to common
235 * clock framework restrictions that do not allow
236 * to disable a clock that has not been enabled,
237 * we need to enable the clock first.
239 ret = clk_prepare_enable(ctx->mclk);
241 clk_disable_unprepare(ctx->mclk);
243 ret = clk_set_rate(ctx->mclk, CHT_PLAT_CLK_3_HZ);
246 dev_err(runtime->dev, "unable to set MCLK rate\n");
251 static int cht_codec_fixup(struct snd_soc_pcm_runtime *rtd,
252 struct snd_pcm_hw_params *params)
254 struct snd_interval *rate = hw_param_interval(params,
255 SNDRV_PCM_HW_PARAM_RATE);
256 struct snd_interval *channels = hw_param_interval(params,
257 SNDRV_PCM_HW_PARAM_CHANNELS);
259 unsigned int fmt = 0;
261 ret = snd_soc_dai_set_tdm_slot(snd_soc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, 16);
263 dev_err(rtd->dev, "can't set cpu_dai slot fmt: %d\n", ret);
267 fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF | SND_SOC_DAIFMT_BP_FP;
269 ret = snd_soc_dai_set_fmt(snd_soc_rtd_to_cpu(rtd, 0), fmt);
271 dev_err(rtd->dev, "can't set cpu_dai set fmt: %d\n", ret);
275 /* The DSP will convert the FE rate to 48k, stereo, 24bits */
276 rate->min = rate->max = 48000;
277 channels->min = channels->max = 2;
279 /* set SSP2 to 16-bit */
280 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
284 static int cht_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 int cht_max98090_headset_init(struct snd_soc_component *component)
292 struct snd_soc_card *card = component->card;
293 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
294 struct snd_soc_jack *jack = &ctx->jack;
299 * TI supports 4 buttons headset detection
305 jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE |
306 SND_JACK_BTN_0 | SND_JACK_BTN_1 |
307 SND_JACK_BTN_2 | SND_JACK_BTN_3;
309 ret = snd_soc_card_jack_new(card, "Headset Jack", jack_type, jack);
311 dev_err(card->dev, "Headset Jack creation failed %d\n", ret);
315 return ts3a227e_enable_jack_detect(component, jack);
318 static const struct snd_soc_ops cht_aif1_ops = {
319 .startup = cht_aif1_startup,
322 static const struct snd_soc_ops cht_be_ssp2_ops = {
323 .hw_params = cht_aif1_hw_params,
326 static struct snd_soc_aux_dev cht_max98090_headset_dev = {
327 .dlc = COMP_AUX("i2c-104C227E:00"),
328 .init = cht_max98090_headset_init,
331 SND_SOC_DAILINK_DEF(dummy,
332 DAILINK_COMP_ARRAY(COMP_DUMMY()));
334 SND_SOC_DAILINK_DEF(media,
335 DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
337 SND_SOC_DAILINK_DEF(deepbuffer,
338 DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
340 SND_SOC_DAILINK_DEF(ssp2_port,
341 DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
342 SND_SOC_DAILINK_DEF(ssp2_codec,
343 DAILINK_COMP_ARRAY(COMP_CODEC("i2c-193C9890:00", "HiFi")));
345 SND_SOC_DAILINK_DEF(platform,
346 DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
348 static struct snd_soc_dai_link cht_dailink[] = {
349 [MERR_DPCM_AUDIO] = {
350 .name = "Audio Port",
351 .stream_name = "Audio",
356 .ops = &cht_aif1_ops,
357 SND_SOC_DAILINK_REG(media, dummy, platform),
359 [MERR_DPCM_DEEP_BUFFER] = {
360 .name = "Deep-Buffer Audio Port",
361 .stream_name = "Deep-Buffer Audio",
365 .ops = &cht_aif1_ops,
366 SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
370 .name = "SSP2-Codec",
373 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
374 | SND_SOC_DAIFMT_CBC_CFC,
375 .init = cht_codec_init,
376 .be_hw_params_fixup = cht_codec_fixup,
379 .ops = &cht_be_ssp2_ops,
380 SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
384 /* use space before codec name to simplify card ID, and simplify driver name */
385 #define SOF_CARD_NAME "bytcht max98090" /* card name will be 'sof-bytcht max98090 */
386 #define SOF_DRIVER_NAME "SOF"
388 #define CARD_NAME "chtmax98090"
389 #define DRIVER_NAME NULL /* card name will be used for driver name */
392 static struct snd_soc_card snd_soc_card_cht = {
393 .owner = THIS_MODULE,
394 .dai_link = cht_dailink,
395 .num_links = ARRAY_SIZE(cht_dailink),
396 .aux_dev = &cht_max98090_headset_dev,
398 .dapm_widgets = cht_dapm_widgets,
399 .num_dapm_widgets = ARRAY_SIZE(cht_dapm_widgets),
400 .dapm_routes = cht_audio_map,
401 .num_dapm_routes = ARRAY_SIZE(cht_audio_map),
402 .controls = cht_mc_controls,
403 .num_controls = ARRAY_SIZE(cht_mc_controls),
406 static const struct dmi_system_id cht_max98090_quirk_table[] = {
408 /* Banjo model Chromebook */
410 DMI_MATCH(DMI_PRODUCT_NAME, "Banjo"),
412 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
415 /* Candy model Chromebook */
417 DMI_MATCH(DMI_PRODUCT_NAME, "Candy"),
419 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
422 /* Clapper model Chromebook */
424 DMI_MATCH(DMI_PRODUCT_NAME, "Clapper"),
426 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
429 /* Cyan model Chromebook */
431 DMI_MATCH(DMI_PRODUCT_NAME, "Cyan"),
433 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
436 /* Enguarde model Chromebook */
438 DMI_MATCH(DMI_PRODUCT_NAME, "Enguarde"),
440 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
443 /* Glimmer model Chromebook */
445 DMI_MATCH(DMI_PRODUCT_NAME, "Glimmer"),
447 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
450 /* Gnawty model Chromebook (Acer Chromebook CB3-111) */
452 DMI_MATCH(DMI_PRODUCT_NAME, "Gnawty"),
454 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
457 /* Heli model Chromebook */
459 DMI_MATCH(DMI_PRODUCT_NAME, "Heli"),
461 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
464 /* Kip model Chromebook */
466 DMI_MATCH(DMI_PRODUCT_NAME, "Kip"),
468 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
471 /* Ninja model Chromebook */
473 DMI_MATCH(DMI_PRODUCT_NAME, "Ninja"),
475 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
478 /* Orco model Chromebook */
480 DMI_MATCH(DMI_PRODUCT_NAME, "Orco"),
482 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
485 /* Quawks model Chromebook */
487 DMI_MATCH(DMI_PRODUCT_NAME, "Quawks"),
489 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
492 /* Rambi model Chromebook */
494 DMI_MATCH(DMI_PRODUCT_NAME, "Rambi"),
496 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
499 /* Squawks model Chromebook */
501 DMI_MATCH(DMI_PRODUCT_NAME, "Squawks"),
503 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
506 /* Sumo model Chromebook */
508 DMI_MATCH(DMI_PRODUCT_NAME, "Sumo"),
510 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
513 /* Swanky model Chromebook (Toshiba Chromebook 2) */
515 DMI_MATCH(DMI_PRODUCT_NAME, "Swanky"),
517 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
520 /* Winky model Chromebook */
522 DMI_MATCH(DMI_PRODUCT_NAME, "Winky"),
524 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
529 static int snd_cht_mc_probe(struct platform_device *pdev)
531 const struct dmi_system_id *dmi_id;
532 struct device *dev = &pdev->dev;
534 struct cht_mc_private *drv;
535 const char *mclk_name;
536 struct snd_soc_acpi_mach *mach;
537 const char *platform_name;
540 drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
544 dmi_id = dmi_first_match(cht_max98090_quirk_table);
546 drv->quirks = (unsigned long)dmi_id->driver_data;
548 drv->ts3a227e_present = acpi_dev_found("104C227E");
549 if (!drv->ts3a227e_present) {
550 /* no need probe TI jack detection chip */
551 snd_soc_card_cht.aux_dev = NULL;
552 snd_soc_card_cht.num_aux_devs = 0;
554 ret_val = devm_acpi_dev_add_driver_gpios(dev->parent,
555 acpi_max98090_gpios);
557 dev_dbg(dev, "Unable to add GPIO mapping table\n");
560 /* override platform name, if required */
561 snd_soc_card_cht.dev = dev;
562 mach = dev->platform_data;
563 platform_name = mach->mach_params.platform;
565 ret_val = snd_soc_fixup_dai_links_platform_name(&snd_soc_card_cht,
570 /* register the soc card */
571 snd_soc_card_set_drvdata(&snd_soc_card_cht, drv);
573 if (drv->quirks & QUIRK_PMC_PLT_CLK_0)
574 mclk_name = "pmc_plt_clk_0";
576 mclk_name = "pmc_plt_clk_3";
578 drv->mclk = devm_clk_get(dev, mclk_name);
579 if (IS_ERR(drv->mclk)) {
581 "Failed to get MCLK from %s: %ld\n",
582 mclk_name, PTR_ERR(drv->mclk));
583 return PTR_ERR(drv->mclk);
587 * Boards which have the MAX98090's clk connected to clk_0 do not seem
588 * to like it if we muck with the clock. If we disable the clock when
589 * it is unused we get "max98090 i2c-193C9890:00: PLL unlocked" errors
590 * and the PLL never seems to lock again.
591 * So for these boards we enable it here once and leave it at that.
593 if (drv->quirks & QUIRK_PMC_PLT_CLK_0) {
594 ret_val = clk_prepare_enable(drv->mclk);
596 dev_err(dev, "MCLK enable error: %d\n", ret_val);
601 sof_parent = snd_soc_acpi_sof_parent(dev);
603 /* set card and driver name */
605 snd_soc_card_cht.name = SOF_CARD_NAME;
606 snd_soc_card_cht.driver_name = SOF_DRIVER_NAME;
608 snd_soc_card_cht.name = CARD_NAME;
609 snd_soc_card_cht.driver_name = DRIVER_NAME;
614 dev->driver->pm = &snd_soc_pm_ops;
616 ret_val = devm_snd_soc_register_card(dev, &snd_soc_card_cht);
619 "snd_soc_register_card failed %d\n", ret_val);
622 platform_set_drvdata(pdev, &snd_soc_card_cht);
626 static void snd_cht_mc_remove(struct platform_device *pdev)
628 struct snd_soc_card *card = platform_get_drvdata(pdev);
629 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
631 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
632 clk_disable_unprepare(ctx->mclk);
635 static struct platform_driver snd_cht_mc_driver = {
637 .name = "cht-bsw-max98090",
639 .probe = snd_cht_mc_probe,
640 .remove_new = snd_cht_mc_remove,
643 module_platform_driver(snd_cht_mc_driver)
645 MODULE_DESCRIPTION("ASoC Intel(R) Braswell Machine driver");
646 MODULE_AUTHOR("Fang, Yang A <yang.a.fang@intel.com>");
647 MODULE_LICENSE("GPL v2");
648 MODULE_ALIAS("platform:cht-bsw-max98090");