1 // SPDX-License-Identifier: GPL-2.0-only
2 //
3 // Copyright(c) 2021-2022 Intel Corporation. All rights reserved.
4 //
5 // Authors: Cezary Rojewski <cezary.rojewski@intel.com>
6 //          Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
7 //
8 
9 #include <linux/acpi.h>
10 #include <linux/module.h>
11 #include <linux/dmi.h>
12 #include <linux/pci.h>
13 #include <linux/platform_device.h>
14 #include <sound/hda_codec.h>
15 #include <sound/hda_register.h>
16 #include <sound/intel-nhlt.h>
17 #include <sound/soc-acpi.h>
18 #include <sound/soc-component.h>
19 #include "avs.h"
20 
21 static bool i2s_test;
22 module_param(i2s_test, bool, 0444);
23 MODULE_PARM_DESC(i2s_test, "Probe I2S test-board and skip all other I2S boards");
24 
25 static const struct dmi_system_id kbl_dmi_table[] = {
26 	{
27 		.matches = {
28 			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
29 			DMI_MATCH(DMI_BOARD_NAME, "Skylake Y LPDDR3 RVP3"),
30 		},
31 	},
32 	{
33 		.matches = {
34 			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
35 			DMI_MATCH(DMI_BOARD_NAME, "AmberLake Y"),
36 		},
37 	},
38 	{}
39 };
40 
41 static const struct dmi_system_id kblr_dmi_table[] = {
42 	{
43 		.matches = {
44 			DMI_MATCH(DMI_SYS_VENDOR, "Intel Corporation"),
45 			DMI_MATCH(DMI_BOARD_NAME, "Kabylake R DDR4 RVP"),
46 		},
47 	},
48 	{}
49 };
50 
51 static struct snd_soc_acpi_mach *dmi_match_quirk(void *arg)
52 {
53 	struct snd_soc_acpi_mach *mach = arg;
54 	const struct dmi_system_id *dmi_id;
55 	struct dmi_system_id *dmi_table;
56 
57 	if (mach->quirk_data == NULL)
58 		return mach;
59 
60 	dmi_table = (struct dmi_system_id *)mach->quirk_data;
61 
62 	dmi_id = dmi_first_match(dmi_table);
63 	if (!dmi_id)
64 		return NULL;
65 
66 	return mach;
67 }
68 
69 #define AVS_SSP(x)		(BIT(x))
70 #define AVS_SSP_RANGE(a, b)	(GENMASK(b, a))
71 
72 /* supported I2S board codec configurations */
73 static struct snd_soc_acpi_mach avs_skl_i2s_machines[] = {
74 	{
75 		.id = "INT343A",
76 		.drv_name = "avs_rt286",
77 		.mach_params = {
78 			.i2s_link_mask = AVS_SSP(0),
79 		},
80 		.tplg_filename = "rt286-tplg.bin",
81 	},
82 	{
83 		.id = "10508825",
84 		.drv_name = "avs_nau8825",
85 		.mach_params = {
86 			.i2s_link_mask = AVS_SSP(1),
87 		},
88 		.tplg_filename = "nau8825-tplg.bin",
89 	},
90 	{
91 		.id = "INT343B",
92 		.drv_name = "avs_ssm4567",
93 		.mach_params = {
94 			.i2s_link_mask = AVS_SSP(0),
95 		},
96 		.tplg_filename = "ssm4567-tplg.bin",
97 	},
98 	{
99 		.id = "MX98357A",
100 		.drv_name = "avs_max98357a",
101 		.mach_params = {
102 			.i2s_link_mask = AVS_SSP(0),
103 		},
104 		.tplg_filename = "max98357a-tplg.bin",
105 	},
106 	{},
107 };
108 
109 static struct snd_soc_acpi_mach avs_kbl_i2s_machines[] = {
110 	{
111 		.id = "INT343A",
112 		.drv_name = "avs_rt286",
113 		.mach_params = {
114 			.i2s_link_mask = AVS_SSP(0),
115 		},
116 		.quirk_data = &kbl_dmi_table,
117 		.machine_quirk = dmi_match_quirk,
118 		.tplg_filename = "rt286-tplg.bin",
119 	},
120 	{
121 		.id = "INT343A",
122 		.drv_name = "avs_rt298",
123 		.mach_params = {
124 			.i2s_link_mask = AVS_SSP(0),
125 		},
126 		.quirk_data = &kblr_dmi_table,
127 		.machine_quirk = dmi_match_quirk,
128 		.tplg_filename = "rt298-tplg.bin",
129 	},
130 	{
131 		.id = "MX98927",
132 		.drv_name = "avs_max98927",
133 		.mach_params = {
134 			.i2s_link_mask = AVS_SSP(0),
135 		},
136 		.tplg_filename = "max98927-tplg.bin",
137 	},
138 	{
139 		.id = "MX98373",
140 		.drv_name = "avs_max98373",
141 		.mach_params = {
142 			.i2s_link_mask = AVS_SSP(0),
143 		},
144 		.tplg_filename = "max98373-tplg.bin",
145 	},
146 	{
147 		.id = "MX98357A",
148 		.drv_name = "avs_max98357a",
149 		.mach_params = {
150 			.i2s_link_mask = AVS_SSP(0),
151 		},
152 		.tplg_filename = "max98357a-tplg.bin",
153 	},
154 	{
155 		.id = "DLGS7219",
156 		.drv_name = "avs_da7219",
157 		.mach_params = {
158 			.i2s_link_mask = AVS_SSP(1),
159 		},
160 		.tplg_filename = "da7219-tplg.bin",
161 	},
162 	{},
163 };
164 
165 static struct snd_soc_acpi_mach avs_apl_i2s_machines[] = {
166 	{
167 		.id = "INT343A",
168 		.drv_name = "avs_rt298",
169 		.mach_params = {
170 			.i2s_link_mask = AVS_SSP(5),
171 		},
172 		.tplg_filename = "rt298-tplg.bin",
173 	},
174 	{
175 		.id = "INT34C3",
176 		.drv_name = "avs_tdf8532",
177 		.mach_params = {
178 			.i2s_link_mask = AVS_SSP_RANGE(0, 5),
179 		},
180 		.pdata = (unsigned long[]){ 0, 0, 0x14, 0, 0, 0 }, /* SSP2 TDMs */
181 		.tplg_filename = "tdf8532-tplg.bin",
182 	},
183 	{
184 		.id = "MX98357A",
185 		.drv_name = "avs_max98357a",
186 		.mach_params = {
187 			.i2s_link_mask = AVS_SSP(5),
188 		},
189 		.tplg_filename = "max98357a-tplg.bin",
190 	},
191 	{
192 		.id = "DLGS7219",
193 		.drv_name = "avs_da7219",
194 		.mach_params = {
195 			.i2s_link_mask = AVS_SSP(1),
196 		},
197 		.tplg_filename = "da7219-tplg.bin",
198 	},
199 	{},
200 };
201 
202 static struct snd_soc_acpi_mach avs_gml_i2s_machines[] = {
203 	{
204 		.id = "INT343A",
205 		.drv_name = "avs_rt298",
206 		.mach_params = {
207 			.i2s_link_mask = AVS_SSP(2),
208 		},
209 		.tplg_filename = "rt298-tplg.bin",
210 	},
211 	{},
212 };
213 
214 static struct snd_soc_acpi_mach avs_test_i2s_machines[] = {
215 	{
216 		.drv_name = "avs_i2s_test",
217 		.mach_params = {
218 			.i2s_link_mask = AVS_SSP(0),
219 		},
220 		.tplg_filename = "i2s-test-tplg.bin",
221 	},
222 	{
223 		.drv_name = "avs_i2s_test",
224 		.mach_params = {
225 			.i2s_link_mask = AVS_SSP(1),
226 		},
227 		.tplg_filename = "i2s-test-tplg.bin",
228 	},
229 	{
230 		.drv_name = "avs_i2s_test",
231 		.mach_params = {
232 			.i2s_link_mask = AVS_SSP(2),
233 		},
234 		.tplg_filename = "i2s-test-tplg.bin",
235 	},
236 	{
237 		.drv_name = "avs_i2s_test",
238 		.mach_params = {
239 			.i2s_link_mask = AVS_SSP(3),
240 		},
241 		.tplg_filename = "i2s-test-tplg.bin",
242 	},
243 	{
244 		.drv_name = "avs_i2s_test",
245 		.mach_params = {
246 			.i2s_link_mask = AVS_SSP(4),
247 		},
248 		.tplg_filename = "i2s-test-tplg.bin",
249 	},
250 	{
251 		.drv_name = "avs_i2s_test",
252 		.mach_params = {
253 			.i2s_link_mask = AVS_SSP(5),
254 		},
255 		.tplg_filename = "i2s-test-tplg.bin",
256 	},
257 	/* no NULL terminator, as we depend on ARRAY SIZE due to .id == NULL */
258 };
259 
260 struct avs_acpi_boards {
261 	int id;
262 	struct snd_soc_acpi_mach *machs;
263 };
264 
265 #define AVS_MACH_ENTRY(_id, _mach) \
266 	{ .id = (_id), .machs = (_mach), }
267 
268 /* supported I2S boards per platform */
269 static const struct avs_acpi_boards i2s_boards[] = {
270 	AVS_MACH_ENTRY(0x9d70, avs_skl_i2s_machines), /* SKL */
271 	AVS_MACH_ENTRY(0x9d71, avs_kbl_i2s_machines), /* KBL */
272 	AVS_MACH_ENTRY(0x5a98, avs_apl_i2s_machines), /* APL */
273 	AVS_MACH_ENTRY(0x3198, avs_gml_i2s_machines), /* GML */
274 	{},
275 };
276 
277 static const struct avs_acpi_boards *avs_get_i2s_boards(struct avs_dev *adev)
278 {
279 	int id, i;
280 
281 	id = adev->base.pci->device;
282 	for (i = 0; i < ARRAY_SIZE(i2s_boards); i++)
283 		if (i2s_boards[i].id == id)
284 			return &i2s_boards[i];
285 	return NULL;
286 }
287 
288 /* platform devices owned by AVS audio are removed with this hook */
289 static void board_pdev_unregister(void *data)
290 {
291 	platform_device_unregister(data);
292 }
293 
294 static int avs_register_dmic_board(struct avs_dev *adev)
295 {
296 	struct platform_device *codec, *board;
297 	struct snd_soc_acpi_mach mach = {{0}};
298 	int ret;
299 
300 	if (!adev->nhlt ||
301 	    !intel_nhlt_has_endpoint_type(adev->nhlt, NHLT_LINK_DMIC)) {
302 		dev_dbg(adev->dev, "no DMIC endpoints present\n");
303 		return 0;
304 	}
305 
306 	codec = platform_device_register_simple("dmic-codec", PLATFORM_DEVID_NONE, NULL, 0);
307 	if (IS_ERR(codec)) {
308 		dev_err(adev->dev, "dmic codec register failed\n");
309 		return PTR_ERR(codec);
310 	}
311 
312 	ret = devm_add_action(adev->dev, board_pdev_unregister, codec);
313 	if (ret < 0) {
314 		platform_device_unregister(codec);
315 		return ret;
316 	}
317 
318 	ret = avs_dmic_platform_register(adev, "dmic-platform");
319 	if (ret < 0)
320 		return ret;
321 
322 	mach.tplg_filename = "dmic-tplg.bin";
323 	mach.mach_params.platform = "dmic-platform";
324 
325 	board = platform_device_register_data(NULL, "avs_dmic", PLATFORM_DEVID_NONE,
326 					(const void *)&mach, sizeof(mach));
327 	if (IS_ERR(board)) {
328 		dev_err(adev->dev, "dmic board register failed\n");
329 		return PTR_ERR(board);
330 	}
331 
332 	ret = devm_add_action(adev->dev, board_pdev_unregister, board);
333 	if (ret < 0) {
334 		platform_device_unregister(board);
335 		return ret;
336 	}
337 
338 	return 0;
339 }
340 
341 static int avs_register_i2s_board(struct avs_dev *adev, struct snd_soc_acpi_mach *mach)
342 {
343 	struct platform_device *board;
344 	int num_ssps;
345 	char *name;
346 	int ret;
347 
348 	num_ssps = adev->hw_cfg.i2s_caps.ctrl_count;
349 	if (fls(mach->mach_params.i2s_link_mask) > num_ssps) {
350 		dev_err(adev->dev, "Platform supports %d SSPs but board %s requires SSP%ld\n",
351 			num_ssps, mach->drv_name,
352 			(unsigned long)__fls(mach->mach_params.i2s_link_mask));
353 		return -ENODEV;
354 	}
355 
356 	name = devm_kasprintf(adev->dev, GFP_KERNEL, "%s.%d-platform", mach->drv_name,
357 			      mach->mach_params.i2s_link_mask);
358 	if (!name)
359 		return -ENOMEM;
360 
361 	ret = avs_i2s_platform_register(adev, name, mach->mach_params.i2s_link_mask, mach->pdata);
362 	if (ret < 0)
363 		return ret;
364 
365 	mach->mach_params.platform = name;
366 
367 	board = platform_device_register_data(NULL, mach->drv_name, mach->mach_params.i2s_link_mask,
368 					      (const void *)mach, sizeof(*mach));
369 	if (IS_ERR(board)) {
370 		dev_err(adev->dev, "ssp board register failed\n");
371 		return PTR_ERR(board);
372 	}
373 
374 	ret = devm_add_action(adev->dev, board_pdev_unregister, board);
375 	if (ret < 0) {
376 		platform_device_unregister(board);
377 		return ret;
378 	}
379 
380 	return 0;
381 }
382 
383 static int avs_register_i2s_boards(struct avs_dev *adev)
384 {
385 	const struct avs_acpi_boards *boards;
386 	struct snd_soc_acpi_mach *mach;
387 	int ret;
388 
389 	if (!adev->nhlt || !intel_nhlt_has_endpoint_type(adev->nhlt, NHLT_LINK_SSP)) {
390 		dev_dbg(adev->dev, "no I2S endpoints present\n");
391 		return 0;
392 	}
393 
394 	if (i2s_test) {
395 		int i, num_ssps;
396 
397 		num_ssps = adev->hw_cfg.i2s_caps.ctrl_count;
398 		/* constrain just in case FW says there can be more SSPs than possible */
399 		num_ssps = min_t(int, ARRAY_SIZE(avs_test_i2s_machines), num_ssps);
400 
401 		mach = avs_test_i2s_machines;
402 
403 		for (i = 0; i < num_ssps; i++) {
404 			ret = avs_register_i2s_board(adev, &mach[i]);
405 			if (ret < 0)
406 				dev_warn(adev->dev, "register i2s %s failed: %d\n", mach->drv_name,
407 					 ret);
408 		}
409 		return 0;
410 	}
411 
412 	boards = avs_get_i2s_boards(adev);
413 	if (!boards) {
414 		dev_dbg(adev->dev, "no I2S endpoints supported\n");
415 		return 0;
416 	}
417 
418 	for (mach = boards->machs; mach->id[0]; mach++) {
419 		if (!acpi_dev_present(mach->id, NULL, -1))
420 			continue;
421 
422 		if (mach->machine_quirk)
423 			if (!mach->machine_quirk(mach))
424 				continue;
425 
426 		ret = avs_register_i2s_board(adev, mach);
427 		if (ret < 0)
428 			dev_warn(adev->dev, "register i2s %s failed: %d\n", mach->drv_name, ret);
429 	}
430 
431 	return 0;
432 }
433 
434 static int avs_register_hda_board(struct avs_dev *adev, struct hda_codec *codec)
435 {
436 	struct snd_soc_acpi_mach mach = {{0}};
437 	struct platform_device *board;
438 	struct hdac_device *hdev = &codec->core;
439 	char *pname;
440 	int ret, id;
441 
442 	pname = devm_kasprintf(adev->dev, GFP_KERNEL, "%s-platform", dev_name(&hdev->dev));
443 	if (!pname)
444 		return -ENOMEM;
445 
446 	ret = avs_hda_platform_register(adev, pname);
447 	if (ret < 0)
448 		return ret;
449 
450 	mach.pdata = codec;
451 	mach.mach_params.platform = pname;
452 	mach.tplg_filename = devm_kasprintf(adev->dev, GFP_KERNEL, "hda-%08x-tplg.bin",
453 					    hdev->vendor_id);
454 	if (!mach.tplg_filename)
455 		return -ENOMEM;
456 
457 	id = adev->base.core.idx * HDA_MAX_CODECS + hdev->addr;
458 	board = platform_device_register_data(NULL, "avs_hdaudio", id, (const void *)&mach,
459 					      sizeof(mach));
460 	if (IS_ERR(board)) {
461 		dev_err(adev->dev, "hda board register failed\n");
462 		return PTR_ERR(board);
463 	}
464 
465 	ret = devm_add_action(adev->dev, board_pdev_unregister, board);
466 	if (ret < 0) {
467 		platform_device_unregister(board);
468 		return ret;
469 	}
470 
471 	return 0;
472 }
473 
474 static int avs_register_hda_boards(struct avs_dev *adev)
475 {
476 	struct hdac_bus *bus = &adev->base.core;
477 	struct hdac_device *hdev;
478 	int ret;
479 
480 	if (!bus->num_codecs) {
481 		dev_dbg(adev->dev, "no HDA endpoints present\n");
482 		return 0;
483 	}
484 
485 	list_for_each_entry(hdev, &bus->codec_list, list) {
486 		struct hda_codec *codec;
487 
488 		codec = dev_to_hda_codec(&hdev->dev);
489 
490 		ret = avs_register_hda_board(adev, codec);
491 		if (ret < 0)
492 			dev_warn(adev->dev, "register hda-%08x failed: %d\n",
493 				 codec->core.vendor_id, ret);
494 	}
495 
496 	return 0;
497 }
498 
499 int avs_register_all_boards(struct avs_dev *adev)
500 {
501 	int ret;
502 
503 	ret = avs_register_dmic_board(adev);
504 	if (ret < 0)
505 		dev_warn(adev->dev, "enumerate DMIC endpoints failed: %d\n",
506 			 ret);
507 
508 	ret = avs_register_i2s_boards(adev);
509 	if (ret < 0)
510 		dev_warn(adev->dev, "enumerate I2S endpoints failed: %d\n",
511 			 ret);
512 
513 	ret = avs_register_hda_boards(adev);
514 	if (ret < 0)
515 		dev_warn(adev->dev, "enumerate HDA endpoints failed: %d\n",
516 			 ret);
517 
518 	return 0;
519 }
520 
521 void avs_unregister_all_boards(struct avs_dev *adev)
522 {
523 	snd_soc_unregister_component(adev->dev);
524 }
525