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. All rights reserved.
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
39/* DAI */
40/* Token retired with ABI 3.2, do not use for new capabilities
41 * #define	SOF_TKN_DAI_DMAC_CONFIG			153
42 */
43#define SOF_TKN_DAI_TYPE			154
44#define SOF_TKN_DAI_INDEX			155
45#define SOF_TKN_DAI_DIRECTION			156
46
47/* scheduling */
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
57#define SOF_TKN_SCHED_USE_CHAIN_DMA		209
58
59/* volume */
60#define SOF_TKN_VOLUME_RAMP_STEP_TYPE		250
61#define SOF_TKN_VOLUME_RAMP_STEP_MS		251
62
63#define SOF_TKN_GAIN_RAMP_TYPE			260
64#define SOF_TKN_GAIN_RAMP_DURATION		261
65#define SOF_TKN_GAIN_VAL			262
66
67/* SRC */
68#define SOF_TKN_SRC_RATE_IN			300
69#define SOF_TKN_SRC_RATE_OUT			301
70
71/* ASRC */
72#define SOF_TKN_ASRC_RATE_IN			320
73#define SOF_TKN_ASRC_RATE_OUT			321
74#define SOF_TKN_ASRC_ASYNCHRONOUS_MODE		322
75#define SOF_TKN_ASRC_OPERATION_MODE		323
76
77/* PCM */
78#define SOF_TKN_PCM_DMAC_CONFIG			353
79
80/* Generic components */
81#define SOF_TKN_COMP_PERIOD_SINK_COUNT		400
82#define SOF_TKN_COMP_PERIOD_SOURCE_COUNT	401
83#define SOF_TKN_COMP_FORMAT			402
84/* Token retired with ABI 3.2, do not use for new capabilities
85 * #define SOF_TKN_COMP_PRELOAD_COUNT		403
86 */
87#define SOF_TKN_COMP_CORE_ID			404
88#define SOF_TKN_COMP_UUID                       405
89#define SOF_TKN_COMP_CPC			406
90#define SOF_TKN_COMP_IS_PAGES			409
91#define SOF_TKN_COMP_NUM_AUDIO_FORMATS		410
92#define SOF_TKN_COMP_NUM_INPUT_PINS		411
93#define SOF_TKN_COMP_NUM_OUTPUT_PINS		412
94/*
95 * The token for input/output pin binding, it specifies the widget
96 * name that the input/output pin is connected from/to.
97 */
98#define SOF_TKN_COMP_INPUT_PIN_BINDING_WNAME	413
99#define SOF_TKN_COMP_OUTPUT_PIN_BINDING_WNAME	414
100#define SOF_TKN_COMP_NUM_INPUT_AUDIO_FORMATS	415
101#define SOF_TKN_COMP_NUM_OUTPUT_AUDIO_FORMATS	416
102/*
103 * The token value is copied to the dapm_widget's
104 * no_wname_in_kcontrol_name.
105 */
106#define SOF_TKN_COMP_NO_WNAME_IN_KCONTROL_NAME	417
107
108/* SSP */
109#define SOF_TKN_INTEL_SSP_CLKS_CONTROL		500
110#define SOF_TKN_INTEL_SSP_MCLK_ID		501
111#define SOF_TKN_INTEL_SSP_SAMPLE_BITS		502
112#define SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH	503
113#define SOF_TKN_INTEL_SSP_QUIRKS		504
114#define SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT	505
115#define SOF_TKN_INTEL_SSP_BCLK_DELAY		506
116
117/* DMIC */
118#define SOF_TKN_INTEL_DMIC_DRIVER_VERSION	600
119#define SOF_TKN_INTEL_DMIC_CLK_MIN		601
120#define SOF_TKN_INTEL_DMIC_CLK_MAX		602
121#define SOF_TKN_INTEL_DMIC_DUTY_MIN		603
122#define SOF_TKN_INTEL_DMIC_DUTY_MAX		604
123#define SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE	605
124#define SOF_TKN_INTEL_DMIC_SAMPLE_RATE		608
125#define SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH	609
126#define SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS  610
127
128/* DMIC PDM */
129#define SOF_TKN_INTEL_DMIC_PDM_CTRL_ID		700
130#define SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable	701
131#define SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable	702
132#define SOF_TKN_INTEL_DMIC_PDM_POLARITY_A	703
133#define SOF_TKN_INTEL_DMIC_PDM_POLARITY_B	704
134#define SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE		705
135#define SOF_TKN_INTEL_DMIC_PDM_SKEW		706
136
137/* Tone */
138#define SOF_TKN_TONE_SAMPLE_RATE		800
139
140/* Processing Components */
141#define SOF_TKN_PROCESS_TYPE                    900
142
143/* for backward compatibility */
144#define SOF_TKN_EFFECT_TYPE	SOF_TKN_PROCESS_TYPE
145
146/* SAI */
147#define SOF_TKN_IMX_SAI_MCLK_ID			1000
148
149/* ESAI */
150#define SOF_TKN_IMX_ESAI_MCLK_ID		1100
151
152/* Stream */
153#define SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3	1200
154#define SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3	1201
155
156/* Led control for mute switches */
157#define SOF_TKN_MUTE_LED_USE			1300
158#define SOF_TKN_MUTE_LED_DIRECTION		1301
159
160/* ALH */
161#define SOF_TKN_INTEL_ALH_RATE			1400
162#define SOF_TKN_INTEL_ALH_CH			1401
163
164/* HDA */
165#define SOF_TKN_INTEL_HDA_RATE			1500
166#define SOF_TKN_INTEL_HDA_CH			1501
167
168/* AFE */
169#define SOF_TKN_MEDIATEK_AFE_RATE		1600
170#define SOF_TKN_MEDIATEK_AFE_CH			1601
171#define SOF_TKN_MEDIATEK_AFE_FORMAT		1602
172
173/* MIXER */
174#define SOF_TKN_MIXER_TYPE			1700
175
176/* ACPDMIC */
177#define SOF_TKN_AMD_ACPDMIC_RATE		1800
178#define SOF_TKN_AMD_ACPDMIC_CH			1801
179
180/* CAVS AUDIO FORMAT */
181#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_RATE	1900
182#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_BIT_DEPTH	1901
183#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_VALID_BIT_DEPTH	1902
184#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CHANNELS	1903
185#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_MAP	1904
186#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_CH_CFG	1905
187#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_INTERLEAVING_STYLE	1906
188#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_FMT_CFG	1907
189#define SOF_TKN_CAVS_AUDIO_FORMAT_IN_SAMPLE_TYPE	1908
190#define SOF_TKN_CAVS_AUDIO_FORMAT_INPUT_PIN_INDEX	1909
191/* intentional token numbering discontinuity, reserved for future use */
192#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_RATE	1930
193#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_BIT_DEPTH	1931
194#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_VALID_BIT_DEPTH 1932
195#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CHANNELS	1933
196#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_MAP	1934
197#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_CH_CFG	1935
198#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_INTERLEAVING_STYLE	1936
199#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_FMT_CFG	1937
200#define SOF_TKN_CAVS_AUDIO_FORMAT_OUT_SAMPLE_TYPE	1938
201#define SOF_TKN_CAVS_AUDIO_FORMAT_OUTPUT_PIN_INDEX	1939
202/* intentional token numbering discontinuity, reserved for future use */
203#define SOF_TKN_CAVS_AUDIO_FORMAT_IBS		1970
204#define SOF_TKN_CAVS_AUDIO_FORMAT_OBS		1971
205#define SOF_TKN_CAVS_AUDIO_FORMAT_DMA_BUFFER_SIZE	1972
206
207/* COPIER */
208#define SOF_TKN_INTEL_COPIER_NODE_TYPE		1980
209#define SOF_TKN_INTEL_COPIER_DEEP_BUFFER_DMA_MS	1981
210
211/* ACP I2S */
212#define SOF_TKN_AMD_ACPI2S_RATE			1700
213#define SOF_TKN_AMD_ACPI2S_CH			1701
214#define SOF_TKN_AMD_ACPI2S_TDM_MODE		1702
215
216#endif
217