2 * cht-bsw-max98090.c - ASoc Machine driver for Intel Cherryview-based
3 * platforms Cherrytrail and Braswell, with max98090 & TI codec.
5 * Copyright (C) 2015 Intel Corp
6 * Author: Fang, Yang A <yang.a.fang@intel.com>
7 * This file is modified from cht_bsw_rt5645.c
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 #include <linux/dmi.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
26 #include <linux/acpi.h>
27 #include <linux/clk.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/soc-acpi.h>
32 #include <sound/jack.h>
33 #include "../../codecs/max98090.h"
34 #include "../atom/sst-atom-controls.h"
35 #include "../../codecs/ts3a227e.h"
37 #define CHT_PLAT_CLK_3_HZ 19200000
38 #define CHT_CODEC_DAI "HiFi"
40 #define QUIRK_PMC_PLT_CLK_0 0x01
42 struct cht_mc_private {
44 struct snd_soc_jack jack;
45 bool ts3a227e_present;
49 static int platform_clock_control(struct snd_soc_dapm_widget *w,
50 struct snd_kcontrol *k, int event)
52 struct snd_soc_dapm_context *dapm = w->dapm;
53 struct snd_soc_card *card = dapm->card;
54 struct snd_soc_dai *codec_dai;
55 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
58 /* See the comment in snd_cht_mc_probe() */
59 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
62 codec_dai = snd_soc_card_get_codec_dai(card, CHT_CODEC_DAI);
64 dev_err(card->dev, "Codec dai not found; Unable to set platform clock\n");
68 if (SND_SOC_DAPM_EVENT_ON(event)) {
69 ret = clk_prepare_enable(ctx->mclk);
72 "could not configure MCLK state");
76 clk_disable_unprepare(ctx->mclk);
82 static const struct snd_soc_dapm_widget cht_dapm_widgets[] = {
83 SND_SOC_DAPM_HP("Headphone", NULL),
84 SND_SOC_DAPM_MIC("Headset Mic", NULL),
85 SND_SOC_DAPM_MIC("Int Mic", NULL),
86 SND_SOC_DAPM_SPK("Ext Spk", NULL),
87 SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
88 platform_clock_control, SND_SOC_DAPM_PRE_PMU |
89 SND_SOC_DAPM_POST_PMD),
92 static const struct snd_soc_dapm_route cht_audio_map[] = {
93 {"IN34", NULL, "Headset Mic"},
94 {"Headset Mic", NULL, "MICBIAS"},
95 {"DMICL", NULL, "Int Mic"},
96 {"Headphone", NULL, "HPL"},
97 {"Headphone", NULL, "HPR"},
98 {"Ext Spk", NULL, "SPKL"},
99 {"Ext Spk", NULL, "SPKR"},
100 {"HiFi Playback", NULL, "ssp2 Tx"},
101 {"ssp2 Tx", NULL, "codec_out0"},
102 {"ssp2 Tx", NULL, "codec_out1"},
103 {"codec_in0", NULL, "ssp2 Rx" },
104 {"codec_in1", NULL, "ssp2 Rx" },
105 {"ssp2 Rx", NULL, "HiFi Capture"},
106 {"Headphone", NULL, "Platform Clock"},
107 {"Headset Mic", NULL, "Platform Clock"},
108 {"Int Mic", NULL, "Platform Clock"},
109 {"Ext Spk", NULL, "Platform Clock"},
112 static const struct snd_kcontrol_new cht_mc_controls[] = {
113 SOC_DAPM_PIN_SWITCH("Headphone"),
114 SOC_DAPM_PIN_SWITCH("Headset Mic"),
115 SOC_DAPM_PIN_SWITCH("Int Mic"),
116 SOC_DAPM_PIN_SWITCH("Ext Spk"),
119 static int cht_aif1_hw_params(struct snd_pcm_substream *substream,
120 struct snd_pcm_hw_params *params)
122 struct snd_soc_pcm_runtime *rtd = substream->private_data;
123 struct snd_soc_dai *codec_dai = rtd->codec_dai;
126 ret = snd_soc_dai_set_sysclk(codec_dai, M98090_REG_SYSTEM_CLOCK,
127 CHT_PLAT_CLK_3_HZ, SND_SOC_CLOCK_IN);
129 dev_err(rtd->dev, "can't set codec sysclk: %d\n", ret);
136 static int cht_ti_jack_event(struct notifier_block *nb,
137 unsigned long event, void *data)
139 struct snd_soc_jack *jack = (struct snd_soc_jack *)data;
140 struct snd_soc_dapm_context *dapm = &jack->card->dapm;
142 if (event & SND_JACK_MICROPHONE) {
143 snd_soc_dapm_force_enable_pin(dapm, "SHDN");
144 snd_soc_dapm_force_enable_pin(dapm, "MICBIAS");
145 snd_soc_dapm_sync(dapm);
147 snd_soc_dapm_disable_pin(dapm, "MICBIAS");
148 snd_soc_dapm_disable_pin(dapm, "SHDN");
149 snd_soc_dapm_sync(dapm);
155 static struct notifier_block cht_jack_nb = {
156 .notifier_call = cht_ti_jack_event,
159 static struct snd_soc_jack_pin hs_jack_pins[] = {
162 .mask = SND_JACK_HEADPHONE,
165 .pin = "Headset Mic",
166 .mask = SND_JACK_MICROPHONE,
170 static struct snd_soc_jack_gpio hs_jack_gpios[] = {
173 .report = SND_JACK_HEADPHONE | SND_JACK_LINEOUT,
174 .debounce_time = 200,
179 .report = SND_JACK_MICROPHONE,
180 .debounce_time = 200,
184 static const struct acpi_gpio_params hp_gpios = { 0, 0, false };
185 static const struct acpi_gpio_params mic_gpios = { 1, 0, false };
187 static const struct acpi_gpio_mapping acpi_max98090_gpios[] = {
188 { "hp-gpios", &hp_gpios, 1 },
189 { "mic-gpios", &mic_gpios, 1 },
193 static int cht_codec_init(struct snd_soc_pcm_runtime *runtime)
197 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(runtime->card);
198 struct snd_soc_jack *jack = &ctx->jack;
200 if (ctx->ts3a227e_present) {
202 * The jack has already been created in the
203 * cht_max98090_headset_init() function.
205 snd_soc_jack_notifier_register(jack, &cht_jack_nb);
209 jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE;
211 ret = snd_soc_card_jack_new(runtime->card, "Headset Jack",
213 hs_jack_pins, ARRAY_SIZE(hs_jack_pins));
215 dev_err(runtime->dev, "Headset Jack creation failed %d\n", ret);
219 ret = snd_soc_jack_add_gpiods(runtime->card->dev->parent, jack,
220 ARRAY_SIZE(hs_jack_gpios),
224 * flag error but don't bail if jack detect is broken
225 * due to platform issues or bad BIOS/configuration
227 dev_err(runtime->dev,
228 "jack detection gpios not added, error %d\n", ret);
231 /* See the comment in snd_cht_mc_probe() */
232 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
236 * The firmware might enable the clock at
237 * boot (this information may or may not
238 * be reflected in the enable clock register).
239 * To change the rate we must disable the clock
240 * first to cover these cases. Due to common
241 * clock framework restrictions that do not allow
242 * to disable a clock that has not been enabled,
243 * we need to enable the clock first.
245 ret = clk_prepare_enable(ctx->mclk);
247 clk_disable_unprepare(ctx->mclk);
249 ret = clk_set_rate(ctx->mclk, CHT_PLAT_CLK_3_HZ);
252 dev_err(runtime->dev, "unable to set MCLK rate\n");
257 static int cht_codec_fixup(struct snd_soc_pcm_runtime *rtd,
258 struct snd_pcm_hw_params *params)
260 struct snd_interval *rate = hw_param_interval(params,
261 SNDRV_PCM_HW_PARAM_RATE);
262 struct snd_interval *channels = hw_param_interval(params,
263 SNDRV_PCM_HW_PARAM_CHANNELS);
265 unsigned int fmt = 0;
267 ret = snd_soc_dai_set_tdm_slot(rtd->cpu_dai, 0x3, 0x3, 2, 16);
269 dev_err(rtd->dev, "can't set cpu_dai slot fmt: %d\n", ret);
273 fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
274 | SND_SOC_DAIFMT_CBS_CFS;
276 ret = snd_soc_dai_set_fmt(rtd->cpu_dai, fmt);
278 dev_err(rtd->dev, "can't set cpu_dai set fmt: %d\n", ret);
282 /* The DSP will covert the FE rate to 48k, stereo, 24bits */
283 rate->min = rate->max = 48000;
284 channels->min = channels->max = 2;
286 /* set SSP2 to 16-bit */
287 params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
291 static int cht_aif1_startup(struct snd_pcm_substream *substream)
293 return snd_pcm_hw_constraint_single(substream->runtime,
294 SNDRV_PCM_HW_PARAM_RATE, 48000);
297 static int cht_max98090_headset_init(struct snd_soc_component *component)
299 struct snd_soc_card *card = component->card;
300 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
301 struct snd_soc_jack *jack = &ctx->jack;
306 * TI supports 4 butons headset detection
312 jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE |
313 SND_JACK_BTN_0 | SND_JACK_BTN_1 |
314 SND_JACK_BTN_2 | SND_JACK_BTN_3;
316 ret = snd_soc_card_jack_new(card, "Headset Jack", jack_type,
319 dev_err(card->dev, "Headset Jack creation failed %d\n", ret);
323 return ts3a227e_enable_jack_detect(component, jack);
326 static const struct snd_soc_ops cht_aif1_ops = {
327 .startup = cht_aif1_startup,
330 static const struct snd_soc_ops cht_be_ssp2_ops = {
331 .hw_params = cht_aif1_hw_params,
334 static struct snd_soc_aux_dev cht_max98090_headset_dev = {
335 .name = "Headset Chip",
336 .init = cht_max98090_headset_init,
337 .codec_name = "i2c-104C227E:00",
340 static struct snd_soc_dai_link cht_dailink[] = {
341 [MERR_DPCM_AUDIO] = {
342 .name = "Audio Port",
343 .stream_name = "Audio",
344 .cpu_dai_name = "media-cpu-dai",
345 .codec_dai_name = "snd-soc-dummy-dai",
346 .codec_name = "snd-soc-dummy",
347 .platform_name = "sst-mfld-platform",
352 .ops = &cht_aif1_ops,
354 [MERR_DPCM_DEEP_BUFFER] = {
355 .name = "Deep-Buffer Audio Port",
356 .stream_name = "Deep-Buffer Audio",
357 .cpu_dai_name = "deepbuffer-cpu-dai",
358 .codec_dai_name = "snd-soc-dummy-dai",
359 .codec_name = "snd-soc-dummy",
360 .platform_name = "sst-mfld-platform",
364 .ops = &cht_aif1_ops,
368 .name = "SSP2-Codec",
370 .cpu_dai_name = "ssp2-port",
371 .platform_name = "sst-mfld-platform",
373 .codec_dai_name = "HiFi",
374 .codec_name = "i2c-193C9890:00",
375 .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
376 | SND_SOC_DAIFMT_CBS_CFS,
377 .init = cht_codec_init,
378 .be_hw_params_fixup = cht_codec_fixup,
381 .ops = &cht_be_ssp2_ops,
386 static struct snd_soc_card snd_soc_card_cht = {
387 .name = "chtmax98090",
388 .owner = THIS_MODULE,
389 .dai_link = cht_dailink,
390 .num_links = ARRAY_SIZE(cht_dailink),
391 .aux_dev = &cht_max98090_headset_dev,
393 .dapm_widgets = cht_dapm_widgets,
394 .num_dapm_widgets = ARRAY_SIZE(cht_dapm_widgets),
395 .dapm_routes = cht_audio_map,
396 .num_dapm_routes = ARRAY_SIZE(cht_audio_map),
397 .controls = cht_mc_controls,
398 .num_controls = ARRAY_SIZE(cht_mc_controls),
401 static const struct dmi_system_id cht_max98090_quirk_table[] = {
403 /* Clapper model Chromebook */
405 DMI_MATCH(DMI_PRODUCT_NAME, "Clapper"),
407 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
410 /* Gnawty model Chromebook (Acer Chromebook CB3-111) */
412 DMI_MATCH(DMI_PRODUCT_NAME, "Gnawty"),
414 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
417 /* Swanky model Chromebook (Toshiba Chromebook 2) */
419 DMI_MATCH(DMI_PRODUCT_NAME, "Swanky"),
421 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
426 static int snd_cht_mc_probe(struct platform_device *pdev)
428 const struct dmi_system_id *dmi_id;
429 struct device *dev = &pdev->dev;
431 struct cht_mc_private *drv;
432 const char *mclk_name;
433 struct snd_soc_acpi_mach *mach;
434 const char *platform_name;
436 drv = devm_kzalloc(&pdev->dev, sizeof(*drv), GFP_KERNEL);
440 dmi_id = dmi_first_match(cht_max98090_quirk_table);
442 drv->quirks = (unsigned long)dmi_id->driver_data;
444 drv->ts3a227e_present = acpi_dev_found("104C227E");
445 if (!drv->ts3a227e_present) {
446 /* no need probe TI jack detection chip */
447 snd_soc_card_cht.aux_dev = NULL;
448 snd_soc_card_cht.num_aux_devs = 0;
450 ret_val = devm_acpi_dev_add_driver_gpios(dev->parent,
451 acpi_max98090_gpios);
453 dev_dbg(dev, "Unable to add GPIO mapping table\n");
456 /* override plaform name, if required */
457 mach = (&pdev->dev)->platform_data;
458 platform_name = mach->mach_params.platform;
460 ret_val = snd_soc_fixup_dai_links_platform_name(&snd_soc_card_cht,
465 /* register the soc card */
466 snd_soc_card_cht.dev = &pdev->dev;
467 snd_soc_card_set_drvdata(&snd_soc_card_cht, drv);
469 if (drv->quirks & QUIRK_PMC_PLT_CLK_0)
470 mclk_name = "pmc_plt_clk_0";
472 mclk_name = "pmc_plt_clk_3";
474 drv->mclk = devm_clk_get(&pdev->dev, mclk_name);
475 if (IS_ERR(drv->mclk)) {
477 "Failed to get MCLK from %s: %ld\n",
478 mclk_name, PTR_ERR(drv->mclk));
479 return PTR_ERR(drv->mclk);
483 * Boards which have the MAX98090's clk connected to clk_0 do not seem
484 * to like it if we muck with the clock. If we disable the clock when
485 * it is unused we get "max98090 i2c-193C9890:00: PLL unlocked" errors
486 * and the PLL never seems to lock again.
487 * So for these boards we enable it here once and leave it at that.
489 if (drv->quirks & QUIRK_PMC_PLT_CLK_0) {
490 ret_val = clk_prepare_enable(drv->mclk);
492 dev_err(&pdev->dev, "MCLK enable error: %d\n", ret_val);
497 ret_val = devm_snd_soc_register_card(&pdev->dev, &snd_soc_card_cht);
500 "snd_soc_register_card failed %d\n", ret_val);
503 platform_set_drvdata(pdev, &snd_soc_card_cht);
507 static int snd_cht_mc_remove(struct platform_device *pdev)
509 struct snd_soc_card *card = platform_get_drvdata(pdev);
510 struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
512 if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
513 clk_disable_unprepare(ctx->mclk);
518 static struct platform_driver snd_cht_mc_driver = {
520 .name = "cht-bsw-max98090",
522 .probe = snd_cht_mc_probe,
523 .remove = snd_cht_mc_remove,
526 module_platform_driver(snd_cht_mc_driver)
528 MODULE_DESCRIPTION("ASoC Intel(R) Braswell Machine driver");
529 MODULE_AUTHOR("Fang, Yang A <yang.a.fang@intel.com>");
530 MODULE_LICENSE("GPL v2");
531 MODULE_ALIAS("platform:cht-bsw-max98090");