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 
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 <sound/sof/ipc4/header.h>
15 #include "sof-priv.h"
16 
17 /* The DSP window indices are fixed */
18 #define SOF_IPC4_INBOX_WINDOW_IDX	0
19 #define SOF_IPC4_OUTBOX_WINDOW_IDX	1
20 #define SOF_IPC4_DEBUG_WINDOW_IDX	2
21 
22 enum sof_ipc4_mtrace_type {
23 	SOF_IPC4_MTRACE_NOT_AVAILABLE = 0,
24 	SOF_IPC4_MTRACE_INTEL_CAVS_1_5,
25 	SOF_IPC4_MTRACE_INTEL_CAVS_1_8,
26 	SOF_IPC4_MTRACE_INTEL_CAVS_2,
27 };
28 
29 /**
30  * struct sof_ipc4_fw_module - IPC4 module info
31  * @sof_man4_module: Module info
32  * @fw_mod_cfg: Pointer to the module config start of the module
33  * @m_ida: Module instance identifier
34  * @private: Module private data
35  */
36 struct sof_ipc4_fw_module {
37 	struct sof_man4_module man4_module_entry;
38 	const struct sof_man4_module_config *fw_mod_cfg;
39 	struct ida m_ida;
40 	void *private;
41 };
42 
43 /**
44  * struct sof_ipc4_fw_library - IPC4 library information
45  * @sof_fw: SOF Firmware of the library
46  * @id: Library ID. 0 is reserved for basefw, external libraries must have unique
47  *	ID number between 1 and (sof_ipc4_fw_data.max_libs_count - 1)
48  *	Note: sof_ipc4_fw_data.max_libs_count == 1 implies that external libraries
49  *	are not supported
50  * @num_modules : Number of FW modules in the library
51  * @modules: Array of FW modules
52  */
53 struct sof_ipc4_fw_library {
54 	struct sof_firmware sof_fw;
55 	const char *name;
56 	u32 id;
57 	int num_modules;
58 	struct sof_ipc4_fw_module *modules;
59 };
60 
61 /**
62  * struct sof_ipc4_fw_data - IPC4-specific data
63  * @manifest_fw_hdr_offset: FW header offset in the manifest
64  * @fw_lib_xa: XArray for firmware libraries, including basefw (ID = 0)
65  *	       Used to store the FW libraries and to manage the unique IDs of the
66  *	       libraries.
67  * @nhlt: NHLT table either from the BIOS or the topology manifest
68  * @mtrace_type: mtrace type supported on the booted platform
69  * @mtrace_log_bytes: log bytes as reported by the firmware via fw_config reply
70  * @num_playback_streams: max number of playback DMAs, needed for CHAIN_DMA offset
71  * @num_capture_streams: max number of capture DMAs
72  * @max_num_pipelines: max number of pipelines
73  * @max_libs_count: Maximum number of libraries support by the FW including the
74  *		    base firmware
75  *
76  * @load_library: Callback function for platform dependent library loading
77  * @pipeline_state_mutex: Mutex to protect pipeline triggers, ref counts, states and deletion
78  */
79 struct sof_ipc4_fw_data {
80 	u32 manifest_fw_hdr_offset;
81 	struct xarray fw_lib_xa;
82 	void *nhlt;
83 	enum sof_ipc4_mtrace_type mtrace_type;
84 	u32 mtrace_log_bytes;
85 	int num_playback_streams;
86 	int num_capture_streams;
87 	int max_num_pipelines;
88 	u32 max_libs_count;
89 	bool fw_context_save;
90 
91 	int (*load_library)(struct snd_sof_dev *sdev,
92 			    struct sof_ipc4_fw_library *fw_lib, bool reload);
93 	void (*intel_configure_mic_privacy)(struct snd_sof_dev *sdev,
94 					    struct sof_ipc4_intel_mic_privacy_cap *caps);
95 	struct mutex pipeline_state_mutex; /* protect pipeline triggers, ref counts and states */
96 };
97 
98 extern const struct sof_ipc_fw_loader_ops ipc4_loader_ops;
99 extern const struct sof_ipc_tplg_ops ipc4_tplg_ops;
100 extern const struct sof_ipc_tplg_control_ops tplg_ipc4_control_ops;
101 extern const struct sof_ipc_pcm_ops ipc4_pcm_ops;
102 extern const struct sof_ipc_fw_tracing_ops ipc4_mtrace_ops;
103 
104 int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 instance_id, u32 state);
105 int sof_ipc4_mtrace_update_pos(struct snd_sof_dev *sdev, int core);
106 
107 int sof_ipc4_complete_split_release(struct snd_sof_dev *sdev);
108 int sof_ipc4_query_fw_configuration(struct snd_sof_dev *sdev);
109 int sof_ipc4_reload_fw_libraries(struct snd_sof_dev *sdev);
110 struct sof_ipc4_fw_module *sof_ipc4_find_module_by_uuid(struct snd_sof_dev *sdev,
111 							const guid_t *uuid);
112 
113 struct snd_sof_widget *sof_ipc4_find_swidget_by_ids(struct snd_sof_dev *sdev,
114 						    u32 module_id, int instance_id);
115 
116 struct sof_ipc4_base_module_cfg;
117 void sof_ipc4_update_cpc_from_manifest(struct snd_sof_dev *sdev,
118 				       struct sof_ipc4_fw_module *fw_module,
119 				       struct sof_ipc4_base_module_cfg *basecfg);
120 
121 size_t sof_ipc4_find_debug_slot_offset_by_type(struct snd_sof_dev *sdev,
122 					       u32 slot_type);
123 
124 void sof_ipc4_mic_privacy_state_change(struct snd_sof_dev *sdev, bool state);
125 
126 #endif
127