sound/soc/intel/boards/cht_bsw_max98090_ti.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  cht-bsw-max98090.c - ASoc Machine driver for Intel Cherryview-based
   4  *  platforms Cherrytrail and Braswell, with max98090 & TI codec.
   5  *
   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  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10  *
  11  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  12  */
  13
  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"
  29
  30 #define CHT_PLAT_CLK_3_HZ       19200000
  31 #define CHT_CODEC_DAI   "HiFi"
  32
  33 #define QUIRK_PMC_PLT_CLK_0                             0x01
  34
  35 struct cht_mc_private {
  36         struct clk *mclk;
  37         struct snd_soc_jack jack;
  38         bool ts3a227e_present;
  39         int quirks;
  40 };
  41
  42 static int platform_clock_control(struct snd_soc_dapm_widget *w,
  43                                           struct snd_kcontrol *k, int  event)
  44 {
  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);
  49         int ret;
  50
  51         /* See the comment in snd_cht_mc_probe() */
  52         if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
  53                 return 0;
  54
  55         codec_dai = snd_soc_card_get_codec_dai(card, CHT_CODEC_DAI);
  56         if (!codec_dai) {
  57                 dev_err(card->dev, "Codec dai not found; Unable to set platform clock\n");
  58                 return -EIO;
  59         }
  60
  61         if (SND_SOC_DAPM_EVENT_ON(event)) {
  62                 ret = clk_prepare_enable(ctx->mclk);
  63                 if (ret < 0) {
  64                         dev_err(card->dev,
  65                                 "could not configure MCLK state");
  66                         return ret;
  67                 }
  68         } else {
  69                 clk_disable_unprepare(ctx->mclk);
  70         }
  71
  72         return 0;
  73 }
  74
  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),
  83 };
  84
  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"},
 103 };
 104
 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"),
 110 };
 111
 112 static int cht_aif1_hw_params(struct snd_pcm_substream *substream,
 113                              struct snd_pcm_hw_params *params)
 114 {
 115         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 116         struct snd_soc_dai *codec_dai = rtd->codec_dai;
 117         int ret;
 118
 119         ret = snd_soc_dai_set_sysclk(codec_dai, M98090_REG_SYSTEM_CLOCK,
 120                                      CHT_PLAT_CLK_3_HZ, SND_SOC_CLOCK_IN);
 121         if (ret < 0) {
 122                 dev_err(rtd->dev, "can't set codec sysclk: %d\n", ret);
 123                 return ret;
 124         }
 125
 126         return 0;
 127 }
 128
 129 static int cht_ti_jack_event(struct notifier_block *nb,
 130                 unsigned long event, void *data)
 131 {
 132         struct snd_soc_jack *jack = (struct snd_soc_jack *)data;
 133         struct snd_soc_dapm_context *dapm = &jack->card->dapm;
 134
 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);
 139         } else {
 140                 snd_soc_dapm_disable_pin(dapm, "MICBIAS");
 141                 snd_soc_dapm_disable_pin(dapm, "SHDN");
 142                 snd_soc_dapm_sync(dapm);
 143         }
 144
 145         return 0;
 146 }
 147
 148 static struct notifier_block cht_jack_nb = {
 149         .notifier_call = cht_ti_jack_event,
 150 };
 151
 152 static struct snd_soc_jack_pin hs_jack_pins[] = {
 153         {
 154                 .pin    = "Headphone",
 155                 .mask   = SND_JACK_HEADPHONE,
 156         },
 157         {
 158                 .pin    = "Headset Mic",
 159                 .mask   = SND_JACK_MICROPHONE,
 160         },
 161 };
 162
 163 static struct snd_soc_jack_gpio hs_jack_gpios[] = {
 164         {
 165                 .name           = "hp",
 166                 .report         = SND_JACK_HEADPHONE | SND_JACK_LINEOUT,
 167                 .debounce_time  = 200,
 168         },
 169         {
 170                 .name           = "mic",
 171                 .invert         = 1,
 172                 .report         = SND_JACK_MICROPHONE,
 173                 .debounce_time  = 200,
 174         },
 175 };
 176
 177 static const struct acpi_gpio_params hp_gpios = { 0, 0, false };
 178 static const struct acpi_gpio_params mic_gpios = { 1, 0, false };
 179
 180 static const struct acpi_gpio_mapping acpi_max98090_gpios[] = {
 181         { "hp-gpios", &hp_gpios, 1 },
 182         { "mic-gpios", &mic_gpios, 1 },
 183         {},
 184 };
 185
 186 static int cht_codec_init(struct snd_soc_pcm_runtime *runtime)
 187 {
 188         int ret;
 189         int jack_type;
 190         struct cht_mc_private *ctx = snd_soc_card_get_drvdata(runtime->card);
 191         struct snd_soc_jack *jack = &ctx->jack;
 192
 193         if (ctx->ts3a227e_present) {
 194                 /*
 195                  * The jack has already been created in the
 196                  * cht_max98090_headset_init() function.
 197                  */
 198                 snd_soc_jack_notifier_register(jack, &cht_jack_nb);
 199                 return 0;
 200         }
 201
 202         jack_type = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE;
 203
 204         ret = snd_soc_card_jack_new(runtime->card, "Headset Jack",
 205                                     jack_type, jack,
 206                                     hs_jack_pins, ARRAY_SIZE(hs_jack_pins));
 207         if (ret) {
 208                 dev_err(runtime->dev, "Headset Jack creation failed %d\n", ret);
 209                 return ret;
 210         }
 211
 212         ret = snd_soc_jack_add_gpiods(runtime->card->dev->parent, jack,
 213                                       ARRAY_SIZE(hs_jack_gpios),
 214                                       hs_jack_gpios);
 215         if (ret) {
 216                 /*
 217                  * flag error but don't bail if jack detect is broken
 218                  * due to platform issues or bad BIOS/configuration
 219                  */
 220                 dev_err(runtime->dev,
 221                         "jack detection gpios not added, error %d\n", ret);
 222         }
 223
 224         /* See the comment in snd_cht_mc_probe() */
 225         if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
 226                 return 0;
 227
 228         /*
 229          * The firmware might enable the clock at
 230          * boot (this information may or may not
 231          * be reflected in the enable clock register).
 232          * To change the rate we must disable the clock
 233          * first to cover these cases. Due to common
 234          * clock framework restrictions that do not allow
 235          * to disable a clock that has not been enabled,
 236          * we need to enable the clock first.
 237          */
 238         ret = clk_prepare_enable(ctx->mclk);
 239         if (!ret)
 240                 clk_disable_unprepare(ctx->mclk);
 241
 242         ret = clk_set_rate(ctx->mclk, CHT_PLAT_CLK_3_HZ);
 243
 244         if (ret)
 245                 dev_err(runtime->dev, "unable to set MCLK rate\n");
 246
 247         return ret;
 248 }
 249
 250 static int cht_codec_fixup(struct snd_soc_pcm_runtime *rtd,
 251                             struct snd_pcm_hw_params *params)
 252 {
 253         struct snd_interval *rate = hw_param_interval(params,
 254                         SNDRV_PCM_HW_PARAM_RATE);
 255         struct snd_interval *channels = hw_param_interval(params,
 256                                                 SNDRV_PCM_HW_PARAM_CHANNELS);
 257         int ret = 0;
 258         unsigned int fmt = 0;
 259
 260         ret = snd_soc_dai_set_tdm_slot(rtd->cpu_dai, 0x3, 0x3, 2, 16);
 261         if (ret < 0) {
 262                 dev_err(rtd->dev, "can't set cpu_dai slot fmt: %d\n", ret);
 263                 return ret;
 264         }
 265
 266         fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
 267                                 | SND_SOC_DAIFMT_CBS_CFS;
 268
 269         ret = snd_soc_dai_set_fmt(rtd->cpu_dai, fmt);
 270         if (ret < 0) {
 271                 dev_err(rtd->dev, "can't set cpu_dai set fmt: %d\n", ret);
 272                 return ret;
 273         }
 274
 275         /* The DSP will covert the FE rate to 48k, stereo, 24bits */
 276         rate->min = rate->max = 48000;
 277         channels->min = channels->max = 2;
 278
 279         /* set SSP2 to 16-bit */
 280         params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
 281         return 0;
 282 }
 283
 284 static int cht_aif1_startup(struct snd_pcm_substream *substream)
 285 {
 286         return snd_pcm_hw_constraint_single(substream->runtime,
 287                         SNDRV_PCM_HW_PARAM_RATE, 48000);
 288 }
 289
 290 static int cht_max98090_headset_init(struct snd_soc_component *component)
 291 {
 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;
 295         int jack_type;
 296         int ret;
 297
 298         /*
 299          * TI supports 4 butons headset detection
 300          * KEY_MEDIA
 301          * KEY_VOICECOMMAND
 302          * KEY_VOLUMEUP
 303          * KEY_VOLUMEDOWN
 304          */
 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;
 308
 309         ret = snd_soc_card_jack_new(card, "Headset Jack", jack_type,
 310                                     jack, NULL, 0);
 311         if (ret) {
 312                 dev_err(card->dev, "Headset Jack creation failed %d\n", ret);
 313                 return ret;
 314         }
 315
 316         return ts3a227e_enable_jack_detect(component, jack);
 317 }
 318
 319 static const struct snd_soc_ops cht_aif1_ops = {
 320         .startup = cht_aif1_startup,
 321 };
 322
 323 static const struct snd_soc_ops cht_be_ssp2_ops = {
 324         .hw_params = cht_aif1_hw_params,
 325 };
 326
 327 static struct snd_soc_aux_dev cht_max98090_headset_dev = {
 328         .name = "Headset Chip",
 329         .init = cht_max98090_headset_init,
 330         .codec_name = "i2c-104C227E:00",
 331 };
 332
 333 SND_SOC_DAILINK_DEF(dummy,
 334         DAILINK_COMP_ARRAY(COMP_DUMMY()));
 335
 336 SND_SOC_DAILINK_DEF(media,
 337         DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));
 338
 339 SND_SOC_DAILINK_DEF(deepbuffer,
 340         DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));
 341
 342 SND_SOC_DAILINK_DEF(ssp2_port,
 343         DAILINK_COMP_ARRAY(COMP_CPU("ssp2-port")));
 344 SND_SOC_DAILINK_DEF(ssp2_codec,
 345         DAILINK_COMP_ARRAY(COMP_CODEC("i2c-193C9890:00", "HiFi")));
 346
 347 SND_SOC_DAILINK_DEF(platform,
 348         DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));
 349
 350 static struct snd_soc_dai_link cht_dailink[] = {
 351         [MERR_DPCM_AUDIO] = {
 352                 .name = "Audio Port",
 353                 .stream_name = "Audio",
 354                 .nonatomic = true,
 355                 .dynamic = 1,
 356                 .dpcm_playback = 1,
 357                 .dpcm_capture = 1,
 358                 .ops = &cht_aif1_ops,
 359                 SND_SOC_DAILINK_REG(media, dummy, platform),
 360         },
 361         [MERR_DPCM_DEEP_BUFFER] = {
 362                 .name = "Deep-Buffer Audio Port",
 363                 .stream_name = "Deep-Buffer Audio",
 364                 .nonatomic = true,
 365                 .dynamic = 1,
 366                 .dpcm_playback = 1,
 367                 .ops = &cht_aif1_ops,
 368                 SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
 369         },
 370         /* back ends */
 371         {
 372                 .name = "SSP2-Codec",
 373                 .id = 0,
 374                 .no_pcm = 1,
 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,
 379                 .dpcm_playback = 1,
 380                 .dpcm_capture = 1,
 381                 .ops = &cht_be_ssp2_ops,
 382                 SND_SOC_DAILINK_REG(ssp2_port, ssp2_codec, platform),
 383         },
 384 };
 385
 386 /* SoC card */
 387 static struct snd_soc_card snd_soc_card_cht = {
 388         .name = "chtmax98090",
 389         .owner = THIS_MODULE,
 390         .dai_link = cht_dailink,
 391         .num_links = ARRAY_SIZE(cht_dailink),
 392         .aux_dev = &cht_max98090_headset_dev,
 393         .num_aux_devs = 1,
 394         .dapm_widgets = cht_dapm_widgets,
 395         .num_dapm_widgets = ARRAY_SIZE(cht_dapm_widgets),
 396         .dapm_routes = cht_audio_map,
 397         .num_dapm_routes = ARRAY_SIZE(cht_audio_map),
 398         .controls = cht_mc_controls,
 399         .num_controls = ARRAY_SIZE(cht_mc_controls),
 400 };
 401
 402 static const struct dmi_system_id cht_max98090_quirk_table[] = {
 403         {
 404                 /* Clapper model Chromebook */
 405                 .matches = {
 406                         DMI_MATCH(DMI_PRODUCT_NAME, "Clapper"),
 407                 },
 408                 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
 409         },
 410         {
 411                 /* Gnawty model Chromebook (Acer Chromebook CB3-111) */
 412                 .matches = {
 413                         DMI_MATCH(DMI_PRODUCT_NAME, "Gnawty"),
 414                 },
 415                 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
 416         },
 417         {
 418                 /* Swanky model Chromebook (Toshiba Chromebook 2) */
 419                 .matches = {
 420                         DMI_MATCH(DMI_PRODUCT_NAME, "Swanky"),
 421                 },
 422                 .driver_data = (void *)QUIRK_PMC_PLT_CLK_0,
 423         },
 424         {}
 425 };
 426
 427 static int snd_cht_mc_probe(struct platform_device *pdev)
 428 {
 429         const struct dmi_system_id *dmi_id;
 430         struct device *dev = &pdev->dev;
 431         int ret_val = 0;
 432         struct cht_mc_private *drv;
 433         const char *mclk_name;
 434         struct snd_soc_acpi_mach *mach;
 435         const char *platform_name;
 436
 437         drv = devm_kzalloc(&pdev->dev, sizeof(*drv), GFP_KERNEL);
 438         if (!drv)
 439                 return -ENOMEM;
 440
 441         dmi_id = dmi_first_match(cht_max98090_quirk_table);
 442         if (dmi_id)
 443                 drv->quirks = (unsigned long)dmi_id->driver_data;
 444
 445         drv->ts3a227e_present = acpi_dev_found("104C227E");
 446         if (!drv->ts3a227e_present) {
 447                 /* no need probe TI jack detection chip */
 448                 snd_soc_card_cht.aux_dev = NULL;
 449                 snd_soc_card_cht.num_aux_devs = 0;
 450
 451                 ret_val = devm_acpi_dev_add_driver_gpios(dev->parent,
 452                                                          acpi_max98090_gpios);
 453                 if (ret_val)
 454                         dev_dbg(dev, "Unable to add GPIO mapping table\n");
 455         }
 456
 457         /* override plaform name, if required */
 458         snd_soc_card_cht.dev = &pdev->dev;
 459         mach = (&pdev->dev)->platform_data;
 460         platform_name = mach->mach_params.platform;
 461
 462         ret_val = snd_soc_fixup_dai_links_platform_name(&snd_soc_card_cht,
 463                                                         platform_name);
 464         if (ret_val)
 465                 return ret_val;
 466
 467         /* register the soc card */
 468         snd_soc_card_set_drvdata(&snd_soc_card_cht, drv);
 469
 470         if (drv->quirks & QUIRK_PMC_PLT_CLK_0)
 471                 mclk_name = "pmc_plt_clk_0";
 472         else
 473                 mclk_name = "pmc_plt_clk_3";
 474
 475         drv->mclk = devm_clk_get(&pdev->dev, mclk_name);
 476         if (IS_ERR(drv->mclk)) {
 477                 dev_err(&pdev->dev,
 478                         "Failed to get MCLK from %s: %ld\n",
 479                         mclk_name, PTR_ERR(drv->mclk));
 480                 return PTR_ERR(drv->mclk);
 481         }
 482
 483         /*
 484          * Boards which have the MAX98090's clk connected to clk_0 do not seem
 485          * to like it if we muck with the clock. If we disable the clock when
 486          * it is unused we get "max98090 i2c-193C9890:00: PLL unlocked" errors
 487          * and the PLL never seems to lock again.
 488          * So for these boards we enable it here once and leave it at that.
 489          */
 490         if (drv->quirks & QUIRK_PMC_PLT_CLK_0) {
 491                 ret_val = clk_prepare_enable(drv->mclk);
 492                 if (ret_val < 0) {
 493                         dev_err(&pdev->dev, "MCLK enable error: %d\n", ret_val);
 494                         return ret_val;
 495                 }
 496         }
 497
 498         ret_val = devm_snd_soc_register_card(&pdev->dev, &snd_soc_card_cht);
 499         if (ret_val) {
 500                 dev_err(&pdev->dev,
 501                         "snd_soc_register_card failed %d\n", ret_val);
 502                 return ret_val;
 503         }
 504         platform_set_drvdata(pdev, &snd_soc_card_cht);
 505         return ret_val;
 506 }
 507
 508 static int snd_cht_mc_remove(struct platform_device *pdev)
 509 {
 510         struct snd_soc_card *card = platform_get_drvdata(pdev);
 511         struct cht_mc_private *ctx = snd_soc_card_get_drvdata(card);
 512
 513         if (ctx->quirks & QUIRK_PMC_PLT_CLK_0)
 514                 clk_disable_unprepare(ctx->mclk);
 515
 516         return 0;
 517 }
 518
 519 static struct platform_driver snd_cht_mc_driver = {
 520         .driver = {
 521                 .name = "cht-bsw-max98090",
 522         },
 523         .probe = snd_cht_mc_probe,
 524         .remove = snd_cht_mc_remove,
 525 };
 526
 527 module_platform_driver(snd_cht_mc_driver)
 528
 529 MODULE_DESCRIPTION("ASoC Intel(R) Braswell Machine driver");
 530 MODULE_AUTHOR("Fang, Yang A <yang.a.fang@intel.com>");
 531 MODULE_LICENSE("GPL v2");
 532 MODULE_ALIAS("platform:cht-bsw-max98090");