1// SPDX-License-Identifier: GPL-2.0-only
2// Copyright(c) 2019-2020 Intel Corporation.
3
4/*
5 * Intel SOF Machine Driver with Realtek rt5682 Codec
6 * and speaker codec MAX98357A or RT1015.
7 */
8#include <linux/i2c.h>
9#include <linux/input.h>
10#include <linux/module.h>
11#include <linux/platform_device.h>
12#include <linux/clk.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/sof.h>
20#include <sound/rt5682.h>
21#include <sound/rt5682s.h>
22#include <sound/soc-acpi.h>
23#include "../../codecs/rt5682.h"
24#include "../../codecs/rt5682s.h"
25#include "../../codecs/rt5645.h"
26#include "../common/soc-intel-quirks.h"
27#include "sof_board_helpers.h"
28#include "sof_maxim_common.h"
29#include "sof_realtek_common.h"
30#include "sof_ssp_common.h"
31
32#define SOF_RT5682_SSP_CODEC(quirk)		((quirk) & GENMASK(2, 0))
33#define SOF_RT5682_SSP_CODEC_MASK			(GENMASK(2, 0))
34#define SOF_RT5682_MCLK_EN			BIT(3)
35#define SOF_RT5682_SSP_AMP_SHIFT		6
36#define SOF_RT5682_SSP_AMP_MASK                 (GENMASK(8, 6))
37#define SOF_RT5682_SSP_AMP(quirk)	\
38	(((quirk) << SOF_RT5682_SSP_AMP_SHIFT) & SOF_RT5682_SSP_AMP_MASK)
39#define SOF_RT5682_MCLK_BYTCHT_EN		BIT(9)
40#define SOF_RT5682_NUM_HDMIDEV_SHIFT		10
41#define SOF_RT5682_NUM_HDMIDEV_MASK		(GENMASK(12, 10))
42#define SOF_RT5682_NUM_HDMIDEV(quirk)	\
43	((quirk << SOF_RT5682_NUM_HDMIDEV_SHIFT) & SOF_RT5682_NUM_HDMIDEV_MASK)
44
45/* BT audio offload: reserve 3 bits for future */
46#define SOF_BT_OFFLOAD_SSP_SHIFT		19
47#define SOF_BT_OFFLOAD_SSP_MASK		(GENMASK(21, 19))
48#define SOF_BT_OFFLOAD_SSP(quirk)	\
49	(((quirk) << SOF_BT_OFFLOAD_SSP_SHIFT) & SOF_BT_OFFLOAD_SSP_MASK)
50#define SOF_SSP_BT_OFFLOAD_PRESENT		BIT(22)
51
52/* HDMI capture*/
53#define SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT  27
54#define SOF_SSP_HDMI_CAPTURE_PRESENT_MASK (GENMASK(30, 27))
55#define SOF_HDMI_CAPTURE_SSP_MASK(quirk)   \
56	(((quirk) << SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT) & SOF_SSP_HDMI_CAPTURE_PRESENT_MASK)
57
58/* Default: MCLK on, MCLK 19.2M, SSP0  */
59static unsigned long sof_rt5682_quirk = SOF_RT5682_MCLK_EN |
60					SOF_RT5682_SSP_CODEC(0);
61
62static int sof_rt5682_quirk_cb(const struct dmi_system_id *id)
63{
64	sof_rt5682_quirk = (unsigned long)id->driver_data;
65	return 1;
66}
67
68static const struct dmi_system_id sof_rt5682_quirk_table[] = {
69	{
70		.callback = sof_rt5682_quirk_cb,
71		.matches = {
72			DMI_MATCH(DMI_SYS_VENDOR, "Circuitco"),
73			DMI_MATCH(DMI_PRODUCT_NAME, "Minnowboard Max"),
74		},
75		.driver_data = (void *)(SOF_RT5682_SSP_CODEC(2)),
76	},
77	{
78		.callback = sof_rt5682_quirk_cb,
79		.matches = {
80			DMI_MATCH(DMI_SYS_VENDOR, "AAEON"),
81			DMI_MATCH(DMI_PRODUCT_NAME, "UP-CHT01"),
82		},
83		.driver_data = (void *)(SOF_RT5682_SSP_CODEC(2)),
84	},
85	{
86		.callback = sof_rt5682_quirk_cb,
87		.matches = {
88			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
89			DMI_MATCH(DMI_PRODUCT_NAME, "WhiskeyLake Client"),
90		},
91		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
92					SOF_RT5682_SSP_CODEC(1)),
93	},
94	{
95		.callback = sof_rt5682_quirk_cb,
96		.matches = {
97			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Hatch"),
98		},
99		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
100					SOF_RT5682_SSP_CODEC(0) |
101					SOF_RT5682_SSP_AMP(1)),
102	},
103	{
104		.callback = sof_rt5682_quirk_cb,
105		.matches = {
106			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
107			DMI_MATCH(DMI_PRODUCT_NAME, "Ice Lake Client"),
108		},
109		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
110					SOF_RT5682_SSP_CODEC(0)),
111	},
112	{
113		.callback = sof_rt5682_quirk_cb,
114		.matches = {
115			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Volteer"),
116			DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98373_ALC5682I_I2S_UP4"),
117		},
118		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
119					SOF_RT5682_SSP_CODEC(0) |
120					SOF_RT5682_SSP_AMP(2) |
121					SOF_RT5682_NUM_HDMIDEV(4)),
122	},
123	{
124		.callback = sof_rt5682_quirk_cb,
125		.matches = {
126			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
127			DMI_MATCH(DMI_PRODUCT_NAME, "Alder Lake Client Platform"),
128			DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98373_ALC5682I_I2S"),
129		},
130		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
131					SOF_RT5682_SSP_CODEC(0) |
132					SOF_RT5682_SSP_AMP(2) |
133					SOF_RT5682_NUM_HDMIDEV(4)),
134	},
135	{
136		.callback = sof_rt5682_quirk_cb,
137		.matches = {
138			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
139			DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98390_ALC5682I_I2S"),
140		},
141		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
142					SOF_RT5682_SSP_CODEC(0) |
143					SOF_RT5682_SSP_AMP(2) |
144					SOF_RT5682_NUM_HDMIDEV(4)),
145	},
146	{
147		.callback = sof_rt5682_quirk_cb,
148		.matches = {
149			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
150			DMI_MATCH(DMI_OEM_STRING, "AUDIO-MAX98360_ALC5682I_I2S_AMP_SSP2"),
151		},
152		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
153					SOF_RT5682_SSP_CODEC(0) |
154					SOF_RT5682_SSP_AMP(2) |
155					SOF_RT5682_NUM_HDMIDEV(4)),
156	},
157	{
158		.callback = sof_rt5682_quirk_cb,
159		.matches = {
160			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Rex"),
161		},
162		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
163					SOF_RT5682_SSP_CODEC(2) |
164					SOF_RT5682_SSP_AMP(0) |
165					SOF_RT5682_NUM_HDMIDEV(3) |
166					SOF_BT_OFFLOAD_SSP(1) |
167					SOF_SSP_BT_OFFLOAD_PRESENT
168					),
169	},
170	{}
171};
172
173static struct snd_soc_jack_pin jack_pins[] = {
174	{
175		.pin    = "Headphone Jack",
176		.mask   = SND_JACK_HEADPHONE,
177	},
178	{
179		.pin    = "Headset Mic",
180		.mask   = SND_JACK_MICROPHONE,
181	},
182};
183
184static int sof_rt5682_codec_init(struct snd_soc_pcm_runtime *rtd)
185{
186	struct sof_card_private *ctx = snd_soc_card_get_drvdata(rtd->card);
187	struct snd_soc_component *component = snd_soc_rtd_to_codec(rtd, 0)->component;
188	struct snd_soc_jack *jack = &ctx->headset_jack;
189	int extra_jack_data;
190	int ret, mclk_freq;
191
192	if (sof_rt5682_quirk & SOF_RT5682_MCLK_EN) {
193		mclk_freq = sof_dai_get_mclk(rtd);
194		if (mclk_freq <= 0) {
195			dev_err(rtd->dev, "invalid mclk freq %d\n", mclk_freq);
196			return -EINVAL;
197		}
198
199		/* need to enable ASRC function for 24MHz mclk rate */
200		if (mclk_freq == 24000000) {
201			dev_info(rtd->dev, "enable ASRC\n");
202
203			switch (ctx->codec_type) {
204			case CODEC_RT5650:
205				rt5645_sel_asrc_clk_src(component,
206							RT5645_DA_STEREO_FILTER |
207							RT5645_AD_STEREO_FILTER,
208							RT5645_CLK_SEL_I2S1_ASRC);
209				rt5645_sel_asrc_clk_src(component,
210							RT5645_DA_MONO_L_FILTER |
211							RT5645_DA_MONO_R_FILTER,
212							RT5645_CLK_SEL_I2S2_ASRC);
213				break;
214			case CODEC_RT5682:
215				rt5682_sel_asrc_clk_src(component,
216							RT5682_DA_STEREO1_FILTER |
217							RT5682_AD_STEREO1_FILTER,
218							RT5682_CLK_SEL_I2S1_ASRC);
219				break;
220			case CODEC_RT5682S:
221				rt5682s_sel_asrc_clk_src(component,
222							 RT5682S_DA_STEREO1_FILTER |
223							 RT5682S_AD_STEREO1_FILTER,
224							 RT5682S_CLK_SEL_I2S1_ASRC);
225				break;
226			default:
227				dev_err(rtd->dev, "invalid codec type %d\n",
228					ctx->codec_type);
229				return -EINVAL;
230			}
231		}
232
233		if (sof_rt5682_quirk & SOF_RT5682_MCLK_BYTCHT_EN) {
234			/*
235			 * The firmware might enable the clock at
236			 * boot (this information may or may not
237			 * be reflected in the enable clock register).
238			 * To change the rate we must disable the clock
239			 * first to cover these cases. Due to common
240			 * clock framework restrictions that do not allow
241			 * to disable a clock that has not been enabled,
242			 * we need to enable the clock first.
243			 */
244			ret = clk_prepare_enable(ctx->rt5682.mclk);
245			if (!ret)
246				clk_disable_unprepare(ctx->rt5682.mclk);
247
248			ret = clk_set_rate(ctx->rt5682.mclk, 19200000);
249
250			if (ret)
251				dev_err(rtd->dev, "unable to set MCLK rate\n");
252		}
253	}
254
255	/*
256	 * Headset buttons map to the google Reference headset.
257	 * These can be configured by userspace.
258	 */
259	ret = snd_soc_card_jack_new_pins(rtd->card, "Headset Jack",
260					 SND_JACK_HEADSET | SND_JACK_BTN_0 |
261					 SND_JACK_BTN_1 | SND_JACK_BTN_2 |
262					 SND_JACK_BTN_3,
263					 jack,
264					 jack_pins,
265					 ARRAY_SIZE(jack_pins));
266	if (ret) {
267		dev_err(rtd->dev, "Headset Jack creation failed: %d\n", ret);
268		return ret;
269	}
270
271	snd_jack_set_key(jack->jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
272	snd_jack_set_key(jack->jack, SND_JACK_BTN_1, KEY_VOICECOMMAND);
273	snd_jack_set_key(jack->jack, SND_JACK_BTN_2, KEY_VOLUMEUP);
274	snd_jack_set_key(jack->jack, SND_JACK_BTN_3, KEY_VOLUMEDOWN);
275
276	if (ctx->codec_type == CODEC_RT5650) {
277		extra_jack_data = SND_JACK_MICROPHONE | SND_JACK_BTN_0;
278		ret = snd_soc_component_set_jack(component, jack, &extra_jack_data);
279	} else
280		ret = snd_soc_component_set_jack(component, jack, NULL);
281
282	if (ret) {
283		dev_err(rtd->dev, "Headset Jack call-back failed: %d\n", ret);
284		return ret;
285	}
286
287	return ret;
288};
289
290static void sof_rt5682_codec_exit(struct snd_soc_pcm_runtime *rtd)
291{
292	struct snd_soc_component *component = snd_soc_rtd_to_codec(rtd, 0)->component;
293
294	snd_soc_component_set_jack(component, NULL, NULL);
295}
296
297static int sof_rt5682_hw_params(struct snd_pcm_substream *substream,
298				struct snd_pcm_hw_params *params)
299{
300	struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
301	struct sof_card_private *ctx = snd_soc_card_get_drvdata(rtd->card);
302	struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
303	int pll_id, pll_source, pll_in, pll_out, clk_id, ret;
304
305	if (sof_rt5682_quirk & SOF_RT5682_MCLK_EN) {
306		if (sof_rt5682_quirk & SOF_RT5682_MCLK_BYTCHT_EN) {
307			ret = clk_prepare_enable(ctx->rt5682.mclk);
308			if (ret < 0) {
309				dev_err(rtd->dev,
310					"could not configure MCLK state");
311				return ret;
312			}
313		}
314
315		switch (ctx->codec_type) {
316		case CODEC_RT5650:
317			pll_source = RT5645_PLL1_S_MCLK;
318			break;
319		case CODEC_RT5682:
320			pll_source = RT5682_PLL1_S_MCLK;
321			break;
322		case CODEC_RT5682S:
323			pll_source = RT5682S_PLL_S_MCLK;
324			break;
325		default:
326			dev_err(rtd->dev, "invalid codec type %d\n",
327				ctx->codec_type);
328			return -EINVAL;
329		}
330
331		/* get the tplg configured mclk. */
332		pll_in = sof_dai_get_mclk(rtd);
333		if (pll_in <= 0) {
334			dev_err(rtd->dev, "invalid mclk freq %d\n", pll_in);
335			return -EINVAL;
336		}
337	} else {
338		switch (ctx->codec_type) {
339		case CODEC_RT5650:
340			pll_source = RT5645_PLL1_S_BCLK1;
341			break;
342		case CODEC_RT5682:
343			pll_source = RT5682_PLL1_S_BCLK1;
344			break;
345		case CODEC_RT5682S:
346			pll_source = RT5682S_PLL_S_BCLK1;
347			break;
348		default:
349			dev_err(rtd->dev, "invalid codec type %d\n",
350				ctx->codec_type);
351			return -EINVAL;
352		}
353
354		pll_in = params_rate(params) * 50;
355	}
356
357	switch (ctx->codec_type) {
358	case CODEC_RT5650:
359		pll_id = 0; /* not used in codec driver */
360		clk_id = RT5645_SCLK_S_PLL1;
361		break;
362	case CODEC_RT5682:
363		pll_id = RT5682_PLL1;
364		clk_id = RT5682_SCLK_S_PLL1;
365		break;
366	case CODEC_RT5682S:
367		pll_id = RT5682S_PLL2;
368		clk_id = RT5682S_SCLK_S_PLL2;
369		break;
370	default:
371		dev_err(rtd->dev, "invalid codec type %d\n", ctx->codec_type);
372		return -EINVAL;
373	}
374
375	pll_out = params_rate(params) * 512;
376
377	/* when MCLK is 512FS, no need to set PLL configuration additionally. */
378	if (pll_in == pll_out) {
379		switch (ctx->codec_type) {
380		case CODEC_RT5650:
381			clk_id = RT5645_SCLK_S_MCLK;
382			break;
383		case CODEC_RT5682:
384			clk_id = RT5682_SCLK_S_MCLK;
385			break;
386		case CODEC_RT5682S:
387			clk_id = RT5682S_SCLK_S_MCLK;
388			break;
389		default:
390			dev_err(rtd->dev, "invalid codec type %d\n",
391				ctx->codec_type);
392			return -EINVAL;
393		}
394	} else {
395		/* Configure pll for codec */
396		ret = snd_soc_dai_set_pll(codec_dai, pll_id, pll_source, pll_in,
397					  pll_out);
398		if (ret < 0)
399			dev_err(rtd->dev, "snd_soc_dai_set_pll err = %d\n", ret);
400	}
401
402	/* Configure sysclk for codec */
403	ret = snd_soc_dai_set_sysclk(codec_dai, clk_id,
404				     pll_out, SND_SOC_CLOCK_IN);
405	if (ret < 0)
406		dev_err(rtd->dev, "snd_soc_dai_set_sysclk err = %d\n", ret);
407
408	/*
409	 * slot_width should equal or large than data length, set them
410	 * be the same
411	 */
412	ret = snd_soc_dai_set_tdm_slot(codec_dai, 0x0, 0x0, 2,
413				       params_width(params));
414	if (ret < 0) {
415		dev_err(rtd->dev, "set TDM slot err:%d\n", ret);
416		return ret;
417	}
418
419	return ret;
420}
421
422static struct snd_soc_ops sof_rt5682_ops = {
423	.hw_params = sof_rt5682_hw_params,
424};
425
426static int sof_card_late_probe(struct snd_soc_card *card)
427{
428	struct sof_card_private *ctx = snd_soc_card_get_drvdata(card);
429	struct snd_soc_dapm_context *dapm = &card->dapm;
430	int err;
431
432	if (ctx->amp_type == CODEC_MAX98373) {
433		/* Disable Left and Right Spk pin after boot */
434		snd_soc_dapm_disable_pin(dapm, "Left Spk");
435		snd_soc_dapm_disable_pin(dapm, "Right Spk");
436		err = snd_soc_dapm_sync(dapm);
437		if (err < 0)
438			return err;
439	}
440
441	return sof_intel_board_card_late_probe(card);
442}
443
444static const struct snd_kcontrol_new sof_controls[] = {
445	SOC_DAPM_PIN_SWITCH("Headphone Jack"),
446	SOC_DAPM_PIN_SWITCH("Headset Mic"),
447	SOC_DAPM_PIN_SWITCH("Left Spk"),
448	SOC_DAPM_PIN_SWITCH("Right Spk"),
449
450};
451
452static const struct snd_soc_dapm_widget sof_widgets[] = {
453	SND_SOC_DAPM_HP("Headphone Jack", NULL),
454	SND_SOC_DAPM_MIC("Headset Mic", NULL),
455	SND_SOC_DAPM_SPK("Left Spk", NULL),
456	SND_SOC_DAPM_SPK("Right Spk", NULL),
457};
458
459static const struct snd_soc_dapm_route sof_map[] = {
460	/* HP jack connectors - unknown if we have jack detection */
461	{ "Headphone Jack", NULL, "HPOL" },
462	{ "Headphone Jack", NULL, "HPOR" },
463
464	/* other jacks */
465	{ "IN1P", NULL, "Headset Mic" },
466};
467
468static const struct snd_soc_dapm_route rt5650_spk_dapm_routes[] = {
469	/* speaker */
470	{ "Left Spk", NULL, "SPOL" },
471	{ "Right Spk", NULL, "SPOR" },
472};
473
474static int rt5650_spk_init(struct snd_soc_pcm_runtime *rtd)
475{
476	struct snd_soc_card *card = rtd->card;
477	int ret;
478
479	ret = snd_soc_dapm_add_routes(&card->dapm, rt5650_spk_dapm_routes,
480				      ARRAY_SIZE(rt5650_spk_dapm_routes));
481	if (ret)
482		dev_err(rtd->dev, "fail to add dapm routes, ret=%d\n", ret);
483
484	return ret;
485}
486
487/* sof audio machine driver for rt5682 codec */
488static struct snd_soc_card sof_audio_card_rt5682 = {
489	.name = "rt5682", /* the sof- prefix is added by the core */
490	.owner = THIS_MODULE,
491	.controls = sof_controls,
492	.num_controls = ARRAY_SIZE(sof_controls),
493	.dapm_widgets = sof_widgets,
494	.num_dapm_widgets = ARRAY_SIZE(sof_widgets),
495	.dapm_routes = sof_map,
496	.num_dapm_routes = ARRAY_SIZE(sof_map),
497	.fully_routed = true,
498	.late_probe = sof_card_late_probe,
499};
500
501static struct snd_soc_dai_link_component rt5682_component[] = {
502	{
503		.name = "i2c-10EC5682:00",
504		.dai_name = "rt5682-aif1",
505	}
506};
507
508static struct snd_soc_dai_link_component rt5682s_component[] = {
509	{
510		.name = "i2c-RTL5682:00",
511		.dai_name = "rt5682s-aif1",
512	}
513};
514
515static struct snd_soc_dai_link_component rt5650_components[] = {
516	{
517		.name = "i2c-10EC5650:00",
518		.dai_name = "rt5645-aif1",
519	},
520	{
521		.name = "i2c-10EC5650:00",
522		.dai_name = "rt5645-aif2",
523	}
524};
525
526static int
527sof_card_dai_links_create(struct device *dev, struct snd_soc_card *card,
528			  struct sof_card_private *ctx)
529{
530	int ret;
531
532	ret = sof_intel_board_set_dai_link(dev, card, ctx);
533	if (ret)
534		return ret;
535
536	if (!ctx->codec_link) {
537		dev_err(dev, "codec link not available");
538		return -EINVAL;
539	}
540
541	/* codec-specific fields for headphone codec */
542	switch (ctx->codec_type) {
543	case CODEC_RT5650:
544		ctx->codec_link->codecs = &rt5650_components[0];
545		ctx->codec_link->num_codecs = 1;
546		break;
547	case CODEC_RT5682:
548		ctx->codec_link->codecs = rt5682_component;
549		ctx->codec_link->num_codecs = ARRAY_SIZE(rt5682_component);
550		break;
551	case CODEC_RT5682S:
552		ctx->codec_link->codecs = rt5682s_component;
553		ctx->codec_link->num_codecs = ARRAY_SIZE(rt5682s_component);
554		break;
555	default:
556		dev_err(dev, "invalid codec type %d\n", ctx->codec_type);
557		return -EINVAL;
558	}
559
560	ctx->codec_link->init = sof_rt5682_codec_init;
561	ctx->codec_link->exit = sof_rt5682_codec_exit;
562	ctx->codec_link->ops = &sof_rt5682_ops;
563
564	if (!ctx->rt5682.is_legacy_cpu) {
565		/*
566		 * Currently, On SKL+ platforms MCLK will be turned off in sof
567		 * runtime suspended, and it will go into runtime suspended
568		 * right after playback is stop. However, rt5682 will output
569		 * static noise if sysclk turns off during playback. Set
570		 * ignore_pmdown_time to power down rt5682 immediately and
571		 * avoid the noise.
572		 * It can be removed once we can control MCLK by driver.
573		 */
574		ctx->codec_link->ignore_pmdown_time = 1;
575	}
576
577	if (ctx->amp_type == CODEC_NONE)
578		return 0;
579
580	if (!ctx->amp_link) {
581		dev_err(dev, "amp link not available");
582		return -EINVAL;
583	}
584
585	/* codec-specific fields for speaker amplifier */
586	switch (ctx->amp_type) {
587	case CODEC_MAX98357A:
588		max_98357a_dai_link(ctx->amp_link);
589		break;
590	case CODEC_MAX98360A:
591		max_98360a_dai_link(ctx->amp_link);
592		break;
593	case CODEC_MAX98373:
594		ctx->amp_link->codecs = max_98373_components;
595		ctx->amp_link->num_codecs = ARRAY_SIZE(max_98373_components);
596		ctx->amp_link->init = max_98373_spk_codec_init;
597		ctx->amp_link->ops = &max_98373_ops;
598		break;
599	case CODEC_MAX98390:
600		max_98390_dai_link(dev, ctx->amp_link);
601		break;
602	case CODEC_RT1011:
603		sof_rt1011_dai_link(ctx->amp_link);
604		break;
605	case CODEC_RT1015:
606		sof_rt1015_dai_link(ctx->amp_link);
607		break;
608	case CODEC_RT1015P:
609		sof_rt1015p_dai_link(ctx->amp_link);
610		break;
611	case CODEC_RT1019P:
612		sof_rt1019p_dai_link(ctx->amp_link);
613		break;
614	case CODEC_RT5650:
615		/* use AIF2 to support speaker pipeline */
616		ctx->amp_link->codecs = &rt5650_components[1];
617		ctx->amp_link->num_codecs = 1;
618		ctx->amp_link->init = rt5650_spk_init;
619		ctx->amp_link->ops = &sof_rt5682_ops;
620		break;
621	default:
622		dev_err(dev, "invalid amp type %d\n", ctx->amp_type);
623		return -EINVAL;
624	}
625
626	return 0;
627}
628
629static int sof_audio_probe(struct platform_device *pdev)
630{
631	struct snd_soc_acpi_mach *mach = pdev->dev.platform_data;
632	struct sof_card_private *ctx;
633	int ret;
634
635	ctx = devm_kzalloc(&pdev->dev, sizeof(*ctx), GFP_KERNEL);
636	if (!ctx)
637		return -ENOMEM;
638
639	if (pdev->id_entry && pdev->id_entry->driver_data)
640		sof_rt5682_quirk = (unsigned long)pdev->id_entry->driver_data;
641
642	dmi_check_system(sof_rt5682_quirk_table);
643
644	ctx->codec_type = sof_ssp_detect_codec_type(&pdev->dev);
645	ctx->amp_type = sof_ssp_detect_amp_type(&pdev->dev);
646
647	if (ctx->codec_type == CODEC_RT5650) {
648		sof_audio_card_rt5682.name = devm_kstrdup(&pdev->dev, "rt5650",
649							  GFP_KERNEL);
650
651		/* create speaker dai link also */
652		if (ctx->amp_type == CODEC_NONE)
653			ctx->amp_type = CODEC_RT5650;
654	}
655
656	if (soc_intel_is_byt() || soc_intel_is_cht()) {
657		ctx->rt5682.is_legacy_cpu = true;
658		ctx->dmic_be_num = 0;
659		/* HDMI is not supported by SOF on Baytrail/CherryTrail */
660		ctx->hdmi_num = 0;
661		/* default quirk for legacy cpu */
662		sof_rt5682_quirk = SOF_RT5682_MCLK_EN |
663						SOF_RT5682_MCLK_BYTCHT_EN |
664						SOF_RT5682_SSP_CODEC(2);
665	} else {
666		ctx->dmic_be_num = 2;
667		ctx->hdmi_num = (sof_rt5682_quirk & SOF_RT5682_NUM_HDMIDEV_MASK) >>
668			 SOF_RT5682_NUM_HDMIDEV_SHIFT;
669		/* default number of HDMI DAI's */
670		if (!ctx->hdmi_num)
671			ctx->hdmi_num = 3;
672
673		if (mach->mach_params.codec_mask & IDISP_CODEC_MASK)
674			ctx->hdmi.idisp_codec = true;
675	}
676
677	/* need to get main clock from pmc */
678	if (sof_rt5682_quirk & SOF_RT5682_MCLK_BYTCHT_EN) {
679		ctx->rt5682.mclk = devm_clk_get(&pdev->dev, "pmc_plt_clk_3");
680		if (IS_ERR(ctx->rt5682.mclk)) {
681			ret = PTR_ERR(ctx->rt5682.mclk);
682
683			dev_err(&pdev->dev,
684				"Failed to get MCLK from pmc_plt_clk_3: %d\n",
685				ret);
686			return ret;
687		}
688
689		ret = clk_prepare_enable(ctx->rt5682.mclk);
690		if (ret < 0) {
691			dev_err(&pdev->dev,
692				"could not configure MCLK state");
693			return ret;
694		}
695	}
696
697	dev_dbg(&pdev->dev, "sof_rt5682_quirk = %lx\n", sof_rt5682_quirk);
698
699	/* port number/mask of peripherals attached to ssp interface */
700	ctx->ssp_mask_hdmi_in = (sof_rt5682_quirk & SOF_SSP_HDMI_CAPTURE_PRESENT_MASK) >>
701			SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT;
702
703	ctx->ssp_bt = (sof_rt5682_quirk & SOF_BT_OFFLOAD_SSP_MASK) >>
704			SOF_BT_OFFLOAD_SSP_SHIFT;
705
706	ctx->ssp_amp = (sof_rt5682_quirk & SOF_RT5682_SSP_AMP_MASK) >>
707			SOF_RT5682_SSP_AMP_SHIFT;
708
709	ctx->ssp_codec = sof_rt5682_quirk & SOF_RT5682_SSP_CODEC_MASK;
710
711	if (sof_rt5682_quirk & SOF_SSP_BT_OFFLOAD_PRESENT)
712		ctx->bt_offload_present = true;
713
714	/* update dai_link */
715	ret = sof_card_dai_links_create(&pdev->dev, &sof_audio_card_rt5682, ctx);
716	if (ret)
717		return ret;
718
719	/* update codec_conf */
720	switch (ctx->amp_type) {
721	case CODEC_MAX98373:
722		max_98373_set_codec_conf(&sof_audio_card_rt5682);
723		break;
724	case CODEC_MAX98390:
725		max_98390_set_codec_conf(&pdev->dev, &sof_audio_card_rt5682);
726		break;
727	case CODEC_RT1011:
728		sof_rt1011_codec_conf(&sof_audio_card_rt5682);
729		break;
730	case CODEC_RT1015:
731		sof_rt1015_codec_conf(&sof_audio_card_rt5682);
732		break;
733	case CODEC_RT1015P:
734		sof_rt1015p_codec_conf(&sof_audio_card_rt5682);
735		break;
736	case CODEC_NONE:
737	case CODEC_MAX98357A:
738	case CODEC_MAX98360A:
739	case CODEC_RT1019P:
740	case CODEC_RT5650:
741		/* no codec conf required */
742		break;
743	default:
744		dev_err(&pdev->dev, "invalid amp type %d\n", ctx->amp_type);
745		return -EINVAL;
746	}
747
748	sof_audio_card_rt5682.dev = &pdev->dev;
749
750	/* set platform name for each dailink */
751	ret = snd_soc_fixup_dai_links_platform_name(&sof_audio_card_rt5682,
752						    mach->mach_params.platform);
753	if (ret)
754		return ret;
755
756	snd_soc_card_set_drvdata(&sof_audio_card_rt5682, ctx);
757
758	return devm_snd_soc_register_card(&pdev->dev,
759					  &sof_audio_card_rt5682);
760}
761
762static const struct platform_device_id board_ids[] = {
763	{
764		.name = "sof_rt5682",
765	},
766	{
767		.name = "cml_rt1015_rt5682",
768		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
769					SOF_RT5682_SSP_CODEC(0) |
770					SOF_RT5682_SSP_AMP(1)),
771	},
772	{
773		.name = "jsl_rt5682_def",
774		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
775					SOF_RT5682_SSP_CODEC(0) |
776					SOF_RT5682_SSP_AMP(1)),
777	},
778	{
779		.name = "tgl_rt5682_def",
780		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
781					SOF_RT5682_SSP_CODEC(0) |
782					SOF_RT5682_SSP_AMP(1) |
783					SOF_RT5682_NUM_HDMIDEV(4) |
784					SOF_BT_OFFLOAD_SSP(2) |
785					SOF_SSP_BT_OFFLOAD_PRESENT),
786	},
787	{
788		.name = "adl_rt5682_def",
789		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
790					SOF_RT5682_SSP_CODEC(0) |
791					SOF_RT5682_SSP_AMP(1) |
792					SOF_RT5682_NUM_HDMIDEV(4) |
793					SOF_BT_OFFLOAD_SSP(2) |
794					SOF_SSP_BT_OFFLOAD_PRESENT),
795	},
796	{
797		.name = "adl_mx98357_rt5682",
798		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
799					SOF_RT5682_SSP_CODEC(0) |
800					SOF_RT5682_SSP_AMP(2) |
801					SOF_RT5682_NUM_HDMIDEV(4)),
802	},
803	{
804		.name = "adl_rt5682_c1_h02",
805		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
806					SOF_RT5682_SSP_CODEC(1) |
807					SOF_RT5682_NUM_HDMIDEV(3) |
808					/* SSP 0 and SSP 2 are used for HDMI IN */
809					SOF_HDMI_CAPTURE_SSP_MASK(0x5)),
810	},
811	{
812		.name = "rpl_mx98357_rt5682",
813		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
814					SOF_RT5682_SSP_CODEC(0) |
815					SOF_RT5682_SSP_AMP(2) |
816					SOF_RT5682_NUM_HDMIDEV(4)),
817	},
818	{
819		.name = "rpl_rt5682_def",
820		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
821					SOF_RT5682_SSP_CODEC(0) |
822					SOF_RT5682_SSP_AMP(1) |
823					SOF_RT5682_NUM_HDMIDEV(4) |
824					SOF_BT_OFFLOAD_SSP(2) |
825					SOF_SSP_BT_OFFLOAD_PRESENT),
826	},
827	{
828		.name = "rpl_rt5682_c1_h02",
829		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
830					SOF_RT5682_SSP_CODEC(1) |
831					SOF_RT5682_NUM_HDMIDEV(3) |
832					/* SSP 0 and SSP 2 are used for HDMI IN */
833					SOF_HDMI_CAPTURE_SSP_MASK(0x5)),
834	},
835	{
836		.name = "mtl_mx98357_rt5682",
837		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
838					SOF_RT5682_SSP_CODEC(0) |
839					SOF_RT5682_SSP_AMP(1) |
840					SOF_RT5682_NUM_HDMIDEV(3) |
841					SOF_BT_OFFLOAD_SSP(2) |
842					SOF_SSP_BT_OFFLOAD_PRESENT),
843	},
844	{
845		.name = "mtl_mx98360_rt5682",
846		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
847					SOF_RT5682_SSP_CODEC(0) |
848					SOF_RT5682_SSP_AMP(1) |
849					SOF_RT5682_NUM_HDMIDEV(3)),
850	},
851	{
852		.name = "mtl_rt5682_def",
853		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
854					SOF_RT5682_SSP_CODEC(2) |
855					SOF_RT5682_SSP_AMP(0) |
856					SOF_RT5682_NUM_HDMIDEV(3) |
857					SOF_BT_OFFLOAD_SSP(1) |
858					SOF_SSP_BT_OFFLOAD_PRESENT),
859	},
860	{ }
861};
862MODULE_DEVICE_TABLE(platform, board_ids);
863
864static struct platform_driver sof_audio = {
865	.probe = sof_audio_probe,
866	.driver = {
867		.name = "sof_rt5682",
868		.pm = &snd_soc_pm_ops,
869	},
870	.id_table = board_ids,
871};
872module_platform_driver(sof_audio)
873
874/* Module information */
875MODULE_DESCRIPTION("SOF Audio Machine driver");
876MODULE_AUTHOR("Bard Liao <bard.liao@intel.com>");
877MODULE_AUTHOR("Sathya Prakash M R <sathya.prakash.m.r@intel.com>");
878MODULE_AUTHOR("Brent Lu <brent.lu@intel.com>");
879MODULE_AUTHOR("Mac Chiang <mac.chiang@intel.com>");
880MODULE_LICENSE("GPL v2");
881MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_BOARD_HELPERS);
882MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_MAXIM_COMMON);
883MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_REALTEK_COMMON);
884MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_SSP_COMMON);
885