1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * skl_topology.h - Intel HDA Platform topology header file
5 * Copyright (C) 2014-15 Intel Corp
6 * Author: Jeeja KP <jeeja.kp@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 #ifndef __SKL_TOPOLOGY_H__
13 #define __SKL_TOPOLOGY_H__
15 #include <linux/types.h>
17 #include <sound/hdaudio_ext.h>
18 #include <sound/soc.h>
19 #include <uapi/sound/skl-tplg-interface.h>
22 #define BITS_PER_BYTE 8
23 #define MAX_TS_GROUPS 8
24 #define MAX_DMIC_TS_GROUPS 4
25 #define MAX_FIXED_DMIC_PARAMS_SIZE 727
27 /* Maximum number of coefficients up down mixer module */
28 #define UP_DOWN_MIXER_MAX_COEFF 8
30 #define MODULE_MAX_IN_PINS 8
31 #define MODULE_MAX_OUT_PINS 8
33 #define SKL_MIC_CH_SUPPORT 4
34 #define SKL_MIC_MAX_CH_SUPPORT 8
35 #define SKL_DEFAULT_MIC_SEL_GAIN 0x3FF
36 #define SKL_MIC_SEL_SWITCH 0x3
38 #define SKL_OUTPUT_PIN 0
39 #define SKL_INPUT_PIN 1
40 #define SKL_MAX_PATH_CONFIGS 8
41 #define SKL_MAX_MODULES_IN_PIPE 8
42 #define SKL_MAX_MODULE_FORMATS 32
43 #define SKL_MAX_MODULE_RESOURCES 32
45 enum skl_channel_index
{
47 SKL_CHANNEL_RIGHT
= 1,
48 SKL_CHANNEL_CENTER
= 2,
49 SKL_CHANNEL_LEFT_SURROUND
= 3,
50 SKL_CHANNEL_CENTER_SURROUND
= 3,
51 SKL_CHANNEL_RIGHT_SURROUND
= 4,
53 SKL_CHANNEL_INVALID
= 0xF,
78 SKL_FS_128000
= 128000,
79 SKL_FS_176400
= 176400,
80 SKL_FS_192000
= 192000,
84 enum skl_widget_type
{
85 SKL_WIDGET_VMIXER
= 1,
91 struct skl_audio_data_format
{
92 enum skl_s_freq s_freq
;
93 enum skl_bitdepth bit_depth
;
95 enum skl_ch_cfg ch_cfg
;
96 enum skl_interleaving interleaving
;
97 u8 number_of_channels
;
103 struct skl_base_cfg
{
108 struct skl_audio_data_format audio_fmt
;
111 struct skl_cpr_gtw_cfg
{
115 /* not mandatory; required only for DMIC/I2S */
119 struct skl_dma_control
{
126 struct skl_base_cfg base_cfg
;
127 struct skl_audio_data_format out_fmt
;
128 u32 cpr_feature_mask
;
129 struct skl_cpr_gtw_cfg gtw_cfg
;
132 struct skl_cpr_pin_fmt
{
134 struct skl_audio_data_format src_fmt
;
135 struct skl_audio_data_format dst_fmt
;
138 struct skl_src_module_cfg
{
139 struct skl_base_cfg base_cfg
;
140 enum skl_s_freq src_cfg
;
143 struct notification_mask
{
148 struct skl_up_down_mixer_cfg
{
149 struct skl_base_cfg base_cfg
;
150 enum skl_ch_cfg out_ch_cfg
;
151 /* This should be set to 1 if user coefficients are required */
153 /* Pass the user coeff in this array */
154 s32 coeff
[UP_DOWN_MIXER_MAX_COEFF
];
158 struct skl_algo_cfg
{
159 struct skl_base_cfg base_cfg
;
163 struct skl_base_outfmt_cfg
{
164 struct skl_base_cfg base_cfg
;
165 struct skl_audio_data_format out_fmt
;
169 SKL_DMA_HDA_HOST_OUTPUT_CLASS
= 0,
170 SKL_DMA_HDA_HOST_INPUT_CLASS
= 1,
171 SKL_DMA_HDA_HOST_INOUT_CLASS
= 2,
172 SKL_DMA_HDA_LINK_OUTPUT_CLASS
= 8,
173 SKL_DMA_HDA_LINK_INPUT_CLASS
= 9,
174 SKL_DMA_HDA_LINK_INOUT_CLASS
= 0xA,
175 SKL_DMA_DMIC_LINK_INPUT_CLASS
= 0xB,
176 SKL_DMA_I2S_LINK_OUTPUT_CLASS
= 0xC,
177 SKL_DMA_I2S_LINK_INPUT_CLASS
= 0xD,
180 union skl_ssp_dma_node
{
183 u8 time_slot_index
:4;
188 union skl_connector_node_id
{
197 struct skl_module_fmt
{
203 u32 interleaving_style
;
208 struct skl_module_cfg
;
210 struct skl_mod_inst_map
{
215 struct skl_uuid_inst_map
{
221 struct skl_kpb_params
{
224 struct skl_mod_inst_map map
[0];
225 struct skl_uuid_inst_map map_uuid
[0];
229 struct skl_module_inst_id
{
236 enum skl_module_pin_state
{
238 SKL_PIN_BIND_DONE
= 1,
241 struct skl_module_pin
{
242 struct skl_module_inst_id id
;
245 enum skl_module_pin_state pin_state
;
246 struct skl_module_cfg
*tgt_mcfg
;
249 struct skl_specific_cfg
{
256 enum skl_pipe_state
{
257 SKL_PIPE_INVALID
= 0,
258 SKL_PIPE_CREATED
= 1,
260 SKL_PIPE_STARTED
= 3,
264 struct skl_pipe_module
{
265 struct snd_soc_dapm_widget
*w
;
266 struct list_head node
;
269 struct skl_pipe_params
{
276 snd_pcm_format_t format
;
279 unsigned int host_bps
;
280 unsigned int link_bps
;
283 struct skl_pipe_fmt
{
289 struct skl_pipe_mcfg
{
294 struct skl_path_config
{
296 struct skl_pipe_fmt in_fmt
;
297 struct skl_pipe_fmt out_fmt
;
306 struct skl_pipe_params
*p_params
;
307 enum skl_pipe_state state
;
311 struct skl_path_config configs
[SKL_MAX_PATH_CONFIGS
];
312 struct list_head w_list
;
316 enum skl_module_state
{
317 SKL_MODULE_UNINIT
= 0,
318 SKL_MODULE_LOADED
= 1,
319 SKL_MODULE_INIT_DONE
= 2,
320 SKL_MODULE_BIND_DONE
= 3,
321 SKL_MODULE_UNLOADED
= 4,
324 enum d0i3_capability
{
326 SKL_D0I3_STREAMING
= 1,
327 SKL_D0I3_NON_STREAMING
= 2,
330 struct skl_module_pin_fmt
{
332 struct skl_module_fmt fmt
;
335 struct skl_module_iface
{
339 struct skl_module_pin_fmt inputs
[MAX_IN_QUEUE
];
340 struct skl_module_pin_fmt outputs
[MAX_OUT_QUEUE
];
343 struct skl_module_pin_resources
{
348 struct skl_module_res
{
358 struct skl_module_pin_resources input
[MAX_IN_QUEUE
];
359 struct skl_module_pin_resources output
[MAX_OUT_QUEUE
];
371 struct skl_module_res resources
[SKL_MAX_MODULE_RESOURCES
];
372 struct skl_module_iface formats
[SKL_MAX_MODULE_FORMATS
];
375 struct skl_module_cfg
{
377 struct skl_module_inst_id id
;
378 struct skl_module
*module
;
382 bool homogenous_inputs
;
383 bool homogenous_outputs
;
384 struct skl_module_fmt in_fmt
[MODULE_MAX_IN_PINS
];
385 struct skl_module_fmt out_fmt
[MODULE_MAX_OUT_PINS
];
400 u8 dmic_ch_combo_index
;
406 enum d0i3_capability d0i3_caps
;
407 u32 dma_buffer_size
; /* in milli seconds */
408 struct skl_module_pin
*m_in_pin
;
409 struct skl_module_pin
*m_out_pin
;
410 enum skl_module_type m_type
;
411 enum skl_hw_conn_type hw_conn_type
;
412 enum skl_module_state m_state
;
413 struct skl_pipe
*pipe
;
414 struct skl_specific_cfg formats_config
;
415 struct skl_pipe_mcfg mod_cfg
[SKL_MAX_MODULES_IN_PIPE
];
418 struct skl_algo_data
{
426 struct skl_pipeline
{
427 struct skl_pipe
*pipe
;
428 struct list_head node
;
431 struct skl_module_deferred_bind
{
432 struct skl_module_cfg
*src
;
433 struct skl_module_cfg
*dst
;
434 struct list_head node
;
437 struct skl_mic_sel_config
{
440 u16 blob
[SKL_MIC_MAX_CH_SUPPORT
][SKL_MIC_MAX_CH_SUPPORT
];
450 static inline struct skl
*get_skl_ctx(struct device
*dev
)
452 struct hdac_bus
*bus
= dev_get_drvdata(dev
);
454 return bus_to_skl(bus
);
457 int skl_tplg_be_update_params(struct snd_soc_dai
*dai
,
458 struct skl_pipe_params
*params
);
459 int skl_dsp_set_dma_control(struct skl_sst
*ctx
, u32
*caps
,
460 u32 caps_size
, u32 node_id
);
461 void skl_tplg_set_be_dmic_config(struct snd_soc_dai
*dai
,
462 struct skl_pipe_params
*params
, int stream
);
463 int skl_tplg_init(struct snd_soc_component
*component
,
464 struct hdac_bus
*ebus
);
465 void skl_tplg_exit(struct snd_soc_component
*component
,
466 struct hdac_bus
*bus
);
467 struct skl_module_cfg
*skl_tplg_fe_get_cpr_module(
468 struct snd_soc_dai
*dai
, int stream
);
469 int skl_tplg_update_pipe_params(struct device
*dev
,
470 struct skl_module_cfg
*mconfig
, struct skl_pipe_params
*params
);
472 void skl_tplg_d0i3_get(struct skl
*skl
, enum d0i3_capability caps
);
473 void skl_tplg_d0i3_put(struct skl
*skl
, enum d0i3_capability caps
);
475 int skl_create_pipeline(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
477 int skl_run_pipe(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
479 int skl_pause_pipe(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
481 int skl_delete_pipe(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
483 int skl_stop_pipe(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
485 int skl_reset_pipe(struct skl_sst
*ctx
, struct skl_pipe
*pipe
);
487 int skl_init_module(struct skl_sst
*ctx
, struct skl_module_cfg
*module_config
);
489 int skl_bind_modules(struct skl_sst
*ctx
, struct skl_module_cfg
490 *src_module
, struct skl_module_cfg
*dst_module
);
492 int skl_unbind_modules(struct skl_sst
*ctx
, struct skl_module_cfg
493 *src_module
, struct skl_module_cfg
*dst_module
);
495 int skl_set_module_params(struct skl_sst
*ctx
, u32
*params
, int size
,
496 u32 param_id
, struct skl_module_cfg
*mcfg
);
497 int skl_get_module_params(struct skl_sst
*ctx
, u32
*params
, int size
,
498 u32 param_id
, struct skl_module_cfg
*mcfg
);
500 struct skl_module_cfg
*skl_tplg_be_get_cpr_module(struct snd_soc_dai
*dai
,
502 enum skl_bitdepth
skl_get_bit_depth(int params
);
503 int skl_pcm_host_dma_prepare(struct device
*dev
,
504 struct skl_pipe_params
*params
);
505 int skl_pcm_link_dma_prepare(struct device
*dev
,
506 struct skl_pipe_params
*params
);
508 int skl_dai_load(struct snd_soc_component
*cmp
, int index
,
509 struct snd_soc_dai_driver
*dai_drv
,
510 struct snd_soc_tplg_pcm
*pcm
, struct snd_soc_dai
*dai
);
511 void skl_tplg_add_moduleid_in_bind_params(struct skl
*skl
,
512 struct snd_soc_dapm_widget
*w
);