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