xref: /openbmc/linux/include/uapi/sound/sof/tokens.h (revision 2c28ecad)
14483151eSLiam Girdwood /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
24483151eSLiam Girdwood /*
34483151eSLiam Girdwood  * This file is provided under a dual BSD/GPLv2 license.  When using or
44483151eSLiam Girdwood  * redistributing this file, you may do so under either license.
54483151eSLiam Girdwood  *
64483151eSLiam Girdwood  * Copyright(c) 2018 Intel Corporation. All rights reserved.
74483151eSLiam Girdwood  * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
84483151eSLiam Girdwood  *         Keyon Jie <yang.jie@linux.intel.com>
94483151eSLiam Girdwood  */
104483151eSLiam Girdwood 
114483151eSLiam Girdwood /*
124483151eSLiam Girdwood  * Topology IDs and tokens.
134483151eSLiam Girdwood  *
144483151eSLiam Girdwood  * ** MUST BE ALIGNED WITH TOPOLOGY CONFIGURATION TOKEN VALUES **
154483151eSLiam Girdwood  */
164483151eSLiam Girdwood 
174483151eSLiam Girdwood #ifndef __INCLUDE_UAPI_SOF_TOPOLOGY_H__
184483151eSLiam Girdwood #define __INCLUDE_UAPI_SOF_TOPOLOGY_H__
194483151eSLiam Girdwood 
204483151eSLiam Girdwood /*
214483151eSLiam Girdwood  * Kcontrol IDs
224483151eSLiam Girdwood  */
234483151eSLiam Girdwood #define SOF_TPLG_KCTL_VOL_ID	256
244483151eSLiam Girdwood #define SOF_TPLG_KCTL_ENUM_ID	257
254483151eSLiam Girdwood #define SOF_TPLG_KCTL_BYTES_ID	258
264483151eSLiam Girdwood #define SOF_TPLG_KCTL_SWITCH_ID	259
27783560d0SDharageswari R #define SOF_TPLG_KCTL_BYTES_VOLATILE_RO 260
28783560d0SDharageswari R #define SOF_TPLG_KCTL_BYTES_VOLATILE_RW 261
29783560d0SDharageswari R #define SOF_TPLG_KCTL_BYTES_WO_ID 262
304483151eSLiam Girdwood 
314483151eSLiam Girdwood /*
324483151eSLiam Girdwood  * Tokens - must match values in topology configurations
334483151eSLiam Girdwood  */
344483151eSLiam Girdwood 
354483151eSLiam Girdwood /* buffers */
364483151eSLiam Girdwood #define SOF_TKN_BUF_SIZE			100
374483151eSLiam Girdwood #define SOF_TKN_BUF_CAPS			101
384483151eSLiam Girdwood 
394483151eSLiam Girdwood /* DAI */
404483151eSLiam Girdwood /* Token retired with ABI 3.2, do not use for new capabilities
414483151eSLiam Girdwood  * #define	SOF_TKN_DAI_DMAC_CONFIG			153
424483151eSLiam Girdwood  */
434483151eSLiam Girdwood #define SOF_TKN_DAI_TYPE			154
444483151eSLiam Girdwood #define SOF_TKN_DAI_INDEX			155
454483151eSLiam Girdwood #define SOF_TKN_DAI_DIRECTION			156
464483151eSLiam Girdwood 
474483151eSLiam Girdwood /* scheduling */
484483151eSLiam Girdwood #define SOF_TKN_SCHED_PERIOD			200
494483151eSLiam Girdwood #define SOF_TKN_SCHED_PRIORITY			201
504483151eSLiam Girdwood #define SOF_TKN_SCHED_MIPS			202
514483151eSLiam Girdwood #define SOF_TKN_SCHED_CORE			203
524483151eSLiam Girdwood #define SOF_TKN_SCHED_FRAMES			204
534483151eSLiam Girdwood #define SOF_TKN_SCHED_TIME_DOMAIN		205
54*2c28ecadSRanjani Sridharan #define SOF_TKN_SCHED_DYNAMIC_PIPELINE		206
554483151eSLiam Girdwood 
564483151eSLiam Girdwood /* volume */
574483151eSLiam Girdwood #define SOF_TKN_VOLUME_RAMP_STEP_TYPE		250
584483151eSLiam Girdwood #define SOF_TKN_VOLUME_RAMP_STEP_MS		251
594483151eSLiam Girdwood 
604483151eSLiam Girdwood /* SRC */
614483151eSLiam Girdwood #define SOF_TKN_SRC_RATE_IN			300
624483151eSLiam Girdwood #define SOF_TKN_SRC_RATE_OUT			301
634483151eSLiam Girdwood 
64433363e7SSeppo Ingalsuo /* ASRC */
65433363e7SSeppo Ingalsuo #define SOF_TKN_ASRC_RATE_IN			320
66433363e7SSeppo Ingalsuo #define SOF_TKN_ASRC_RATE_OUT			321
67433363e7SSeppo Ingalsuo #define SOF_TKN_ASRC_ASYNCHRONOUS_MODE		322
68433363e7SSeppo Ingalsuo #define SOF_TKN_ASRC_OPERATION_MODE		323
69433363e7SSeppo Ingalsuo 
704483151eSLiam Girdwood /* PCM */
714483151eSLiam Girdwood #define SOF_TKN_PCM_DMAC_CONFIG			353
724483151eSLiam Girdwood 
734483151eSLiam Girdwood /* Generic components */
744483151eSLiam Girdwood #define SOF_TKN_COMP_PERIOD_SINK_COUNT		400
754483151eSLiam Girdwood #define SOF_TKN_COMP_PERIOD_SOURCE_COUNT	401
764483151eSLiam Girdwood #define SOF_TKN_COMP_FORMAT			402
774483151eSLiam Girdwood /* Token retired with ABI 3.2, do not use for new capabilities
784483151eSLiam Girdwood  * #define SOF_TKN_COMP_PRELOAD_COUNT		403
794483151eSLiam Girdwood  */
80d1c6c4a9SGuennadi Liakhovetski #define SOF_TKN_COMP_CORE_ID			404
8143fbb086SKeyon Jie #define SOF_TKN_COMP_UUID                       405
824483151eSLiam Girdwood 
834483151eSLiam Girdwood /* SSP */
844483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_CLKS_CONTROL		500
854483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_MCLK_ID		501
864483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_SAMPLE_BITS		502
874483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH	503
884483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_QUIRKS		504
894483151eSLiam Girdwood #define SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT	505
906298b787SJanusz Jankowski #define SOF_TKN_INTEL_SSP_BCLK_DELAY		506
914483151eSLiam Girdwood 
924483151eSLiam Girdwood /* DMIC */
934483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_DRIVER_VERSION	600
944483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_CLK_MIN		601
954483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_CLK_MAX		602
964483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_DUTY_MIN		603
974483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_DUTY_MAX		604
984483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE	605
994483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_SAMPLE_RATE		608
1004483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH	609
1017df43911SSeppo Ingalsuo #define SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS  610
1024483151eSLiam Girdwood 
1034483151eSLiam Girdwood /* DMIC PDM */
1044483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_CTRL_ID		700
1054483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable	701
1064483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable	702
1074483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_A	703
1084483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_POLARITY_B	704
1094483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE		705
1104483151eSLiam Girdwood #define SOF_TKN_INTEL_DMIC_PDM_SKEW		706
1114483151eSLiam Girdwood 
1124483151eSLiam Girdwood /* Tone */
1134483151eSLiam Girdwood #define SOF_TKN_TONE_SAMPLE_RATE		800
1144483151eSLiam Girdwood 
1154483151eSLiam Girdwood /* Processing Components */
1164483151eSLiam Girdwood #define SOF_TKN_PROCESS_TYPE                    900
1174483151eSLiam Girdwood 
1184483151eSLiam Girdwood /* for backward compatibility */
1194483151eSLiam Girdwood #define SOF_TKN_EFFECT_TYPE	SOF_TKN_PROCESS_TYPE
1204483151eSLiam Girdwood 
121f59b16efSDaniel Baluta /* SAI */
1229c1d4cf6SGuido Roncarolo #define SOF_TKN_IMX_SAI_MCLK_ID			1000
123f59b16efSDaniel Baluta 
124f59b16efSDaniel Baluta /* ESAI */
125b4be4276SDaniel Baluta #define SOF_TKN_IMX_ESAI_MCLK_ID		1100
126f59b16efSDaniel Baluta 
1274a949409SKeyon Jie /* Stream */
1284a949409SKeyon Jie #define SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3	1200
1294a949409SKeyon Jie #define SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3	1201
1304a949409SKeyon Jie 
1315d43001aSJaska Uimonen /* Led control for mute switches */
1325d43001aSJaska Uimonen #define SOF_TKN_MUTE_LED_USE			1300
1335d43001aSJaska Uimonen #define SOF_TKN_MUTE_LED_DIRECTION		1301
1345d43001aSJaska Uimonen 
135c7fc96dfSBard Liao /* ALH */
136c7fc96dfSBard Liao #define SOF_TKN_INTEL_ALH_RATE			1400
137c7fc96dfSBard Liao #define SOF_TKN_INTEL_ALH_CH			1401
138c7fc96dfSBard Liao 
13918aaab64SBard Liao /* HDA */
14018aaab64SBard Liao #define SOF_TKN_INTEL_HDA_RATE			1500
14118aaab64SBard Liao #define SOF_TKN_INTEL_HDA_CH			1501
14218aaab64SBard Liao 
1434483151eSLiam Girdwood #endif
144