1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright(c) 2021 Intel Corporation.
3 
4 /*
5  * Intel SOF Machine Driver with es8336 Codec
6  */
7 
8 #include <linux/device.h>
9 #include <linux/dmi.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/gpio/machine.h>
12 #include <linux/i2c.h>
13 #include <linux/input.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/slab.h>
17 #include <sound/jack.h>
18 #include <sound/pcm.h>
19 #include <sound/pcm_params.h>
20 #include <sound/soc.h>
21 #include <sound/soc-acpi.h>
22 #include "hda_dsp_common.h"
23 
24 /* jd-inv + terminating entry */
25 #define MAX_NO_PROPS 2
26 
27 #define SOF_ES8336_SSP_CODEC(quirk)		((quirk) & GENMASK(3, 0))
28 #define SOF_ES8336_SSP_CODEC_MASK		(GENMASK(3, 0))
29 
30 #define SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK	BIT(4)
31 
32 /* HDMI capture*/
33 #define SOF_SSP_HDMI_CAPTURE_PRESENT		BIT(14)
34 #define SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT		15
35 #define SOF_NO_OF_HDMI_CAPTURE_SSP_MASK		(GENMASK(16, 15))
36 #define SOF_NO_OF_HDMI_CAPTURE_SSP(quirk)	\
37 	(((quirk) << SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT) & SOF_NO_OF_HDMI_CAPTURE_SSP_MASK)
38 
39 #define SOF_HDMI_CAPTURE_1_SSP_SHIFT		7
40 #define SOF_HDMI_CAPTURE_1_SSP_MASK		(GENMASK(9, 7))
41 #define SOF_HDMI_CAPTURE_1_SSP(quirk)	\
42 	(((quirk) << SOF_HDMI_CAPTURE_1_SSP_SHIFT) & SOF_HDMI_CAPTURE_1_SSP_MASK)
43 
44 #define SOF_HDMI_CAPTURE_2_SSP_SHIFT		10
45 #define SOF_HDMI_CAPTURE_2_SSP_MASK		(GENMASK(12, 10))
46 #define SOF_HDMI_CAPTURE_2_SSP(quirk)	\
47 	(((quirk) << SOF_HDMI_CAPTURE_2_SSP_SHIFT) & SOF_HDMI_CAPTURE_2_SSP_MASK)
48 
49 #define SOF_ES8336_ENABLE_DMIC			BIT(5)
50 #define SOF_ES8336_JD_INVERTED			BIT(6)
51 #define SOF_ES8336_HEADPHONE_GPIO		BIT(7)
52 #define SOC_ES8336_HEADSET_MIC1			BIT(8)
53 
54 static unsigned long quirk;
55 
56 static int quirk_override = -1;
57 module_param_named(quirk, quirk_override, int, 0444);
58 MODULE_PARM_DESC(quirk, "Board-specific quirk override");
59 
60 struct sof_es8336_private {
61 	struct device *codec_dev;
62 	struct gpio_desc *gpio_speakers, *gpio_headphone;
63 	struct snd_soc_jack jack;
64 	struct list_head hdmi_pcm_list;
65 	bool speaker_en;
66 	struct delayed_work pcm_pop_work;
67 };
68 
69 struct sof_hdmi_pcm {
70 	struct list_head head;
71 	struct snd_soc_dai *codec_dai;
72 	int device;
73 };
74 
75 static const struct acpi_gpio_params enable_gpio0 = { 0, 0, true };
76 static const struct acpi_gpio_params enable_gpio1 = { 1, 0, true };
77 
78 static const struct acpi_gpio_mapping acpi_speakers_enable_gpio0[] = {
79 	{ "speakers-enable-gpios", &enable_gpio0, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
80 	{ }
81 };
82 
83 static const struct acpi_gpio_mapping acpi_speakers_enable_gpio1[] = {
84 	{ "speakers-enable-gpios", &enable_gpio1, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
85 };
86 
87 static const struct acpi_gpio_mapping acpi_enable_both_gpios[] = {
88 	{ "speakers-enable-gpios", &enable_gpio0, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
89 	{ "headphone-enable-gpios", &enable_gpio1, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
90 	{ }
91 };
92 
93 static const struct acpi_gpio_mapping acpi_enable_both_gpios_rev_order[] = {
94 	{ "speakers-enable-gpios", &enable_gpio1, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
95 	{ "headphone-enable-gpios", &enable_gpio0, 1, ACPI_GPIO_QUIRK_ONLY_GPIOIO },
96 	{ }
97 };
98 
99 static void log_quirks(struct device *dev)
100 {
101 	dev_info(dev, "quirk mask %#lx\n", quirk);
102 	dev_info(dev, "quirk SSP%ld\n",  SOF_ES8336_SSP_CODEC(quirk));
103 	if (quirk & SOF_ES8336_ENABLE_DMIC)
104 		dev_info(dev, "quirk DMIC enabled\n");
105 	if (quirk & SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK)
106 		dev_info(dev, "Speakers GPIO1 quirk enabled\n");
107 	if (quirk & SOF_ES8336_HEADPHONE_GPIO)
108 		dev_info(dev, "quirk headphone GPIO enabled\n");
109 	if (quirk & SOF_ES8336_JD_INVERTED)
110 		dev_info(dev, "quirk JD inverted enabled\n");
111 	if (quirk & SOC_ES8336_HEADSET_MIC1)
112 		dev_info(dev, "quirk headset at mic1 port enabled\n");
113 }
114 
115 static void pcm_pop_work_events(struct work_struct *work)
116 {
117 	struct sof_es8336_private *priv =
118 		container_of(work, struct sof_es8336_private, pcm_pop_work.work);
119 
120 	gpiod_set_value_cansleep(priv->gpio_speakers, priv->speaker_en);
121 
122 	if (quirk & SOF_ES8336_HEADPHONE_GPIO)
123 		gpiod_set_value_cansleep(priv->gpio_headphone, priv->speaker_en);
124 
125 }
126 
127 static int sof_8336_trigger(struct snd_pcm_substream *substream, int cmd)
128 {
129 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
130 	struct snd_soc_card *card = rtd->card;
131 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(card);
132 
133 	switch (cmd) {
134 	case SNDRV_PCM_TRIGGER_START:
135 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
136 	case SNDRV_PCM_TRIGGER_RESUME:
137 		break;
138 
139 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
140 	case SNDRV_PCM_TRIGGER_SUSPEND:
141 	case SNDRV_PCM_TRIGGER_STOP:
142 		if (priv->speaker_en == false)
143 			if (substream->stream == 0) {
144 				cancel_delayed_work(&priv->pcm_pop_work);
145 				gpiod_set_value_cansleep(priv->gpio_speakers, true);
146 			}
147 		break;
148 	default:
149 		return -EINVAL;
150 	}
151 
152 	return 0;
153 }
154 
155 static int sof_es8316_speaker_power_event(struct snd_soc_dapm_widget *w,
156 					  struct snd_kcontrol *kcontrol, int event)
157 {
158 	struct snd_soc_card *card = w->dapm->card;
159 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(card);
160 
161 	if (priv->speaker_en == !SND_SOC_DAPM_EVENT_ON(event))
162 		return 0;
163 
164 	priv->speaker_en = !SND_SOC_DAPM_EVENT_ON(event);
165 
166 	queue_delayed_work(system_wq, &priv->pcm_pop_work, msecs_to_jiffies(70));
167 	return 0;
168 }
169 
170 static const struct snd_soc_dapm_widget sof_es8316_widgets[] = {
171 	SND_SOC_DAPM_SPK("Speaker", NULL),
172 	SND_SOC_DAPM_HP("Headphone", NULL),
173 	SND_SOC_DAPM_MIC("Headset Mic", NULL),
174 	SND_SOC_DAPM_MIC("Internal Mic", NULL),
175 
176 	SND_SOC_DAPM_SUPPLY("Speaker Power", SND_SOC_NOPM, 0, 0,
177 			    sof_es8316_speaker_power_event,
178 			    SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
179 };
180 
181 static const struct snd_soc_dapm_widget dmic_widgets[] = {
182 	SND_SOC_DAPM_MIC("SoC DMIC", NULL),
183 };
184 
185 static const struct snd_soc_dapm_route sof_es8316_audio_map[] = {
186 	{"Headphone", NULL, "HPOL"},
187 	{"Headphone", NULL, "HPOR"},
188 
189 	/*
190 	 * There is no separate speaker output instead the speakers are muxed to
191 	 * the HP outputs. The mux is controlled Speaker and/or headphone switch.
192 	 */
193 	{"Speaker", NULL, "HPOL"},
194 	{"Speaker", NULL, "HPOR"},
195 	{"Speaker", NULL, "Speaker Power"},
196 };
197 
198 static const struct snd_soc_dapm_route sof_es8316_headset_mic2_map[] = {
199 	{"MIC1", NULL, "Internal Mic"},
200 	{"MIC2", NULL, "Headset Mic"},
201 };
202 
203 static const struct snd_soc_dapm_route sof_es8316_headset_mic1_map[] = {
204 	{"MIC2", NULL, "Internal Mic"},
205 	{"MIC1", NULL, "Headset Mic"},
206 };
207 
208 static const struct snd_soc_dapm_route dmic_map[] = {
209 	/* digital mics */
210 	{"DMic", NULL, "SoC DMIC"},
211 };
212 
213 static const struct snd_kcontrol_new sof_es8316_controls[] = {
214 	SOC_DAPM_PIN_SWITCH("Speaker"),
215 	SOC_DAPM_PIN_SWITCH("Headphone"),
216 	SOC_DAPM_PIN_SWITCH("Headset Mic"),
217 	SOC_DAPM_PIN_SWITCH("Internal Mic"),
218 };
219 
220 static struct snd_soc_jack_pin sof_es8316_jack_pins[] = {
221 	{
222 		.pin	= "Headphone",
223 		.mask	= SND_JACK_HEADPHONE,
224 	},
225 	{
226 		.pin	= "Headset Mic",
227 		.mask	= SND_JACK_MICROPHONE,
228 	},
229 };
230 
231 static int dmic_init(struct snd_soc_pcm_runtime *runtime)
232 {
233 	struct snd_soc_card *card = runtime->card;
234 	int ret;
235 
236 	ret = snd_soc_dapm_new_controls(&card->dapm, dmic_widgets,
237 					ARRAY_SIZE(dmic_widgets));
238 	if (ret) {
239 		dev_err(card->dev, "DMic widget addition failed: %d\n", ret);
240 		return ret;
241 	}
242 
243 	ret = snd_soc_dapm_add_routes(&card->dapm, dmic_map,
244 				      ARRAY_SIZE(dmic_map));
245 	if (ret)
246 		dev_err(card->dev, "DMic map addition failed: %d\n", ret);
247 
248 	return ret;
249 }
250 
251 static int sof_hdmi_init(struct snd_soc_pcm_runtime *runtime)
252 {
253 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(runtime->card);
254 	struct snd_soc_dai *dai = asoc_rtd_to_codec(runtime, 0);
255 	struct sof_hdmi_pcm *pcm;
256 
257 	pcm = devm_kzalloc(runtime->card->dev, sizeof(*pcm), GFP_KERNEL);
258 	if (!pcm)
259 		return -ENOMEM;
260 
261 	/* dai_link id is 1:1 mapped to the PCM device */
262 	pcm->device = runtime->dai_link->id;
263 	pcm->codec_dai = dai;
264 
265 	list_add_tail(&pcm->head, &priv->hdmi_pcm_list);
266 
267 	return 0;
268 }
269 
270 static int sof_es8316_init(struct snd_soc_pcm_runtime *runtime)
271 {
272 	struct snd_soc_component *codec = asoc_rtd_to_codec(runtime, 0)->component;
273 	struct snd_soc_card *card = runtime->card;
274 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(card);
275 	const struct snd_soc_dapm_route *custom_map;
276 	int num_routes;
277 	int ret;
278 
279 	card->dapm.idle_bias_off = true;
280 
281 	if (quirk & SOC_ES8336_HEADSET_MIC1) {
282 		custom_map = sof_es8316_headset_mic1_map;
283 		num_routes = ARRAY_SIZE(sof_es8316_headset_mic1_map);
284 	} else {
285 		custom_map = sof_es8316_headset_mic2_map;
286 		num_routes = ARRAY_SIZE(sof_es8316_headset_mic2_map);
287 	}
288 
289 	ret = snd_soc_dapm_add_routes(&card->dapm, custom_map, num_routes);
290 	if (ret)
291 		return ret;
292 
293 	ret = snd_soc_card_jack_new_pins(card, "Headset",
294 					 SND_JACK_HEADSET | SND_JACK_BTN_0,
295 					 &priv->jack, sof_es8316_jack_pins,
296 					 ARRAY_SIZE(sof_es8316_jack_pins));
297 	if (ret) {
298 		dev_err(card->dev, "jack creation failed %d\n", ret);
299 		return ret;
300 	}
301 
302 	snd_jack_set_key(priv->jack.jack, SND_JACK_BTN_0, KEY_PLAYPAUSE);
303 
304 	snd_soc_component_set_jack(codec, &priv->jack, NULL);
305 
306 	return 0;
307 }
308 
309 static void sof_es8316_exit(struct snd_soc_pcm_runtime *rtd)
310 {
311 	struct snd_soc_component *component = asoc_rtd_to_codec(rtd, 0)->component;
312 
313 	snd_soc_component_set_jack(component, NULL, NULL);
314 }
315 
316 static int sof_es8336_quirk_cb(const struct dmi_system_id *id)
317 {
318 	quirk = (unsigned long)id->driver_data;
319 
320 	return 1;
321 }
322 
323 /*
324  * this table should only be used to add GPIO or jack-detection quirks
325  * that cannot be detected from ACPI tables. The SSP and DMIC
326  * information are providing by the platform driver and are aligned
327  * with the topology used.
328  *
329  * If the GPIO support is missing, the quirk parameter can be used to
330  * enable speakers. In that case it's recommended to keep the SSP and DMIC
331  * information consistent, overriding the SSP and DMIC can only be done
332  * if the topology file is modified as well.
333  */
334 static const struct dmi_system_id sof_es8336_quirk_table[] = {
335 	{
336 		.callback = sof_es8336_quirk_cb,
337 		.matches = {
338 			DMI_MATCH(DMI_SYS_VENDOR, "IP3 tech"),
339 			DMI_MATCH(DMI_BOARD_NAME, "WN1"),
340 		},
341 		.driver_data = (void *)(SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK)
342 	},
343 	{
344 		.callback = sof_es8336_quirk_cb,
345 		.matches = {
346 			DMI_MATCH(DMI_SYS_VENDOR, "HUAWEI"),
347 			DMI_MATCH(DMI_BOARD_NAME, "BOHB-WAX9-PCB-B2"),
348 		},
349 		.driver_data = (void *)(SOF_ES8336_HEADPHONE_GPIO |
350 					SOC_ES8336_HEADSET_MIC1)
351 	},
352 	{}
353 };
354 
355 static int sof_es8336_hw_params(struct snd_pcm_substream *substream,
356 				struct snd_pcm_hw_params *params)
357 {
358 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
359 	struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
360 	const int sysclk = 19200000;
361 	int ret;
362 
363 	ret = snd_soc_dai_set_sysclk(codec_dai, 1, sysclk, SND_SOC_CLOCK_OUT);
364 	if (ret < 0) {
365 		dev_err(rtd->dev, "%s, Failed to set ES8336 SYSCLK: %d\n",
366 			__func__, ret);
367 		return ret;
368 	}
369 
370 	return 0;
371 }
372 
373 /* machine stream operations */
374 static struct snd_soc_ops sof_es8336_ops = {
375 	.hw_params = sof_es8336_hw_params,
376 	.trigger = sof_8336_trigger,
377 };
378 
379 static struct snd_soc_dai_link_component platform_component[] = {
380 	{
381 		/* name might be overridden during probe */
382 		.name = "0000:00:1f.3"
383 	}
384 };
385 
386 SND_SOC_DAILINK_DEF(es8336_codec,
387 	DAILINK_COMP_ARRAY(COMP_CODEC("i2c-ESSX8336:00", "ES8316 HiFi")));
388 
389 static struct snd_soc_dai_link_component dmic_component[] = {
390 	{
391 		.name = "dmic-codec",
392 		.dai_name = "dmic-hifi",
393 	}
394 };
395 
396 static struct snd_soc_dai_link_component dummy_component[] = {
397 	{
398 		.name = "snd-soc-dummy",
399 		.dai_name = "snd-soc-dummy-dai",
400 	}
401 };
402 
403 static int sof_es8336_late_probe(struct snd_soc_card *card)
404 {
405 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(card);
406 	struct sof_hdmi_pcm *pcm;
407 
408 	if (list_empty(&priv->hdmi_pcm_list))
409 		return -ENOENT;
410 
411 	pcm = list_first_entry(&priv->hdmi_pcm_list, struct sof_hdmi_pcm, head);
412 
413 	return hda_dsp_hdmi_build_controls(card, pcm->codec_dai->component);
414 }
415 
416 /* SoC card */
417 static struct snd_soc_card sof_es8336_card = {
418 	.name = "essx8336", /* sof- prefix added automatically */
419 	.owner = THIS_MODULE,
420 	.dapm_widgets = sof_es8316_widgets,
421 	.num_dapm_widgets = ARRAY_SIZE(sof_es8316_widgets),
422 	.dapm_routes = sof_es8316_audio_map,
423 	.num_dapm_routes = ARRAY_SIZE(sof_es8316_audio_map),
424 	.controls = sof_es8316_controls,
425 	.num_controls = ARRAY_SIZE(sof_es8316_controls),
426 	.fully_routed = true,
427 	.late_probe = sof_es8336_late_probe,
428 	.num_links = 1,
429 };
430 
431 static struct snd_soc_dai_link *sof_card_dai_links_create(struct device *dev,
432 							  int ssp_codec,
433 							  int dmic_be_num,
434 							  int hdmi_num)
435 {
436 	struct snd_soc_dai_link_component *cpus;
437 	struct snd_soc_dai_link *links;
438 	struct snd_soc_dai_link_component *idisp_components;
439 	int hdmi_id_offset = 0;
440 	int id = 0;
441 	int i;
442 
443 	links = devm_kcalloc(dev, sof_es8336_card.num_links,
444 			     sizeof(struct snd_soc_dai_link), GFP_KERNEL);
445 	cpus = devm_kcalloc(dev, sof_es8336_card.num_links,
446 			    sizeof(struct snd_soc_dai_link_component), GFP_KERNEL);
447 	if (!links || !cpus)
448 		goto devm_err;
449 
450 	/* codec SSP */
451 	links[id].name = devm_kasprintf(dev, GFP_KERNEL,
452 					"SSP%d-Codec", ssp_codec);
453 	if (!links[id].name)
454 		goto devm_err;
455 
456 	links[id].id = id;
457 	links[id].codecs = es8336_codec;
458 	links[id].num_codecs = ARRAY_SIZE(es8336_codec);
459 	links[id].platforms = platform_component;
460 	links[id].num_platforms = ARRAY_SIZE(platform_component);
461 	links[id].init = sof_es8316_init;
462 	links[id].exit = sof_es8316_exit;
463 	links[id].ops = &sof_es8336_ops;
464 	links[id].nonatomic = true;
465 	links[id].dpcm_playback = 1;
466 	links[id].dpcm_capture = 1;
467 	links[id].no_pcm = 1;
468 	links[id].cpus = &cpus[id];
469 	links[id].num_cpus = 1;
470 
471 	links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
472 						  "SSP%d Pin",
473 						  ssp_codec);
474 	if (!links[id].cpus->dai_name)
475 		goto devm_err;
476 
477 	id++;
478 
479 	/* dmic */
480 	if (dmic_be_num > 0) {
481 		/* at least we have dmic01 */
482 		links[id].name = "dmic01";
483 		links[id].cpus = &cpus[id];
484 		links[id].cpus->dai_name = "DMIC01 Pin";
485 		links[id].init = dmic_init;
486 		if (dmic_be_num > 1) {
487 			/* set up 2 BE links at most */
488 			links[id + 1].name = "dmic16k";
489 			links[id + 1].cpus = &cpus[id + 1];
490 			links[id + 1].cpus->dai_name = "DMIC16k Pin";
491 			dmic_be_num = 2;
492 		}
493 	} else {
494 		/* HDMI dai link starts at 3 according to current topology settings */
495 		hdmi_id_offset = 2;
496 	}
497 
498 	for (i = 0; i < dmic_be_num; i++) {
499 		links[id].id = id;
500 		links[id].num_cpus = 1;
501 		links[id].codecs = dmic_component;
502 		links[id].num_codecs = ARRAY_SIZE(dmic_component);
503 		links[id].platforms = platform_component;
504 		links[id].num_platforms = ARRAY_SIZE(platform_component);
505 		links[id].ignore_suspend = 1;
506 		links[id].dpcm_capture = 1;
507 		links[id].no_pcm = 1;
508 
509 		id++;
510 	}
511 
512 	/* HDMI */
513 	if (hdmi_num > 0) {
514 		idisp_components = devm_kcalloc(dev,
515 						hdmi_num,
516 						sizeof(struct snd_soc_dai_link_component),
517 						GFP_KERNEL);
518 		if (!idisp_components)
519 			goto devm_err;
520 	}
521 
522 	for (i = 1; i <= hdmi_num; i++) {
523 		links[id].name = devm_kasprintf(dev, GFP_KERNEL,
524 						"iDisp%d", i);
525 		if (!links[id].name)
526 			goto devm_err;
527 
528 		links[id].id = id + hdmi_id_offset;
529 		links[id].cpus = &cpus[id];
530 		links[id].num_cpus = 1;
531 		links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
532 							  "iDisp%d Pin", i);
533 		if (!links[id].cpus->dai_name)
534 			goto devm_err;
535 
536 		idisp_components[i - 1].name = "ehdaudio0D2";
537 		idisp_components[i - 1].dai_name = devm_kasprintf(dev,
538 								  GFP_KERNEL,
539 								  "intel-hdmi-hifi%d",
540 								  i);
541 		if (!idisp_components[i - 1].dai_name)
542 			goto devm_err;
543 
544 		links[id].codecs = &idisp_components[i - 1];
545 		links[id].num_codecs = 1;
546 		links[id].platforms = platform_component;
547 		links[id].num_platforms = ARRAY_SIZE(platform_component);
548 		links[id].init = sof_hdmi_init;
549 		links[id].dpcm_playback = 1;
550 		links[id].no_pcm = 1;
551 
552 		id++;
553 	}
554 
555 	/* HDMI-In SSP */
556 	if (quirk & SOF_SSP_HDMI_CAPTURE_PRESENT) {
557 		int num_of_hdmi_ssp = (quirk & SOF_NO_OF_HDMI_CAPTURE_SSP_MASK) >>
558 				SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT;
559 
560 		for (i = 1; i <= num_of_hdmi_ssp; i++) {
561 			int port = (i == 1 ? (quirk & SOF_HDMI_CAPTURE_1_SSP_MASK) >>
562 						SOF_HDMI_CAPTURE_1_SSP_SHIFT :
563 						(quirk & SOF_HDMI_CAPTURE_2_SSP_MASK) >>
564 						SOF_HDMI_CAPTURE_2_SSP_SHIFT);
565 
566 			links[id].cpus = &cpus[id];
567 			links[id].cpus->dai_name = devm_kasprintf(dev, GFP_KERNEL,
568 								  "SSP%d Pin", port);
569 			if (!links[id].cpus->dai_name)
570 				return NULL;
571 			links[id].name = devm_kasprintf(dev, GFP_KERNEL, "SSP%d-HDMI", port);
572 			if (!links[id].name)
573 				return NULL;
574 			links[id].id = id + hdmi_id_offset;
575 			links[id].codecs = dummy_component;
576 			links[id].num_codecs = ARRAY_SIZE(dummy_component);
577 			links[id].platforms = platform_component;
578 			links[id].num_platforms = ARRAY_SIZE(platform_component);
579 			links[id].dpcm_capture = 1;
580 			links[id].no_pcm = 1;
581 			links[id].num_cpus = 1;
582 			id++;
583 		}
584 	}
585 
586 	return links;
587 
588 devm_err:
589 	return NULL;
590 }
591 
592 static char soc_components[30];
593 
594  /* i2c-<HID>:00 with HID being 8 chars */
595 static char codec_name[SND_ACPI_I2C_ID_LEN];
596 
597 static int sof_es8336_probe(struct platform_device *pdev)
598 {
599 	struct device *dev = &pdev->dev;
600 	struct snd_soc_card *card;
601 	struct snd_soc_acpi_mach *mach = pdev->dev.platform_data;
602 	struct property_entry props[MAX_NO_PROPS] = {};
603 	struct sof_es8336_private *priv;
604 	struct fwnode_handle *fwnode;
605 	struct acpi_device *adev;
606 	struct snd_soc_dai_link *dai_links;
607 	struct device *codec_dev;
608 	const struct acpi_gpio_mapping *gpio_mapping;
609 	unsigned int cnt = 0;
610 	int dmic_be_num = 0;
611 	int hdmi_num = 3;
612 	int ret;
613 
614 	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
615 	if (!priv)
616 		return -ENOMEM;
617 
618 	card = &sof_es8336_card;
619 	card->dev = dev;
620 
621 	if (pdev->id_entry && pdev->id_entry->driver_data)
622 		quirk = (unsigned long)pdev->id_entry->driver_data;
623 
624 	/* check GPIO DMI quirks */
625 	dmi_check_system(sof_es8336_quirk_table);
626 
627 	/* Use NHLT configuration only for Non-HDMI capture use case.
628 	 * Because more than one SSP will be enabled for HDMI capture hence wrong codec
629 	 * SSP will be set.
630 	 */
631 	if (mach->tplg_quirk_mask & SND_SOC_ACPI_TPLG_INTEL_SSP_NUMBER) {
632 		if (!mach->mach_params.i2s_link_mask) {
633 			dev_warn(dev, "No I2S link information provided, using SSP0. This may need to be modified with the quirk module parameter\n");
634 		} else {
635 			/*
636 			 * Set configuration based on platform NHLT.
637 			 * In this machine driver, we can only support one SSP for the
638 			 * ES8336 link.
639 			 * In some cases multiple SSPs can be reported by NHLT, starting MSB-first
640 			 * seems to pick the right connection.
641 			 */
642 			unsigned long ssp;
643 
644 			/* fls returns 1-based results, SSPs indices are 0-based */
645 			ssp = fls(mach->mach_params.i2s_link_mask) - 1;
646 
647 			quirk |= ssp;
648 		}
649 	}
650 
651 	if (mach->mach_params.dmic_num)
652 		quirk |= SOF_ES8336_ENABLE_DMIC;
653 
654 	if (quirk_override != -1) {
655 		dev_info(dev, "Overriding quirk 0x%lx => 0x%x\n",
656 			 quirk, quirk_override);
657 		quirk = quirk_override;
658 	}
659 	log_quirks(dev);
660 
661 	if (quirk & SOF_ES8336_ENABLE_DMIC)
662 		dmic_be_num = 2;
663 
664 	/* compute number of dai links */
665 	sof_es8336_card.num_links = 1 + dmic_be_num + hdmi_num;
666 
667 	if (quirk & SOF_SSP_HDMI_CAPTURE_PRESENT)
668 		sof_es8336_card.num_links += (quirk & SOF_NO_OF_HDMI_CAPTURE_SSP_MASK) >>
669 				SOF_NO_OF_HDMI_CAPTURE_SSP_SHIFT;
670 
671 	dai_links = sof_card_dai_links_create(dev,
672 					      SOF_ES8336_SSP_CODEC(quirk),
673 					      dmic_be_num, hdmi_num);
674 	if (!dai_links)
675 		return -ENOMEM;
676 
677 	sof_es8336_card.dai_link = dai_links;
678 
679 	/* fixup codec name based on HID */
680 	adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
681 	if (adev) {
682 		snprintf(codec_name, sizeof(codec_name),
683 			 "i2c-%s", acpi_dev_name(adev));
684 		dai_links[0].codecs->name = codec_name;
685 
686 		/* also fixup codec dai name if relevant */
687 		if (!strncmp(mach->id, "ESSX8326", SND_ACPI_I2C_ID_LEN))
688 			dai_links[0].codecs->dai_name = "ES8326 HiFi";
689 	} else {
690 		dev_err(dev, "Error cannot find '%s' dev\n", mach->id);
691 		return -ENXIO;
692 	}
693 
694 	codec_dev = acpi_get_first_physical_node(adev);
695 	acpi_dev_put(adev);
696 	if (!codec_dev)
697 		return -EPROBE_DEFER;
698 	priv->codec_dev = get_device(codec_dev);
699 
700 	ret = snd_soc_fixup_dai_links_platform_name(&sof_es8336_card,
701 						    mach->mach_params.platform);
702 	if (ret) {
703 		put_device(codec_dev);
704 		return ret;
705 	}
706 
707 	if (quirk & SOF_ES8336_JD_INVERTED)
708 		props[cnt++] = PROPERTY_ENTRY_BOOL("everest,jack-detect-inverted");
709 
710 	if (cnt) {
711 		fwnode = fwnode_create_software_node(props, NULL);
712 		if (IS_ERR(fwnode)) {
713 			put_device(codec_dev);
714 			return PTR_ERR(fwnode);
715 		}
716 
717 		ret = device_add_software_node(codec_dev, to_software_node(fwnode));
718 
719 		fwnode_handle_put(fwnode);
720 
721 		if (ret) {
722 			put_device(codec_dev);
723 			return ret;
724 		}
725 	}
726 
727 	/* get speaker enable GPIO */
728 	if (quirk & SOF_ES8336_HEADPHONE_GPIO) {
729 		if (quirk & SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK)
730 			gpio_mapping = acpi_enable_both_gpios;
731 		else
732 			gpio_mapping = acpi_enable_both_gpios_rev_order;
733 	} else if (quirk & SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK) {
734 		gpio_mapping = acpi_speakers_enable_gpio1;
735 	} else {
736 		gpio_mapping = acpi_speakers_enable_gpio0;
737 	}
738 
739 	ret = devm_acpi_dev_add_driver_gpios(codec_dev, gpio_mapping);
740 	if (ret)
741 		dev_warn(codec_dev, "unable to add GPIO mapping table\n");
742 
743 	priv->gpio_speakers = gpiod_get_optional(codec_dev, "speakers-enable", GPIOD_OUT_LOW);
744 	if (IS_ERR(priv->gpio_speakers)) {
745 		ret = dev_err_probe(dev, PTR_ERR(priv->gpio_speakers),
746 				    "could not get speakers-enable GPIO\n");
747 		goto err_put_codec;
748 	}
749 
750 	priv->gpio_headphone = gpiod_get_optional(codec_dev, "headphone-enable", GPIOD_OUT_LOW);
751 	if (IS_ERR(priv->gpio_headphone)) {
752 		ret = dev_err_probe(dev, PTR_ERR(priv->gpio_headphone),
753 				    "could not get headphone-enable GPIO\n");
754 		goto err_put_codec;
755 	}
756 
757 	INIT_LIST_HEAD(&priv->hdmi_pcm_list);
758 	INIT_DELAYED_WORK(&priv->pcm_pop_work,
759 				pcm_pop_work_events);
760 	snd_soc_card_set_drvdata(card, priv);
761 
762 	if (mach->mach_params.dmic_num > 0) {
763 		snprintf(soc_components, sizeof(soc_components),
764 			 "cfg-dmics:%d", mach->mach_params.dmic_num);
765 		card->components = soc_components;
766 	}
767 
768 	ret = devm_snd_soc_register_card(dev, card);
769 	if (ret) {
770 		gpiod_put(priv->gpio_speakers);
771 		dev_err(dev, "snd_soc_register_card failed: %d\n", ret);
772 		goto err_put_codec;
773 	}
774 	platform_set_drvdata(pdev, &sof_es8336_card);
775 	return 0;
776 
777 err_put_codec:
778 	device_remove_software_node(priv->codec_dev);
779 	put_device(codec_dev);
780 	return ret;
781 }
782 
783 static int sof_es8336_remove(struct platform_device *pdev)
784 {
785 	struct snd_soc_card *card = platform_get_drvdata(pdev);
786 	struct sof_es8336_private *priv = snd_soc_card_get_drvdata(card);
787 
788 	cancel_delayed_work_sync(&priv->pcm_pop_work);
789 	gpiod_put(priv->gpio_speakers);
790 	device_remove_software_node(priv->codec_dev);
791 	put_device(priv->codec_dev);
792 
793 	return 0;
794 }
795 
796 static const struct platform_device_id board_ids[] = {
797 	{
798 		.name = "sof-essx8336", /* default quirk == 0 */
799 	},
800 	{
801 		.name = "adl_es83x6_c1_h02",
802 		.driver_data = (kernel_ulong_t)(SOF_ES8336_SSP_CODEC(1) |
803 					SOF_NO_OF_HDMI_CAPTURE_SSP(2) |
804 					SOF_HDMI_CAPTURE_1_SSP(0) |
805 					SOF_HDMI_CAPTURE_2_SSP(2) |
806 					SOF_SSP_HDMI_CAPTURE_PRESENT |
807 					SOF_ES8336_SPEAKERS_EN_GPIO1_QUIRK |
808 					SOF_ES8336_JD_INVERTED),
809 	},
810 	{ }
811 };
812 MODULE_DEVICE_TABLE(platform, board_ids);
813 
814 static struct platform_driver sof_es8336_driver = {
815 	.driver = {
816 		.name = "sof-essx8336",
817 		.pm = &snd_soc_pm_ops,
818 	},
819 	.probe = sof_es8336_probe,
820 	.remove = sof_es8336_remove,
821 	.id_table = board_ids,
822 };
823 module_platform_driver(sof_es8336_driver);
824 
825 MODULE_DESCRIPTION("ASoC Intel(R) SOF + ES8336 Machine driver");
826 MODULE_LICENSE("GPL");
827 MODULE_IMPORT_NS(SND_SOC_INTEL_HDA_DSP_COMMON);
828