1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
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.
6 * Copyright(c) 2018 Intel Corporation. All rights reserved.
7 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
8 * Keyon Jie <yang.jie@linux.intel.com>
12 * Topology IDs and tokens.
14 * ** MUST BE ALIGNED WITH TOPOLOGY CONFIGURATION TOKEN VALUES **
17 #ifndef __INCLUDE_UAPI_SOF_TOPOLOGY_H__
18 #define __INCLUDE_UAPI_SOF_TOPOLOGY_H__
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
32 * Tokens - must match values in topology configurations
36 #define SOF_TKN_BUF_SIZE 100
37 #define SOF_TKN_BUF_CAPS 101
40 /* Token retired with ABI 3.2, do not use for new capabilities
41 * #define SOF_TKN_DAI_DMAC_CONFIG 153
43 #define SOF_TKN_DAI_TYPE 154
44 #define SOF_TKN_DAI_INDEX 155
45 #define SOF_TKN_DAI_DIRECTION 156
48 #define SOF_TKN_SCHED_PERIOD 200
49 #define SOF_TKN_SCHED_PRIORITY 201
50 #define SOF_TKN_SCHED_MIPS 202
51 #define SOF_TKN_SCHED_CORE 203
52 #define SOF_TKN_SCHED_FRAMES 204
53 #define SOF_TKN_SCHED_TIME_DOMAIN 205
54 #define SOF_TKN_SCHED_DYNAMIC_PIPELINE 206
55 #define SOF_TKN_SCHED_LP_MODE 207
56 #define SOF_TKN_SCHED_MEM_USAGE 208
59 #define SOF_TKN_VOLUME_RAMP_STEP_TYPE 250
60 #define SOF_TKN_VOLUME_RAMP_STEP_MS 251
62 #define SOF_TKN_GAIN_RAMP_TYPE 260
63 #define SOF_TKN_GAIN_RAMP_DURATION 261
64 #define SOF_TKN_GAIN_VAL 262
67 #define SOF_TKN_SRC_RATE_IN 300
68 #define SOF_TKN_SRC_RATE_OUT 301
71 #define SOF_TKN_ASRC_RATE_IN 320
72 #define SOF_TKN_ASRC_RATE_OUT 321
73 #define SOF_TKN_ASRC_ASYNCHRONOUS_MODE 322
74 #define SOF_TKN_ASRC_OPERATION_MODE 323
77 #define SOF_TKN_PCM_DMAC_CONFIG 353
79 /* Generic components */
80 #define SOF_TKN_COMP_PERIOD_SINK_COUNT 400
81 #define SOF_TKN_COMP_PERIOD_SOURCE_COUNT 401
82 #define SOF_TKN_COMP_FORMAT 402
83 /* Token retired with ABI 3.2, do not use for new capabilities
84 * #define SOF_TKN_COMP_PRELOAD_COUNT 403
86 #define SOF_TKN_COMP_CORE_ID 404
87 #define SOF_TKN_COMP_UUID 405
88 #define SOF_TKN_COMP_CPC 406
89 #define SOF_TKN_COMP_IS_PAGES 409
90 #define SOF_TKN_COMP_NUM_AUDIO_FORMATS 410
93 #define SOF_TKN_INTEL_SSP_CLKS_CONTROL 500
94 #define SOF_TKN_INTEL_SSP_MCLK_ID 501
95 #define SOF_TKN_INTEL_SSP_SAMPLE_BITS 502
96 #define SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH 503
97 #define SOF_TKN_INTEL_SSP_QUIRKS 504
98 #define SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT 505
99 #define SOF_TKN_INTEL_SSP_BCLK_DELAY 506
102 #define SOF_TKN_INTEL_DMIC_DRIVER_VERSION 600
103 #define SOF_TKN_INTEL_DMIC_CLK_MIN 601
104 #define SOF_TKN_INTEL_DMIC_CLK_MAX 602
105 #define SOF_TKN_INTEL_DMIC_DUTY_MIN 603
106 #define SOF_TKN_INTEL_DMIC_DUTY_MAX 604
107 #define SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE 605
108 #define SOF_TKN_INTEL_DMIC_SAMPLE_RATE 608
109 #define SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH 609
110 #define SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS 610
113 #define SOF_TKN_INTEL_DMIC_PDM_CTRL_ID 700
114 #define SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable 701
115 #define SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable 702
116 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_A 703
117 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_B 704
118 #define SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE 705
119 #define SOF_TKN_INTEL_DMIC_PDM_SKEW 706
122 #define SOF_TKN_TONE_SAMPLE_RATE 800
124 /* Processing Components */
125 #define SOF_TKN_PROCESS_TYPE 900
127 /* for backward compatibility */
128 #define SOF_TKN_EFFECT_TYPE SOF_TKN_PROCESS_TYPE
131 #define SOF_TKN_IMX_SAI_MCLK_ID 1000
134 #define SOF_TKN_IMX_ESAI_MCLK_ID 1100
137 #define SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3 1200
138 #define SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3 1201
140 /* Led control for mute switches */
141 #define SOF_TKN_MUTE_LED_USE 1300
142 #define SOF_TKN_MUTE_LED_DIRECTION 1301
145 #define SOF_TKN_INTEL_ALH_RATE 1400
146 #define SOF_TKN_INTEL_ALH_CH 1401
149 #define SOF_TKN_INTEL_HDA_RATE 1500
150 #define SOF_TKN_INTEL_HDA_CH 1501
153 #define SOF_TKN_MEDIATEK_AFE_RATE 1600
154 #define SOF_TKN_MEDIATEK_AFE_CH 1601
155 #define SOF_TKN_MEDIATEK_AFE_FORMAT 1602
158 #define SOF_TKN_MIXER_TYPE 1700
161 #define SOF_TKN_AMD_ACPDMIC_RATE 1800
162 #define SOF_TKN_AMD_ACPDMIC_CH 1801
164 /* CAVS AUDIO FORMAT */
165 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_RATE 1900
166 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_BIT_DEPTH 1901
167 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_VALID_BIT 1902
168 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CHANNELS 1903
169 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_MAP 1904
170 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_CFG 1905
171 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_INTERLEAVING_STYLE 1906
172 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_FMT_CFG 1907
173 #define SOF_TKN_CAVS_AUDIO_FORMAT_IN_SAMPLE_TYPE 1908
174 /* intentional token numbering discontinuity, reserved for future use */
175 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_RATE 1930
176 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_BIT_DEPTH 1931
177 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_VALID_BIT 1932
178 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CHANNELS 1933
179 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_MAP 1934
180 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_CFG 1935
181 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_INTERLEAVING_STYLE 1936
182 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_FMT_CFG 1937
183 #define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_SAMPLE_TYPE 1938
184 /* intentional token numbering discontinuity, reserved for future use */
185 #define SOF_TKN_CAVS_AUDIO_FORMAT_IBS 1970
186 #define SOF_TKN_CAVS_AUDIO_FORMAT_OBS 1971
187 #define SOF_TKN_CAVS_AUDIO_FORMAT_DMA_BUFFER_SIZE 1972
190 #define SOF_TKN_INTEL_COPIER_NODE_TYPE 1980