1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
2 //
3 // This file is provided under a dual BSD/GPLv2 license.  When using or
4 // redistributing this file, you may do so under either license.
5 //
6 // Copyright(c) 2022 Intel Corporation
7 
8 #include <linux/firmware.h>
9 #include <sound/sof/ext_manifest4.h>
10 #include <sound/sof/ipc4/header.h>
11 #include <trace/events/sof.h>
12 #include "ipc4-priv.h"
13 #include "sof-audio.h"
14 #include "sof-priv.h"
15 #include "ops.h"
16 
17 /* The module ID includes the id of the library it is part of at offset 12 */
18 #define SOF_IPC4_MOD_LIB_ID_SHIFT	12
19 
sof_ipc4_fw_parse_ext_man(struct snd_sof_dev * sdev,struct sof_ipc4_fw_library * fw_lib)20 static ssize_t sof_ipc4_fw_parse_ext_man(struct snd_sof_dev *sdev,
21 					 struct sof_ipc4_fw_library *fw_lib)
22 {
23 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
24 	const struct firmware *fw = fw_lib->sof_fw.fw;
25 	struct sof_man4_fw_binary_header *fw_header;
26 	struct sof_ext_manifest4_hdr *ext_man_hdr;
27 	struct sof_man4_module_config *fm_config;
28 	struct sof_ipc4_fw_module *fw_module;
29 	struct sof_man4_module *fm_entry;
30 	ssize_t remaining;
31 	u32 fw_hdr_offset;
32 	int i;
33 
34 	if (!ipc4_data) {
35 		dev_err(sdev->dev, "%s: ipc4_data is not available\n", __func__);
36 		return -EINVAL;
37 	}
38 
39 	remaining = fw->size;
40 	if (remaining <= sizeof(*ext_man_hdr)) {
41 		dev_err(sdev->dev, "Firmware size is too small: %zu\n", remaining);
42 		return -EINVAL;
43 	}
44 
45 	ext_man_hdr = (struct sof_ext_manifest4_hdr *)fw->data;
46 
47 	/*
48 	 * At the start of the firmware image we must have an extended manifest.
49 	 * Verify that the magic number is correct.
50 	 */
51 	if (ext_man_hdr->id != SOF_EXT_MAN4_MAGIC_NUMBER) {
52 		dev_err(sdev->dev,
53 			"Unexpected extended manifest magic number: %#x\n",
54 			ext_man_hdr->id);
55 		return -EINVAL;
56 	}
57 
58 	fw_hdr_offset = ipc4_data->manifest_fw_hdr_offset;
59 	if (!fw_hdr_offset)
60 		return -EINVAL;
61 
62 	if (remaining <= ext_man_hdr->len + fw_hdr_offset + sizeof(*fw_header)) {
63 		dev_err(sdev->dev, "Invalid firmware size %zu, should be at least %zu\n",
64 			remaining, ext_man_hdr->len + fw_hdr_offset + sizeof(*fw_header));
65 		return -EINVAL;
66 	}
67 
68 	fw_header = (struct sof_man4_fw_binary_header *)
69 				(fw->data + ext_man_hdr->len + fw_hdr_offset);
70 	remaining -= (ext_man_hdr->len + fw_hdr_offset);
71 
72 	if (remaining <= fw_header->len) {
73 		dev_err(sdev->dev, "Invalid fw_header->len %u\n", fw_header->len);
74 		return -EINVAL;
75 	}
76 
77 	dev_info(sdev->dev, "Loaded firmware library: %s, version: %u.%u.%u.%u\n",
78 		 fw_header->name, fw_header->major_version, fw_header->minor_version,
79 		 fw_header->hotfix_version, fw_header->build_version);
80 	dev_dbg(sdev->dev, "Header length: %u, module count: %u\n",
81 		fw_header->len, fw_header->num_module_entries);
82 
83 	/* copy the fw_version of basefw into debugfs at first boot */
84 	if (fw == sdev->basefw.fw) {
85 		sdev->fw_version.major = fw_header->major_version;
86 		sdev->fw_version.minor = fw_header->minor_version;
87 		sdev->fw_version.micro = fw_header->hotfix_version;
88 		sdev->fw_version.build = fw_header->build_version;
89 	}
90 
91 	fw_lib->modules = devm_kmalloc_array(sdev->dev, fw_header->num_module_entries,
92 					     sizeof(*fw_module), GFP_KERNEL);
93 	if (!fw_lib->modules)
94 		return -ENOMEM;
95 
96 	fw_lib->name = fw_header->name;
97 	fw_lib->num_modules = fw_header->num_module_entries;
98 	fw_module = fw_lib->modules;
99 
100 	fm_entry = (struct sof_man4_module *)((u8 *)fw_header + fw_header->len);
101 	remaining -= fw_header->len;
102 
103 	if (remaining < fw_header->num_module_entries * sizeof(*fm_entry)) {
104 		dev_err(sdev->dev, "Invalid num_module_entries %u\n",
105 			fw_header->num_module_entries);
106 		return -EINVAL;
107 	}
108 
109 	fm_config = (struct sof_man4_module_config *)
110 				(fm_entry + fw_header->num_module_entries);
111 	remaining -= (fw_header->num_module_entries * sizeof(*fm_entry));
112 	for (i = 0; i < fw_header->num_module_entries; i++) {
113 		memcpy(&fw_module->man4_module_entry, fm_entry, sizeof(*fm_entry));
114 
115 		if (fm_entry->cfg_count) {
116 			if (remaining < (fm_entry->cfg_offset + fm_entry->cfg_count) *
117 			    sizeof(*fm_config)) {
118 				dev_err(sdev->dev, "Invalid module cfg_offset %u\n",
119 					fm_entry->cfg_offset);
120 				return -EINVAL;
121 			}
122 
123 			fw_module->fw_mod_cfg = &fm_config[fm_entry->cfg_offset];
124 
125 			dev_dbg(sdev->dev,
126 				"module %s: UUID %pUL cfg_count: %u, bss_size: %#x\n",
127 				fm_entry->name, &fm_entry->uuid, fm_entry->cfg_count,
128 				fm_config[fm_entry->cfg_offset].is_bytes);
129 		} else {
130 			dev_dbg(sdev->dev, "module %s: UUID %pUL\n", fm_entry->name,
131 				&fm_entry->uuid);
132 		}
133 
134 		fw_module->man4_module_entry.id = i;
135 		ida_init(&fw_module->m_ida);
136 		fw_module->private = NULL;
137 
138 		fw_module++;
139 		fm_entry++;
140 	}
141 
142 	return ext_man_hdr->len;
143 }
144 
sof_ipc4_fw_parse_basefw_ext_man(struct snd_sof_dev * sdev)145 static size_t sof_ipc4_fw_parse_basefw_ext_man(struct snd_sof_dev *sdev)
146 {
147 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
148 	struct sof_ipc4_fw_library *fw_lib;
149 	ssize_t payload_offset;
150 	int ret;
151 
152 	fw_lib = devm_kzalloc(sdev->dev, sizeof(*fw_lib), GFP_KERNEL);
153 	if (!fw_lib)
154 		return -ENOMEM;
155 
156 	fw_lib->sof_fw.fw = sdev->basefw.fw;
157 
158 	payload_offset = sof_ipc4_fw_parse_ext_man(sdev, fw_lib);
159 	if (payload_offset > 0) {
160 		fw_lib->sof_fw.payload_offset = payload_offset;
161 
162 		/* basefw ID is 0 */
163 		fw_lib->id = 0;
164 		ret = xa_insert(&ipc4_data->fw_lib_xa, 0, fw_lib, GFP_KERNEL);
165 		if (ret)
166 			return ret;
167 	}
168 
169 	return payload_offset;
170 }
171 
sof_ipc4_load_library(struct snd_sof_dev * sdev,unsigned long lib_id,const char * lib_filename,bool optional)172 static int sof_ipc4_load_library(struct snd_sof_dev *sdev, unsigned long lib_id,
173 				 const char *lib_filename, bool optional)
174 {
175 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
176 	struct sof_ipc4_fw_library *fw_lib;
177 	ssize_t payload_offset;
178 	int ret, i, err;
179 
180 	if (!ipc4_data->load_library) {
181 		dev_err(sdev->dev, "Library loading is not supported on this platform\n");
182 		return -EOPNOTSUPP;
183 	}
184 
185 	fw_lib = devm_kzalloc(sdev->dev, sizeof(*fw_lib), GFP_KERNEL);
186 	if (!fw_lib)
187 		return -ENOMEM;
188 
189 	if (optional) {
190 		ret = firmware_request_nowarn(&fw_lib->sof_fw.fw, lib_filename,
191 					      sdev->dev);
192 		if (ret < 0) {
193 			/* optional library, override the error */
194 			ret = 0;
195 			goto free_fw_lib;
196 		}
197 	} else {
198 		ret = request_firmware(&fw_lib->sof_fw.fw, lib_filename,
199 				       sdev->dev);
200 		if (ret < 0) {
201 			dev_err(sdev->dev, "Library file '%s' is missing\n",
202 				lib_filename);
203 			goto free_fw_lib;
204 		}
205 	}
206 
207 	dev_dbg(sdev->dev, "Library file '%s' loaded\n", lib_filename);
208 
209 	payload_offset = sof_ipc4_fw_parse_ext_man(sdev, fw_lib);
210 	if (payload_offset <= 0) {
211 		if (!payload_offset)
212 			ret = -EINVAL;
213 		else
214 			ret = payload_offset;
215 
216 		goto release;
217 	}
218 
219 	fw_lib->sof_fw.payload_offset = payload_offset;
220 	fw_lib->id = lib_id;
221 
222 	/* Fix up the module ID numbers within the library */
223 	for (i = 0; i < fw_lib->num_modules; i++)
224 		fw_lib->modules[i].man4_module_entry.id |= (lib_id << SOF_IPC4_MOD_LIB_ID_SHIFT);
225 
226 	/*
227 	 * Make sure that the DSP is booted and stays up while attempting the
228 	 * loading the library for the first time
229 	 */
230 	ret = pm_runtime_resume_and_get(sdev->dev);
231 	if (ret < 0 && ret != -EACCES) {
232 		dev_err_ratelimited(sdev->dev, "%s: pm_runtime resume failed: %d\n",
233 				    __func__, ret);
234 		goto release;
235 	}
236 
237 	ret = ipc4_data->load_library(sdev, fw_lib, false);
238 
239 	pm_runtime_mark_last_busy(sdev->dev);
240 	err = pm_runtime_put_autosuspend(sdev->dev);
241 	if (err < 0)
242 		dev_err_ratelimited(sdev->dev, "%s: pm_runtime idle failed: %d\n",
243 				    __func__, err);
244 
245 	if (ret)
246 		goto release;
247 
248 	ret = xa_insert(&ipc4_data->fw_lib_xa, lib_id, fw_lib, GFP_KERNEL);
249 	if (unlikely(ret))
250 		goto release;
251 
252 	return 0;
253 
254 release:
255 	release_firmware(fw_lib->sof_fw.fw);
256 	/* Allocated within sof_ipc4_fw_parse_ext_man() */
257 	devm_kfree(sdev->dev, fw_lib->modules);
258 free_fw_lib:
259 	devm_kfree(sdev->dev, fw_lib);
260 
261 	return ret;
262 }
263 
264 /**
265  * sof_ipc4_complete_split_release - loads the library parts of a split firmware
266  * @sdev: SOF device
267  *
268  * With IPC4 the firmware can be a single binary or a split release.
269  * - single binary: only the basefw
270  * - split release: basefw and two libraries (openmodules, debug)
271  *
272  * With split firmware release it is also allowed that for example only the
273  * debug library is present (the openmodules content is built in the basefw).
274  *
275  * To handle the permutations try to load the openmodules then the debug
276  * libraries as optional ones after the basefw boot.
277  *
278  * The libraries for the split release are stored alongside the basefw on the
279  * filesystem.
280  */
sof_ipc4_complete_split_release(struct snd_sof_dev * sdev)281 int sof_ipc4_complete_split_release(struct snd_sof_dev *sdev)
282 {
283 	static const char * const lib_bundle[] = { "openmodules", "debug" };
284 	const char *fw_filename = sdev->pdata->fw_filename;
285 	const char *lib_filename, *p;
286 	size_t lib_name_base_size;
287 	unsigned long lib_id = 1;
288 	char *lib_name_base;
289 	int i;
290 
291 	p = strstr(fw_filename, ".ri");
292 	if (!p || strlen(p) != 3) {
293 		dev_info(sdev->dev,
294 			 "%s: Firmware name '%s' is missing .ri extension\n",
295 			 __func__, fw_filename);
296 		return 0;
297 	}
298 
299 	/* Space for the firmware basename + '\0', without the extension */
300 	lib_name_base_size = strlen(fw_filename) - 2;
301 	lib_name_base = kzalloc(lib_name_base_size, GFP_KERNEL);
302 	if (!lib_name_base)
303 		return -ENOMEM;
304 
305 	/*
306 	 * strscpy will 0 terminate the copied string, removing the '.ri' from
307 	 * the end of the fw_filename, for example:
308 	 * fw_filename:		"sof-ptl.ri\0"
309 	 * lib_name_base:	"sof-ptl\0"
310 	 */
311 	strscpy(lib_name_base, fw_filename, lib_name_base_size);
312 
313 	for (i = 0; i < ARRAY_SIZE(lib_bundle); i++) {
314 		int ret;
315 
316 		lib_filename = kasprintf(GFP_KERNEL, "%s/%s-%s.ri",
317 					 sdev->pdata->fw_filename_prefix,
318 					 lib_name_base, lib_bundle[i]);
319 		if (!lib_filename) {
320 			kfree(lib_name_base);
321 			return -ENOMEM;
322 		}
323 
324 		ret = sof_ipc4_load_library(sdev, lib_id, lib_filename, true);
325 		if (ret)
326 			dev_warn(sdev->dev, "%s: Failed to load %s: %d\n",
327 				 __func__, lib_filename, ret);
328 		else
329 			lib_id++;
330 
331 		kfree(lib_filename);
332 	}
333 
334 	kfree(lib_name_base);
335 
336 	return 0;
337 }
338 
sof_ipc4_load_library_by_uuid(struct snd_sof_dev * sdev,unsigned long lib_id,const guid_t * uuid)339 static int sof_ipc4_load_library_by_uuid(struct snd_sof_dev *sdev,
340 					 unsigned long lib_id, const guid_t *uuid)
341 {
342 	const char *lib_filename;
343 	int ret;
344 
345 	if (!sdev->pdata->fw_lib_prefix) {
346 		dev_err(sdev->dev,
347 			"Library loading is not supported due to not set library path\n");
348 		return -EINVAL;
349 	}
350 
351 	lib_filename = kasprintf(GFP_KERNEL, "%s/%pUL.bin",
352 				 sdev->pdata->fw_lib_prefix, uuid);
353 	if (!lib_filename)
354 		return -ENOMEM;
355 
356 	ret = sof_ipc4_load_library(sdev, lib_id, lib_filename, false);
357 
358 	kfree(lib_filename);
359 
360 	return ret;
361 }
362 
sof_ipc4_find_module_by_uuid(struct snd_sof_dev * sdev,const guid_t * uuid)363 struct sof_ipc4_fw_module *sof_ipc4_find_module_by_uuid(struct snd_sof_dev *sdev,
364 							const guid_t *uuid)
365 {
366 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
367 	struct sof_ipc4_fw_library *fw_lib;
368 	unsigned long lib_id;
369 	int i, ret;
370 
371 	if (guid_is_null(uuid))
372 		return NULL;
373 
374 	xa_for_each(&ipc4_data->fw_lib_xa, lib_id, fw_lib) {
375 		for (i = 0; i < fw_lib->num_modules; i++) {
376 			if (guid_equal(uuid, &fw_lib->modules[i].man4_module_entry.uuid))
377 				return &fw_lib->modules[i];
378 		}
379 	}
380 
381 	/*
382 	 * Do not attempt to load external library in case the maximum number of
383 	 * firmware libraries have been already loaded
384 	 */
385 	if ((lib_id + 1) == ipc4_data->max_libs_count) {
386 		dev_err(sdev->dev,
387 			"%s: Maximum allowed number of libraries reached (%u)\n",
388 			__func__, ipc4_data->max_libs_count);
389 		return NULL;
390 	}
391 
392 	/* The module cannot be found, try to load it as a library */
393 	ret = sof_ipc4_load_library_by_uuid(sdev, lib_id + 1, uuid);
394 	if (ret)
395 		return NULL;
396 
397 	/* Look for the module in the newly loaded library, it should be available now */
398 	xa_for_each_start(&ipc4_data->fw_lib_xa, lib_id, fw_lib, lib_id) {
399 		for (i = 0; i < fw_lib->num_modules; i++) {
400 			if (guid_equal(uuid, &fw_lib->modules[i].man4_module_entry.uuid))
401 				return &fw_lib->modules[i];
402 		}
403 	}
404 
405 	return NULL;
406 }
407 
sof_ipc4_validate_firmware(struct snd_sof_dev * sdev)408 static int sof_ipc4_validate_firmware(struct snd_sof_dev *sdev)
409 {
410 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
411 	u32 fw_hdr_offset = ipc4_data->manifest_fw_hdr_offset;
412 	struct sof_man4_fw_binary_header *fw_header;
413 	const struct firmware *fw = sdev->basefw.fw;
414 	struct sof_ext_manifest4_hdr *ext_man_hdr;
415 
416 	ext_man_hdr = (struct sof_ext_manifest4_hdr *)fw->data;
417 	fw_header = (struct sof_man4_fw_binary_header *)
418 				(fw->data + ext_man_hdr->len + fw_hdr_offset);
419 
420 	/* TODO: Add firmware verification code here */
421 
422 	dev_dbg(sdev->dev, "Validated firmware version: %u.%u.%u.%u\n",
423 		fw_header->major_version, fw_header->minor_version,
424 		fw_header->hotfix_version, fw_header->build_version);
425 
426 	return 0;
427 }
428 
sof_ipc4_query_fw_configuration(struct snd_sof_dev * sdev)429 int sof_ipc4_query_fw_configuration(struct snd_sof_dev *sdev)
430 {
431 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
432 	const struct sof_ipc_ops *iops = sdev->ipc->ops;
433 	struct sof_ipc4_fw_version *fw_ver;
434 	struct sof_ipc4_tuple *tuple;
435 	struct sof_ipc4_msg msg;
436 	size_t offset = 0;
437 	int ret;
438 
439 	/* Get the firmware configuration */
440 	msg.primary = SOF_IPC4_MSG_TARGET(SOF_IPC4_MODULE_MSG);
441 	msg.primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
442 	msg.primary |= SOF_IPC4_MOD_ID(SOF_IPC4_MOD_INIT_BASEFW_MOD_ID);
443 	msg.primary |= SOF_IPC4_MOD_INSTANCE(SOF_IPC4_MOD_INIT_BASEFW_INSTANCE_ID);
444 	msg.extension = SOF_IPC4_MOD_EXT_MSG_PARAM_ID(SOF_IPC4_FW_PARAM_FW_CONFIG);
445 
446 	msg.data_size = sdev->ipc->max_payload_size;
447 	msg.data_ptr = kzalloc(msg.data_size, GFP_KERNEL);
448 	if (!msg.data_ptr)
449 		return -ENOMEM;
450 
451 	ret = iops->set_get_data(sdev, &msg, msg.data_size, false);
452 	if (ret)
453 		goto out;
454 
455 	while (offset < msg.data_size) {
456 		tuple = (struct sof_ipc4_tuple *)((u8 *)msg.data_ptr + offset);
457 
458 		switch (tuple->type) {
459 		case SOF_IPC4_FW_CFG_FW_VERSION:
460 			fw_ver = (struct sof_ipc4_fw_version *)tuple->value;
461 
462 			dev_info(sdev->dev,
463 				 "Booted firmware version: %u.%u.%u.%u\n",
464 				 fw_ver->major, fw_ver->minor, fw_ver->hotfix,
465 				 fw_ver->build);
466 			break;
467 		case SOF_IPC4_FW_CFG_DL_MAILBOX_BYTES:
468 			trace_sof_ipc4_fw_config(sdev, "DL mailbox size", *tuple->value);
469 			break;
470 		case SOF_IPC4_FW_CFG_UL_MAILBOX_BYTES:
471 			trace_sof_ipc4_fw_config(sdev, "UL mailbox size", *tuple->value);
472 			break;
473 		case SOF_IPC4_FW_CFG_TRACE_LOG_BYTES:
474 			trace_sof_ipc4_fw_config(sdev, "Trace log size", *tuple->value);
475 			ipc4_data->mtrace_log_bytes = *tuple->value;
476 			break;
477 		case SOF_IPC4_FW_CFG_MAX_LIBS_COUNT:
478 			trace_sof_ipc4_fw_config(sdev, "maximum number of libraries",
479 						 *tuple->value);
480 			ipc4_data->max_libs_count = *tuple->value;
481 			if (!ipc4_data->max_libs_count)
482 				ipc4_data->max_libs_count = 1;
483 			break;
484 		case SOF_IPC4_FW_CFG_MAX_PPL_COUNT:
485 			ipc4_data->max_num_pipelines = *tuple->value;
486 			trace_sof_ipc4_fw_config(sdev, "Max PPL count %d",
487 						 ipc4_data->max_num_pipelines);
488 			if (ipc4_data->max_num_pipelines <= 0) {
489 				dev_err(sdev->dev, "Invalid max_num_pipelines %d",
490 					ipc4_data->max_num_pipelines);
491 				ret = -EINVAL;
492 				goto out;
493 			}
494 			break;
495 		case SOF_IPC4_FW_CONTEXT_SAVE:
496 			ipc4_data->fw_context_save = *tuple->value;
497 			break;
498 		default:
499 			break;
500 		}
501 
502 		offset += sizeof(*tuple) + tuple->size;
503 	}
504 
505 	/* Get the hardware configuration */
506 	msg.primary = SOF_IPC4_MSG_TARGET(SOF_IPC4_MODULE_MSG);
507 	msg.primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
508 	msg.primary |= SOF_IPC4_MOD_ID(SOF_IPC4_MOD_INIT_BASEFW_MOD_ID);
509 	msg.primary |= SOF_IPC4_MOD_INSTANCE(SOF_IPC4_MOD_INIT_BASEFW_INSTANCE_ID);
510 	msg.extension = SOF_IPC4_MOD_EXT_MSG_PARAM_ID(SOF_IPC4_FW_PARAM_HW_CONFIG_GET);
511 
512 	msg.data_size = sdev->ipc->max_payload_size;
513 
514 	ret = iops->set_get_data(sdev, &msg, msg.data_size, false);
515 	if (ret)
516 		goto out;
517 
518 	offset = 0;
519 	while (offset < msg.data_size) {
520 		tuple = (struct sof_ipc4_tuple *)((u8 *)msg.data_ptr + offset);
521 
522 		switch (tuple->type) {
523 		case SOF_IPC4_HW_CFG_INTEL_MIC_PRIVACY_CAPS:
524 			if (ipc4_data->intel_configure_mic_privacy) {
525 				struct sof_ipc4_intel_mic_privacy_cap *caps;
526 
527 				caps = (struct sof_ipc4_intel_mic_privacy_cap *)tuple->value;
528 				ipc4_data->intel_configure_mic_privacy(sdev, caps);
529 			}
530 			break;
531 		default:
532 			break;
533 		}
534 
535 		offset += sizeof(*tuple) + tuple->size;
536 	}
537 
538 out:
539 	kfree(msg.data_ptr);
540 
541 	return ret;
542 }
543 
sof_ipc4_reload_fw_libraries(struct snd_sof_dev * sdev)544 int sof_ipc4_reload_fw_libraries(struct snd_sof_dev *sdev)
545 {
546 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
547 	struct sof_ipc4_fw_library *fw_lib;
548 	unsigned long lib_id;
549 	int ret = 0;
550 
551 	xa_for_each_start(&ipc4_data->fw_lib_xa, lib_id, fw_lib, 1) {
552 		ret = ipc4_data->load_library(sdev, fw_lib, true);
553 		if (ret) {
554 			dev_err(sdev->dev, "%s: Failed to reload library: %s, %d\n",
555 				__func__, fw_lib->name, ret);
556 			break;
557 		}
558 	}
559 
560 	return ret;
561 }
562 
563 /**
564  * sof_ipc4_update_cpc_from_manifest - Update the cpc in base config from manifest
565  * @sdev: SOF device
566  * @fw_module: pointer struct sof_ipc4_fw_module to parse
567  * @basecfg: Pointer to the base_config to update
568  */
sof_ipc4_update_cpc_from_manifest(struct snd_sof_dev * sdev,struct sof_ipc4_fw_module * fw_module,struct sof_ipc4_base_module_cfg * basecfg)569 void sof_ipc4_update_cpc_from_manifest(struct snd_sof_dev *sdev,
570 				       struct sof_ipc4_fw_module *fw_module,
571 				       struct sof_ipc4_base_module_cfg *basecfg)
572 {
573 	const struct sof_man4_module_config *fw_mod_cfg;
574 	u32 cpc_pick = 0;
575 	u32 max_cpc = 0;
576 	const char *msg;
577 	int i;
578 
579 	if (!fw_module->fw_mod_cfg) {
580 		msg = "No mod_cfg available for CPC lookup in the firmware file's manifest";
581 		goto no_cpc;
582 	}
583 
584 	/*
585 	 * Find the best matching (highest) CPC value based on the module's
586 	 * IBS/OBS configuration inferred from the audio format selection.
587 	 *
588 	 * The CPC value in each module config entry has been measured and
589 	 * recorded as a IBS/OBS/CPC triplet and stored in the firmware file's
590 	 * manifest
591 	 */
592 	fw_mod_cfg = fw_module->fw_mod_cfg;
593 	for (i = 0; i < fw_module->man4_module_entry.cfg_count; i++) {
594 		if (basecfg->obs == fw_mod_cfg[i].obs &&
595 		    basecfg->ibs == fw_mod_cfg[i].ibs &&
596 		    cpc_pick < fw_mod_cfg[i].cpc)
597 			cpc_pick = fw_mod_cfg[i].cpc;
598 
599 		if (max_cpc < fw_mod_cfg[i].cpc)
600 			max_cpc = fw_mod_cfg[i].cpc;
601 	}
602 
603 	basecfg->cpc = cpc_pick;
604 
605 	/* We have a matching configuration for CPC */
606 	if (basecfg->cpc)
607 		return;
608 
609 	/*
610 	 * No matching IBS/OBS found, the firmware manifest is missing
611 	 * information in the module's module configuration table.
612 	 */
613 	if (!max_cpc)
614 		msg = "No CPC value available in the firmware file's manifest";
615 	else if (!cpc_pick)
616 		msg = "No CPC match in the firmware file's manifest";
617 
618 no_cpc:
619 	dev_dbg(sdev->dev, "%s (UUID: %pUL): %s (ibs/obs: %u/%u)\n",
620 		fw_module->man4_module_entry.name,
621 		&fw_module->man4_module_entry.uuid, msg, basecfg->ibs,
622 		basecfg->obs);
623 }
624 
625 const struct sof_ipc_fw_loader_ops ipc4_loader_ops = {
626 	.validate = sof_ipc4_validate_firmware,
627 	.parse_ext_manifest = sof_ipc4_fw_parse_basefw_ext_man,
628 };
629