123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538 |
- /* 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. All rights reserved.
- *
- * Author: Ranjani Sridharan <[email protected]>
- */
- #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"
- /* 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 SOF_DAI_CLK_INTEL_SSP_MCLK 0
- #define SOF_DAI_CLK_INTEL_SSP_BCLK 1
- 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_dai_config_data {
- int dai_index;
- int dai_data; /* contains DAI-specific information */
- };
- /**
- * 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
- */
- 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);
- };
- /**
- * 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: Optional op 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
- * @dai_get_clk: Function pointer for getting the DAI clock setting
- * @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: Optional function pointer for ipc4 specific parsing of topology manifest
- */
- 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);
- int (*dai_get_clk)(struct snd_sof_dev *sdev, struct snd_sof_dai *dai, int clk_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);
- };
- /** 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_AUDIO_FORMAT_BUFFER_SIZE_TOKENS,
- SOF_COPIER_GATEWAY_CFG_TOKENS,
- SOF_COPIER_TOKENS,
- SOF_AUDIO_FMT_NUM_TOKENS,
- SOF_COPIER_FORMAT_TOKENS,
- SOF_GAIN_TOKENS,
- SOF_ACPDMIC_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;
- };
- /* 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 */
- /*
- * flag to indicate that the DSP pipelines should be kept
- * active or not while suspending the stream
- */
- bool suspend_ignored;
- };
- /* ALSA SOF PCM device */
- struct snd_sof_pcm {
- struct snd_soc_component *scomp;
- struct snd_soc_tplg_pcm pcm;
- struct snd_sof_pcm_stream stream[2];
- struct list_head list; /* list in sdev pcm list */
- struct snd_pcm_hw_params params[2];
- bool prepared[2]; /* PCM_PARAMS set successfully */
- };
- 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;
- 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;
- struct snd_soc_tplg_hw_config *hw_configs;
- int num_hw_configs;
- int default_hw_cfg_id;
- int type;
- struct list_head list;
- };
- /* ASoC SOF DAPM widget */
- struct snd_sof_widget {
- struct snd_soc_component *scomp;
- int comp_id;
- int pipeline_id;
- /*
- * complete flag is used to indicate that pipeline set up is complete for scheduler type
- * widgets. It is unused for all other widget types.
- */
- int complete;
- /*
- * the prepared flag is used to indicate that a widget has been prepared for getting set
- * up in the DSP.
- */
- bool prepared;
- int use_count; /* use_count will be protected by the PCM mutex held by the core */
- 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;
- struct snd_soc_dapm_widget *widget;
- struct list_head list; /* list in sdev widget list */
- struct snd_sof_widget *pipe_widget;
- void *module_info;
- const guid_t uuid;
- int num_tuples;
- struct snd_sof_tuple *tuples;
- void *private; /* core does not touch this */
- };
- /* ASoC SOF DAPM route */
- struct snd_sof_route {
- struct snd_soc_component *scomp;
- struct snd_soc_dapm_route *route;
- struct list_head list; /* list in sdev route list */
- struct snd_sof_widget *src_widget;
- struct snd_sof_widget *sink_widget;
- bool setup;
- void *private;
- };
- /* ASoC DAI device */
- struct snd_sof_dai {
- struct snd_soc_component *scomp;
- const char *name;
- int number_configs;
- int current_config;
- struct list_head list; /* list in sdev dai list */
- void *private;
- };
- /*
- * Kcontrols.
- */
- int snd_sof_volume_get(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_volume_put(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_volume_info(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_info *uinfo);
- int snd_sof_switch_get(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_switch_put(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_enum_get(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_enum_put(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_bytes_get(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_bytes_put(struct snd_kcontrol *kcontrol,
- struct snd_ctl_elem_value *ucontrol);
- int snd_sof_bytes_ext_put(struct snd_kcontrol *kcontrol,
- const unsigned int __user *binary_data,
- unsigned int size);
- int snd_sof_bytes_ext_get(struct snd_kcontrol *kcontrol,
- unsigned int __user *binary_data,
- unsigned int size);
- int snd_sof_bytes_ext_volatile_get(struct snd_kcontrol *kcontrol, unsigned int __user *binary_data,
- unsigned int size);
- void snd_sof_control_notify(struct snd_sof_dev *sdev,
- struct sof_ipc_ctrl_data *cdata);
- /*
- * Topology.
- * There is no snd_sof_free_topology since topology components will
- * be freed by snd_soc_unregister_component,
- */
- int snd_sof_load_topology(struct snd_soc_component *scomp, const char *file);
- /*
- * Stream IPC
- */
- int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
- struct snd_sof_pcm *spcm, int direction,
- struct sof_ipc_stream_posn *posn);
- struct snd_sof_widget *snd_sof_find_swidget(struct snd_soc_component *scomp,
- const char *name);
- struct snd_sof_widget *
- snd_sof_find_swidget_sname(struct snd_soc_component *scomp,
- const char *pcm_name, int dir);
- struct snd_sof_dai *snd_sof_find_dai(struct snd_soc_component *scomp,
- const char *name);
- static inline
- struct snd_sof_pcm *snd_sof_find_spcm_dai(struct snd_soc_component *scomp,
- struct snd_soc_pcm_runtime *rtd)
- {
- struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
- struct snd_sof_pcm *spcm;
- list_for_each_entry(spcm, &sdev->pcm_list, list) {
- if (le32_to_cpu(spcm->pcm.dai_id) == rtd->dai_link->id)
- return spcm;
- }
- return NULL;
- }
- struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_soc_component *scomp,
- const char *name);
- struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_soc_component *scomp,
- unsigned int comp_id,
- int *direction);
- void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream);
- void snd_sof_pcm_init_elapsed_work(struct work_struct *work);
- #if IS_ENABLED(CONFIG_SND_SOC_SOF_COMPRESS)
- void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream);
- void snd_sof_compr_init_elapsed_work(struct work_struct *work);
- #else
- static inline void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream) { }
- static inline void snd_sof_compr_init_elapsed_work(struct work_struct *work) { }
- #endif
- /* DAI link fixup */
- int sof_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params);
- /* PM */
- bool snd_sof_stream_suspend_ignored(struct snd_sof_dev *sdev);
- bool snd_sof_dsp_only_d0i3_compatible_stream_active(struct snd_sof_dev *sdev);
- /* Machine driver enumeration */
- int sof_machine_register(struct snd_sof_dev *sdev, void *pdata);
- void sof_machine_unregister(struct snd_sof_dev *sdev, void *pdata);
- int sof_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
- int sof_widget_free(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
- int sof_route_setup(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *wsource,
- struct snd_soc_dapm_widget *wsink);
- /* PCM */
- int sof_widget_list_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
- struct snd_pcm_hw_params *fe_params,
- struct snd_sof_platform_stream_params *platform_params,
- int dir);
- int sof_widget_list_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm, int dir);
- int sof_pcm_dsp_pcm_free(struct snd_pcm_substream *substream, struct snd_sof_dev *sdev,
- struct snd_sof_pcm *spcm);
- int sof_pcm_stream_free(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream,
- struct snd_sof_pcm *spcm, int dir, bool free_widget_list);
- int get_token_u32(void *elem, void *object, u32 offset);
- int get_token_u16(void *elem, void *object, u32 offset);
- int get_token_comp_format(void *elem, void *object, u32 offset);
- int get_token_dai_type(void *elem, void *object, u32 offset);
- int get_token_uuid(void *elem, void *object, u32 offset);
- int sof_update_ipc_object(struct snd_soc_component *scomp, void *object, enum sof_tokens token_id,
- struct snd_sof_tuple *tuples, int num_tuples,
- size_t object_size, int token_instance_num);
- u32 vol_compute_gain(u32 value, int *tlv);
- #endif
|