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