2 * uapi/sound/asoc.h -- ALSA SoC Firmware Controls and DAPM
4 * Copyright (C) 2012 Texas Instruments Inc.
5 * Copyright (C) 2015 Intel Corporation.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * Simple file API to load FW that includes mixers, coefficients, DAPM graphs,
12 * algorithms, equalisers, DAIs, widgets etc.
15 #ifndef __LINUX_UAPI_SND_ASOC_H
16 #define __LINUX_UAPI_SND_ASOC_H
18 #include <linux/types.h>
19 #include <sound/asound.h>
22 * Maximum number of channels topology kcontrol can represent.
24 #define SND_SOC_TPLG_MAX_CHAN 8
27 * Maximum number of PCM formats capability
29 #define SND_SOC_TPLG_MAX_FORMATS 16
32 * Maximum number of PCM stream configs
34 #define SND_SOC_TPLG_STREAM_CONFIG_MAX 8
36 /* individual kcontrol info types - can be mixed with other types */
37 #define SND_SOC_TPLG_CTL_VOLSW 1
38 #define SND_SOC_TPLG_CTL_VOLSW_SX 2
39 #define SND_SOC_TPLG_CTL_VOLSW_XR_SX 3
40 #define SND_SOC_TPLG_CTL_ENUM 4
41 #define SND_SOC_TPLG_CTL_BYTES 5
42 #define SND_SOC_TPLG_CTL_ENUM_VALUE 6
43 #define SND_SOC_TPLG_CTL_RANGE 7
44 #define SND_SOC_TPLG_CTL_STROBE 8
47 /* individual widget kcontrol info types - can be mixed with other types */
48 #define SND_SOC_TPLG_DAPM_CTL_VOLSW 64
49 #define SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE 65
50 #define SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT 66
51 #define SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE 67
52 #define SND_SOC_TPLG_DAPM_CTL_PIN 68
54 /* DAPM widget types - add new items to the end */
55 #define SND_SOC_TPLG_DAPM_INPUT 0
56 #define SND_SOC_TPLG_DAPM_OUTPUT 1
57 #define SND_SOC_TPLG_DAPM_MUX 2
58 #define SND_SOC_TPLG_DAPM_MIXER 3
59 #define SND_SOC_TPLG_DAPM_PGA 4
60 #define SND_SOC_TPLG_DAPM_OUT_DRV 5
61 #define SND_SOC_TPLG_DAPM_ADC 6
62 #define SND_SOC_TPLG_DAPM_DAC 7
63 #define SND_SOC_TPLG_DAPM_SWITCH 8
64 #define SND_SOC_TPLG_DAPM_PRE 9
65 #define SND_SOC_TPLG_DAPM_POST 10
66 #define SND_SOC_TPLG_DAPM_AIF_IN 11
67 #define SND_SOC_TPLG_DAPM_AIF_OUT 12
68 #define SND_SOC_TPLG_DAPM_DAI_IN 13
69 #define SND_SOC_TPLG_DAPM_DAI_OUT 14
70 #define SND_SOC_TPLG_DAPM_DAI_LINK 15
71 #define SND_SOC_TPLG_DAPM_LAST SND_SOC_TPLG_DAPM_DAI_LINK
73 /* Header magic number and string sizes */
74 #define SND_SOC_TPLG_MAGIC 0x41536F43 /* ASoC */
77 #define SND_SOC_TPLG_NUM_TEXTS 16
80 #define SND_SOC_TPLG_ABI_VERSION 0x2
82 /* Max size of TLV data */
83 #define SND_SOC_TPLG_TLV_SIZE 32
86 * File and Block header data types.
87 * Add new generic and vendor types to end of list.
88 * Generic types are handled by the core whilst vendors types are passed
89 * to the component drivers for handling.
91 #define SND_SOC_TPLG_TYPE_MIXER 1
92 #define SND_SOC_TPLG_TYPE_BYTES 2
93 #define SND_SOC_TPLG_TYPE_ENUM 3
94 #define SND_SOC_TPLG_TYPE_DAPM_GRAPH 4
95 #define SND_SOC_TPLG_TYPE_DAPM_WIDGET 5
96 #define SND_SOC_TPLG_TYPE_DAI_LINK 6
97 #define SND_SOC_TPLG_TYPE_PCM 7
98 #define SND_SOC_TPLG_TYPE_MANIFEST 8
99 #define SND_SOC_TPLG_TYPE_CODEC_LINK 9
100 #define SND_SOC_TPLG_TYPE_MAX SND_SOC_TPLG_TYPE_CODEC_LINK
102 /* vendor block IDs - please add new vendor types to end */
103 #define SND_SOC_TPLG_TYPE_VENDOR_FW 1000
104 #define SND_SOC_TPLG_TYPE_VENDOR_CONFIG 1001
105 #define SND_SOC_TPLG_TYPE_VENDOR_COEFF 1002
106 #define SND_SOC_TPLG_TYPEVENDOR_CODEC 1003
108 #define SND_SOC_TPLG_STREAM_PLAYBACK 0
109 #define SND_SOC_TPLG_STREAM_CAPTURE 1
113 * This header precedes all object and object arrays below.
115 struct snd_soc_tplg_hdr
{
116 __le32 magic
; /* magic number */
117 __le32 abi
; /* ABI version */
118 __le32 version
; /* optional vendor specific version details */
119 __le32 type
; /* SND_SOC_TPLG_TYPE_ */
120 __le32 size
; /* size of this structure */
121 __le32 vendor_type
; /* optional vendor specific type info */
122 __le32 payload_size
; /* data bytes, excluding this header */
123 __le32 index
; /* identifier for block */
124 __le32 count
; /* number of elements in block */
125 } __attribute__((packed
));
129 * All topology objects may have private data that can be used by the driver or
130 * firmware. Core will ignore this data.
132 struct snd_soc_tplg_private
{
133 __le32 size
; /* in bytes of private data */
135 } __attribute__((packed
));
140 struct snd_soc_tplg_tlv_dbscale
{
144 } __attribute__((packed
));
146 struct snd_soc_tplg_ctl_tlv
{
147 __le32 size
; /* in bytes of this structure */
148 __le32 type
; /* SNDRV_CTL_TLVT_*, type of TLV */
150 __le32 data
[SND_SOC_TPLG_TLV_SIZE
];
151 struct snd_soc_tplg_tlv_dbscale scale
;
153 } __attribute__((packed
));
156 * Kcontrol channel data
158 struct snd_soc_tplg_channel
{
159 __le32 size
; /* in bytes of this structure */
162 __le32 id
; /* ID maps to Left, Right, LFE etc */
163 } __attribute__((packed
));
166 * Kcontrol Operations IDs
168 struct snd_soc_tplg_kcontrol_ops_id
{
172 } __attribute__((packed
));
177 struct snd_soc_tplg_ctl_hdr
{
178 __le32 size
; /* in bytes of this structure */
180 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
182 struct snd_soc_tplg_kcontrol_ops_id ops
;
183 struct snd_soc_tplg_ctl_tlv tlv
;
184 } __attribute__((packed
));
187 * Stream Capabilities
189 struct snd_soc_tplg_stream_caps
{
190 __le32 size
; /* in bytes of this structure */
191 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
192 __le64 formats
[SND_SOC_TPLG_MAX_FORMATS
]; /* supported formats SNDRV_PCM_FMTBIT_* */
193 __le32 rates
; /* supported rates SNDRV_PCM_RATE_* */
194 __le32 rate_min
; /* min rate */
195 __le32 rate_max
; /* max rate */
196 __le32 channels_min
; /* min channels */
197 __le32 channels_max
; /* max channels */
198 __le32 periods_min
; /* min number of periods */
199 __le32 periods_max
; /* max number of periods */
200 __le32 period_size_min
; /* min period size bytes */
201 __le32 period_size_max
; /* max period size bytes */
202 __le32 buffer_size_min
; /* min buffer size bytes */
203 __le32 buffer_size_max
; /* max buffer size bytes */
204 } __attribute__((packed
));
207 * FE or BE Stream configuration supported by SW/FW
209 struct snd_soc_tplg_stream
{
210 __le32 size
; /* in bytes of this structure */
211 __le64 format
; /* SNDRV_PCM_FMTBIT_* */
212 __le32 rate
; /* SNDRV_PCM_RATE_* */
213 __le32 period_bytes
; /* size of period in bytes */
214 __le32 buffer_bytes
; /* size of buffer in bytes */
215 __le32 channels
; /* channels */
216 __le32 tdm_slot
; /* optional BE bitmask of supported TDM slots */
217 __le32 dai_fmt
; /* SND_SOC_DAIFMT_ */
218 } __attribute__((packed
));
221 * Duplex stream configuration supported by SW/FW.
223 struct snd_soc_tplg_stream_config
{
224 __le32 size
; /* in bytes of this structure */
225 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
226 struct snd_soc_tplg_stream playback
;
227 struct snd_soc_tplg_stream capture
;
228 } __attribute__((packed
));
231 * Manifest. List totals for each payload type. Not used in parsing, but will
232 * be passed to the component driver before any other objects in order for any
233 * global component resource allocations.
235 * File block representation for manifest :-
236 * +-----------------------------------+----+
237 * | struct snd_soc_tplg_hdr | 1 |
238 * +-----------------------------------+----+
239 * | struct snd_soc_tplg_manifest | 1 |
240 * +-----------------------------------+----+
242 struct snd_soc_tplg_manifest
{
243 __le32 size
; /* in bytes of this structure */
244 __le32 control_elems
; /* number of control elements */
245 __le32 widget_elems
; /* number of widget elements */
246 __le32 graph_elems
; /* number of graph elements */
247 __le32 dai_elems
; /* number of DAI elements */
248 __le32 dai_link_elems
; /* number of DAI link elements */
249 struct snd_soc_tplg_private priv
;
250 } __attribute__((packed
));
255 * File block representation for mixer kcontrol :-
256 * +-----------------------------------+----+
257 * | struct snd_soc_tplg_hdr | 1 |
258 * +-----------------------------------+----+
259 * | struct snd_soc_tplg_mixer_control | N |
260 * +-----------------------------------+----+
262 struct snd_soc_tplg_mixer_control
{
263 struct snd_soc_tplg_ctl_hdr hdr
;
264 __le32 size
; /* in bytes of this structure */
270 struct snd_soc_tplg_channel channel
[SND_SOC_TPLG_MAX_CHAN
];
271 struct snd_soc_tplg_private priv
;
272 } __attribute__((packed
));
275 * Enumerated kcontrol
277 * File block representation for enum kcontrol :-
278 * +-----------------------------------+----+
279 * | struct snd_soc_tplg_hdr | 1 |
280 * +-----------------------------------+----+
281 * | struct snd_soc_tplg_enum_control | N |
282 * +-----------------------------------+----+
284 struct snd_soc_tplg_enum_control
{
285 struct snd_soc_tplg_ctl_hdr hdr
;
286 __le32 size
; /* in bytes of this structure */
288 struct snd_soc_tplg_channel channel
[SND_SOC_TPLG_MAX_CHAN
];
292 char texts
[SND_SOC_TPLG_NUM_TEXTS
][SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
293 __le32 values
[SND_SOC_TPLG_NUM_TEXTS
* SNDRV_CTL_ELEM_ID_NAME_MAXLEN
/ 4];
294 struct snd_soc_tplg_private priv
;
295 } __attribute__((packed
));
300 * File block representation for bytes kcontrol :-
301 * +-----------------------------------+----+
302 * | struct snd_soc_tplg_hdr | 1 |
303 * +-----------------------------------+----+
304 * | struct snd_soc_tplg_bytes_control | N |
305 * +-----------------------------------+----+
307 struct snd_soc_tplg_bytes_control
{
308 struct snd_soc_tplg_ctl_hdr hdr
;
309 __le32 size
; /* in bytes of this structure */
314 struct snd_soc_tplg_private priv
;
315 } __attribute__((packed
));
320 * File block representation for DAPM graph elements :-
321 * +-------------------------------------+----+
322 * | struct snd_soc_tplg_hdr | 1 |
323 * +-------------------------------------+----+
324 * | struct snd_soc_tplg_dapm_graph_elem | N |
325 * +-------------------------------------+----+
327 struct snd_soc_tplg_dapm_graph_elem
{
328 char sink
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
329 char control
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
330 char source
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
331 } __attribute__((packed
));
336 * File block representation for DAPM widget :-
337 * +-------------------------------------+-----+
338 * | struct snd_soc_tplg_hdr | 1 |
339 * +-------------------------------------+-----+
340 * | struct snd_soc_tplg_dapm_widget | N |
341 * +-------------------------------------+-----+
342 * | struct snd_soc_tplg_enum_control | 0|1 |
343 * | struct snd_soc_tplg_mixer_control | 0|N |
344 * +-------------------------------------+-----+
346 * Optional enum or mixer control can be appended to the end of each widget
349 struct snd_soc_tplg_dapm_widget
{
350 __le32 size
; /* in bytes of this structure */
351 __le32 id
; /* SND_SOC_DAPM_CTL */
352 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
353 char sname
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
355 __le32 reg
; /* negative reg = no direct dapm */
356 __le32 shift
; /* bits to shift */
357 __le32 mask
; /* non-shifted mask */
358 __le32 subseq
; /* sort within widget type */
359 __u32 invert
; /* invert the power bit */
360 __u32 ignore_suspend
; /* kept enabled over suspend */
364 struct snd_soc_tplg_private priv
;
366 * kcontrols that relate to this widget
367 * follow here after widget private data
369 } __attribute__((packed
));
371 struct snd_soc_tplg_pcm_cfg_caps
{
372 struct snd_soc_tplg_stream_caps caps
;
373 struct snd_soc_tplg_stream_config configs
[SND_SOC_TPLG_STREAM_CONFIG_MAX
];
374 __le32 num_configs
; /* number of configs */
375 } __attribute__((packed
));
378 * Describes SW/FW specific features of PCM or DAI link.
380 * File block representation for PCM/DAI-Link :-
381 * +-----------------------------------+-----+
382 * | struct snd_soc_tplg_hdr | 1 |
383 * +-----------------------------------+-----+
384 * | struct snd_soc_tplg_dapm_pcm_dai | N |
385 * +-----------------------------------+-----+
387 struct snd_soc_tplg_pcm_dai
{
388 __le32 size
; /* in bytes of this structure */
389 char name
[SNDRV_CTL_ELEM_ID_NAME_MAXLEN
];
390 __le32 id
; /* unique ID - used to match */
391 __le32 playback
; /* supports playback mode */
392 __le32 capture
; /* supports capture mode */
393 __le32 compress
; /* 1 = compressed; 0 = PCM */
394 struct snd_soc_tplg_pcm_cfg_caps capconf
[2]; /* capabilities and configs */
395 } __attribute__((packed
));