121 lines · c
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 or4 * redistributing this file, you may do so under either license.5 *6 * Copyright(c) 2022 Intel Corporation7 */8 9#ifndef __SOUND_SOC_SOF_IPC4_PRIV_H10#define __SOUND_SOC_SOF_IPC4_PRIV_H11 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 018#define SOF_IPC4_OUTBOX_WINDOW_IDX 119#define SOF_IPC4_DEBUG_WINDOW_IDX 220 21enum 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 info30 * @sof_man4_module: Module info31 * @fw_mod_cfg: Pointer to the module config start of the module32 * @m_ida: Module instance identifier33 * @private: Module private data34 */35struct 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 information44 * @sof_fw: SOF Firmware of the library45 * @id: Library ID. 0 is reserved for basefw, external libraries must have unique46 * 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 libraries48 * are not supported49 * @num_modules : Number of FW modules in the library50 * @modules: Array of FW modules51 */52struct 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 data62 * @manifest_fw_hdr_offset: FW header offset in the manifest63 * @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 the65 * libraries.66 * @nhlt: NHLT table either from the BIOS or the topology manifest67 * @mtrace_type: mtrace type supported on the booted platform68 * @mtrace_log_bytes: log bytes as reported by the firmware via fw_config reply69 * @num_playback_streams: max number of playback DMAs, needed for CHAIN_DMA offset70 * @num_capture_streams: max number of capture DMAs71 * @max_num_pipelines: max number of pipelines72 * @max_libs_count: Maximum number of libraries support by the FW including the73 * base firmware74 *75 * @load_library: Callback function for platform dependent library loading76 * @pipeline_state_mutex: Mutex to protect pipeline triggers, ref counts, states and deletion77 */78struct 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 95extern const struct sof_ipc_fw_loader_ops ipc4_loader_ops;96extern const struct sof_ipc_tplg_ops ipc4_tplg_ops;97extern const struct sof_ipc_tplg_control_ops tplg_ipc4_control_ops;98extern const struct sof_ipc_pcm_ops ipc4_pcm_ops;99extern const struct sof_ipc_fw_tracing_ops ipc4_mtrace_ops;100 101int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 instance_id, u32 state);102int sof_ipc4_mtrace_update_pos(struct snd_sof_dev *sdev, int core);103 104int sof_ipc4_query_fw_configuration(struct snd_sof_dev *sdev);105int sof_ipc4_reload_fw_libraries(struct snd_sof_dev *sdev);106struct sof_ipc4_fw_module *sof_ipc4_find_module_by_uuid(struct snd_sof_dev *sdev,107 const guid_t *uuid);108 109struct snd_sof_widget *sof_ipc4_find_swidget_by_ids(struct snd_sof_dev *sdev,110 u32 module_id, int instance_id);111 112struct sof_ipc4_base_module_cfg;113void 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 117size_t sof_ipc4_find_debug_slot_offset_by_type(struct snd_sof_dev *sdev,118 u32 slot_type);119 120#endif121