1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright(c) 2021 Intel Corporation.
5 * Intel SOF Machine Driver with Cirrus Logic CS42L42 Codec
6 * and speaker codec MAX98357A
9 #include <linux/input.h>
10 #include <linux/module.h>
11 #include <linux/platform_device.h>
12 #include <linux/regulator/consumer.h>
13 #include <linux/dmi.h>
14 #include <sound/core.h>
15 #include <sound/jack.h>
16 #include <sound/pcm.h>
17 #include <sound/pcm_params.h>
18 #include <sound/soc.h>
19 #include <sound/soc-acpi.h>
20 #include <dt-bindings/sound/cs42l42.h>
21 #include "../../codecs/hdac_hdmi.h"
22 #include "../common/soc-intel-quirks.h"
23 #include "hda_dsp_common.h"
24 #include "sof_maxim_common.h"
28 #define SOF_CS42L42_SSP_CODEC(quirk) ((quirk) & GENMASK(2, 0))
29 #define SOF_CS42L42_SSP_CODEC_MASK (GENMASK(2, 0))
30 #define SOF_SPEAKER_AMP_PRESENT BIT(3)
31 #define SOF_CS42L42_SSP_AMP_SHIFT 4
32 #define SOF_CS42L42_SSP_AMP_MASK (GENMASK(6, 4))
33 #define SOF_CS42L42_SSP_AMP(quirk) \
34 (((quirk) << SOF_CS42L42_SSP_AMP_SHIFT) & SOF_CS42L42_SSP_AMP_MASK)
35 #define SOF_CS42L42_NUM_HDMIDEV_SHIFT 7
36 #define SOF_CS42L42_NUM_HDMIDEV_MASK (GENMASK(9, 7))
37 #define SOF_CS42L42_NUM_HDMIDEV(quirk) \
38 (((quirk) << SOF_CS42L42_NUM_HDMIDEV_SHIFT) & SOF_CS42L42_NUM_HDMIDEV_MASK)
39 #define SOF_MAX98357A_SPEAKER_AMP_PRESENT BIT(10)
42 static unsigned long sof_cs42l42_quirk = SOF_CS42L42_SSP_CODEC(2);
45 struct list_head head;
46 struct snd_soc_dai *codec_dai;
47 struct snd_soc_jack hdmi_jack;
51 struct sof_card_private {
52 struct snd_soc_jack headset_jack;
53 struct list_head hdmi_pcm_list;
54 bool common_hdmi_codec_drv;
57 static int sof_hdmi_init(struct snd_soc_pcm_runtime *rtd)
59 struct sof_card_private *ctx = snd_soc_card_get_drvdata(rtd->card);
60 struct snd_soc_dai *dai = asoc_rtd_to_codec(rtd, 0);
61 struct sof_hdmi_pcm *pcm;
63 pcm = devm_kzalloc(rtd->card->dev, sizeof(*pcm), GFP_KERNEL);
67 /* dai_link id is 1:1 mapped to the PCM device */
68 pcm->device = rtd->dai_link->id;
71 list_add_tail(&pcm->head, &ctx->hdmi_pcm_list);
76 static int sof_cs42l42_init(struct snd_soc_pcm_runtime *rtd)
78 struct sof_card_private *ctx = snd_soc_card_get_drvdata(rtd->card);
79 struct snd_soc_component *component = asoc_rtd_to_codec(rtd, 0)->component;
80 struct snd_soc_jack *jack = &ctx->headset_jack;
84 * Headset buttons map to the google Reference headset.
85 * These can be configured by userspace.
87 ret = snd_soc_card_jack_new(rtd->card, "Headset Jack",
88 SND_JACK_HEADSET | SND_JACK_BTN_0 |
89 SND_JACK_BTN_1 | SND_JACK_BTN_2 |
93 dev_err(rtd->dev, "Headset Jack creation failed: %d\n", ret);
97 snd_jack_set_key(jack->jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
98 snd_jack_set_key(jack->jack, SND_JACK_BTN_1, KEY_VOLUMEUP);
99 snd_jack_set_key(jack->jack, SND_JACK_BTN_2, KEY_VOLUMEDOWN);
100 snd_jack_set_key(jack->jack, SND_JACK_BTN_3, KEY_VOICECOMMAND);
102 ret = snd_soc_component_set_jack(component, jack, NULL);
104 dev_err(rtd->dev, "Headset Jack call-back failed: %d\n", ret);
111 static void sof_cs42l42_exit(struct snd_soc_pcm_runtime *rtd)
113 struct snd_soc_component *component = asoc_rtd_to_codec(rtd, 0)->component;
115 snd_soc_component_set_jack(component, NULL, NULL);
118 static int sof_cs42l42_hw_params(struct snd_pcm_substream *substream,
119 struct snd_pcm_hw_params *params)
121 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
122 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
125 clk_freq = 3072000; /* BCLK freq */
127 /* Configure sysclk for codec */
128 ret = snd_soc_dai_set_sysclk(codec_dai, 0,
129 clk_freq, SND_SOC_CLOCK_IN);
131 dev_err(rtd->dev, "snd_soc_dai_set_sysclk err = %d\n", ret);
136 static const struct snd_soc_ops sof_cs42l42_ops = {
137 .hw_params = sof_cs42l42_hw_params,
140 static struct snd_soc_dai_link_component platform_component[] = {
142 /* name might be overridden during probe */
143 .name = "0000:00:1f.3"
147 static int sof_card_late_probe(struct snd_soc_card *card)
149 struct sof_card_private *ctx = snd_soc_card_get_drvdata(card);
150 struct snd_soc_component *component = NULL;
151 char jack_name[NAME_SIZE];
152 struct sof_hdmi_pcm *pcm;
155 if (list_empty(&ctx->hdmi_pcm_list))
158 if (ctx->common_hdmi_codec_drv) {
159 pcm = list_first_entry(&ctx->hdmi_pcm_list, struct sof_hdmi_pcm,
161 component = pcm->codec_dai->component;
162 return hda_dsp_hdmi_build_controls(card, component);
165 list_for_each_entry(pcm, &ctx->hdmi_pcm_list, head) {
166 component = pcm->codec_dai->component;
167 snprintf(jack_name, sizeof(jack_name),
168 "HDMI/DP, pcm=%d Jack", pcm->device);
169 err = snd_soc_card_jack_new(card, jack_name,
170 SND_JACK_AVOUT, &pcm->hdmi_jack,
176 err = hdac_hdmi_jack_init(pcm->codec_dai, pcm->device,
182 return hdac_hdmi_jack_port_init(component, &card->dapm);
185 static const struct snd_kcontrol_new sof_controls[] = {
186 SOC_DAPM_PIN_SWITCH("Headphone Jack"),
187 SOC_DAPM_PIN_SWITCH("Headset Mic"),
190 static const struct snd_soc_dapm_widget sof_widgets[] = {
191 SND_SOC_DAPM_HP("Headphone Jack", NULL),
192 SND_SOC_DAPM_MIC("Headset Mic", NULL),
195 static const struct snd_soc_dapm_widget dmic_widgets[] = {
196 SND_SOC_DAPM_MIC("SoC DMIC", NULL),
199 static const struct snd_soc_dapm_route sof_map[] = {
200 /* HP jack connectors - unknown if we have jack detection */
201 {"Headphone Jack", NULL, "HP"},
204 {"HS", NULL, "Headset Mic"},
207 static const struct snd_soc_dapm_route dmic_map[] = {
209 {"DMic", NULL, "SoC DMIC"},
212 static int dmic_init(struct snd_soc_pcm_runtime *rtd)
214 struct snd_soc_card *card = rtd->card;
217 ret = snd_soc_dapm_new_controls(&card->dapm, dmic_widgets,
218 ARRAY_SIZE(dmic_widgets));
220 dev_err(card->dev, "DMic widget addition failed: %d\n", ret);
221 /* Don't need to add routes if widget addition failed */
225 ret = snd_soc_dapm_add_routes(&card->dapm, dmic_map,
226 ARRAY_SIZE(dmic_map));
229 dev_err(card->dev, "DMic map addition failed: %d\n", ret);
234 /* sof audio machine driver for cs42l42 codec */
235 static struct snd_soc_card sof_audio_card_cs42l42 = {
236 .name = "cs42l42", /* the sof- prefix is added by the core */
237 .owner = THIS_MODULE,
238 .controls = sof_controls,
239 .num_controls = ARRAY_SIZE(sof_controls),
240 .dapm_widgets = sof_widgets,
241 .num_dapm_widgets = ARRAY_SIZE(sof_widgets),
242 .dapm_routes = sof_map,
243 .num_dapm_routes = ARRAY_SIZE(sof_map),
244 .fully_routed = true,
245 .late_probe = sof_card_late_probe,
248 static struct snd_soc_dai_link_component cs42l42_component[] = {
250 .name = "i2c-10134242:00",
251 .dai_name = "cs42l42",
255 static struct snd_soc_dai_link_component dmic_component[] = {
257 .name = "dmic-codec",
258 .dai_name = "dmic-hifi",
262 static struct snd_soc_dai_link *sof_card_dai_links_create(struct device *dev,
268 struct snd_soc_dai_link_component *idisp_components;
269 struct snd_soc_dai_link_component *cpus;
270 struct snd_soc_dai_link *links;
273 links = devm_kzalloc(dev, sizeof(struct snd_soc_dai_link) *
274 sof_audio_card_cs42l42.num_links, GFP_KERNEL);
275 cpus = devm_kzalloc(dev, sizeof(struct snd_soc_dai_link_component) *
276 sof_audio_card_cs42l42.num_links, GFP_KERNEL);
281 if (sof_cs42l42_quirk & SOF_SPEAKER_AMP_PRESENT) {
282 links[id].name = devm_kasprintf(dev, GFP_KERNEL,
283 "SSP%d-Codec", ssp_amp);
289 if (sof_cs42l42_quirk & SOF_MAX98357A_SPEAKER_AMP_PRESENT) {
290 max_98357a_dai_link(&links[id]);
292 dev_err(dev, "no amp defined\n");
296 links[id].platforms = platform_component;
297 links[id].num_platforms = ARRAY_SIZE(platform_component);
298 links[id].dpcm_playback = 1;
299 links[id].no_pcm = 1;
300 links[id].cpus = &cpus[id];
301 links[id].num_cpus = 1;
303 links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
306 if (!links[id].cpus->dai_name)
313 links[id].name = devm_kasprintf(dev, GFP_KERNEL,
314 "SSP%d-Codec", ssp_codec);
319 links[id].codecs = cs42l42_component;
320 links[id].num_codecs = ARRAY_SIZE(cs42l42_component);
321 links[id].platforms = platform_component;
322 links[id].num_platforms = ARRAY_SIZE(platform_component);
323 links[id].init = sof_cs42l42_init;
324 links[id].exit = sof_cs42l42_exit;
325 links[id].ops = &sof_cs42l42_ops;
326 links[id].dpcm_playback = 1;
327 links[id].dpcm_capture = 1;
328 links[id].no_pcm = 1;
329 links[id].cpus = &cpus[id];
330 links[id].num_cpus = 1;
332 links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
335 if (!links[id].cpus->dai_name)
341 if (dmic_be_num > 0) {
342 /* at least we have dmic01 */
343 links[id].name = "dmic01";
344 links[id].cpus = &cpus[id];
345 links[id].cpus->dai_name = "DMIC01 Pin";
346 links[id].init = dmic_init;
347 if (dmic_be_num > 1) {
348 /* set up 2 BE links at most */
349 links[id + 1].name = "dmic16k";
350 links[id + 1].cpus = &cpus[id + 1];
351 links[id + 1].cpus->dai_name = "DMIC16k Pin";
356 for (i = 0; i < dmic_be_num; i++) {
358 links[id].num_cpus = 1;
359 links[id].codecs = dmic_component;
360 links[id].num_codecs = ARRAY_SIZE(dmic_component);
361 links[id].platforms = platform_component;
362 links[id].num_platforms = ARRAY_SIZE(platform_component);
363 links[id].ignore_suspend = 1;
364 links[id].dpcm_capture = 1;
365 links[id].no_pcm = 1;
371 idisp_components = devm_kzalloc(dev,
372 sizeof(struct snd_soc_dai_link_component) *
373 hdmi_num, GFP_KERNEL);
374 if (!idisp_components)
377 for (i = 1; i <= hdmi_num; i++) {
378 links[id].name = devm_kasprintf(dev, GFP_KERNEL,
384 links[id].cpus = &cpus[id];
385 links[id].num_cpus = 1;
386 links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
388 if (!links[id].cpus->dai_name)
391 idisp_components[i - 1].name = "ehdaudio0D2";
392 idisp_components[i - 1].dai_name = devm_kasprintf(dev,
396 if (!idisp_components[i - 1].dai_name)
399 links[id].codecs = &idisp_components[i - 1];
400 links[id].num_codecs = 1;
401 links[id].platforms = platform_component;
402 links[id].num_platforms = ARRAY_SIZE(platform_component);
403 links[id].init = sof_hdmi_init;
404 links[id].dpcm_playback = 1;
405 links[id].no_pcm = 1;
414 static int sof_audio_probe(struct platform_device *pdev)
416 struct snd_soc_dai_link *dai_links;
417 struct snd_soc_acpi_mach *mach;
418 struct sof_card_private *ctx;
419 int dmic_be_num, hdmi_num;
420 int ret, ssp_amp, ssp_codec;
422 ctx = devm_kzalloc(&pdev->dev, sizeof(*ctx), GFP_KERNEL);
426 if (pdev->id_entry && pdev->id_entry->driver_data)
427 sof_cs42l42_quirk = (unsigned long)pdev->id_entry->driver_data;
429 mach = pdev->dev.platform_data;
431 if (soc_intel_is_glk()) {
436 hdmi_num = (sof_cs42l42_quirk & SOF_CS42L42_NUM_HDMIDEV_MASK) >>
437 SOF_CS42L42_NUM_HDMIDEV_SHIFT;
438 /* default number of HDMI DAI's */
443 dev_dbg(&pdev->dev, "sof_cs42l42_quirk = %lx\n", sof_cs42l42_quirk);
445 ssp_amp = (sof_cs42l42_quirk & SOF_CS42L42_SSP_AMP_MASK) >>
446 SOF_CS42L42_SSP_AMP_SHIFT;
448 ssp_codec = sof_cs42l42_quirk & SOF_CS42L42_SSP_CODEC_MASK;
450 /* compute number of dai links */
451 sof_audio_card_cs42l42.num_links = 1 + dmic_be_num + hdmi_num;
453 if (sof_cs42l42_quirk & SOF_SPEAKER_AMP_PRESENT)
454 sof_audio_card_cs42l42.num_links++;
456 dai_links = sof_card_dai_links_create(&pdev->dev, ssp_codec, ssp_amp,
457 dmic_be_num, hdmi_num);
461 sof_audio_card_cs42l42.dai_link = dai_links;
463 INIT_LIST_HEAD(&ctx->hdmi_pcm_list);
465 sof_audio_card_cs42l42.dev = &pdev->dev;
467 /* set platform name for each dailink */
468 ret = snd_soc_fixup_dai_links_platform_name(&sof_audio_card_cs42l42,
469 mach->mach_params.platform);
473 ctx->common_hdmi_codec_drv = mach->mach_params.common_hdmi_codec_drv;
475 snd_soc_card_set_drvdata(&sof_audio_card_cs42l42, ctx);
477 return devm_snd_soc_register_card(&pdev->dev,
478 &sof_audio_card_cs42l42);
481 static const struct platform_device_id board_ids[] = {
483 .name = "glk_cs4242_max98357a",
484 .driver_data = (kernel_ulong_t)(SOF_CS42L42_SSP_CODEC(2) |
485 SOF_SPEAKER_AMP_PRESENT |
486 SOF_MAX98357A_SPEAKER_AMP_PRESENT |
487 SOF_CS42L42_SSP_AMP(1)),
492 static struct platform_driver sof_audio = {
493 .probe = sof_audio_probe,
495 .name = "sof_cs42l42",
496 .pm = &snd_soc_pm_ops,
498 .id_table = board_ids,
500 module_platform_driver(sof_audio)
502 /* Module information */
503 MODULE_DESCRIPTION("SOF Audio Machine driver for CS42L42");
504 MODULE_AUTHOR("Brent Lu <brent.lu@intel.com>");
505 MODULE_LICENSE("GPL");
506 MODULE_ALIAS("platform:sof_cs42l42");
507 MODULE_ALIAS("platform:glk_cs4242_max98357a");
508 MODULE_IMPORT_NS(SND_SOC_INTEL_HDA_DSP_COMMON);
509 MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_MAXIM_COMMON);