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. All rights reserved.
7  */
8 
9 #ifndef __SOUND_SOC_SOF_IPC4_PRIV_H
10 #define __SOUND_SOC_SOF_IPC4_PRIV_H
11 
12 #include <linux/idr.h>
13 #include <sound/sof/ext_manifest4.h>
14 #include "sof-priv.h"
15 
16 /* The DSP window indices are fixed */
17 #define SOF_IPC4_OUTBOX_WINDOW_IDX	1
18 #define SOF_IPC4_DEBUG_WINDOW_IDX	2
19 
20 enum sof_ipc4_mtrace_type {
21 	SOF_IPC4_MTRACE_NOT_AVAILABLE = 0,
22 	SOF_IPC4_MTRACE_INTEL_CAVS_1_5,
23 	SOF_IPC4_MTRACE_INTEL_CAVS_1_8,
24 	SOF_IPC4_MTRACE_INTEL_CAVS_2,
25 };
26 
27 /**
28  * struct sof_ipc4_fw_data - IPC4-specific data
29  * @manifest_fw_hdr_offset: FW header offset in the manifest
30  * @num_fw_modules : Number of modules in base FW
31  * @fw_modules: Array of base FW modules
32  * @nhlt: NHLT table either from the BIOS or the topology manifest
33  * @mtrace_type: mtrace type supported on the booted platform
34  * @mtrace_log_bytes: log bytes as reported by the firmware via fw_config reply
35  */
36 struct sof_ipc4_fw_data {
37 	u32 manifest_fw_hdr_offset;
38 	int num_fw_modules;
39 	void *fw_modules;
40 	void *nhlt;
41 	enum sof_ipc4_mtrace_type mtrace_type;
42 	u32 mtrace_log_bytes;
43 };
44 
45 /**
46  * struct sof_ipc4_fw_module - IPC4 module info
47  * @sof_man4_module : Module info
48  * @m_ida: Module instance identifier
49  * @bss_size: Module object size
50  * @private: Module private data
51  */
52 struct sof_ipc4_fw_module {
53 	struct sof_man4_module man4_module_entry;
54 	struct ida m_ida;
55 	u32 bss_size;
56 	void *private;
57 };
58 
59 extern const struct sof_ipc_fw_loader_ops ipc4_loader_ops;
60 extern const struct sof_ipc_tplg_ops ipc4_tplg_ops;
61 extern const struct sof_ipc_tplg_control_ops tplg_ipc4_control_ops;
62 extern const struct sof_ipc_pcm_ops ipc4_pcm_ops;
63 extern const struct sof_ipc_fw_tracing_ops ipc4_mtrace_ops;
64 
65 int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 id, u32 state);
66 int sof_ipc4_mtrace_update_pos(struct snd_sof_dev *sdev, int core);
67 #endif
68