]> git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blame - sound/soc/intel/skylake/skl-topology.h
ASoC: Intel: Skylake: Add module instance id generation APIs
[mirror_ubuntu-eoan-kernel.git] / sound / soc / intel / skylake / skl-topology.h
CommitLineData
23db472b
JK
1/*
2 * skl_topology.h - Intel HDA Platform topology header file
3 *
4 * Copyright (C) 2014-15 Intel Corp
5 * Author: Jeeja KP <jeeja.kp@intel.com>
6 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 *
19 */
20
21#ifndef __SKL_TOPOLOGY_H__
22#define __SKL_TOPOLOGY_H__
23
24#include <linux/types.h>
25
26#include <sound/hdaudio_ext.h>
27#include <sound/soc.h>
28#include "skl.h"
29#include "skl-tplg-interface.h"
30
31#define BITS_PER_BYTE 8
32#define MAX_TS_GROUPS 8
33#define MAX_DMIC_TS_GROUPS 4
34#define MAX_FIXED_DMIC_PARAMS_SIZE 727
35
36/* Maximum number of coefficients up down mixer module */
37#define UP_DOWN_MIXER_MAX_COEFF 6
38
4cd9899f
HS
39#define MODULE_MAX_IN_PINS 8
40#define MODULE_MAX_OUT_PINS 8
41
23db472b
JK
42enum skl_channel_index {
43 SKL_CHANNEL_LEFT = 0,
44 SKL_CHANNEL_RIGHT = 1,
45 SKL_CHANNEL_CENTER = 2,
46 SKL_CHANNEL_LEFT_SURROUND = 3,
47 SKL_CHANNEL_CENTER_SURROUND = 3,
48 SKL_CHANNEL_RIGHT_SURROUND = 4,
49 SKL_CHANNEL_LFE = 7,
50 SKL_CHANNEL_INVALID = 0xF,
51};
52
53enum skl_bitdepth {
54 SKL_DEPTH_8BIT = 8,
55 SKL_DEPTH_16BIT = 16,
56 SKL_DEPTH_24BIT = 24,
57 SKL_DEPTH_32BIT = 32,
58 SKL_DEPTH_INVALID
59};
60
23db472b
JK
61
62enum skl_s_freq {
63 SKL_FS_8000 = 8000,
64 SKL_FS_11025 = 11025,
65 SKL_FS_12000 = 12000,
66 SKL_FS_16000 = 16000,
67 SKL_FS_22050 = 22050,
68 SKL_FS_24000 = 24000,
69 SKL_FS_32000 = 32000,
70 SKL_FS_44100 = 44100,
71 SKL_FS_48000 = 48000,
72 SKL_FS_64000 = 64000,
73 SKL_FS_88200 = 88200,
74 SKL_FS_96000 = 96000,
75 SKL_FS_128000 = 128000,
76 SKL_FS_176400 = 176400,
77 SKL_FS_192000 = 192000,
78 SKL_FS_INVALID
79};
80
81enum skl_widget_type {
82 SKL_WIDGET_VMIXER = 1,
83 SKL_WIDGET_MIXER = 2,
84 SKL_WIDGET_PGA = 3,
85 SKL_WIDGET_MUX = 4
86};
87
88struct skl_audio_data_format {
89 enum skl_s_freq s_freq;
90 enum skl_bitdepth bit_depth;
91 u32 channel_map;
92 enum skl_ch_cfg ch_cfg;
93 enum skl_interleaving interleaving;
94 u8 number_of_channels;
95 u8 valid_bit_depth;
96 u8 sample_type;
97 u8 reserved[1];
98} __packed;
99
100struct skl_base_cfg {
101 u32 cps;
102 u32 ibs;
103 u32 obs;
104 u32 is_pages;
105 struct skl_audio_data_format audio_fmt;
106};
107
108struct skl_cpr_gtw_cfg {
109 u32 node_id;
110 u32 dma_buffer_size;
111 u32 config_length;
112 /* not mandatory; required only for DMIC/I2S */
113 u32 config_data[1];
114} __packed;
115
c115fa5e
D
116struct skl_i2s_config_blob {
117 u32 gateway_attrib;
118 u32 tdm_ts_group[8];
119 u32 ssc0;
120 u32 ssc1;
121 u32 sscto;
122 u32 sspsp;
123 u32 sstsa;
124 u32 ssrsa;
125 u32 ssc2;
126 u32 sspsp2;
127 u32 ssc3;
128 u32 ssioc;
129 u32 mdivc;
130 u32 mdivr;
131} __packed;
132
133struct skl_dma_control {
134 u32 node_id;
135 u32 config_length;
0b6d76bb 136 u32 config_data[0];
c115fa5e
D
137} __packed;
138
23db472b
JK
139struct skl_cpr_cfg {
140 struct skl_base_cfg base_cfg;
141 struct skl_audio_data_format out_fmt;
142 u32 cpr_feature_mask;
143 struct skl_cpr_gtw_cfg gtw_cfg;
144} __packed;
145
a0ffe48b
HS
146
147struct skl_src_module_cfg {
148 struct skl_base_cfg base_cfg;
149 enum skl_s_freq src_cfg;
150} __packed;
151
4e10996b
JK
152struct notification_mask {
153 u32 notify;
154 u32 enable;
155} __packed;
156
a0ffe48b
HS
157struct skl_up_down_mixer_cfg {
158 struct skl_base_cfg base_cfg;
159 enum skl_ch_cfg out_ch_cfg;
160 /* This should be set to 1 if user coefficients are required */
161 u32 coeff_sel;
162 /* Pass the user coeff in this array */
163 s32 coeff[UP_DOWN_MIXER_MAX_COEFF];
164} __packed;
165
399b210b
JK
166struct skl_algo_cfg {
167 struct skl_base_cfg base_cfg;
168 char params[0];
169} __packed;
170
fd18110f
D
171struct skl_base_outfmt_cfg {
172 struct skl_base_cfg base_cfg;
173 struct skl_audio_data_format out_fmt;
174} __packed;
175
23db472b
JK
176enum skl_dma_type {
177 SKL_DMA_HDA_HOST_OUTPUT_CLASS = 0,
178 SKL_DMA_HDA_HOST_INPUT_CLASS = 1,
179 SKL_DMA_HDA_HOST_INOUT_CLASS = 2,
180 SKL_DMA_HDA_LINK_OUTPUT_CLASS = 8,
181 SKL_DMA_HDA_LINK_INPUT_CLASS = 9,
182 SKL_DMA_HDA_LINK_INOUT_CLASS = 0xA,
183 SKL_DMA_DMIC_LINK_INPUT_CLASS = 0xB,
184 SKL_DMA_I2S_LINK_OUTPUT_CLASS = 0xC,
185 SKL_DMA_I2S_LINK_INPUT_CLASS = 0xD,
186};
187
188union skl_ssp_dma_node {
189 u8 val;
190 struct {
d7b18813 191 u8 time_slot_index:4;
23db472b
JK
192 u8 i2s_instance:4;
193 } dma_node;
194};
195
196union skl_connector_node_id {
197 u32 val;
198 struct {
199 u32 vindex:8;
200 u32 dma_type:4;
201 u32 rsvd:20;
202 } node;
203};
204
205struct skl_module_fmt {
206 u32 channels;
207 u32 s_freq;
208 u32 bit_depth;
209 u32 valid_bit_depth;
210 u32 ch_cfg;
4cd9899f
HS
211 u32 interleaving_style;
212 u32 sample_type;
213 u32 ch_map;
23db472b
JK
214};
215
4f745708
JK
216struct skl_module_cfg;
217
23db472b 218struct skl_module_inst_id {
b7c50555 219 int module_id;
23db472b 220 u32 instance_id;
700a9a63 221 int pvt_id;
23db472b
JK
222};
223
4f745708
JK
224enum skl_module_pin_state {
225 SKL_PIN_UNBIND = 0,
226 SKL_PIN_BIND_DONE = 1,
227};
228
23db472b
JK
229struct skl_module_pin {
230 struct skl_module_inst_id id;
23db472b
JK
231 bool is_dynamic;
232 bool in_use;
4f745708
JK
233 enum skl_module_pin_state pin_state;
234 struct skl_module_cfg *tgt_mcfg;
23db472b
JK
235};
236
237struct skl_specific_cfg {
4ced1827 238 u32 set_params;
abb74003 239 u32 param_id;
23db472b
JK
240 u32 caps_size;
241 u32 *caps;
242};
243
244enum skl_pipe_state {
245 SKL_PIPE_INVALID = 0,
246 SKL_PIPE_CREATED = 1,
247 SKL_PIPE_PAUSED = 2,
2004432f
JK
248 SKL_PIPE_STARTED = 3,
249 SKL_PIPE_RESET = 4
23db472b
JK
250};
251
252struct skl_pipe_module {
253 struct snd_soc_dapm_widget *w;
254 struct list_head node;
255};
256
257struct skl_pipe_params {
258 u8 host_dma_id;
259 u8 link_dma_id;
260 u32 ch;
261 u32 s_freq;
262 u32 s_fmt;
263 u8 linktype;
264 int stream;
265};
266
267struct skl_pipe {
268 u8 ppl_id;
269 u8 pipe_priority;
270 u16 conn_type;
271 u32 memory_pages;
272 struct skl_pipe_params *p_params;
273 enum skl_pipe_state state;
274 struct list_head w_list;
f0aa94fa 275 bool passthru;
23db472b
JK
276};
277
278enum skl_module_state {
279 SKL_MODULE_UNINIT = 0,
d643678b
JK
280 SKL_MODULE_LOADED = 1,
281 SKL_MODULE_INIT_DONE = 2,
282 SKL_MODULE_BIND_DONE = 3,
283 SKL_MODULE_UNLOADED = 4,
23db472b
JK
284};
285
286struct skl_module_cfg {
09305da9 287 u8 guid[16];
23db472b 288 struct skl_module_inst_id id;
04afbbbb 289 u8 domain;
4cd9899f
HS
290 bool homogenous_inputs;
291 bool homogenous_outputs;
292 struct skl_module_fmt in_fmt[MODULE_MAX_IN_PINS];
293 struct skl_module_fmt out_fmt[MODULE_MAX_OUT_PINS];
23db472b
JK
294 u8 max_in_queue;
295 u8 max_out_queue;
296 u8 in_queue_mask;
297 u8 out_queue_mask;
298 u8 in_queue;
299 u8 out_queue;
300 u32 mcps;
301 u32 ibs;
302 u32 obs;
303 u8 is_loadable;
304 u8 core_id;
305 u8 dev_type;
306 u8 dma_id;
307 u8 time_slot;
308 u32 params_fixup;
309 u32 converter;
310 u32 vbus_id;
b18c458d 311 u32 mem_pages;
23db472b
JK
312 struct skl_module_pin *m_in_pin;
313 struct skl_module_pin *m_out_pin;
314 enum skl_module_type m_type;
315 enum skl_hw_conn_type hw_conn_type;
316 enum skl_module_state m_state;
317 struct skl_pipe *pipe;
318 struct skl_specific_cfg formats_config;
319};
a0ffe48b 320
abb74003
JK
321struct skl_algo_data {
322 u32 param_id;
4ced1827 323 u32 set_params;
abb74003 324 u32 max;
0d682104 325 u32 size;
abb74003
JK
326 char *params;
327};
328
e4e2d2f4
JK
329struct skl_pipeline {
330 struct skl_pipe *pipe;
331 struct list_head node;
332};
333
d93f8e55
VK
334static inline struct skl *get_skl_ctx(struct device *dev)
335{
336 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
337
338 return ebus_to_skl(ebus);
339}
340
cfb0a873
VK
341int skl_tplg_be_update_params(struct snd_soc_dai *dai,
342 struct skl_pipe_params *params);
c115fa5e
D
343int skl_dsp_set_dma_control(struct skl_sst *ctx,
344 struct skl_module_cfg *mconfig);
cfb0a873
VK
345void skl_tplg_set_be_dmic_config(struct snd_soc_dai *dai,
346 struct skl_pipe_params *params, int stream);
347int skl_tplg_init(struct snd_soc_platform *platform,
348 struct hdac_ext_bus *ebus);
349struct skl_module_cfg *skl_tplg_fe_get_cpr_module(
350 struct snd_soc_dai *dai, int stream);
351int skl_tplg_update_pipe_params(struct device *dev,
352 struct skl_module_cfg *mconfig, struct skl_pipe_params *params);
353
c9b1e834
JK
354int skl_create_pipeline(struct skl_sst *ctx, struct skl_pipe *pipe);
355
356int skl_run_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
357
358int skl_pause_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
359
360int skl_delete_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
361
362int skl_stop_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
363
2004432f
JK
364int skl_reset_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
365
9939a9c3 366int skl_init_module(struct skl_sst *ctx, struct skl_module_cfg *module_config);
beb73b26
JK
367
368int skl_bind_modules(struct skl_sst *ctx, struct skl_module_cfg
369 *src_module, struct skl_module_cfg *dst_module);
370
371int skl_unbind_modules(struct skl_sst *ctx, struct skl_module_cfg
372 *src_module, struct skl_module_cfg *dst_module);
373
9939a9c3
JK
374int skl_set_module_params(struct skl_sst *ctx, u32 *params, int size,
375 u32 param_id, struct skl_module_cfg *mcfg);
7d9f2911
OA
376int skl_get_module_params(struct skl_sst *ctx, u32 *params, int size,
377 u32 param_id, struct skl_module_cfg *mcfg);
9939a9c3 378
718a42b5
D
379struct skl_module_cfg *skl_tplg_be_get_cpr_module(struct snd_soc_dai *dai,
380 int stream);
23db472b
JK
381enum skl_bitdepth skl_get_bit_depth(int params);
382#endif