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