Linux Audio

Check our new training course

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