/* 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) 2019 Intel Corporation * * Author: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> */ #ifndef __SOUND_SOC_SOF_AUDIO_H#define __SOUND_SOC_SOF_AUDIO_H #include <linux/workqueue.h> #include <sound/soc.h>#include <sound/control.h>#include <sound/sof/stream.h> /* needs to be included before control.h */#include <sound/sof/control.h>#include <sound/sof/dai.h>#include <sound/sof/topology.h>#include "sof-priv.h" #define SOF_AUDIO_PCM_DRV_NAME "sof-audio-component" /* * The ipc4 firmware only supports up to 8 sink or source pins * per widget, because only 3 bits are used for queue(pin) ID * in ipc4 protocol. */#define SOF_WIDGET_MAX_NUM_PINS 8 /* Widget pin type */#define SOF_PIN_TYPE_INPUT 0#define SOF_PIN_TYPE_OUTPUT 1 /* max number of FE PCMs before BEs */#define SOF_BE_PCM_BASE 16 #define DMA_CHAN_INVALID 0xFFFFFFFF #define WIDGET_IS_DAI(id) ((id) == snd_soc_dapm_dai_in || (id) == snd_soc_dapm_dai_out)#define WIDGET_IS_AIF(id) ((id) == snd_soc_dapm_aif_in || (id) == snd_soc_dapm_aif_out)#define WIDGET_IS_AIF_OR_DAI(id) (WIDGET_IS_DAI(id) || WIDGET_IS_AIF(id))#define WIDGET_IS_COPIER(id) (WIDGET_IS_AIF_OR_DAI(id) || (id) == snd_soc_dapm_buffer) #define SOF_DAI_PARAM_INTEL_SSP_MCLK 0#define SOF_DAI_PARAM_INTEL_SSP_BCLK 1#define SOF_DAI_PARAM_INTEL_SSP_TDM_SLOTS 2 enum sof_widget_op { SOF_WIDGET_PREPARE, SOF_WIDGET_SETUP, SOF_WIDGET_FREE, SOF_WIDGET_UNPREPARE,}; /* * Volume fractional word length define to 16 sets * the volume linear gain value to use Qx.16 format */#define VOLUME_FWL 16 #define SOF_TLV_ITEMS 3 static inline u32 mixer_to_ipc(unsigned int value, u32 *volume_map, int size){ if (value >= size) return volume_map[size - 1]; return volume_map[value];} static inline u32 ipc_to_mixer(u32 value, u32 *volume_map, int size){ int i; for (i = 0; i < size; i++) { if (volume_map[i] >= value) return i; } return i - 1;} struct snd_sof_widget;struct snd_sof_route;struct snd_sof_control;struct snd_sof_dai;struct snd_sof_pcm; struct snd_sof_dai_config_data { int dai_index; int dai_data; /* contains DAI-specific information */ int dai_node_id; /* contains DAI-specific information for Gateway configuration */}; /** * struct sof_ipc_pcm_ops - IPC-specific PCM ops * @hw_params: Function pointer for hw_params * @hw_free: Function pointer for hw_free * @trigger: Function pointer for trigger * @dai_link_fixup: Function pointer for DAI link fixup * @pcm_setup: Function pointer for IPC-specific PCM set up that can be used for allocating * additional memory in the SOF PCM stream structure * @pcm_free: Function pointer for PCM free that can be used for freeing any * additional memory in the SOF PCM stream structure * @pointer: Function pointer for pcm pointer * Note: the @pointer callback may return -EOPNOTSUPP which should be * handled in a same way as if the callback is not provided * @delay: Function pointer for pcm delay reporting * @reset_hw_params_during_stop: Flag indicating whether the hw_params should be reset during the * STOP pcm trigger * @ipc_first_on_start: Send IPC before invoking platform trigger during * START/PAUSE_RELEASE triggers * @platform_stop_during_hw_free: Invoke the platform trigger during hw_free. This is needed for * IPC4 where a pipeline is only paused during stop/pause/suspend * triggers. The FW keeps the host DMA running in this case and * therefore the host must do the same and should stop the DMA during * hw_free. * @d0i3_supported_in_s0ix: Allow DSP D0I3 during S0iX */struct sof_ipc_pcm_ops { int (*hw_params)(struct snd_soc_component *component, struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params, struct snd_sof_platform_stream_params *platform_params); int (*hw_free)(struct snd_soc_component *component, struct snd_pcm_substream *substream); int (*trigger)(struct snd_soc_component *component, struct snd_pcm_substream *substream, int cmd); int (*dai_link_fixup)(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params); int (*pcm_setup)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm); void (*pcm_free)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm); int (*pointer)(struct snd_soc_component *component, struct snd_pcm_substream *substream, snd_pcm_uframes_t *pointer); snd_pcm_sframes_t (*delay)(struct snd_soc_component *component, struct snd_pcm_substream *substream); bool reset_hw_params_during_stop; bool ipc_first_on_start; bool platform_stop_during_hw_free; bool d0i3_supported_in_s0ix;}; /** * struct sof_ipc_tplg_control_ops - IPC-specific ops for topology kcontrol IO */struct sof_ipc_tplg_control_ops { bool (*volume_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*volume_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); bool (*switch_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*switch_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); bool (*enum_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*enum_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_ext_get)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); int (*bytes_ext_volatile_get)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); int (*bytes_ext_put)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); /* update control data based on notification from the DSP */ void (*update)(struct snd_sof_dev *sdev, void *ipc_control_message); /* Optional callback to setup kcontrols associated with an swidget */ int (*widget_kcontrol_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); /* mandatory callback to set up volume table for volume kcontrols */ int (*set_up_volume_table)(struct snd_sof_control *scontrol, int tlv[SOF_TLV_ITEMS], int size);}; /** * struct sof_ipc_tplg_widget_ops - IPC-specific ops for topology widgets * @ipc_setup: Function pointer for setting up widget IPC params * @ipc_free: Function pointer for freeing widget IPC params * @token_list: List of token ID's that should be parsed for the widget * @token_list_size: number of elements in token_list * @bind_event: Function pointer for binding events to the widget * @ipc_prepare: Optional op for preparing a widget for set up * @ipc_unprepare: Optional op for unpreparing a widget */struct sof_ipc_tplg_widget_ops { int (*ipc_setup)(struct snd_sof_widget *swidget); void (*ipc_free)(struct snd_sof_widget *swidget); enum sof_tokens *token_list; int token_list_size; int (*bind_event)(struct snd_soc_component *scomp, struct snd_sof_widget *swidget, u16 event_type); int (*ipc_prepare)(struct snd_sof_widget *swidget, struct snd_pcm_hw_params *fe_params, struct snd_sof_platform_stream_params *platform_params, struct snd_pcm_hw_params *source_params, int dir); void (*ipc_unprepare)(struct snd_sof_widget *swidget);}; /** * struct sof_ipc_tplg_ops - IPC-specific topology ops * @widget: Array of pointers to IPC-specific ops for widgets. This should always be of size * SND_SOF_DAPM_TYPE_COUNT i.e one per widget type. Unsupported widget types will be * initialized to 0. * @control: Pointer to the IPC-specific ops for topology kcontrol IO * @route_setup: Function pointer for setting up pipeline connections * @route_free: Function pointer for freeing pipeline connections. * @token_list: List of all tokens supported by the IPC version. The size of the token_list * array should be SOF_TOKEN_COUNT. The unused elements in the array will be * initialized to 0. * @control_setup: Function pointer for setting up kcontrol IPC-specific data * @control_free: Function pointer for freeing kcontrol IPC-specific data * @pipeline_complete: Function pointer for pipeline complete IPC * @widget_setup: Function pointer for setting up setup in the DSP * @widget_free: Function pointer for freeing widget in the DSP * @dai_config: Function pointer for sending DAI config IPC to the DSP * @host_config: Function pointer for setting the DMA ID for host widgets * @dai_get_param: Function pointer for getting the DAI parameter * @set_up_all_pipelines: Function pointer for setting up all topology pipelines * @tear_down_all_pipelines: Function pointer for tearing down all topology pipelines * @parse_manifest: Function pointer for ipc4 specific parsing of topology manifest * @link_setup: Function pointer for IPC-specific DAI link set up * * Note: function pointers (ops) are optional */struct sof_ipc_tplg_ops { const struct sof_ipc_tplg_widget_ops *widget; const struct sof_ipc_tplg_control_ops *control; int (*route_setup)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute); int (*route_free)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute); const struct sof_token_info *token_list; int (*control_setup)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol); int (*control_free)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol); int (*pipeline_complete)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*widget_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*widget_free)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*dai_config)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget, unsigned int flags, struct snd_sof_dai_config_data *data); void (*host_config)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget, struct snd_sof_platform_stream_params *platform_params); int (*dai_get_param)(struct snd_sof_dev *sdev, struct snd_sof_dai *dai, int param_type); int (*set_up_all_pipelines)(struct snd_sof_dev *sdev, bool verify); int (*tear_down_all_pipelines)(struct snd_sof_dev *sdev, bool verify); int (*parse_manifest)(struct snd_soc_component *scomp, int index, struct snd_soc_tplg_manifest *man); int (*link_setup)(struct snd_sof_dev *sdev, struct snd_soc_dai_link *link);}; /** struct snd_sof_tuple - Tuple info * @token: Token ID * @value: union of a string or a u32 values */struct snd_sof_tuple { u32 token; union { u32 v; const char *s; } value;}; /* * List of SOF token ID's. The order of ID's does not matter as token arrays are looked up based on * the ID. */enum sof_tokens { SOF_PCM_TOKENS, SOF_PIPELINE_TOKENS, SOF_SCHED_TOKENS, SOF_ASRC_TOKENS, SOF_SRC_TOKENS, SOF_COMP_TOKENS, SOF_BUFFER_TOKENS, SOF_VOLUME_TOKENS, SOF_PROCESS_TOKENS, SOF_DAI_TOKENS, SOF_DAI_LINK_TOKENS, SOF_HDA_TOKENS, SOF_SSP_TOKENS, SOF_ALH_TOKENS, SOF_DMIC_TOKENS, SOF_DMIC_PDM_TOKENS, SOF_ESAI_TOKENS, SOF_SAI_TOKENS, SOF_AFE_TOKENS, SOF_CORE_TOKENS, SOF_COMP_EXT_TOKENS, SOF_IN_AUDIO_FORMAT_TOKENS, SOF_OUT_AUDIO_FORMAT_TOKENS, SOF_COPIER_DEEP_BUFFER_TOKENS, SOF_COPIER_TOKENS, SOF_AUDIO_FMT_NUM_TOKENS, SOF_COPIER_FORMAT_TOKENS, SOF_GAIN_TOKENS, SOF_ACPDMIC_TOKENS, SOF_ACPI2S_TOKENS, SOF_MICFIL_TOKENS, SOF_ACP_SDW_TOKENS, /* this should be the last */ SOF_TOKEN_COUNT,}; /** * struct sof_topology_token - SOF topology token definition * @token: Token number * @type: Token type * @get_token: Function pointer to parse the token value and save it in a object * @offset: Offset within an object to save the token value into */struct sof_topology_token { u32 token; u32 type; int (*get_token)(void *elem, void *object, u32 offset); u32 offset;}; struct sof_token_info { const char *name; const struct sof_topology_token *tokens; int count;}; /** * struct snd_sof_pcm_stream_pipeline_list - List of pipelines associated with a PCM stream * @pipelines: array of pipelines * @count: number of pipeline widgets in the @pipe_widgets array */struct snd_sof_pcm_stream_pipeline_list { struct snd_sof_pipeline **pipelines; u32 count;}; /* PCM stream, mapped to FW component */struct snd_sof_pcm_stream { u32 comp_id; struct snd_dma_buffer page_table; struct sof_ipc_stream_posn posn; struct snd_pcm_substream *substream; struct snd_compr_stream *cstream; struct work_struct period_elapsed_work; struct snd_soc_dapm_widget_list *list; /* list of connected DAPM widgets */ bool d0i3_compatible; /* DSP can be in D0I3 when this pcm is opened */ bool pause_supported; /* PCM device supports PAUSE operation */ unsigned int dsp_max_burst_size_in_ms; /* The maximum size of the host DMA burst in ms */ /* * flag to indicate that the DSP pipelines should be kept * active or not while suspending the stream */ bool suspend_ignored; struct snd_sof_pcm_stream_pipeline_list pipeline_list; /* used by IPC implementation and core does not touch it */ void *private;}; /* ALSA SOF PCM device */struct snd_sof_pcm { struct snd_soc_component *scomp; struct snd_sof_pcm_stream stream[2]; struct list_head list; /* list in sdev pcm list */ struct snd_pcm_hw_params params[2]; struct snd_sof_platform_stream_params platform_params[2]; bool prepared[2]; /* PCM_PARAMS set successfully */ bool setup_done[2]; /* the setup of the SOF PCM device is done */ bool pending_stop[2]; /* only used if (!pcm_ops->platform_stop_during_hw_free) */ /* Must be last - ends in a flex-array member. */ struct snd_soc_tplg_pcm pcm;}; struct snd_sof_led_control { unsigned int use_led; unsigned int direction; int led_value;}; /* ALSA SOF Kcontrol device */struct snd_sof_control { struct snd_soc_component *scomp; const char *name; int comp_id; int min_volume_step; /* min volume step for volume_table */ int max_volume_step; /* max volume step for volume_table */ int num_channels; unsigned int access; int info_type; int index; /* pipeline ID */ void *priv; /* private data copied from topology */ size_t priv_size; /* size of private data */ size_t max_size; void *ipc_control_data; void *old_ipc_control_data; int max; /* applicable to volume controls */ u32 size; /* cdata size */ u32 *volume_table; /* volume table computed from tlv data*/ struct list_head list; /* list in sdev control list */ struct snd_sof_led_control led_ctl; /* if true, the control's data needs to be updated from Firmware */ bool comp_data_dirty;}; /** struct snd_sof_dai_link - DAI link info * @tuples: array of parsed tuples * @num_tuples: number of tuples in the tuples array * @link: Pointer to snd_soc_dai_link * @hw_configs: Pointer to hw configs in topology * @num_hw_configs: Number of hw configs in topology * @default_hw_cfg_id: Default hw config ID * @type: DAI type * @list: item in snd_sof_dev dai_link list */struct snd_sof_dai_link { struct snd_sof_tuple *tuples; int num_tuples; struct snd_soc_dai_link *link; int num_hw_configs; int default_hw_cfg_id; int type; struct list_head list; struct snd_soc_tplg_hw_config hw_configs[] __counted_by(num_hw_configs);}; /* ASoC SOF DAPM widget */struct snd_sof_widget { struct snd_soc_component *scomp; int comp_id; int pipeline_id; /* * the prepared flag is used to indicate that a widget has been prepared for getting set * up in the DSP. */ bool prepared; struct mutex setup_mutex; /* to protect the swidget setup and free operations */ /* * use_count is protected by the PCM mutex held by the core and the * setup_mutex against non stream domain races (kcontrol access for * example) */ int use_count; int core; int id; /* id is the DAPM widget type */ /* * Instance ID is set dynamically when the widget gets set up in the FW. It should be * unique for each module type across all pipelines. This will not be used in SOF_IPC. */ int instance_id; /* * Flag indicating if the widget should be set up dynamically when a PCM is opened. * This flag is only set for the scheduler type widget in topology. During topology * loading, this flag is propagated to all the widgets belonging to the same pipeline. * When this flag is not set, a widget is set up at the time of topology loading * and retained until the DSP enters D3. It will need to be set up again when resuming * from D3. */ bool dynamic_pipeline_widget; /* Scheduling domain (enum sof_comp_domain), unset, Low Latency, or Data Processing */ u32 comp_domain; /* Module instance's memory configuration. */ u32 domain_id; /* Module instance's userspace domain ID */ u32 stack_bytes; /* Module instance's stack size requirement */ u32 heap_bytes; /* Module instance's heap size requirement */ struct snd_soc_dapm_widget *widget; struct list_head list; /* list in sdev widget list */ struct snd_sof_pipeline *spipe; void *module_info; const guid_t uuid; int num_tuples; struct snd_sof_tuple *tuples; /* * The allowed range for num_input/output_pins is [0, SOF_WIDGET_MAX_NUM_PINS]. * Widgets may have zero input or output pins, for example the tone widget has * zero input pins. */ u32 num_input_pins; u32 num_output_pins; /* * The input/output pin binding array, it takes the form of * [widget_name_connected_to_pin0, widget_name_connected_to_pin1, ...], * with the index as the queue ID. * * The array is used for special pin binding. Note that even if there * is only one input/output pin requires special pin binding, pin binding * should be defined for all input/output pins in topology, for pin(s) that * are not used, give the value "NotConnected". * * If pin binding is not defined in topology, nothing to parse in the kernel, * input_pin_binding and output_pin_binding shall be NULL. */ char **input_pin_binding; char **output_pin_binding; Lines 1–500 of 708. Load more
/* 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) 2019 Intel Corporation * * Author: Ranjani Sridharan <ranjani.sridharan@linux.intel.com> */ #ifndef __SOUND_SOC_SOF_AUDIO_H #define __SOUND_SOC_SOF_AUDIO_H #include <linux/workqueue.h> #include <sound/soc.h> #include <sound/control.h> #include <sound/sof/stream.h> /* needs to be included before control.h */ #include <sound/sof/control.h> #include <sound/sof/dai.h> #include <sound/sof/topology.h> #include "sof-priv.h" #define SOF_AUDIO_PCM_DRV_NAME "sof-audio-component" /* * The ipc4 firmware only supports up to 8 sink or source pins * per widget, because only 3 bits are used for queue(pin) ID * in ipc4 protocol. */ #define SOF_WIDGET_MAX_NUM_PINS 8 /* Widget pin type */ #define SOF_PIN_TYPE_INPUT 0 #define SOF_PIN_TYPE_OUTPUT 1 /* max number of FE PCMs before BEs */ #define SOF_BE_PCM_BASE 16 #define DMA_CHAN_INVALID 0xFFFFFFFF #define WIDGET_IS_DAI(id) ((id) == snd_soc_dapm_dai_in || (id) == snd_soc_dapm_dai_out) #define WIDGET_IS_AIF(id) ((id) == snd_soc_dapm_aif_in || (id) == snd_soc_dapm_aif_out) #define WIDGET_IS_AIF_OR_DAI(id) (WIDGET_IS_DAI(id) || WIDGET_IS_AIF(id)) #define WIDGET_IS_COPIER(id) (WIDGET_IS_AIF_OR_DAI(id) || (id) == snd_soc_dapm_buffer) #define SOF_DAI_PARAM_INTEL_SSP_MCLK 0 #define SOF_DAI_PARAM_INTEL_SSP_BCLK 1 #define SOF_DAI_PARAM_INTEL_SSP_TDM_SLOTS 2 enum sof_widget_op { SOF_WIDGET_PREPARE, SOF_WIDGET_SETUP, SOF_WIDGET_FREE, SOF_WIDGET_UNPREPARE, }; /* * Volume fractional word length define to 16 sets * the volume linear gain value to use Qx.16 format */ #define VOLUME_FWL 16 #define SOF_TLV_ITEMS 3 static inline u32 mixer_to_ipc(unsigned int value, u32 *volume_map, int size) { if (value >= size) return volume_map[size - 1]; return volume_map[value]; } static inline u32 ipc_to_mixer(u32 value, u32 *volume_map, int size) { int i; for (i = 0; i < size; i++) { if (volume_map[i] >= value) return i; } return i - 1; } struct snd_sof_widget; struct snd_sof_route; struct snd_sof_control; struct snd_sof_dai; struct snd_sof_pcm; struct snd_sof_dai_config_data { int dai_index; int dai_data; /* contains DAI-specific information */ int dai_node_id; /* contains DAI-specific information for Gateway configuration */ }; /** * struct sof_ipc_pcm_ops - IPC-specific PCM ops * @hw_params: Function pointer for hw_params * @hw_free: Function pointer for hw_free * @trigger: Function pointer for trigger * @dai_link_fixup: Function pointer for DAI link fixup * @pcm_setup: Function pointer for IPC-specific PCM set up that can be used for allocating * additional memory in the SOF PCM stream structure * @pcm_free: Function pointer for PCM free that can be used for freeing any * additional memory in the SOF PCM stream structure * @pointer: Function pointer for pcm pointer * Note: the @pointer callback may return -EOPNOTSUPP which should be * handled in a same way as if the callback is not provided * @delay: Function pointer for pcm delay reporting * @reset_hw_params_during_stop: Flag indicating whether the hw_params should be reset during the * STOP pcm trigger * @ipc_first_on_start: Send IPC before invoking platform trigger during * START/PAUSE_RELEASE triggers * @platform_stop_during_hw_free: Invoke the platform trigger during hw_free. This is needed for * IPC4 where a pipeline is only paused during stop/pause/suspend * triggers. The FW keeps the host DMA running in this case and * therefore the host must do the same and should stop the DMA during * hw_free. * @d0i3_supported_in_s0ix: Allow DSP D0I3 during S0iX */ struct sof_ipc_pcm_ops { int (*hw_params)(struct snd_soc_component *component, struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params, struct snd_sof_platform_stream_params *platform_params); int (*hw_free)(struct snd_soc_component *component, struct snd_pcm_substream *substream); int (*trigger)(struct snd_soc_component *component, struct snd_pcm_substream *substream, int cmd); int (*dai_link_fixup)(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params); int (*pcm_setup)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm); void (*pcm_free)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm); int (*pointer)(struct snd_soc_component *component, struct snd_pcm_substream *substream, snd_pcm_uframes_t *pointer); snd_pcm_sframes_t (*delay)(struct snd_soc_component *component, struct snd_pcm_substream *substream); bool reset_hw_params_during_stop; bool ipc_first_on_start; bool platform_stop_during_hw_free; bool d0i3_supported_in_s0ix; }; /** * struct sof_ipc_tplg_control_ops - IPC-specific ops for topology kcontrol IO */ struct sof_ipc_tplg_control_ops { bool (*volume_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*volume_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); bool (*switch_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*switch_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); bool (*enum_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*enum_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol); int (*bytes_ext_get)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); int (*bytes_ext_volatile_get)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); int (*bytes_ext_put)(struct snd_sof_control *scontrol, const unsigned int __user *binary_data, unsigned int size); /* update control data based on notification from the DSP */ void (*update)(struct snd_sof_dev *sdev, void *ipc_control_message); /* Optional callback to setup kcontrols associated with an swidget */ int (*widget_kcontrol_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); /* mandatory callback to set up volume table for volume kcontrols */ int (*set_up_volume_table)(struct snd_sof_control *scontrol, int tlv[SOF_TLV_ITEMS], int size); }; /** * struct sof_ipc_tplg_widget_ops - IPC-specific ops for topology widgets * @ipc_setup: Function pointer for setting up widget IPC params * @ipc_free: Function pointer for freeing widget IPC params * @token_list: List of token ID's that should be parsed for the widget * @token_list_size: number of elements in token_list * @bind_event: Function pointer for binding events to the widget * @ipc_prepare: Optional op for preparing a widget for set up * @ipc_unprepare: Optional op for unpreparing a widget */ struct sof_ipc_tplg_widget_ops { int (*ipc_setup)(struct snd_sof_widget *swidget); void (*ipc_free)(struct snd_sof_widget *swidget); enum sof_tokens *token_list; int token_list_size; int (*bind_event)(struct snd_soc_component *scomp, struct snd_sof_widget *swidget, u16 event_type); int (*ipc_prepare)(struct snd_sof_widget *swidget, struct snd_pcm_hw_params *fe_params, struct snd_sof_platform_stream_params *platform_params, struct snd_pcm_hw_params *source_params, int dir); void (*ipc_unprepare)(struct snd_sof_widget *swidget); }; /** * struct sof_ipc_tplg_ops - IPC-specific topology ops * @widget: Array of pointers to IPC-specific ops for widgets. This should always be of size * SND_SOF_DAPM_TYPE_COUNT i.e one per widget type. Unsupported widget types will be * initialized to 0. * @control: Pointer to the IPC-specific ops for topology kcontrol IO * @route_setup: Function pointer for setting up pipeline connections * @route_free: Function pointer for freeing pipeline connections. * @token_list: List of all tokens supported by the IPC version. The size of the token_list * array should be SOF_TOKEN_COUNT. The unused elements in the array will be * initialized to 0. * @control_setup: Function pointer for setting up kcontrol IPC-specific data * @control_free: Function pointer for freeing kcontrol IPC-specific data * @pipeline_complete: Function pointer for pipeline complete IPC * @widget_setup: Function pointer for setting up setup in the DSP * @widget_free: Function pointer for freeing widget in the DSP * @dai_config: Function pointer for sending DAI config IPC to the DSP * @host_config: Function pointer for setting the DMA ID for host widgets * @dai_get_param: Function pointer for getting the DAI parameter * @set_up_all_pipelines: Function pointer for setting up all topology pipelines * @tear_down_all_pipelines: Function pointer for tearing down all topology pipelines * @parse_manifest: Function pointer for ipc4 specific parsing of topology manifest * @link_setup: Function pointer for IPC-specific DAI link set up * * Note: function pointers (ops) are optional */ struct sof_ipc_tplg_ops { const struct sof_ipc_tplg_widget_ops *widget; const struct sof_ipc_tplg_control_ops *control; int (*route_setup)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute); int (*route_free)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute); const struct sof_token_info *token_list; int (*control_setup)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol); int (*control_free)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol); int (*pipeline_complete)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*widget_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*widget_free)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget); int (*dai_config)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget, unsigned int flags, struct snd_sof_dai_config_data *data); void (*host_config)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget, struct snd_sof_platform_stream_params *platform_params); int (*dai_get_param)(struct snd_sof_dev *sdev, struct snd_sof_dai *dai, int param_type); int (*set_up_all_pipelines)(struct snd_sof_dev *sdev, bool verify); int (*tear_down_all_pipelines)(struct snd_sof_dev *sdev, bool verify); int (*parse_manifest)(struct snd_soc_component *scomp, int index, struct snd_soc_tplg_manifest *man); int (*link_setup)(struct snd_sof_dev *sdev, struct snd_soc_dai_link *link); }; /** struct snd_sof_tuple - Tuple info * @token: Token ID * @value: union of a string or a u32 values */ struct snd_sof_tuple { u32 token; union { u32 v; const char *s; } value; }; /* * List of SOF token ID's. The order of ID's does not matter as token arrays are looked up based on * the ID. */ enum sof_tokens { SOF_PCM_TOKENS, SOF_PIPELINE_TOKENS, SOF_SCHED_TOKENS, SOF_ASRC_TOKENS, SOF_SRC_TOKENS, SOF_COMP_TOKENS, SOF_BUFFER_TOKENS, SOF_VOLUME_TOKENS, SOF_PROCESS_TOKENS, SOF_DAI_TOKENS, SOF_DAI_LINK_TOKENS, SOF_HDA_TOKENS, SOF_SSP_TOKENS, SOF_ALH_TOKENS, SOF_DMIC_TOKENS, SOF_DMIC_PDM_TOKENS, SOF_ESAI_TOKENS, SOF_SAI_TOKENS, SOF_AFE_TOKENS, SOF_CORE_TOKENS, SOF_COMP_EXT_TOKENS, SOF_IN_AUDIO_FORMAT_TOKENS, SOF_OUT_AUDIO_FORMAT_TOKENS, SOF_COPIER_DEEP_BUFFER_TOKENS, SOF_COPIER_TOKENS, SOF_AUDIO_FMT_NUM_TOKENS, SOF_COPIER_FORMAT_TOKENS, SOF_GAIN_TOKENS, SOF_ACPDMIC_TOKENS, SOF_ACPI2S_TOKENS, SOF_MICFIL_TOKENS, SOF_ACP_SDW_TOKENS, /* this should be the last */ SOF_TOKEN_COUNT, }; /** * struct sof_topology_token - SOF topology token definition * @token: Token number * @type: Token type * @get_token: Function pointer to parse the token value and save it in a object * @offset: Offset within an object to save the token value into */ struct sof_topology_token { u32 token; u32 type; int (*get_token)(void *elem, void *object, u32 offset); u32 offset; }; struct sof_token_info { const char *name; const struct sof_topology_token *tokens; int count; }; /** * struct snd_sof_pcm_stream_pipeline_list - List of pipelines associated with a PCM stream * @pipelines: array of pipelines * @count: number of pipeline widgets in the @pipe_widgets array */ struct snd_sof_pcm_stream_pipeline_list { struct snd_sof_pipeline **pipelines; u32 count; }; /* PCM stream, mapped to FW component */ struct snd_sof_pcm_stream { u32 comp_id; struct snd_dma_buffer page_table; struct sof_ipc_stream_posn posn; struct snd_pcm_substream *substream; struct snd_compr_stream *cstream; struct work_struct period_elapsed_work; struct snd_soc_dapm_widget_list *list; /* list of connected DAPM widgets */ bool d0i3_compatible; /* DSP can be in D0I3 when this pcm is opened */ bool pause_supported; /* PCM device supports PAUSE operation */ unsigned int dsp_max_burst_size_in_ms; /* The maximum size of the host DMA burst in ms */ /* * flag to indicate that the DSP pipelines should be kept * active or not while suspending the stream */ bool suspend_ignored; struct snd_sof_pcm_stream_pipeline_list pipeline_list; /* used by IPC implementation and core does not touch it */ void *private; }; /* ALSA SOF PCM device */ struct snd_sof_pcm { struct snd_soc_component *scomp; struct snd_sof_pcm_stream stream[2]; struct list_head list; /* list in sdev pcm list */ struct snd_pcm_hw_params params[2]; struct snd_sof_platform_stream_params platform_params[2]; bool prepared[2]; /* PCM_PARAMS set successfully */ bool setup_done[2]; /* the setup of the SOF PCM device is done */ bool pending_stop[2]; /* only used if (!pcm_ops->platform_stop_during_hw_free) */ /* Must be last - ends in a flex-array member. */ struct snd_soc_tplg_pcm pcm; }; struct snd_sof_led_control { unsigned int use_led; unsigned int direction; int led_value; }; /* ALSA SOF Kcontrol device */ struct snd_sof_control { struct snd_soc_component *scomp; const char *name; int comp_id; int min_volume_step; /* min volume step for volume_table */ int max_volume_step; /* max volume step for volume_table */ int num_channels; unsigned int access; int info_type; int index; /* pipeline ID */ void *priv; /* private data copied from topology */ size_t priv_size; /* size of private data */ size_t max_size; void *ipc_control_data; void *old_ipc_control_data; int max; /* applicable to volume controls */ u32 size; /* cdata size */ u32 *volume_table; /* volume table computed from tlv data*/ struct list_head list; /* list in sdev control list */ struct snd_sof_led_control led_ctl; /* if true, the control's data needs to be updated from Firmware */ bool comp_data_dirty; }; /** struct snd_sof_dai_link - DAI link info * @tuples: array of parsed tuples * @num_tuples: number of tuples in the tuples array * @link: Pointer to snd_soc_dai_link * @hw_configs: Pointer to hw configs in topology * @num_hw_configs: Number of hw configs in topology * @default_hw_cfg_id: Default hw config ID * @type: DAI type * @list: item in snd_sof_dev dai_link list */ struct snd_sof_dai_link { struct snd_sof_tuple *tuples; int num_tuples; struct snd_soc_dai_link *link; int num_hw_configs; int default_hw_cfg_id; int type; struct list_head list; struct snd_soc_tplg_hw_config hw_configs[] __counted_by(num_hw_configs); }; /* ASoC SOF DAPM widget */ struct snd_sof_widget { struct snd_soc_component *scomp; int comp_id; int pipeline_id; /* * the prepared flag is used to indicate that a widget has been prepared for getting set * up in the DSP. */ bool prepared; struct mutex setup_mutex; /* to protect the swidget setup and free operations */ /* * use_count is protected by the PCM mutex held by the core and the * setup_mutex against non stream domain races (kcontrol access for * example) */ int use_count; int core; int id; /* id is the DAPM widget type */ /* * Instance ID is set dynamically when the widget gets set up in the FW. It should be * unique for each module type across all pipelines. This will not be used in SOF_IPC. */ int instance_id; /* * Flag indicating if the widget should be set up dynamically when a PCM is opened. * This flag is only set for the scheduler type widget in topology. During topology * loading, this flag is propagated to all the widgets belonging to the same pipeline. * When this flag is not set, a widget is set up at the time of topology loading * and retained until the DSP enters D3. It will need to be set up again when resuming * from D3. */ bool dynamic_pipeline_widget; /* Scheduling domain (enum sof_comp_domain), unset, Low Latency, or Data Processing */ u32 comp_domain; /* Module instance's memory configuration. */ u32 domain_id; /* Module instance's userspace domain ID */ u32 stack_bytes; /* Module instance's stack size requirement */ u32 heap_bytes; /* Module instance's heap size requirement */ struct snd_soc_dapm_widget *widget; struct list_head list; /* list in sdev widget list */ struct snd_sof_pipeline *spipe; void *module_info; const guid_t uuid; int num_tuples; struct snd_sof_tuple *tuples; /* * The allowed range for num_input/output_pins is [0, SOF_WIDGET_MAX_NUM_PINS]. * Widgets may have zero input or output pins, for example the tone widget has * zero input pins. */ u32 num_input_pins; u32 num_output_pins; /* * The input/output pin binding array, it takes the form of * [widget_name_connected_to_pin0, widget_name_connected_to_pin1, ...], * with the index as the queue ID. * * The array is used for special pin binding. Note that even if there * is only one input/output pin requires special pin binding, pin binding * should be defined for all input/output pins in topology, for pin(s) that * are not used, give the value "NotConnected". * * If pin binding is not defined in topology, nothing to parse in the kernel, * input_pin_binding and output_pin_binding shall be NULL. */ char **input_pin_binding; char **output_pin_binding;