xref: /openbmc/linux/include/uapi/sound/sof/tokens.h (revision 36de991e)
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 
56 /* volume */
57 #define SOF_TKN_VOLUME_RAMP_STEP_TYPE		250
58 #define SOF_TKN_VOLUME_RAMP_STEP_MS		251
59 
60 /* SRC */
61 #define SOF_TKN_SRC_RATE_IN			300
62 #define SOF_TKN_SRC_RATE_OUT			301
63 
64 /* ASRC */
65 #define SOF_TKN_ASRC_RATE_IN			320
66 #define SOF_TKN_ASRC_RATE_OUT			321
67 #define SOF_TKN_ASRC_ASYNCHRONOUS_MODE		322
68 #define SOF_TKN_ASRC_OPERATION_MODE		323
69 
70 /* PCM */
71 #define SOF_TKN_PCM_DMAC_CONFIG			353
72 
73 /* Generic components */
74 #define SOF_TKN_COMP_PERIOD_SINK_COUNT		400
75 #define SOF_TKN_COMP_PERIOD_SOURCE_COUNT	401
76 #define SOF_TKN_COMP_FORMAT			402
77 /* Token retired with ABI 3.2, do not use for new capabilities
78  * #define SOF_TKN_COMP_PRELOAD_COUNT		403
79  */
80 #define SOF_TKN_COMP_CORE_ID			404
81 #define SOF_TKN_COMP_UUID                       405
82 
83 /* SSP */
84 #define SOF_TKN_INTEL_SSP_CLKS_CONTROL		500
85 #define SOF_TKN_INTEL_SSP_MCLK_ID		501
86 #define SOF_TKN_INTEL_SSP_SAMPLE_BITS		502
87 #define SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH	503
88 #define SOF_TKN_INTEL_SSP_QUIRKS		504
89 #define SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT	505
90 #define SOF_TKN_INTEL_SSP_BCLK_DELAY		506
91 
92 /* DMIC */
93 #define SOF_TKN_INTEL_DMIC_DRIVER_VERSION	600
94 #define SOF_TKN_INTEL_DMIC_CLK_MIN		601
95 #define SOF_TKN_INTEL_DMIC_CLK_MAX		602
96 #define SOF_TKN_INTEL_DMIC_DUTY_MIN		603
97 #define SOF_TKN_INTEL_DMIC_DUTY_MAX		604
98 #define SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE	605
99 #define SOF_TKN_INTEL_DMIC_SAMPLE_RATE		608
100 #define SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH	609
101 #define SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS  610
102 
103 /* DMIC PDM */
104 #define SOF_TKN_INTEL_DMIC_PDM_CTRL_ID		700
105 #define SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable	701
106 #define SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable	702
107 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_A	703
108 #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_B	704
109 #define SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE		705
110 #define SOF_TKN_INTEL_DMIC_PDM_SKEW		706
111 
112 /* Tone */
113 #define SOF_TKN_TONE_SAMPLE_RATE		800
114 
115 /* Processing Components */
116 #define SOF_TKN_PROCESS_TYPE                    900
117 
118 /* for backward compatibility */
119 #define SOF_TKN_EFFECT_TYPE	SOF_TKN_PROCESS_TYPE
120 
121 /* SAI */
122 #define SOF_TKN_IMX_SAI_MCLK_ID			1000
123 
124 /* ESAI */
125 #define SOF_TKN_IMX_ESAI_MCLK_ID		1100
126 
127 /* Stream */
128 #define SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3	1200
129 #define SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3	1201
130 
131 /* Led control for mute switches */
132 #define SOF_TKN_MUTE_LED_USE			1300
133 #define SOF_TKN_MUTE_LED_DIRECTION		1301
134 
135 /* ALH */
136 #define SOF_TKN_INTEL_ALH_RATE			1400
137 #define SOF_TKN_INTEL_ALH_CH			1401
138 
139 /* HDA */
140 #define SOF_TKN_INTEL_HDA_RATE			1500
141 #define SOF_TKN_INTEL_HDA_CH			1501
142 
143 #endif
144