tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
20enum 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_module - IPC4 module info
29 * @sof_man4_module: Module info
30 * @m_ida: Module instance identifier
31 * @bss_size: Module object size
32 * @private: Module private data
33 */
34struct sof_ipc4_fw_module {
35 struct sof_man4_module man4_module_entry;
36 struct ida m_ida;
37 u32 bss_size;
38 void *private;
39};
40
41/**
42 * struct sof_ipc4_fw_library - IPC4 library information
43 * @sof_fw: SOF Firmware of the library
44 * @id: Library ID. 0 is reserved for basefw, external libraries must have unique
45 * ID number between 1 and (sof_ipc4_fw_data.max_libs_count - 1)
46 * Note: sof_ipc4_fw_data.max_libs_count == 1 implies that external libraries
47 * are not supported
48 * @num_modules : Number of FW modules in the library
49 * @modules: Array of FW modules
50 */
51struct sof_ipc4_fw_library {
52 struct sof_firmware sof_fw;
53 const char *name;
54 u32 id;
55 int num_modules;
56 struct sof_ipc4_fw_module *modules;
57};
58
59/**
60 * struct sof_ipc4_fw_data - IPC4-specific data
61 * @manifest_fw_hdr_offset: FW header offset in the manifest
62 * @fw_lib_xa: XArray for firmware libraries, including basefw (ID = 0)
63 * Used to store the FW libraries and to manage the unique IDs of the
64 * libraries.
65 * @nhlt: NHLT table either from the BIOS or the topology manifest
66 * @mtrace_type: mtrace type supported on the booted platform
67 * @mtrace_log_bytes: log bytes as reported by the firmware via fw_config reply
68 * @max_num_pipelines: max number of pipelines
69 * @max_libs_count: Maximum number of libraries support by the FW including the
70 * base firmware
71 *
72 * @load_library: Callback function for platform dependent library loading
73 */
74struct sof_ipc4_fw_data {
75 u32 manifest_fw_hdr_offset;
76 struct xarray fw_lib_xa;
77 void *nhlt;
78 enum sof_ipc4_mtrace_type mtrace_type;
79 u32 mtrace_log_bytes;
80 int max_num_pipelines;
81 u32 max_libs_count;
82
83 int (*load_library)(struct snd_sof_dev *sdev,
84 struct sof_ipc4_fw_library *fw_lib, bool reload);
85};
86
87extern const struct sof_ipc_fw_loader_ops ipc4_loader_ops;
88extern const struct sof_ipc_tplg_ops ipc4_tplg_ops;
89extern const struct sof_ipc_tplg_control_ops tplg_ipc4_control_ops;
90extern const struct sof_ipc_pcm_ops ipc4_pcm_ops;
91extern const struct sof_ipc_fw_tracing_ops ipc4_mtrace_ops;
92
93int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 id, u32 state);
94int sof_ipc4_mtrace_update_pos(struct snd_sof_dev *sdev, int core);
95
96int sof_ipc4_query_fw_configuration(struct snd_sof_dev *sdev);
97int sof_ipc4_reload_fw_libraries(struct snd_sof_dev *sdev);
98struct sof_ipc4_fw_module *sof_ipc4_find_module_by_uuid(struct snd_sof_dev *sdev,
99 const guid_t *uuid);
100#endif