xref: /linux/include/uapi/sound/sof/tokens.h (revision af0bc3ac9a9e830cb52b718ecb237c4e76a466be)
1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) 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) 2018 Intel Corporation
7  * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
8  *         Keyon Jie <yang.jie@linux.intel.com>
9  */
10 
11 /*
12  * Topology IDs and tokens.
13  *
14  * ** MUST BE ALIGNED WITH TOPOLOGY CONFIGURATION TOKEN VALUES **
15  */
16 
17 #ifndef __INCLUDE_UAPI_SOF_TOPOLOGY_H__
18 #define __INCLUDE_UAPI_SOF_TOPOLOGY_H__
19 
20 /*
21  * Kcontrol IDs
22  */
23 #define SOF_TPLG_KCTL_VOL_ID	256
24 #define SOF_TPLG_KCTL_ENUM_ID	257
25 #define SOF_TPLG_KCTL_BYTES_ID	258
26 #define SOF_TPLG_KCTL_SWITCH_ID	259
27 #define SOF_TPLG_KCTL_BYTES_VOLATILE_RO 260
28 #define SOF_TPLG_KCTL_BYTES_VOLATILE_RW 261
29 #define SOF_TPLG_KCTL_BYTES_WO_ID 262
30 
31 /*
32  * Tokens - must match values in topology configurations
33  */
34 
35 /* buffers */
36 #define SOF_TKN_BUF_SIZE			100
37 #define SOF_TKN_BUF_CAPS			101
38 #define SOF_TKN_BUF_FLAGS			102
39 
40 /* DAI */
41 /* Token retired with ABI 3.2, do not use for new capabilities
42  * #define	SOF_TKN_DAI_DMAC_CONFIG			153
43  */
44 #define SOF_TKN_DAI_TYPE			154
45 #define SOF_TKN_DAI_INDEX			155
46 #define SOF_TKN_DAI_DIRECTION			156
47 
48 /* scheduling */
49 #define SOF_TKN_SCHED_PERIOD			200
50 #define SOF_TKN_SCHED_PRIORITY			201
51 #define SOF_TKN_SCHED_MIPS			202
52 #define SOF_TKN_SCHED_CORE			203
53 #define SOF_TKN_SCHED_FRAMES			204
54 #define SOF_TKN_SCHED_TIME_DOMAIN		205
55 #define SOF_TKN_SCHED_DYNAMIC_PIPELINE		206
56 #define SOF_TKN_SCHED_LP_MODE			207
57 #define SOF_TKN_SCHED_MEM_USAGE			208
58 #define SOF_TKN_SCHED_USE_CHAIN_DMA		209
59 #define SOF_TKN_SCHED_KCPS			210
60 
61 /* volume */
62 #define SOF_TKN_VOLUME_RAMP_STEP_TYPE		250
63 #define SOF_TKN_VOLUME_RAMP_STEP_MS		251
64 
65 #define SOF_TKN_GAIN_RAMP_TYPE			260
66 #define SOF_TKN_GAIN_RAMP_DURATION		261
67 #define SOF_TKN_GAIN_VAL			262
68 
69 /* SRC */
70 #define SOF_TKN_SRC_RATE_IN			300
71 #define SOF_TKN_SRC_RATE_OUT			301
72 
73 /* ASRC */
74 #define SOF_TKN_ASRC_RATE_IN			320
75 #define SOF_TKN_ASRC_RATE_OUT			321
76 #define SOF_TKN_ASRC_ASYNCHRONOUS_MODE		322
77 #define SOF_TKN_ASRC_OPERATION_MODE		323
78 
79 /* PCM */
80 #define SOF_TKN_PCM_DMAC_CONFIG			353
81 
82 /* Generic components */
83 #define SOF_TKN_COMP_PERIOD_SINK_COUNT		400
84 #define SOF_TKN_COMP_PERIOD_SOURCE_COUNT	401
85 #define SOF_TKN_COMP_FORMAT			402
86 /* Token retired with ABI 3.2, do not use for new capabilities
87  * #define SOF_TKN_COMP_PRELOAD_COUNT		403
88  */
89 #define SOF_TKN_COMP_CORE_ID			404
90 #define SOF_TKN_COMP_UUID                       405
91 #define SOF_TKN_COMP_CPC			406
92 #define SOF_TKN_COMP_IS_PAGES			409
93 #define SOF_TKN_COMP_NUM_AUDIO_FORMATS		410
94 #define SOF_TKN_COMP_NUM_INPUT_PINS		411
95 #define SOF_TKN_COMP_NUM_OUTPUT_PINS		412
96 /*
97  * The token for input/output pin binding, it specifies the widget
98  * name that the input/output pin is connected from/to.
99  */
100 #define SOF_TKN_COMP_INPUT_PIN_BINDING_WNAME	413
101 #define SOF_TKN_COMP_OUTPUT_PIN_BINDING_WNAME	414
102 #define SOF_TKN_COMP_NUM_INPUT_AUDIO_FORMATS	415
103 #define SOF_TKN_COMP_NUM_OUTPUT_AUDIO_FORMATS	416
104 /*
105  * The token value is copied to the dapm_widget's
106  * no_wname_in_kcontrol_name.
107  */
108 #define SOF_TKN_COMP_NO_WNAME_IN_KCONTROL_NAME	417
109 
110 #define SOF_TKN_COMP_SCHED_DOMAIN		418
111 #define SOF_TKN_COMP_DOMAIN_ID			419
112 #define SOF_TKN_COMP_HEAP_BYTES_REQUIREMENT	420
113 #define SOF_TKN_COMP_STACK_BYTES_REQUIREMENT	421
114 
115 /* SSP */
116 #define SOF_TKN_INTEL_SSP_CLKS_CONTROL		500
117 #define SOF_TKN_INTEL_SSP_MCLK_ID		501
118 #define SOF_TKN_INTEL_SSP_SAMPLE_BITS		502
119 #define SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH	503
120 #define SOF_TKN_INTEL_SSP_QUIRKS		504
121 #define SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT	505
122 #define SOF_TKN_INTEL_SSP_BCLK_DELAY		506
123 
124 /* DMIC */
125 #define SOF_TKN_INTEL_DMIC_DRIVER_VERSION	600
126 #define SOF_TKN_INTEL_DMIC_CLK_MIN		601
127 #define SOF_TKN_INTEL_DMIC_CLK_MAX		602
128 #define SOF_TKN_INTEL_DMIC_DUTY_MIN		603
129 #define SOF_TKN_INTEL_DMIC_DUTY_MAX		604
130 #define SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE	605
131 #define SOF_TKN_INTEL_DMIC_SAMPLE_RATE		608
132 #define SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH	609
133 #define SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS  610
134 
135 /* DMIC PDM */
136 #define SOF_TKN_INTEL_DMIC_PDM_CTRL_ID		700
137 #define SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable	701
138 #define SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable	702
139 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_A	703
140 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_B	704
141 #define SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE		705
142 #define SOF_TKN_INTEL_DMIC_PDM_SKEW		706
143 
144 /* Tone */
145 #define SOF_TKN_TONE_SAMPLE_RATE		800
146 
147 /* Processing Components */
148 #define SOF_TKN_PROCESS_TYPE                    900
149 
150 /* for backward compatibility */
151 #define SOF_TKN_EFFECT_TYPE	SOF_TKN_PROCESS_TYPE
152 
153 /* SAI */
154 #define SOF_TKN_IMX_SAI_MCLK_ID			1000
155 
156 /* ESAI */
157 #define SOF_TKN_IMX_ESAI_MCLK_ID		1100
158 
159 /* Stream */
160 #define SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3	1200
161 #define SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3	1201
162 #define SOF_TKN_STREAM_PLAYBACK_PAUSE_SUPPORTED	1202
163 #define SOF_TKN_STREAM_CAPTURE_PAUSE_SUPPORTED	1203
164 
165 /* Led control for mute switches */
166 #define SOF_TKN_MUTE_LED_USE			1300
167 #define SOF_TKN_MUTE_LED_DIRECTION		1301
168 
169 /* ALH */
170 #define SOF_TKN_INTEL_ALH_RATE			1400
171 #define SOF_TKN_INTEL_ALH_CH			1401
172 
173 /* HDA */
174 #define SOF_TKN_INTEL_HDA_RATE			1500
175 #define SOF_TKN_INTEL_HDA_CH			1501
176 
177 /* AFE */
178 #define SOF_TKN_MEDIATEK_AFE_RATE		1600
179 #define SOF_TKN_MEDIATEK_AFE_CH			1601
180 #define SOF_TKN_MEDIATEK_AFE_FORMAT		1602
181 
182 /* MIXER */
183 #define SOF_TKN_MIXER_TYPE			1700
184 
185 /* ACPDMIC */
186 #define SOF_TKN_AMD_ACPDMIC_RATE		1800
187 #define SOF_TKN_AMD_ACPDMIC_CH			1801
188 
189 /* CAVS AUDIO FORMAT */
190 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_RATE	1900
191 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_BIT_DEPTH	1901
192 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_VALID_BIT_DEPTH	1902
193 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CHANNELS	1903
194 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_MAP	1904
195 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_CFG	1905
196 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_INTERLEAVING_STYLE	1906
197 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_FMT_CFG	1907
198 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_SAMPLE_TYPE	1908
199 #define SOF_TKN_CAVS_AUDIO_FORMAT_INPUT_PIN_INDEX	1909
200 /* intentional token numbering discontinuity, reserved for future use */
201 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_RATE	1930
202 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_BIT_DEPTH	1931
203 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_VALID_BIT_DEPTH 1932
204 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CHANNELS	1933
205 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_MAP	1934
206 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_CFG	1935
207 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_INTERLEAVING_STYLE	1936
208 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_FMT_CFG	1937
209 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_SAMPLE_TYPE	1938
210 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUTPUT_PIN_INDEX	1939
211 /* intentional token numbering discontinuity, reserved for future use */
212 #define SOF_TKN_CAVS_AUDIO_FORMAT_IBS		1970
213 #define SOF_TKN_CAVS_AUDIO_FORMAT_OBS		1971
214 #define SOF_TKN_CAVS_AUDIO_FORMAT_DMA_BUFFER_SIZE	1972
215 
216 /* COPIER */
217 #define SOF_TKN_INTEL_COPIER_NODE_TYPE		1980
218 #define SOF_TKN_INTEL_COPIER_DEEP_BUFFER_DMA_MS	1981
219 
220 /* ACP I2S */
221 #define SOF_TKN_AMD_ACPI2S_RATE			1700
222 #define SOF_TKN_AMD_ACPI2S_CH			1701
223 #define SOF_TKN_AMD_ACPI2S_TDM_MODE		1702
224 
225 /* MICFIL PDM */
226 #define SOF_TKN_IMX_MICFIL_RATE			2000
227 #define SOF_TKN_IMX_MICFIL_CH			2001
228 
229 /* ACP SDW */
230 #define SOF_TKN_AMD_ACP_SDW_RATE		2100
231 #define SOF_TKN_AMD_ACP_SDW_CH			2101
232 
233 #endif
234