sound/soc/sof/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. 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         SOF_MICFIL_TOKENS,
 279         SOF_ACP_SDW_TOKENS,
 280
 281         /* this should be the last */
 282         SOF_TOKEN_COUNT,
 283 };
 284
 285 /**
 286  * struct sof_topology_token - SOF topology token definition
 287  * @token:              Token number
 288  * @type:               Token type
 289  * @get_token:          Function pointer to parse the token value and save it in a object
 290  * @offset:             Offset within an object to save the token value into
 291  */
 292 struct sof_topology_token {
 293         u32 token;
 294         u32 type;
 295         int (*get_token)(void *elem, void *object, u32 offset);
 296         u32 offset;
 297 };
 298
 299 struct sof_token_info {
 300         const char *name;
 301         const struct sof_topology_token *tokens;
 302         int count;
 303 };
 304
 305 /**
 306  * struct snd_sof_pcm_stream_pipeline_list - List of pipelines associated with a PCM stream
 307  * @count: number of pipeline widgets in the @pipe_widgets array
 308  * @pipelines: array of pipelines
 309  */
 310 struct snd_sof_pcm_stream_pipeline_list {
 311         u32 count;
 312         struct snd_sof_pipeline **pipelines;
 313 };
 314
 315 /* PCM stream, mapped to FW component  */
 316 struct snd_sof_pcm_stream {
 317         u32 comp_id;
 318         struct snd_dma_buffer page_table;
 319         struct sof_ipc_stream_posn posn;
 320         struct snd_pcm_substream *substream;
 321         struct snd_compr_stream *cstream;
 322         struct work_struct period_elapsed_work;
 323         struct snd_soc_dapm_widget_list *list; /* list of connected DAPM widgets */
 324         bool d0i3_compatible; /* DSP can be in D0I3 when this pcm is opened */
 325         /*
 326          * flag to indicate that the DSP pipelines should be kept
 327          * active or not while suspending the stream
 328          */
 329         bool suspend_ignored;
 330         struct snd_sof_pcm_stream_pipeline_list pipeline_list;
 331
 332         /* used by IPC implementation and core does not touch it */
 333         void *private;
 334 };
 335
 336 /* ALSA SOF PCM device */
 337 struct snd_sof_pcm {
 338         struct snd_soc_component *scomp;
 339         struct snd_soc_tplg_pcm pcm;
 340         struct snd_sof_pcm_stream stream[2];
 341         struct list_head list;  /* list in sdev pcm list */
 342         struct snd_pcm_hw_params params[2];
 343         bool prepared[2]; /* PCM_PARAMS set successfully */
 344 };
 345
 346 struct snd_sof_led_control {
 347         unsigned int use_led;
 348         unsigned int direction;
 349         int led_value;
 350 };
 351
 352 /* ALSA SOF Kcontrol device */
 353 struct snd_sof_control {
 354         struct snd_soc_component *scomp;
 355         const char *name;
 356         int comp_id;
 357         int min_volume_step; /* min volume step for volume_table */
 358         int max_volume_step; /* max volume step for volume_table */
 359         int num_channels;
 360         unsigned int access;
 361         int info_type;
 362         int index; /* pipeline ID */
 363         void *priv; /* private data copied from topology */
 364         size_t priv_size; /* size of private data */
 365         size_t max_size;
 366         void *ipc_control_data;
 367         void *old_ipc_control_data;
 368         int max; /* applicable to volume controls */
 369         u32 size;       /* cdata size */
 370         u32 *volume_table; /* volume table computed from tlv data*/
 371
 372         struct list_head list;  /* list in sdev control list */
 373
 374         struct snd_sof_led_control led_ctl;
 375
 376         /* if true, the control's data needs to be updated from Firmware */
 377         bool comp_data_dirty;
 378 };
 379
 380 /** struct snd_sof_dai_link - DAI link info
 381  * @tuples: array of parsed tuples
 382  * @num_tuples: number of tuples in the tuples array
 383  * @link: Pointer to snd_soc_dai_link
 384  * @hw_configs: Pointer to hw configs in topology
 385  * @num_hw_configs: Number of hw configs in topology
 386  * @default_hw_cfg_id: Default hw config ID
 387  * @type: DAI type
 388  * @list: item in snd_sof_dev dai_link list
 389  */
 390 struct snd_sof_dai_link {
 391         struct snd_sof_tuple *tuples;
 392         int num_tuples;
 393         struct snd_soc_dai_link *link;
 394         struct snd_soc_tplg_hw_config *hw_configs;
 395         int num_hw_configs;
 396         int default_hw_cfg_id;
 397         int type;
 398         struct list_head list;
 399 };
 400
 401 /* ASoC SOF DAPM widget */
 402 struct snd_sof_widget {
 403         struct snd_soc_component *scomp;
 404         int comp_id;
 405         int pipeline_id;
 406         /*
 407          * the prepared flag is used to indicate that a widget has been prepared for getting set
 408          * up in the DSP.
 409          */
 410         bool prepared;
 411
 412         struct mutex setup_mutex; /* to protect the swidget setup and free operations */
 413
 414         /*
 415          * use_count is protected by the PCM mutex held by the core and the
 416          * setup_mutex against non stream domain races (kcontrol access for
 417          * example)
 418          */
 419         int use_count;
 420
 421         int core;
 422         int id; /* id is the DAPM widget type */
 423         /*
 424          * Instance ID is set dynamically when the widget gets set up in the FW. It should be
 425          * unique for each module type across all pipelines. This will not be used in SOF_IPC.
 426          */
 427         int instance_id;
 428
 429         /*
 430          * Flag indicating if the widget should be set up dynamically when a PCM is opened.
 431          * This flag is only set for the scheduler type widget in topology. During topology
 432          * loading, this flag is propagated to all the widgets belonging to the same pipeline.
 433          * When this flag is not set, a widget is set up at the time of topology loading
 434          * and retained until the DSP enters D3. It will need to be set up again when resuming
 435          * from D3.
 436          */
 437         bool dynamic_pipeline_widget;
 438
 439         struct snd_soc_dapm_widget *widget;
 440         struct list_head list;  /* list in sdev widget list */
 441         struct snd_sof_pipeline *spipe;
 442         void *module_info;
 443
 444         const guid_t uuid;
 445
 446         int num_tuples;
 447         struct snd_sof_tuple *tuples;
 448
 449         /*
 450          * The allowed range for num_input/output_pins is [0, SOF_WIDGET_MAX_NUM_PINS].
 451          * Widgets may have zero input or output pins, for example the tone widget has
 452          * zero input pins.
 453          */
 454         u32 num_input_pins;
 455         u32 num_output_pins;
 456
 457         /*
 458          * The input/output pin binding array, it takes the form of
 459          * [widget_name_connected_to_pin0, widget_name_connected_to_pin1, ...],
 460          * with the index as the queue ID.
 461          *
 462          * The array is used for special pin binding. Note that even if there
 463          * is only one input/output pin requires special pin binding, pin binding
 464          * should be defined for all input/output pins in topology, for pin(s) that
 465          * are not used, give the value "NotConnected".
 466          *
 467          * If pin binding is not defined in topology, nothing to parse in the kernel,
 468          * input_pin_binding and output_pin_binding shall be NULL.
 469          */
 470         char **input_pin_binding;
 471         char **output_pin_binding;
 472
 473         struct ida output_queue_ida;
 474         struct ida input_queue_ida;
 475
 476         void *private;          /* core does not touch this */
 477 };
 478
 479 /** struct snd_sof_pipeline - ASoC SOF pipeline
 480  * @pipe_widget: Pointer to the pipeline widget
 481  * @started_count: Count of number of PCM's that have started this pipeline
 482  * @paused_count: Count of number of PCM's that have started and have currently paused this
 483                   pipeline
 484  * @complete: flag used to indicate that pipeline set up is complete.
 485  * @core_mask: Mask containing target cores for all modules in the pipeline
 486  * @list: List item in sdev pipeline_list
 487  */
 488 struct snd_sof_pipeline {
 489         struct snd_sof_widget *pipe_widget;
 490         int started_count;
 491         int paused_count;
 492         int complete;
 493         unsigned long core_mask;
 494         struct list_head list;
 495 };
 496
 497 /* ASoC SOF DAPM route */
 498 struct snd_sof_route {
 499         struct snd_soc_component *scomp;
 500
 501         struct snd_soc_dapm_route *route;
 502         struct list_head list;  /* list in sdev route list */
 503         struct snd_sof_widget *src_widget;
 504         struct snd_sof_widget *sink_widget;
 505         bool setup;
 506
 507         int src_queue_id;
 508         int dst_queue_id;
 509
 510         void *private;
 511 };
 512
 513 /* ASoC DAI device */
 514 struct snd_sof_dai {
 515         struct snd_soc_component *scomp;
 516         const char *name;
 517         u32 type;
 518
 519         int number_configs;
 520         int current_config;
 521         struct list_head list;  /* list in sdev dai list */
 522         /* core should not touch this */
 523         const void *platform_private;
 524         void *private;
 525 };
 526
 527 /*
 528  * Kcontrols.
 529  */
 530
 531 int snd_sof_volume_get(struct snd_kcontrol *kcontrol,
 532                        struct snd_ctl_elem_value *ucontrol);
 533 int snd_sof_volume_put(struct snd_kcontrol *kcontrol,
 534                        struct snd_ctl_elem_value *ucontrol);
 535 int snd_sof_volume_info(struct snd_kcontrol *kcontrol,
 536                         struct snd_ctl_elem_info *uinfo);
 537 int snd_sof_switch_get(struct snd_kcontrol *kcontrol,
 538                        struct snd_ctl_elem_value *ucontrol);
 539 int snd_sof_switch_put(struct snd_kcontrol *kcontrol,
 540                        struct snd_ctl_elem_value *ucontrol);
 541 int snd_sof_enum_get(struct snd_kcontrol *kcontrol,
 542                      struct snd_ctl_elem_value *ucontrol);
 543 int snd_sof_enum_put(struct snd_kcontrol *kcontrol,
 544                      struct snd_ctl_elem_value *ucontrol);
 545 int snd_sof_bytes_get(struct snd_kcontrol *kcontrol,
 546                       struct snd_ctl_elem_value *ucontrol);
 547 int snd_sof_bytes_put(struct snd_kcontrol *kcontrol,
 548                       struct snd_ctl_elem_value *ucontrol);
 549 int snd_sof_bytes_ext_put(struct snd_kcontrol *kcontrol,
 550                           const unsigned int __user *binary_data,
 551                           unsigned int size);
 552 int snd_sof_bytes_ext_get(struct snd_kcontrol *kcontrol,
 553                           unsigned int __user *binary_data,
 554                           unsigned int size);
 555 int snd_sof_bytes_ext_volatile_get(struct snd_kcontrol *kcontrol, unsigned int __user *binary_data,
 556                                    unsigned int size);
 557 void snd_sof_control_notify(struct snd_sof_dev *sdev,
 558                             struct sof_ipc_ctrl_data *cdata);
 559
 560 /*
 561  * Topology.
 562  * There is no snd_sof_free_topology since topology components will
 563  * be freed by snd_soc_unregister_component,
 564  */
 565 int snd_sof_load_topology(struct snd_soc_component *scomp, const char *file);
 566
 567 /*
 568  * Stream IPC
 569  */
 570 int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
 571                             struct snd_sof_pcm *spcm, int direction,
 572                             struct sof_ipc_stream_posn *posn);
 573
 574 struct snd_sof_widget *snd_sof_find_swidget(struct snd_soc_component *scomp,
 575                                             const char *name);
 576 struct snd_sof_widget *
 577 snd_sof_find_swidget_sname(struct snd_soc_component *scomp,
 578                            const char *pcm_name, int dir);
 579 struct snd_sof_dai *snd_sof_find_dai(struct snd_soc_component *scomp,
 580                                      const char *name);
 581
 582 static inline
 583 struct snd_sof_pcm *snd_sof_find_spcm_dai(struct snd_soc_component *scomp,
 584                                           struct snd_soc_pcm_runtime *rtd)
 585 {
 586         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 587         struct snd_sof_pcm *spcm;
 588
 589         list_for_each_entry(spcm, &sdev->pcm_list, list) {
 590                 if (le32_to_cpu(spcm->pcm.dai_id) == rtd->dai_link->id)
 591                         return spcm;
 592         }
 593
 594         return NULL;
 595 }
 596
 597 struct snd_sof_pcm *snd_sof_find_spcm_name(struct snd_soc_component *scomp,
 598                                            const char *name);
 599 struct snd_sof_pcm *snd_sof_find_spcm_comp(struct snd_soc_component *scomp,
 600                                            unsigned int comp_id,
 601                                            int *direction);
 602 void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream);
 603 void snd_sof_pcm_init_elapsed_work(struct work_struct *work);
 604
 605 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COMPRESS)
 606 void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream);
 607 void snd_sof_compr_init_elapsed_work(struct work_struct *work);
 608 #else
 609 static inline void snd_sof_compr_fragment_elapsed(struct snd_compr_stream *cstream) { }
 610 static inline void snd_sof_compr_init_elapsed_work(struct work_struct *work) { }
 611 #endif
 612
 613 /* DAI link fixup */
 614 int sof_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params);
 615
 616 /* PM */
 617 bool snd_sof_stream_suspend_ignored(struct snd_sof_dev *sdev);
 618 bool snd_sof_dsp_only_d0i3_compatible_stream_active(struct snd_sof_dev *sdev);
 619
 620 /* Machine driver enumeration */
 621 int sof_machine_register(struct snd_sof_dev *sdev, void *pdata);
 622 void sof_machine_unregister(struct snd_sof_dev *sdev, void *pdata);
 623
 624 int sof_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
 625 int sof_widget_free(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
 626 int sof_route_setup(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *wsource,
 627                     struct snd_soc_dapm_widget *wsink);
 628
 629 /* PCM */
 630 int sof_widget_list_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
 631                           struct snd_pcm_hw_params *fe_params,
 632                           struct snd_sof_platform_stream_params *platform_params,
 633                           int dir);
 634 int sof_widget_list_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm, int dir);
 635 int sof_pcm_dsp_pcm_free(struct snd_pcm_substream *substream, struct snd_sof_dev *sdev,
 636                          struct snd_sof_pcm *spcm);
 637 int sof_pcm_stream_free(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream,
 638                         struct snd_sof_pcm *spcm, int dir, bool free_widget_list);
 639 int get_token_u32(void *elem, void *object, u32 offset);
 640 int get_token_u16(void *elem, void *object, u32 offset);
 641 int get_token_comp_format(void *elem, void *object, u32 offset);
 642 int get_token_dai_type(void *elem, void *object, u32 offset);
 643 int get_token_uuid(void *elem, void *object, u32 offset);
 644 int get_token_string(void *elem, void *object, u32 offset);
 645 int sof_update_ipc_object(struct snd_soc_component *scomp, void *object, enum sof_tokens token_id,
 646                           struct snd_sof_tuple *tuples, int num_tuples,
 647                           size_t object_size, int token_instance_num);
 648 u32 vol_compute_gain(u32 value, int *tlv);
 649 #endif