/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */ /* * This file is provided under a dual BSD/GPLv2 license. When using or * redistributing this file, you may do so under either license. * * Copyright(c) 2022 Intel Corporation */ #ifndef __INCLUDE_SOUND_SOF_IPC4_TOPOLOGY_H__ #define __INCLUDE_SOUND_SOF_IPC4_TOPOLOGY_H__ #include <sound/sof/ipc4/header.h> #define SOF_IPC4_FW_PAGE_SIZE … #define SOF_IPC4_FW_PAGE(x) … #define SOF_IPC4_FW_ROUNDUP(x) … #define SOF_IPC4_MODULE_LOAD_TYPE … #define SOF_IPC4_MODULE_AUTO_START … /* * Two module schedule domains in fw : * LL domain - Low latency domain * DP domain - Data processing domain * The LL setting should be equal to !DP setting */ #define SOF_IPC4_MODULE_LL … #define SOF_IPC4_MODULE_DP … #define SOF_IPC4_MODULE_LIB_CODE … #define SOF_IPC4_MODULE_INIT_CONFIG_MASK … #define SOF_IPC4_MODULE_INIT_CONFIG_TYPE_BASE_CFG … #define SOF_IPC4_MODULE_INIT_CONFIG_TYPE_BASE_CFG_WITH_EXT … #define SOF_IPC4_MODULE_INSTANCE_LIST_ITEM_SIZE … #define SOF_IPC4_PIPELINE_OBJECT_SIZE … #define SOF_IPC4_DATA_QUEUE_OBJECT_SIZE … #define SOF_IPC4_LL_TASK_OBJECT_SIZE … #define SOF_IPC4_DP_TASK_OBJECT_SIZE … #define SOF_IPC4_DP_TASK_LIST_SIZE … #define SOF_IPC4_LL_TASK_LIST_ITEM_SIZE … #define SOF_IPC4_FW_MAX_PAGE_COUNT … #define SOF_IPC4_FW_MAX_QUEUE_COUNT … /* Node index and mask applicable for host copier and ALH/HDA type DAI copiers */ #define SOF_IPC4_NODE_INDEX_MASK … #define SOF_IPC4_NODE_INDEX(x) … #define SOF_IPC4_NODE_TYPE(x) … #define SOF_IPC4_GET_NODE_TYPE(node_id) … /* Node ID for SSP type DAI copiers */ #define SOF_IPC4_NODE_INDEX_INTEL_SSP(x) … /* Node ID for DMIC type DAI copiers */ #define SOF_IPC4_NODE_INDEX_INTEL_DMIC(x) … #define SOF_IPC4_GAIN_ALL_CHANNELS_MASK … #define SOF_IPC4_VOL_ZERO_DB … #define SOF_IPC4_DMA_DEVICE_MAX_COUNT … #define SOF_IPC4_INVALID_NODE_ID … /* FW requires minimum 2ms DMA buffer size */ #define SOF_IPC4_MIN_DMA_BUFFER_SIZE … /* * The base of multi-gateways. Multi-gateways addressing starts from * ALH_MULTI_GTW_BASE and there are ALH_MULTI_GTW_COUNT multi-sources * and ALH_MULTI_GTW_COUNT multi-sinks available. * Addressing is continuous from ALH_MULTI_GTW_BASE to * ALH_MULTI_GTW_BASE + ALH_MULTI_GTW_COUNT - 1. */ #define ALH_MULTI_GTW_BASE … /* A magic number from FW */ #define ALH_MULTI_GTW_COUNT … enum sof_ipc4_copier_module_config_params { … }; struct sof_ipc4_copier_config_set_sink_format { … } __packed __aligned(…); /** * struct sof_ipc4_pipeline - pipeline config data * @priority: Priority of this pipeline * @lp_mode: Low power mode * @mem_usage: Memory usage * @core_id: Target core for the pipeline * @state: Pipeline state * @use_chain_dma: flag to indicate if the firmware shall use chained DMA * @msg: message structure for pipeline * @skip_during_fe_trigger: skip triggering this pipeline during the FE DAI trigger */ struct sof_ipc4_pipeline { … }; /** * struct sof_ipc4_multi_pipeline_data - multi pipeline trigger IPC data * @count: Number of pipelines to be triggered * @pipeline_instance_ids: Flexible array of IDs of the pipelines to be triggered */ struct ipc4_pipeline_set_state_data { … } __packed; /** * struct sof_ipc4_pin_format - Module pin format * @pin_index: pin index * @buffer_size: buffer size in bytes * @audio_fmt: audio format for the pin * * This structure can be used for both output or input pins and the pin_index is relative to the * pin type i.e output/input pin */ struct sof_ipc4_pin_format { … }; /** * struct sof_ipc4_available_audio_format - Available audio formats * @output_pin_fmts: Available output pin formats * @input_pin_fmts: Available input pin formats * @num_input_formats: Number of input pin formats * @num_output_formats: Number of output pin formats */ struct sof_ipc4_available_audio_format { … }; /** * struct sof_copier_gateway_cfg - IPC gateway configuration * @node_id: ID of Gateway Node * @dma_buffer_size: Preferred Gateway DMA buffer size (in bytes) * @config_length: Length of gateway node configuration blob specified in #config_data * config_data: Gateway node configuration blob */ struct sof_copier_gateway_cfg { … }; /** * struct sof_ipc4_copier_data - IPC data for copier * @base_config: Base configuration including input audio format * @out_format: Output audio format * @copier_feature_mask: Copier feature mask * @gtw_cfg: Gateway configuration */ struct sof_ipc4_copier_data { … }; /** * struct sof_ipc4_gtw_attributes: Gateway attributes * @lp_buffer_alloc: Gateway data requested in low power memory * @alloc_from_reg_file: Gateway data requested in register file memory * @rsvd: reserved for future use */ struct sof_ipc4_gtw_attributes { … }; /** * struct sof_ipc4_dma_device_stream_ch_map: abstract representation of * channel mapping to DMAs * @device: representation of hardware device address or FIFO * @channel_mask: channels handled by @device. Channels are expected to be * contiguous */ struct sof_ipc4_dma_device_stream_ch_map { … }; /** * struct sof_ipc4_dma_stream_ch_map: DMA configuration data * @device_count: Number valid items in mapping array * @mapping: device address and channel mask */ struct sof_ipc4_dma_stream_ch_map { … } __packed; #define SOF_IPC4_DMA_METHOD_HDA … #define SOF_IPC4_DMA_METHOD_GPDMA … /** * struct sof_ipc4_dma_config: DMA configuration * @dma_method: HDAudio or GPDMA * @pre_allocated_by_host: 1 if host driver allocates DMA channels, 0 otherwise * @dma_channel_id: for HDaudio defined as @stream_id - 1 * @stream_id: HDaudio stream tag * @dma_stream_channel_map: array of device/channel mappings * @dma_priv_config_size: currently not used * @dma_priv_config: currently not used */ struct sof_ipc4_dma_config { … } __packed; #define SOF_IPC4_GTW_DMA_CONFIG_ID … /** * struct sof_ipc4_dma_config: DMA configuration * @type: set to SOF_IPC4_GTW_DMA_CONFIG_ID * @length: sizeof(struct sof_ipc4_dma_config) + dma_config.dma_priv_config_size * @dma_config: actual DMA configuration */ struct sof_ipc4_dma_config_tlv { … } __packed; /** struct sof_ipc4_alh_configuration_blob: ALH blob * @gw_attr: Gateway attributes * @alh_cfg: ALH configuration data */ struct sof_ipc4_alh_configuration_blob { … }; /** * struct sof_ipc4_copier - copier config data * @data: IPC copier data * @copier_config: Copier + blob * @ipc_config_size: Size of copier_config * @available_fmt: Available audio format * @frame_fmt: frame format * @msg: message structure for copier * @gtw_attr: Gateway attributes for copier blob * @dai_type: DAI type * @dai_index: DAI index * @dma_config_tlv: DMA configuration */ struct sof_ipc4_copier { … }; /** * struct sof_ipc4_ctrl_value_chan: generic channel mapped value data * @channel: Channel ID * @value: Value associated with @channel */ struct sof_ipc4_ctrl_value_chan { … }; /** * struct sof_ipc4_control_data - IPC data for kcontrol IO * @msg: message structure for kcontrol IO * @index: pipeline ID * @chanv: channel ID and value array used by volume type controls * @data: data for binary kcontrols */ struct sof_ipc4_control_data { … }; #define SOF_IPC4_SWITCH_CONTROL_PARAM_ID … #define SOF_IPC4_ENUM_CONTROL_PARAM_ID … /** * struct sof_ipc4_control_msg_payload - IPC payload for kcontrol parameters * @id: unique id of the control * @num_elems: Number of elements in the chanv array * @reserved: reserved for future use, must be set to 0 * @chanv: channel ID and value array */ struct sof_ipc4_control_msg_payload { … } __packed; /** * struct sof_ipc4_gain_params - IPC gain parameters * @channels: Channels * @init_val: Initial value * @curve_type: Curve type * @reserved: reserved for future use * @curve_duration_l: Curve duration low part * @curve_duration_h: Curve duration high part */ struct sof_ipc4_gain_params { … } __packed __aligned(…); /** * struct sof_ipc4_gain_data - IPC gain init blob * @base_config: IPC base config data * @params: Initial parameters for the gain module */ struct sof_ipc4_gain_data { … } __packed __aligned(…); /** * struct sof_ipc4_gain - gain config data * @data: IPC gain blob * @available_fmt: Available audio format * @msg: message structure for gain */ struct sof_ipc4_gain { … }; /** * struct sof_ipc4_mixer - mixer config data * @base_config: IPC base config data * @available_fmt: Available audio format * @msg: IPC4 message struct containing header and data info */ struct sof_ipc4_mixer { … }; /* * struct sof_ipc4_src_data - IPC data for SRC * @base_config: IPC base config data * @sink_rate: Output rate for sink module */ struct sof_ipc4_src_data { … } __packed __aligned(…); /** * struct sof_ipc4_src - SRC config data * @data: IPC base config data * @available_fmt: Available audio format * @msg: IPC4 message struct containing header and data info */ struct sof_ipc4_src { … }; /** * struct sof_ipc4_base_module_cfg_ext - base module config extension containing the pin format * information for the module. Both @num_input_pin_fmts and @num_output_pin_fmts cannot be 0 for a * module. * @num_input_pin_fmts: number of input pin formats in the @pin_formats array * @num_output_pin_fmts: number of output pin formats in the @pin_formats array * @reserved: reserved for future use * @pin_formats: flexible array consisting of @num_input_pin_fmts input pin format items followed * by @num_output_pin_fmts output pin format items */ struct sof_ipc4_base_module_cfg_ext { … } __packed; /** * struct sof_ipc4_process - process config data * @base_config: IPC base config data * @base_config_ext: Base config extension data for module init * @output_format: Output audio format * @available_fmt: Available audio format * @ipc_config_data: Process module config data * @ipc_config_size: Size of process module config data * @msg: IPC4 message struct containing header and data info * @base_config_ext_size: Size of the base config extension data in bytes * @init_config: Module init config type (SOF_IPC4_MODULE_INIT_CONFIG_TYPE_*) */ struct sof_ipc4_process { … }; bool sof_ipc4_copier_is_single_bitdepth(struct snd_sof_dev *sdev, struct sof_ipc4_pin_format *pin_fmts, u32 pin_fmts_size); #endif
Codebase Browser
linux