sof-audio.h

  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) 2019 Intel Corporation
  7 *
  8 * Author: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
  9 */
 10
 11#ifndef __SOUND_SOC_SOF_AUDIO_H
 12#define __SOUND_SOC_SOF_AUDIO_H
 13
 14#include <linux/workqueue.h>
 15
 16#include <sound/soc.h>
 17#include <sound/control.h>
 18#include <sound/sof/stream.h> /* needs to be included before control.h */
 19#include <sound/sof/control.h>
 20#include <sound/sof/dai.h>
 21#include <sound/sof/topology.h>
 22#include "sof-priv.h"
 23
 24#define SOF_AUDIO_PCM_DRV_NAME	"sof-audio-component"
 25
 26/*
 27 * The ipc4 firmware only supports up to 8 sink or source pins
 28 * per widget, because only 3 bits are used for queue(pin) ID
 29 * in ipc4 protocol.
 30 */
 31#define SOF_WIDGET_MAX_NUM_PINS	8
 32
 33/* Widget pin type */
 34#define SOF_PIN_TYPE_INPUT	0
 35#define SOF_PIN_TYPE_OUTPUT	1
 36
 37/* max number of FE PCMs before BEs */
 38#define SOF_BE_PCM_BASE		16
 39
 40#define DMA_CHAN_INVALID	0xFFFFFFFF
 41
 42#define WIDGET_IS_DAI(id) ((id) == snd_soc_dapm_dai_in || (id) == snd_soc_dapm_dai_out)
 43#define WIDGET_IS_AIF(id) ((id) == snd_soc_dapm_aif_in || (id) == snd_soc_dapm_aif_out)
 44#define WIDGET_IS_AIF_OR_DAI(id) (WIDGET_IS_DAI(id) || WIDGET_IS_AIF(id))
 45#define WIDGET_IS_COPIER(id) (WIDGET_IS_AIF_OR_DAI(id) || (id) == snd_soc_dapm_buffer)
 46
 47#define SOF_DAI_PARAM_INTEL_SSP_MCLK		0
 48#define SOF_DAI_PARAM_INTEL_SSP_BCLK		1
 49#define SOF_DAI_PARAM_INTEL_SSP_TDM_SLOTS	2
 50
 51enum sof_widget_op {
 52	SOF_WIDGET_PREPARE,
 53	SOF_WIDGET_SETUP,
 54	SOF_WIDGET_FREE,
 55	SOF_WIDGET_UNPREPARE,
 56};
 57
 58/*
 59 * Volume fractional word length define to 16 sets
 60 * the volume linear gain value to use Qx.16 format
 61 */
 62#define VOLUME_FWL	16
 63
 64#define SOF_TLV_ITEMS 3
 65
 66static inline u32 mixer_to_ipc(unsigned int value, u32 *volume_map, int size)
 67{
 68	if (value >= size)
 69		return volume_map[size - 1];
 70
 71	return volume_map[value];
 72}
 73
 74static inline u32 ipc_to_mixer(u32 value, u32 *volume_map, int size)
 75{
 76	int i;
 77
 78	for (i = 0; i < size; i++) {
 79		if (volume_map[i] >= value)
 80			return i;
 81	}
 82
 83	return i - 1;
 84}
 85
 86struct snd_sof_widget;
 87struct snd_sof_route;
 88struct snd_sof_control;
 89struct snd_sof_dai;
 90struct snd_sof_pcm;
 91
 92struct snd_sof_dai_config_data {
 93	int dai_index;
 94	int dai_data; /* contains DAI-specific information */
 95	int dai_node_id; /* contains DAI-specific information for Gateway configuration */
 96};
 97
 98/**
 99 * struct sof_ipc_pcm_ops - IPC-specific PCM ops
100 * @hw_params: Function pointer for hw_params
101 * @hw_free: Function pointer for hw_free
102 * @trigger: Function pointer for trigger
103 * @dai_link_fixup: Function pointer for DAI link fixup
104 * @pcm_setup: Function pointer for IPC-specific PCM set up that can be used for allocating
105 *	       additional memory in the SOF PCM stream structure
106 * @pcm_free: Function pointer for PCM free that can be used for freeing any
107 *	       additional memory in the SOF PCM stream structure
108 * @pointer: Function pointer for pcm pointer
109 *	     Note: the @pointer callback may return -EOPNOTSUPP which should be
110 *		   handled in a same way as if the callback is not provided
111 * @delay: Function pointer for pcm delay reporting
112 * @reset_hw_params_during_stop: Flag indicating whether the hw_params should be reset during the
113 *				 STOP pcm trigger
114 * @ipc_first_on_start: Send IPC before invoking platform trigger during
115 *				START/PAUSE_RELEASE triggers
116 * @platform_stop_during_hw_free: Invoke the platform trigger during hw_free. This is needed for
117 *				  IPC4 where a pipeline is only paused during stop/pause/suspend
118 *				  triggers. The FW keeps the host DMA running in this case and
119 *				  therefore the host must do the same and should stop the DMA during
120 *				  hw_free.
121 * @d0i3_supported_in_s0ix: Allow DSP D0I3 during S0iX
122 */
123struct sof_ipc_pcm_ops {
124	int (*hw_params)(struct snd_soc_component *component, struct snd_pcm_substream *substream,
125			 struct snd_pcm_hw_params *params,
126			 struct snd_sof_platform_stream_params *platform_params);
127	int (*hw_free)(struct snd_soc_component *component, struct snd_pcm_substream *substream);
128	int (*trigger)(struct snd_soc_component *component,  struct snd_pcm_substream *substream,
129		       int cmd);
130	int (*dai_link_fixup)(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params);
131	int (*pcm_setup)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm);
132	void (*pcm_free)(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm);
133	int (*pointer)(struct snd_soc_component *component,
134		       struct snd_pcm_substream *substream,
135		       snd_pcm_uframes_t *pointer);
136	snd_pcm_sframes_t (*delay)(struct snd_soc_component *component,
137				   struct snd_pcm_substream *substream);
138	bool reset_hw_params_during_stop;
139	bool ipc_first_on_start;
140	bool platform_stop_during_hw_free;
141	bool d0i3_supported_in_s0ix;
142};
143
144/**
145 * struct sof_ipc_tplg_control_ops - IPC-specific ops for topology kcontrol IO
146 */
147struct sof_ipc_tplg_control_ops {
148	bool (*volume_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
149	int (*volume_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
150	bool (*switch_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
151	int (*switch_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
152	bool (*enum_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
153	int (*enum_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
154	int (*bytes_put)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
155	int (*bytes_get)(struct snd_sof_control *scontrol, struct snd_ctl_elem_value *ucontrol);
156	int (*bytes_ext_get)(struct snd_sof_control *scontrol,
157			     const unsigned int __user *binary_data, unsigned int size);
158	int (*bytes_ext_volatile_get)(struct snd_sof_control *scontrol,
159				      const unsigned int __user *binary_data, unsigned int size);
160	int (*bytes_ext_put)(struct snd_sof_control *scontrol,
161			     const unsigned int __user *binary_data, unsigned int size);
162	/* update control data based on notification from the DSP */
163	void (*update)(struct snd_sof_dev *sdev, void *ipc_control_message);
164	/* Optional callback to setup kcontrols associated with an swidget */
165	int (*widget_kcontrol_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
166	/* mandatory callback to set up volume table for volume kcontrols */
167	int (*set_up_volume_table)(struct snd_sof_control *scontrol, int tlv[SOF_TLV_ITEMS],
168				   int size);
169};
170
171/**
172 * struct sof_ipc_tplg_widget_ops - IPC-specific ops for topology widgets
173 * @ipc_setup: Function pointer for setting up widget IPC params
174 * @ipc_free: Function pointer for freeing widget IPC params
175 * @token_list: List of token ID's that should be parsed for the widget
176 * @token_list_size: number of elements in token_list
177 * @bind_event: Function pointer for binding events to the widget
178 * @ipc_prepare: Optional op for preparing a widget for set up
179 * @ipc_unprepare: Optional op for unpreparing a widget
180 */
181struct sof_ipc_tplg_widget_ops {
182	int (*ipc_setup)(struct snd_sof_widget *swidget);
183	void (*ipc_free)(struct snd_sof_widget *swidget);
184	enum sof_tokens *token_list;
185	int token_list_size;
186	int (*bind_event)(struct snd_soc_component *scomp, struct snd_sof_widget *swidget,
187			  u16 event_type);
188	int (*ipc_prepare)(struct snd_sof_widget *swidget,
189			   struct snd_pcm_hw_params *fe_params,
190			   struct snd_sof_platform_stream_params *platform_params,
191			   struct snd_pcm_hw_params *source_params, int dir);
192	void (*ipc_unprepare)(struct snd_sof_widget *swidget);
193};
194
195/**
196 * struct sof_ipc_tplg_ops - IPC-specific topology ops
197 * @widget: Array of pointers to IPC-specific ops for widgets. This should always be of size
198 *	    SND_SOF_DAPM_TYPE_COUNT i.e one per widget type. Unsupported widget types will be
199 *	    initialized to 0.
200 * @control: Pointer to the IPC-specific ops for topology kcontrol IO
201 * @route_setup: Function pointer for setting up pipeline connections
202 * @route_free: Function pointer for freeing pipeline connections.
203 * @token_list: List of all tokens supported by the IPC version. The size of the token_list
204 *		array should be SOF_TOKEN_COUNT. The unused elements in the array will be
205 *		initialized to 0.
206 * @control_setup: Function pointer for setting up kcontrol IPC-specific data
207 * @control_free: Function pointer for freeing kcontrol IPC-specific data
208 * @pipeline_complete: Function pointer for pipeline complete IPC
209 * @widget_setup: Function pointer for setting up setup in the DSP
210 * @widget_free: Function pointer for freeing widget in the DSP
211 * @dai_config: Function pointer for sending DAI config IPC to the DSP
212 * @dai_get_param: Function pointer for getting the DAI parameter
213 * @set_up_all_pipelines: Function pointer for setting up all topology pipelines
214 * @tear_down_all_pipelines: Function pointer for tearing down all topology pipelines
215 * @parse_manifest: Function pointer for ipc4 specific parsing of topology manifest
216 * @link_setup: Function pointer for IPC-specific DAI link set up
217 *
218 * Note: function pointers (ops) are optional
219 */
220struct sof_ipc_tplg_ops {
221	const struct sof_ipc_tplg_widget_ops *widget;
222	const struct sof_ipc_tplg_control_ops *control;
223	int (*route_setup)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute);
224	int (*route_free)(struct snd_sof_dev *sdev, struct snd_sof_route *sroute);
225	const struct sof_token_info *token_list;
226	int (*control_setup)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol);
227	int (*control_free)(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol);
228	int (*pipeline_complete)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
229	int (*widget_setup)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
230	int (*widget_free)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
231	int (*dai_config)(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget,
232			  unsigned int flags, struct snd_sof_dai_config_data *data);
233	int (*dai_get_param)(struct snd_sof_dev *sdev, struct snd_sof_dai *dai, int param_type);
234	int (*set_up_all_pipelines)(struct snd_sof_dev *sdev, bool verify);
235	int (*tear_down_all_pipelines)(struct snd_sof_dev *sdev, bool verify);
236	int (*parse_manifest)(struct snd_soc_component *scomp, int index,
237			      struct snd_soc_tplg_manifest *man);
238	int (*link_setup)(struct snd_sof_dev *sdev, struct snd_soc_dai_link *link);
239};
240
241/** struct snd_sof_tuple - Tuple info
242 * @token:	Token ID
243 * @value:	union of a string or a u32 values
244 */
245struct snd_sof_tuple {
246	u32 token;
247	union {
248		u32 v;
249		const char *s;
250	} value;
251};
252
253/*
254 * List of SOF token ID's. The order of ID's does not matter as token arrays are looked up based on
255 * the ID.
256 */
257enum sof_tokens {
258	SOF_PCM_TOKENS,
259	SOF_PIPELINE_TOKENS,
260	SOF_SCHED_TOKENS,
261	SOF_ASRC_TOKENS,
262	SOF_SRC_TOKENS,
263	SOF_COMP_TOKENS,
264	SOF_BUFFER_TOKENS,
265	SOF_VOLUME_TOKENS,
266	SOF_PROCESS_TOKENS,
267	SOF_DAI_TOKENS,
268	SOF_DAI_LINK_TOKENS,
269	SOF_HDA_TOKENS,
270	SOF_SSP_TOKENS,
271	SOF_ALH_TOKENS,
272	SOF_DMIC_TOKENS,
273	SOF_DMIC_PDM_TOKENS,
274	SOF_ESAI_TOKENS,
275	SOF_SAI_TOKENS,
276	SOF_AFE_TOKENS,
277	SOF_CORE_TOKENS,
278	SOF_COMP_EXT_TOKENS,
279	SOF_IN_AUDIO_FORMAT_TOKENS,
280	SOF_OUT_AUDIO_FORMAT_TOKENS,
281	SOF_COPIER_DEEP_BUFFER_TOKENS,
282	SOF_COPIER_TOKENS,
283	SOF_AUDIO_FMT_NUM_TOKENS,
284	SOF_COPIER_FORMAT_TOKENS,
285	SOF_GAIN_TOKENS,
286	SOF_ACPDMIC_TOKENS,
287	SOF_ACPI2S_TOKENS,
288	SOF_MICFIL_TOKENS,
289	SOF_ACP_SDW_TOKENS,
290
291	/* this should be the last */
292	SOF_TOKEN_COUNT,
293};
294
295/**
296 * struct sof_topology_token - SOF topology token definition
297 * @token:		Token number
298 * @type:		Token type
299 * @get_token:		Function pointer to parse the token value and save it in a object
300 * @offset:		Offset within an object to save the token value into
301 */
302struct sof_topology_token {
303	u32 token;
304	u32 type;
305	int (*get_token)(void *elem, void *object, u32 offset);
306	u32 offset;
307};
308
309struct sof_token_info {
310	const char *name;
311	const struct sof_topology_token *tokens;
312	int count;
313};
314
315/**
316 * struct snd_sof_pcm_stream_pipeline_list - List of pipelines associated with a PCM stream
317 * @pipelines: array of pipelines
318 * @count: number of pipeline widgets in the @pipe_widgets array
319 */
320struct snd_sof_pcm_stream_pipeline_list {
321	struct snd_sof_pipeline **pipelines;
322	u32 count;
323};
324
325/* PCM stream, mapped to FW component  */
326struct snd_sof_pcm_stream {
327	u32 comp_id;
328	struct snd_dma_buffer page_table;
329	struct sof_ipc_stream_posn posn;
330	struct snd_pcm_substream *substream;
331	struct snd_compr_stream *cstream;
332	struct work_struct period_elapsed_work;
333	struct snd_soc_dapm_widget_list *list; /* list of connected DAPM widgets */
334	bool d0i3_compatible; /* DSP can be in D0I3 when this pcm is opened */
335	bool pause_supported; /* PCM device supports PAUSE operation */
336	unsigned int dsp_max_burst_size_in_ms; /* The maximum size of the host DMA burst in ms */
337	/*
338	 * flag to indicate that the DSP pipelines should be kept
339	 * active or not while suspending the stream
340	 */
341	bool suspend_ignored;
342	struct snd_sof_pcm_stream_pipeline_list pipeline_list;
343
344	/* used by IPC implementation and core does not touch it */
345	void *private;
346};
347
348/* ALSA SOF PCM device */
349struct snd_sof_pcm {
350	struct snd_soc_component *scomp;
351	struct snd_sof_pcm_stream stream[2];
352	struct list_head list;	/* list in sdev pcm list */
353	struct snd_pcm_hw_params params[2];
354	bool prepared[2]; /* PCM_PARAMS set successfully */
355	bool pending_stop[2]; /* only used if (!pcm_ops->platform_stop_during_hw_free) */
356
357	/* Must be last - ends in a flex-array member. */
358	struct snd_soc_tplg_pcm pcm;
359};
360
361struct snd_sof_led_control {
362	unsigned int use_led;
363	unsigned int direction;
364	int led_value;
365};
366
367/* ALSA SOF Kcontrol device */
368struct snd_sof_control {
369	struct snd_soc_component *scomp;
370	const char *name;
371	int comp_id;
372	int min_volume_step; /* min volume step for volume_table */
373	int max_volume_step; /* max volume step for volume_table */
374	int num_channels;
375	unsigned int access;
376	int info_type;
377	int index; /* pipeline ID */
378	void *priv; /* private data copied from topology */
379	size_t priv_size; /* size of private data */
380	size_t max_size;
381	void *ipc_control_data;
382	void *old_ipc_control_data;
383	int max; /* applicable to volume controls */
384	u32 size;	/* cdata size */
385	u32 *volume_table; /* volume table computed from tlv data*/
386
387	struct list_head list;	/* list in sdev control list */
388
389	struct snd_sof_led_control led_ctl;
390
391	/* if true, the control's data needs to be updated from Firmware */
392	bool comp_data_dirty;
393};
394
395/** struct snd_sof_dai_link - DAI link info
396 * @tuples: array of parsed tuples
397 * @num_tuples: number of tuples in the tuples array
398 * @link: Pointer to snd_soc_dai_link
399 * @hw_configs: Pointer to hw configs in topology
400 * @num_hw_configs: Number of hw configs in topology
401 * @default_hw_cfg_id: Default hw config ID
402 * @type: DAI type
403 * @list: item in snd_sof_dev dai_link list
404 */
405struct snd_sof_dai_link {
406	struct snd_sof_tuple *tuples;
407	int num_tuples;
408	struct snd_soc_dai_link *link;
409	struct snd_soc_tplg_hw_config *hw_configs;
410	int num_hw_configs;
411	int default_hw_cfg_id;
412	int type;
413	struct list_head list;
414};
415
416/* ASoC SOF DAPM widget */
417struct snd_sof_widget {
418	struct snd_soc_component *scomp;
419	int comp_id;
420	int pipeline_id;
421	/*
422	 * the prepared flag is used to indicate that a widget has been prepared for getting set
423	 * up in the DSP.
424	 */
425	bool prepared;
426
427	struct mutex setup_mutex; /* to protect the swidget setup and free operations */
428
429	/*
430	 * use_count is protected by the PCM mutex held by the core and the
431	 * setup_mutex against non stream domain races (kcontrol access for
432	 * example)
433	 */
434	int use_count;
435
436	int core;
437	int id; /* id is the DAPM widget type */
438	/*
439	 * Instance ID is set dynamically when the widget gets set up in the FW. It should be
440	 * unique for each module type across all pipelines. This will not be used in SOF_IPC.
441	 */
442	int instance_id;
443
444	/*
445	 * Flag indicating if the widget should be set up dynamically when a PCM is opened.
446	 * This flag is only set for the scheduler type widget in topology. During topology
447	 * loading, this flag is propagated to all the widgets belonging to the same pipeline.
448	 * When this flag is not set, a widget is set up at the time of topology loading
449	 * and retained until the DSP enters D3. It will need to be set up again when resuming
450	 * from D3.
451	 */
452	bool dynamic_pipeline_widget;
453
454	/* Scheduling domain (enum sof_comp_domain), unset, Low Latency, or Data Processing */
455	u32 comp_domain;
456
457	struct snd_soc_dapm_widget *widget;
458	struct list_head list;	/* list in sdev widget list */
459	struct snd_sof_pipeline *spipe;
460	void *module_info;
461
462	const guid_t uuid;
463
464	int num_tuples;
465	struct snd_sof_tuple *tuples;
466
467	/*
468	 * The allowed range for num_input/output_pins is [0, SOF_WIDGET_MAX_NUM_PINS].
469	 * Widgets may have zero input or output pins, for example the tone widget has
470	 * zero input pins.
471	 */
472	u32 num_input_pins;
473	u32 num_output_pins;
474
475	/*
476	 * The input/output pin binding array, it takes the form of
477	 * [widget_name_connected_to_pin0, widget_name_connected_to_pin1, ...],
478	 * with the index as the queue ID.
479	 *
480	 * The array is used for special pin binding. Note that even if there
481	 * is only one input/output pin requires special pin binding, pin binding
482	 * should be defined for all input/output pins in topology, for pin(s) that
483	 * are not used, give the value "NotConnected".
484	 *
485	 * If pin binding is not defined in topology, nothing to parse in the kernel,
486	 * input_pin_binding and output_pin_binding shall be NULL.
487	 */
488	char **input_pin_binding;
489	char **output_pin_binding;
490
491	struct ida output_queue_ida;
492	struct ida input_queue_ida;
493
494	void *private;		/* core does not touch this */
495};
496
497/** struct snd_sof_pipeline - ASoC SOF pipeline
498 * @pipe_widget: Pointer to the pipeline widget
499 * @started_count: Count of number of PCM's that have started this pipeline
500 * @paused_count: Count of number of PCM's that have started and have currently paused this
501		  pipeline
502 * @complete: flag used to indicate that pipeline set up is complete.
503 * @core_mask: Mask containing target cores for all modules in the pipeline
504 * @list: List item in sdev pipeline_list
505 */
506struct snd_sof_pipeline {
507	struct snd_sof_widget *pipe_widget;
508	int started_count;
509	int paused_count;
510	int complete;
511	unsigned long core_mask;
512	struct list_head list;
513};
514
515/* ASoC SOF DAPM route */
516struct snd_sof_route {
517	struct snd_soc_component *scomp;
518
519	struct snd_soc_dapm_route *route;
520	struct list_head list;	/* list in sdev route list */
521	struct snd_sof_widget *src_widget;
522	struct snd_sof_widget *sink_widget;
523	bool setup;
524
525	int src_queue_id;
526	int dst_queue_id;
527
528	void *private;
529};
530
531/* ASoC DAI device */
532struct snd_sof_dai {
533	struct snd_soc_component *scomp;
534	const char *name;
535	u32 type;
536
537	int number_configs;
538	int current_config;
539	struct list_head list;	/* list in sdev dai list */
540	/* core should not touch this */
541	const void *platform_private;
542	void *private;
543};
544
545/*
546 * Kcontrols.
547 */
548
549int snd_sof_volume_get(struct snd_kcontrol *kcontrol,
550		       struct snd_ctl_elem_value *ucontrol);
551int snd_sof_volume_put(struct snd_kcontrol *kcontrol,
552		       struct snd_ctl_elem_value *ucontrol);
553int snd_sof_volume_info(struct snd_kcontrol *kcontrol,
554			struct snd_ctl_elem_info *uinfo);
555int snd_sof_switch_get(struct snd_kcontrol *kcontrol,
556		       struct snd_ctl_elem_value *ucontrol);
557int snd_sof_switch_put(struct snd_kcontrol *kcontrol,
558		       struct snd_ctl_elem_value *ucontrol);
559int snd_sof_enum_get(struct snd_kcontrol *kcontrol,
560		     struct snd_ctl_elem_value *ucontrol);
561int snd_sof_enum_put(struct snd_kcontrol *kcontrol,
562		     struct snd_ctl_elem_value *ucontrol);
563int snd_sof_bytes_get(struct snd_kcontrol *kcontrol,
564		      struct snd_ctl_elem_value *ucontrol);
565int snd_sof_bytes_put(struct snd_kcontrol *kcontrol,
566		      struct snd_ctl_elem_value *ucontrol);
567int snd_sof_bytes_ext_put(struct snd_kcontrol *kcontrol,
568			  const unsigned int __user *binary_data,
569			  unsigned int size);
570int snd_sof_bytes_ext_get(struct snd_kcontrol *kcontrol,
571			  unsigned int __user *binary_data,
572			  unsigned int size);
573int snd_sof_bytes_ext_volatile_get(struct snd_kcontrol *kcontrol, unsigned int __user *binary_data,
574				   unsigned int size);
575void snd_sof_control_notify(struct snd_sof_dev *sdev,
576			    struct sof_ipc_ctrl_data *cdata);
577
578/*
579 * Topology.
580 * There is no snd_sof_free_topology since topology components will
581 * be freed by snd_soc_unregister_component,
582 */
583int snd_sof_load_topology(struct snd_soc_component *scomp, const char *file);
584
585/*
586 * Stream IPC
587 */
588int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
589			    struct snd_sof_pcm *spcm, int direction,
590			    struct sof_ipc_stream_posn *posn);
591
592struct snd_sof_widget *snd_sof_find_swidget(struct snd_soc_component *scomp,
593					    const char *name);
594struct snd_sof_widget *
595snd_sof_find_swidget_sname(struct snd_soc_component *scomp,
596			   const char *pcm_name, int dir);
597struct snd_sof_dai *snd_sof_find_dai(struct snd_soc_component *scomp,
598				     const char *name);
599
600static inline
601struct snd_sof_pcm *snd_sof_find_spcm_dai(struct snd_soc_component *scomp,
602					  struct snd_soc_pcm_runtime *rtd)
603{
604	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
605	struct snd_sof_pcm *spcm;
606
607	list_for_each_entry(spcm, &sdev->pcm_list, list) {
608		if (le32_to_cpu(spcm->pcm.dai_id) == rtd->dai_link->id)
609			return spcm;
610	}
611
612	return NULL;
613}
614
615struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_soc_component *scomp,
616					   const char *name);
617struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_soc_component *scomp,
618					   unsigned int comp_id,
619					   int *direction);
620void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream);
621void snd_sof_pcm_init_elapsed_work(struct work_struct *work);
622
623/*
624 * snd_sof_pcm specific wrappers for dev_dbg() and dev_err() to provide
625 * consistent and useful prints.
626 */
627#define spcm_dbg(__spcm, __dir, __fmt, ...)					\
628	dev_dbg((__spcm)->scomp->dev, "pcm%u (%s), dir %d: " __fmt,		\
629		(__spcm)->pcm.pcm_id, (__spcm)->pcm.pcm_name, __dir,		\
630		##__VA_ARGS__)
631
632#define spcm_dbg_ratelimited(__spcm, __dir, __fmt, ...)				\
633	dev_dbg_ratelimited((__spcm)->scomp->dev, "pcm%u (%s), dir %d: " __fmt,	\
634		(__spcm)->pcm.pcm_id, (__spcm)->pcm.pcm_name, __dir,		\
635		##__VA_ARGS__)
636
637#define spcm_err(__spcm, __dir, __fmt, ...)					\
638	dev_err((__spcm)->scomp->dev, "%s: pcm%u (%s), dir %d: " __fmt,		\
639		__func__, (__spcm)->pcm.pcm_id, (__spcm)->pcm.pcm_name, __dir,	\
640		##__VA_ARGS__)
641
642#if IS_ENABLED(CONFIG_SND_SOC_SOF_COMPRESS)
643void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream);
644void snd_sof_compr_init_elapsed_work(struct work_struct *work);
645#else
646static inline void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream) { }
647static inline void snd_sof_compr_init_elapsed_work(struct work_struct *work) { }
648#endif
649
650/* DAI link fixup */
651int sof_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params);
652
653/* PM */
654bool snd_sof_stream_suspend_ignored(struct snd_sof_dev *sdev);
655bool snd_sof_dsp_only_d0i3_compatible_stream_active(struct snd_sof_dev *sdev);
656
657/* Machine driver enumeration */
658int sof_machine_register(struct snd_sof_dev *sdev, void *pdata);
659void sof_machine_unregister(struct snd_sof_dev *sdev, void *pdata);
660
661int sof_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
662int sof_widget_free(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
663int sof_route_setup(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *wsource,
664		    struct snd_soc_dapm_widget *wsink);
665
666/* PCM */
667int sof_widget_list_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
668			  struct snd_pcm_hw_params *fe_params,
669			  struct snd_sof_platform_stream_params *platform_params,
670			  int dir);
671int sof_widget_list_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm, int dir);
672int sof_pcm_dsp_pcm_free(struct snd_pcm_substream *substream, struct snd_sof_dev *sdev,
673			 struct snd_sof_pcm *spcm);
674int sof_pcm_free_all_streams(struct snd_sof_dev *sdev);
675int get_token_u32(void *elem, void *object, u32 offset);
676int get_token_u16(void *elem, void *object, u32 offset);
677int get_token_comp_format(void *elem, void *object, u32 offset);
678int get_token_dai_type(void *elem, void *object, u32 offset);
679int get_token_uuid(void *elem, void *object, u32 offset);
680int get_token_string(void *elem, void *object, u32 offset);
681int sof_update_ipc_object(struct snd_soc_component *scomp, void *object, enum sof_tokens token_id,
682			  struct snd_sof_tuple *tuples, int num_tuples,
683			  size_t object_size, int token_instance_num);
684u32 vol_compute_gain(u32 value, int *tlv);
685#endif