xref: /linux/include/sound/sdca_function.h (revision fcab107abe1ab5be9dbe874baa722372da8f4f73) 
1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2 /*
3  * The MIPI SDCA specification is available for public downloads at
4  * https://www.mipi.org/mipi-sdca-v1-0-download
5  *
6  * Copyright(c) 2024 Intel Corporation
7  */
8 
9 #ifndef __SDCA_FUNCTION_H__
10 #define __SDCA_FUNCTION_H__
11 
12 #include <linux/bits.h>
13 #include <linux/types.h>
14 
15 struct device;
16 struct sdca_entity;
17 struct sdca_function_desc;
18 
19 /*
20  * The addressing space for SDCA relies on 7 bits for Entities, so a
21  * maximum of 128 Entities per function can be represented.
22  */
23 #define SDCA_MAX_ENTITY_COUNT 128
24 
25 /*
26  * Sanity check on number of initialization writes, can be expanded if needed.
27  */
28 #define SDCA_MAX_INIT_COUNT 2048
29 
30 /*
31  * The Cluster IDs are 16-bit, so a maximum of 65535 Clusters per
32  * function can be represented, however limit this to a slightly
33  * more reasonable value. Can be expanded if needed.
34  */
35 #define SDCA_MAX_CLUSTER_COUNT 256
36 
37 /*
38  * Sanity check on number of channels per Cluster, can be expanded if needed.
39  */
40 #define SDCA_MAX_CHANNEL_COUNT 32
41 
42 /*
43  * Sanity check on number of PDE delays, can be expanded if needed.
44  */
45 #define SDCA_MAX_DELAY_COUNT 256
46 
47 /*
48  * Sanity check on size of affected controls data, can be expanded if needed.
49  */
50 #define SDCA_MAX_AFFECTED_COUNT 2048
51 
52 /**
53  * enum sdca_function_type - SDCA Function Type codes
54  * @SDCA_FUNCTION_TYPE_SMART_AMP: Amplifier with protection features.
55  * @SDCA_FUNCTION_TYPE_SIMPLE_AMP: Subset of SmartAmp.
56  * @SDCA_FUNCTION_TYPE_SMART_MIC: Smart microphone with acoustic triggers.
57  * @SDCA_FUNCTION_TYPE_SIMPLE_MIC: Subset of SmartMic.
58  * @SDCA_FUNCTION_TYPE_SPEAKER_MIC: Combination of SmartMic and SmartAmp.
59  * @SDCA_FUNCTION_TYPE_UAJ: 3.5mm Universal Audio jack.
60  * @SDCA_FUNCTION_TYPE_RJ: Retaskable jack.
61  * @SDCA_FUNCTION_TYPE_SIMPLE_JACK: Subset of UAJ.
62  * @SDCA_FUNCTION_TYPE_HID: Human Interface Device, for e.g. buttons.
63  * @SDCA_FUNCTION_TYPE_IMP_DEF: Implementation-defined function.
64  *
65  * SDCA Function Types from SDCA specification v1.0a Section 5.1.2
66  * all Function types not described are reserved.
67  *
68  * Note that SIMPLE_AMP, SIMPLE_MIC and SIMPLE_JACK Function Types
69  * are NOT defined in SDCA 1.0a, but they were defined in earlier
70  * drafts and are planned for 1.1.
71  */
72 enum sdca_function_type {
73 	SDCA_FUNCTION_TYPE_SMART_AMP			= 0x01,
74 	SDCA_FUNCTION_TYPE_SIMPLE_AMP			= 0x02,
75 	SDCA_FUNCTION_TYPE_SMART_MIC			= 0x03,
76 	SDCA_FUNCTION_TYPE_SIMPLE_MIC			= 0x04,
77 	SDCA_FUNCTION_TYPE_SPEAKER_MIC			= 0x05,
78 	SDCA_FUNCTION_TYPE_UAJ				= 0x06,
79 	SDCA_FUNCTION_TYPE_RJ				= 0x07,
80 	SDCA_FUNCTION_TYPE_SIMPLE_JACK			= 0x08,
81 	SDCA_FUNCTION_TYPE_HID				= 0x0A,
82 	SDCA_FUNCTION_TYPE_IMP_DEF			= 0x1F,
83 };
84 
85 /* Human-readable names used for kernel logs and Function device registration/bind */
86 #define	SDCA_FUNCTION_TYPE_SMART_AMP_NAME		"SmartAmp"
87 #define	SDCA_FUNCTION_TYPE_SIMPLE_AMP_NAME		"SimpleAmp"
88 #define	SDCA_FUNCTION_TYPE_SMART_MIC_NAME		"SmartMic"
89 #define	SDCA_FUNCTION_TYPE_SIMPLE_MIC_NAME		"SimpleMic"
90 #define	SDCA_FUNCTION_TYPE_SPEAKER_MIC_NAME		"SpeakerMic"
91 #define	SDCA_FUNCTION_TYPE_UAJ_NAME			"UAJ"
92 #define	SDCA_FUNCTION_TYPE_RJ_NAME			"RJ"
93 #define	SDCA_FUNCTION_TYPE_SIMPLE_NAME			"SimpleJack"
94 #define	SDCA_FUNCTION_TYPE_HID_NAME			"HID"
95 #define	SDCA_FUNCTION_TYPE_IMP_DEF_NAME			"ImplementationDefined"
96 
97 /**
98  * struct sdca_init_write - a single initialization write
99  * @addr: Register address to be written
100  * @val: Single byte value to be written
101  */
102 struct sdca_init_write {
103 	u32 addr;
104 	u8 val;
105 };
106 
107 /**
108  * define SDCA_CTL_TYPE - create a unique identifier for an SDCA Control
109  * @ent: Entity Type code.
110  * @sel: Control Selector code.
111  *
112  * Sometimes there is a need to identify a type of Control, for example to
113  * determine what name the control should have. SDCA Selectors are reused
114  * across Entity types, as such it is necessary to combine both the Entity
115  * Type and the Control Selector to obtain a unique identifier.
116  */
117 #define SDCA_CTL_TYPE(ent, sel) ((ent) << 8 | (sel))
118 
119 /**
120  * define SDCA_CTL_TYPE_S - static version of SDCA_CTL_TYPE
121  * @ent: Entity name, for example IT, MFPU, etc. this string can be read
122  * from the last characters of the SDCA_ENTITY_TYPE_* macros.
123  * @sel: Control Selector name, for example MIC_BIAS, MUTE, etc. this
124  * string can be read from the last characters of the SDCA_CTL_*_*
125  * macros.
126  *
127  * Short hand to specific a Control type statically for example:
128  * SDCA_CTL_TYPE_S(IT, MIC_BIAS).
129  */
130 #define SDCA_CTL_TYPE_S(ent, sel) SDCA_CTL_TYPE(SDCA_ENTITY_TYPE_##ent, \
131 						SDCA_CTL_##ent##_##sel)
132 
133 /**
134  * enum sdca_it_controls - SDCA Controls for Input Terminal
135  *
136  * Control Selectors for Input Terminal from SDCA specification v1.0
137  * section 6.2.1.3.
138  */
139 enum sdca_it_controls {
140 	SDCA_CTL_IT_MIC_BIAS				= 0x03,
141 	SDCA_CTL_IT_USAGE				= 0x04,
142 	SDCA_CTL_IT_LATENCY				= 0x08,
143 	SDCA_CTL_IT_CLUSTERINDEX			= 0x10,
144 	SDCA_CTL_IT_DATAPORT_SELECTOR			= 0x11,
145 	SDCA_CTL_IT_MATCHING_GUID			= 0x12,
146 	SDCA_CTL_IT_KEEP_ALIVE				= 0x13,
147 	SDCA_CTL_IT_NDAI_STREAM				= 0x14,
148 	SDCA_CTL_IT_NDAI_CATEGORY			= 0x15,
149 	SDCA_CTL_IT_NDAI_CODINGTYPE			= 0x16,
150 	SDCA_CTL_IT_NDAI_PACKETTYPE			= 0x17,
151 };
152 
153 /**
154  * enum sdca_ot_controls - SDCA Controls for Output Terminal
155  *
156  * Control Selectors for Output Terminal from SDCA specification v1.0
157  * section 6.2.2.3.
158  */
159 enum sdca_ot_controls {
160 	SDCA_CTL_OT_USAGE				= 0x04,
161 	SDCA_CTL_OT_LATENCY				= 0x08,
162 	SDCA_CTL_OT_DATAPORT_SELECTOR			= 0x11,
163 	SDCA_CTL_OT_MATCHING_GUID			= 0x12,
164 	SDCA_CTL_OT_KEEP_ALIVE				= 0x13,
165 	SDCA_CTL_OT_NDAI_STREAM				= 0x14,
166 	SDCA_CTL_OT_NDAI_CATEGORY			= 0x15,
167 	SDCA_CTL_OT_NDAI_CODINGTYPE			= 0x16,
168 	SDCA_CTL_OT_NDAI_PACKETTYPE			= 0x17,
169 };
170 
171 /**
172  * enum sdca_usage_range - Column definitions for Usage
173  */
174 enum sdca_usage_range {
175 	SDCA_USAGE_NUMBER				= 0,
176 	SDCA_USAGE_CBN					= 1,
177 	SDCA_USAGE_SAMPLE_RATE				= 2,
178 	SDCA_USAGE_SAMPLE_WIDTH				= 3,
179 	SDCA_USAGE_FULL_SCALE				= 4,
180 	SDCA_USAGE_NOISE_FLOOR				= 5,
181 	SDCA_USAGE_TAG					= 6,
182 	SDCA_USAGE_NCOLS				= 7,
183 };
184 
185 /**
186  * enum sdca_mu_controls - SDCA Controls for Mixer Unit
187  *
188  * Control Selectors for Mixer Unit from SDCA specification v1.0
189  * section 6.3.4.2.
190  */
191 enum sdca_mu_controls {
192 	SDCA_CTL_MU_MIXER				= 0x01,
193 	SDCA_CTL_MU_LATENCY				= 0x06,
194 };
195 
196 /**
197  * enum sdca_su_controls - SDCA Controls for Selector Unit
198  *
199  * Control Selectors for Selector Unit from SDCA specification v1.0
200  * section 6.3.8.3.
201  */
202 enum sdca_su_controls {
203 	SDCA_CTL_SU_SELECTOR				= 0x01,
204 	SDCA_CTL_SU_LATENCY				= 0x02,
205 };
206 
207 /**
208  * enum sdca_fu_controls - SDCA Controls for Feature Unit
209  *
210  * Control Selectors for Feature Unit from SDCA specification v1.0
211  * section 6.3.2.3.
212  */
213 enum sdca_fu_controls {
214 	SDCA_CTL_FU_MUTE				= 0x01,
215 	SDCA_CTL_FU_CHANNEL_VOLUME			= 0x02,
216 	SDCA_CTL_FU_AGC					= 0x07,
217 	SDCA_CTL_FU_BASS_BOOST				= 0x09,
218 	SDCA_CTL_FU_LOUDNESS				= 0x0A,
219 	SDCA_CTL_FU_GAIN				= 0x0B,
220 	SDCA_CTL_FU_LATENCY				= 0x10,
221 };
222 
223 /**
224  * enum sdca_volume_range - Column definitions for Q7.8dB volumes/gains
225  */
226 enum sdca_volume_range {
227 	SDCA_VOLUME_LINEAR_MIN				= 0,
228 	SDCA_VOLUME_LINEAR_MAX				= 1,
229 	SDCA_VOLUME_LINEAR_STEP				= 2,
230 	SDCA_VOLUME_LINEAR_NCOLS			= 3,
231 };
232 
233 /**
234  * enum sdca_xu_controls - SDCA Controls for Extension Unit
235  *
236  * Control Selectors for Extension Unit from SDCA specification v1.0
237  * section 6.3.10.3.
238  */
239 enum sdca_xu_controls {
240 	SDCA_CTL_XU_BYPASS				= 0x01,
241 	SDCA_CTL_XU_LATENCY				= 0x06,
242 	SDCA_CTL_XU_XU_ID				= 0x07,
243 	SDCA_CTL_XU_XU_VERSION				= 0x08,
244 	SDCA_CTL_XU_FDL_CURRENTOWNER			= 0x10,
245 	SDCA_CTL_XU_FDL_MESSAGEOFFSET			= 0x12,
246 	SDCA_CTL_XU_FDL_MESSAGELENGTH			= 0x13,
247 	SDCA_CTL_XU_FDL_STATUS				= 0x14,
248 	SDCA_CTL_XU_FDL_SET_INDEX			= 0x15,
249 	SDCA_CTL_XU_FDL_HOST_REQUEST			= 0x16,
250 };
251 
252 /**
253  * enum sdca_cs_controls - SDCA Controls for Clock Source
254  *
255  * Control Selectors for Clock Source from SDCA specification v1.0
256  * section 6.4.1.3.
257  */
258 enum sdca_cs_controls {
259 	SDCA_CTL_CS_CLOCK_VALID				= 0x02,
260 	SDCA_CTL_CS_SAMPLERATEINDEX			= 0x10,
261 };
262 
263 /**
264  * enum sdca_samplerateindex_range - Column definitions for SampleRateIndex
265  */
266 enum sdca_samplerateindex_range {
267 	SDCA_SAMPLERATEINDEX_INDEX			= 0,
268 	SDCA_SAMPLERATEINDEX_RATE			= 1,
269 	SDCA_SAMPLERATEINDEX_NCOLS			= 2,
270 };
271 
272 /**
273  * enum sdca_cx_controls - SDCA Controls for Clock Selector
274  *
275  * Control Selectors for Clock Selector from SDCA specification v1.0
276  * section 6.4.2.3.
277  */
278 enum sdca_cx_controls {
279 	SDCA_CTL_CX_CLOCK_SELECT			= 0x01,
280 };
281 
282 /**
283  * enum sdca_pde_controls - SDCA Controls for Power Domain Entity
284  *
285  * Control Selectors for Power Domain Entity from SDCA specification
286  * v1.0 section 6.5.2.2.
287  */
288 enum sdca_pde_controls {
289 	SDCA_CTL_PDE_REQUESTED_PS			= 0x01,
290 	SDCA_CTL_PDE_ACTUAL_PS				= 0x10,
291 };
292 
293 /**
294  * enum sdca_requested_ps_range - Column definitions for Requested PS
295  */
296 enum sdca_requested_ps_range {
297 	SDCA_REQUESTED_PS_STATE				= 0,
298 	SDCA_REQUESTED_PS_NCOLS				= 1,
299 };
300 
301 /**
302  * enum sdca_ge_controls - SDCA Controls for Group Unit
303  *
304  * Control Selectors for Group Unit from SDCA specification v1.0
305  * section 6.5.1.4.
306  */
307 enum sdca_ge_controls {
308 	SDCA_CTL_GE_SELECTED_MODE			= 0x01,
309 	SDCA_CTL_GE_DETECTED_MODE			= 0x02,
310 };
311 
312 /**
313  * enum sdca_selected_mode_range - Column definitions for Selected Mode
314  */
315 enum sdca_selected_mode_range {
316 	SDCA_SELECTED_MODE_INDEX			= 0,
317 	SDCA_SELECTED_MODE_TERM_TYPE			= 1,
318 	SDCA_SELECTED_MODE_NCOLS			= 2,
319 };
320 
321 /**
322  * enum sdca_spe_controls - SDCA Controls for Security & Privacy Unit
323  *
324  * Control Selectors for Security & Privacy Unit from SDCA
325  * specification v1.0 Section 6.5.3.2.
326  */
327 enum sdca_spe_controls {
328 	SDCA_CTL_SPE_PRIVATE				= 0x01,
329 	SDCA_CTL_SPE_PRIVACY_POLICY			= 0x02,
330 	SDCA_CTL_SPE_PRIVACY_LOCKSTATE			= 0x03,
331 	SDCA_CTL_SPE_PRIVACY_OWNER			= 0x04,
332 	SDCA_CTL_SPE_AUTHTX_CURRENTOWNER		= 0x10,
333 	SDCA_CTL_SPE_AUTHTX_MESSAGEOFFSET		= 0x12,
334 	SDCA_CTL_SPE_AUTHTX_MESSAGELENGTH		= 0x13,
335 	SDCA_CTL_SPE_AUTHRX_CURRENTOWNER		= 0x14,
336 	SDCA_CTL_SPE_AUTHRX_MESSAGEOFFSET		= 0x16,
337 	SDCA_CTL_SPE_AUTHRX_MESSAGELENGTH		= 0x17,
338 };
339 
340 /**
341  * enum sdca_cru_controls - SDCA Controls for Channel Remapping Unit
342  *
343  * Control Selectors for Channel Remapping Unit from SDCA
344  * specification v1.0 Section 6.3.1.3.
345  */
346 enum sdca_cru_controls {
347 	SDCA_CTL_CRU_LATENCY				= 0x06,
348 	SDCA_CTL_CRU_CLUSTERINDEX			= 0x10,
349 };
350 
351 /**
352  * enum sdca_udmpu_controls - SDCA Controls for Up-Down Mixer Processing Unit
353  *
354  * Control Selectors for Up-Down Mixer Processing Unit from SDCA
355  * specification v1.0 Section 6.3.9.3.
356  */
357 enum sdca_udmpu_controls {
358 	SDCA_CTL_UDMPU_LATENCY				= 0x06,
359 	SDCA_CTL_UDMPU_CLUSTERINDEX			= 0x10,
360 	SDCA_CTL_UDMPU_ACOUSTIC_ENERGY_LEVEL_MONITOR	= 0x11,
361 	SDCA_CTL_UDMPU_ULTRASOUND_LOOP_GAIN		= 0x12,
362 	SDCA_CTL_UDMPU_OPAQUESET_0			= 0x18,
363 	SDCA_CTL_UDMPU_OPAQUESET_1			= 0x19,
364 	SDCA_CTL_UDMPU_OPAQUESET_2			= 0x1A,
365 	SDCA_CTL_UDMPU_OPAQUESET_3			= 0x1B,
366 	SDCA_CTL_UDMPU_OPAQUESET_4			= 0x1C,
367 	SDCA_CTL_UDMPU_OPAQUESET_5			= 0x1D,
368 	SDCA_CTL_UDMPU_OPAQUESET_6			= 0x1E,
369 	SDCA_CTL_UDMPU_OPAQUESET_7			= 0x1F,
370 	SDCA_CTL_UDMPU_OPAQUESET_8			= 0x20,
371 	SDCA_CTL_UDMPU_OPAQUESET_9			= 0x21,
372 	SDCA_CTL_UDMPU_OPAQUESET_10			= 0x22,
373 	SDCA_CTL_UDMPU_OPAQUESET_11			= 0x23,
374 	SDCA_CTL_UDMPU_OPAQUESET_12			= 0x24,
375 	SDCA_CTL_UDMPU_OPAQUESET_13			= 0x25,
376 	SDCA_CTL_UDMPU_OPAQUESET_14			= 0x26,
377 	SDCA_CTL_UDMPU_OPAQUESET_15			= 0x27,
378 	SDCA_CTL_UDMPU_OPAQUESET_16			= 0x28,
379 	SDCA_CTL_UDMPU_OPAQUESET_17			= 0x29,
380 	SDCA_CTL_UDMPU_OPAQUESET_18			= 0x2A,
381 	SDCA_CTL_UDMPU_OPAQUESET_19			= 0x2B,
382 	SDCA_CTL_UDMPU_OPAQUESET_20			= 0x2C,
383 	SDCA_CTL_UDMPU_OPAQUESET_21			= 0x2D,
384 	SDCA_CTL_UDMPU_OPAQUESET_22			= 0x2E,
385 	SDCA_CTL_UDMPU_OPAQUESET_23			= 0x2F,
386 };
387 
388 /**
389  * enum sdca_mfpu_controls - SDCA Controls for Multi-Function Processing Unit
390  *
391  * Control Selectors for Multi-Function Processing Unit from SDCA
392  * specification v1.0 Section 6.3.3.4.
393  */
394 enum sdca_mfpu_controls {
395 	SDCA_CTL_MFPU_BYPASS				= 0x01,
396 	SDCA_CTL_MFPU_ALGORITHM_READY			= 0x04,
397 	SDCA_CTL_MFPU_ALGORITHM_ENABLE			= 0x05,
398 	SDCA_CTL_MFPU_LATENCY				= 0x08,
399 	SDCA_CTL_MFPU_ALGORITHM_PREPARE			= 0x09,
400 	SDCA_CTL_MFPU_CLUSTERINDEX			= 0x10,
401 	SDCA_CTL_MFPU_CENTER_FREQUENCY_INDEX		= 0x11,
402 	SDCA_CTL_MFPU_ULTRASOUND_LEVEL			= 0x12,
403 	SDCA_CTL_MFPU_AE_NUMBER				= 0x13,
404 	SDCA_CTL_MFPU_AE_CURRENTOWNER			= 0x14,
405 	SDCA_CTL_MFPU_AE_MESSAGEOFFSET			= 0x16,
406 	SDCA_CTL_MFPU_AE_MESSAGELENGTH			= 0x17,
407 };
408 
409 /**
410  * enum sdca_smpu_controls - SDCA Controls for Smart Mic Processing Unit
411  *
412  * Control Selectors for Smart Mic Processing Unit from SDCA
413  * specification v1.0 Section 6.3.7.3.
414  */
415 enum sdca_smpu_controls {
416 	SDCA_CTL_SMPU_LATENCY				= 0x06,
417 	SDCA_CTL_SMPU_TRIGGER_ENABLE			= 0x10,
418 	SDCA_CTL_SMPU_TRIGGER_STATUS			= 0x11,
419 	SDCA_CTL_SMPU_HIST_BUFFER_MODE			= 0x12,
420 	SDCA_CTL_SMPU_HIST_BUFFER_PREAMBLE		= 0x13,
421 	SDCA_CTL_SMPU_HIST_ERROR			= 0x14,
422 	SDCA_CTL_SMPU_TRIGGER_EXTENSION			= 0x15,
423 	SDCA_CTL_SMPU_TRIGGER_READY			= 0x16,
424 	SDCA_CTL_SMPU_HIST_CURRENTOWNER			= 0x18,
425 	SDCA_CTL_SMPU_HIST_MESSAGEOFFSET		= 0x1A,
426 	SDCA_CTL_SMPU_HIST_MESSAGELENGTH		= 0x1B,
427 	SDCA_CTL_SMPU_DTODTX_CURRENTOWNER		= 0x1C,
428 	SDCA_CTL_SMPU_DTODTX_MESSAGEOFFSET		= 0x1E,
429 	SDCA_CTL_SMPU_DTODTX_MESSAGELENGTH		= 0x1F,
430 	SDCA_CTL_SMPU_DTODRX_CURRENTOWNER		= 0x20,
431 	SDCA_CTL_SMPU_DTODRX_MESSAGEOFFSET		= 0x22,
432 	SDCA_CTL_SMPU_DTODRX_MESSAGELENGTH		= 0x23,
433 };
434 
435 /**
436  * enum sdca_sapu_controls - SDCA Controls for Smart Amp Processing Unit
437  *
438  * Control Selectors for Smart Amp Processing Unit from SDCA
439  * specification v1.0 Section 6.3.6.3.
440  */
441 enum sdca_sapu_controls {
442 	SDCA_CTL_SAPU_LATENCY				= 0x05,
443 	SDCA_CTL_SAPU_PROTECTION_MODE			= 0x10,
444 	SDCA_CTL_SAPU_PROTECTION_STATUS			= 0x11,
445 	SDCA_CTL_SAPU_OPAQUESETREQ_INDEX		= 0x12,
446 	SDCA_CTL_SAPU_DTODTX_CURRENTOWNER		= 0x14,
447 	SDCA_CTL_SAPU_DTODTX_MESSAGEOFFSET		= 0x16,
448 	SDCA_CTL_SAPU_DTODTX_MESSAGELENGTH		= 0x17,
449 	SDCA_CTL_SAPU_DTODRX_CURRENTOWNER		= 0x18,
450 	SDCA_CTL_SAPU_DTODRX_MESSAGEOFFSET		= 0x1A,
451 	SDCA_CTL_SAPU_DTODRX_MESSAGELENGTH		= 0x1B,
452 };
453 
454 /**
455  * enum sdca_ppu_controls - SDCA Controls for Post Processing Unit
456  *
457  * Control Selectors for Post Processing Unit from SDCA specification
458  * v1.0 Section 6.3.5.3.
459  */
460 enum sdca_ppu_controls {
461 	SDCA_CTL_PPU_LATENCY				= 0x06,
462 	SDCA_CTL_PPU_POSTURENUMBER			= 0x10,
463 	SDCA_CTL_PPU_POSTUREEXTENSION			= 0x11,
464 	SDCA_CTL_PPU_HORIZONTALBALANCE			= 0x12,
465 	SDCA_CTL_PPU_VERTICALBALANCE			= 0x13,
466 };
467 
468 /**
469  * enum sdca_tg_controls - SDCA Controls for Tone Generator Entity
470  *
471  * Control Selectors for Tone Generator from SDCA specification v1.0
472  * Section 6.5.4.4.
473  */
474 enum sdca_tg_controls {
475 	SDCA_CTL_TG_TONE_DIVIDER			= 0x10,
476 };
477 
478 /**
479  * enum sdca_hide_controls - SDCA Controls for HIDE Entity
480  *
481  * Control Selectors for HIDE from SDCA specification v1.0 Section
482  * 6.6.1.2.
483  */
484 enum sdca_hide_controls {
485 	SDCA_CTL_HIDE_HIDTX_CURRENTOWNER		= 0x10,
486 	SDCA_CTL_HIDE_HIDTX_MESSAGEOFFSET		= 0x12,
487 	SDCA_CTL_HIDE_HIDTX_MESSAGELENGTH		= 0x13,
488 	SDCA_CTL_HIDE_HIDRX_CURRENTOWNER		= 0x14,
489 	SDCA_CTL_HIDE_HIDRX_MESSAGEOFFSET		= 0x16,
490 	SDCA_CTL_HIDE_HIDRX_MESSAGELENGTH		= 0x17,
491 };
492 
493 /**
494  * enum sdca_entity0_controls - SDCA Controls for Entity 0
495  *
496  * Control Selectors for Entity 0 from SDCA specification v1.0 Section
497  * 6.7.1.1.
498  */
499 enum sdca_entity0_controls {
500 	SDCA_CTL_ENTITY_0_COMMIT_GROUP_MASK		= 0x01,
501 	SDCA_CTL_ENTITY_0_FUNCTION_SDCA_VERSION		= 0x04,
502 	SDCA_CTL_ENTITY_0_FUNCTION_TYPE			= 0x05,
503 	SDCA_CTL_ENTITY_0_FUNCTION_MANUFACTURER_ID	= 0x06,
504 	SDCA_CTL_ENTITY_0_FUNCTION_ID			= 0x07,
505 	SDCA_CTL_ENTITY_0_FUNCTION_VERSION		= 0x08,
506 	SDCA_CTL_ENTITY_0_FUNCTION_EXTENSION_ID		= 0x09,
507 	SDCA_CTL_ENTITY_0_FUNCTION_EXTENSION_VERSION	= 0x0A,
508 	SDCA_CTL_ENTITY_0_FUNCTION_STATUS		= 0x10,
509 	SDCA_CTL_ENTITY_0_FUNCTION_ACTION		= 0x11,
510 	SDCA_CTL_ENTITY_0_MATCHING_GUID			= 0x12,
511 	SDCA_CTL_ENTITY_0_DEVICE_MANUFACTURER_ID	= 0x2C,
512 	SDCA_CTL_ENTITY_0_DEVICE_PART_ID		= 0x2D,
513 	SDCA_CTL_ENTITY_0_DEVICE_VERSION		= 0x2E,
514 	SDCA_CTL_ENTITY_0_DEVICE_SDCA_VERSION		= 0x2F,
515 
516 	/* Function Status Bits */
517 	SDCA_CTL_ENTITY_0_DEVICE_NEWLY_ATTACHED		= BIT(0),
518 	SDCA_CTL_ENTITY_0_INTS_DISABLED_ABNORMALLY	= BIT(1),
519 	SDCA_CTL_ENTITY_0_STREAMING_STOPPED_ABNORMALLY	= BIT(2),
520 	SDCA_CTL_ENTITY_0_FUNCTION_FAULT		= BIT(3),
521 	SDCA_CTL_ENTITY_0_UMP_SEQUENCE_FAULT		= BIT(4),
522 	SDCA_CTL_ENTITY_0_FUNCTION_NEEDS_INITIALIZATION	= BIT(5),
523 	SDCA_CTL_ENTITY_0_FUNCTION_HAS_BEEN_RESET	= BIT(6),
524 	SDCA_CTL_ENTITY_0_FUNCTION_BUSY			= BIT(7),
525 };
526 
527 #define SDCA_CTL_MIC_BIAS_NAME				"Mic Bias"
528 #define SDCA_CTL_USAGE_NAME				"Usage"
529 #define SDCA_CTL_LATENCY_NAME				"Latency"
530 #define SDCA_CTL_CLUSTERINDEX_NAME			"Cluster Index"
531 #define SDCA_CTL_DATAPORT_SELECTOR_NAME			"Dataport Selector"
532 #define SDCA_CTL_MATCHING_GUID_NAME			"Matching GUID"
533 #define SDCA_CTL_KEEP_ALIVE_NAME			"Keep Alive"
534 #define SDCA_CTL_NDAI_STREAM_NAME			"NDAI Stream"
535 #define SDCA_CTL_NDAI_CATEGORY_NAME			"NDAI Category"
536 #define SDCA_CTL_NDAI_CODINGTYPE_NAME			"NDAI Coding Type"
537 #define SDCA_CTL_NDAI_PACKETTYPE_NAME			"NDAI Packet Type"
538 #define SDCA_CTL_MIXER_NAME				"Mixer"
539 #define SDCA_CTL_SELECTOR_NAME				"Selector"
540 #define SDCA_CTL_MUTE_NAME				"Mute"
541 #define SDCA_CTL_CHANNEL_VOLUME_NAME			"Channel Volume"
542 #define SDCA_CTL_AGC_NAME				"AGC"
543 #define SDCA_CTL_BASS_BOOST_NAME			"Bass Boost"
544 #define SDCA_CTL_LOUDNESS_NAME				"Loudness"
545 #define SDCA_CTL_GAIN_NAME				"Gain"
546 #define SDCA_CTL_BYPASS_NAME				"Bypass"
547 #define SDCA_CTL_XU_ID_NAME				"XU ID"
548 #define SDCA_CTL_XU_VERSION_NAME			"XU Version"
549 #define SDCA_CTL_FDL_CURRENTOWNER_NAME			"FDL Current Owner"
550 #define SDCA_CTL_FDL_MESSAGEOFFSET_NAME			"FDL Message Offset"
551 #define SDCA_CTL_FDL_MESSAGELENGTH_NAME			"FDL Message Length"
552 #define SDCA_CTL_FDL_STATUS_NAME			"FDL Status"
553 #define SDCA_CTL_FDL_SET_INDEX_NAME			"FDL Set Index"
554 #define SDCA_CTL_FDL_HOST_REQUEST_NAME			"FDL Host Request"
555 #define SDCA_CTL_CLOCK_VALID_NAME			"Clock Valid"
556 #define SDCA_CTL_SAMPLERATEINDEX_NAME			"Sample Rate Index"
557 #define SDCA_CTL_CLOCK_SELECT_NAME			"Clock Select"
558 #define SDCA_CTL_REQUESTED_PS_NAME			"Requested PS"
559 #define SDCA_CTL_ACTUAL_PS_NAME				"Actual PS"
560 #define SDCA_CTL_SELECTED_MODE_NAME			"Selected Mode"
561 #define SDCA_CTL_DETECTED_MODE_NAME			"Detected Mode"
562 #define SDCA_CTL_PRIVATE_NAME				"Private"
563 #define SDCA_CTL_PRIVACY_POLICY_NAME			"Privacy Policy"
564 #define SDCA_CTL_PRIVACY_LOCKSTATE_NAME			"Privacy Lockstate"
565 #define SDCA_CTL_PRIVACY_OWNER_NAME			"Privacy Owner"
566 #define SDCA_CTL_AUTHTX_CURRENTOWNER_NAME		"AuthTX Current Owner"
567 #define SDCA_CTL_AUTHTX_MESSAGEOFFSET_NAME		"AuthTX Message Offset"
568 #define SDCA_CTL_AUTHTX_MESSAGELENGTH_NAME		"AuthTX Message Length"
569 #define SDCA_CTL_AUTHRX_CURRENTOWNER_NAME		"AuthRX Current Owner"
570 #define SDCA_CTL_AUTHRX_MESSAGEOFFSET_NAME		"AuthRX Message Offset"
571 #define SDCA_CTL_AUTHRX_MESSAGELENGTH_NAME		"AuthRX Message Length"
572 #define SDCA_CTL_ACOUSTIC_ENERGY_LEVEL_MONITOR_NAME	"Acoustic Energy Level Monitor"
573 #define SDCA_CTL_ULTRASOUND_LOOP_GAIN_NAME		"Ultrasound Loop Gain"
574 #define SDCA_CTL_OPAQUESET_0_NAME			"Opaqueset 0"
575 #define SDCA_CTL_OPAQUESET_1_NAME			"Opaqueset 1"
576 #define SDCA_CTL_OPAQUESET_2_NAME			"Opaqueset 2"
577 #define SDCA_CTL_OPAQUESET_3_NAME			"Opaqueset 3"
578 #define SDCA_CTL_OPAQUESET_4_NAME			"Opaqueset 4"
579 #define SDCA_CTL_OPAQUESET_5_NAME			"Opaqueset 5"
580 #define SDCA_CTL_OPAQUESET_6_NAME			"Opaqueset 6"
581 #define SDCA_CTL_OPAQUESET_7_NAME			"Opaqueset 7"
582 #define SDCA_CTL_OPAQUESET_8_NAME			"Opaqueset 8"
583 #define SDCA_CTL_OPAQUESET_9_NAME			"Opaqueset 9"
584 #define SDCA_CTL_OPAQUESET_10_NAME			"Opaqueset 10"
585 #define SDCA_CTL_OPAQUESET_11_NAME			"Opaqueset 11"
586 #define SDCA_CTL_OPAQUESET_12_NAME			"Opaqueset 12"
587 #define SDCA_CTL_OPAQUESET_13_NAME			"Opaqueset 13"
588 #define SDCA_CTL_OPAQUESET_14_NAME			"Opaqueset 14"
589 #define SDCA_CTL_OPAQUESET_15_NAME			"Opaqueset 15"
590 #define SDCA_CTL_OPAQUESET_16_NAME			"Opaqueset 16"
591 #define SDCA_CTL_OPAQUESET_17_NAME			"Opaqueset 17"
592 #define SDCA_CTL_OPAQUESET_18_NAME			"Opaqueset 18"
593 #define SDCA_CTL_OPAQUESET_19_NAME			"Opaqueset 19"
594 #define SDCA_CTL_OPAQUESET_20_NAME			"Opaqueset 20"
595 #define SDCA_CTL_OPAQUESET_21_NAME			"Opaqueset 21"
596 #define SDCA_CTL_OPAQUESET_22_NAME			"Opaqueset 22"
597 #define SDCA_CTL_OPAQUESET_23_NAME			"Opaqueset 23"
598 #define SDCA_CTL_ALGORITHM_READY_NAME			"Algorithm Ready"
599 #define SDCA_CTL_ALGORITHM_ENABLE_NAME			"Algorithm Enable"
600 #define SDCA_CTL_ALGORITHM_PREPARE_NAME			"Algorithm Prepare"
601 #define SDCA_CTL_CENTER_FREQUENCY_INDEX_NAME		"Center Frequency Index"
602 #define SDCA_CTL_ULTRASOUND_LEVEL_NAME			"Ultrasound Level"
603 #define SDCA_CTL_AE_NUMBER_NAME				"AE Number"
604 #define SDCA_CTL_AE_CURRENTOWNER_NAME			"AE Current Owner"
605 #define SDCA_CTL_AE_MESSAGEOFFSET_NAME			"AE Message Offset"
606 #define SDCA_CTL_AE_MESSAGELENGTH_NAME			"AE Message Length"
607 #define SDCA_CTL_TRIGGER_ENABLE_NAME			"Trigger Enable"
608 #define SDCA_CTL_TRIGGER_STATUS_NAME			"Trigger Status"
609 #define SDCA_CTL_HIST_BUFFER_MODE_NAME			"Hist Buffer Mode"
610 #define SDCA_CTL_HIST_BUFFER_PREAMBLE_NAME		"Hist Buffer Preamble"
611 #define SDCA_CTL_HIST_ERROR_NAME			"Hist Error"
612 #define SDCA_CTL_TRIGGER_EXTENSION_NAME			"Trigger Extension"
613 #define SDCA_CTL_TRIGGER_READY_NAME			"Trigger Ready"
614 #define SDCA_CTL_HIST_CURRENTOWNER_NAME			"Hist Current Owner"
615 #define SDCA_CTL_HIST_MESSAGEOFFSET_NAME		"Hist Message Offset"
616 #define SDCA_CTL_HIST_MESSAGELENGTH_NAME		"Hist Message Length"
617 #define SDCA_CTL_DTODTX_CURRENTOWNER_NAME		"DTODTX Current Owner"
618 #define SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME		"DTODTX Message Offset"
619 #define SDCA_CTL_DTODTX_MESSAGELENGTH_NAME		"DTODTX Message Length"
620 #define SDCA_CTL_DTODRX_CURRENTOWNER_NAME		"DTODRX Current Owner"
621 #define SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME		"DTODRX Message Offset"
622 #define SDCA_CTL_DTODRX_MESSAGELENGTH_NAME		"DTODRX Message Length"
623 #define SDCA_CTL_PROTECTION_MODE_NAME			"Protection Mode"
624 #define SDCA_CTL_PROTECTION_STATUS_NAME			"Protection Status"
625 #define SDCA_CTL_OPAQUESETREQ_INDEX_NAME		"Opaqueset Req Index"
626 #define SDCA_CTL_DTODTX_CURRENTOWNER_NAME		"DTODTX Current Owner"
627 #define SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME		"DTODTX Message Offset"
628 #define SDCA_CTL_DTODTX_MESSAGELENGTH_NAME		"DTODTX Message Length"
629 #define SDCA_CTL_DTODRX_CURRENTOWNER_NAME		"DTODRX Current Owner"
630 #define SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME		"DTODRX Message Offset"
631 #define SDCA_CTL_DTODRX_MESSAGELENGTH_NAME		"DTODRX Message Length"
632 #define SDCA_CTL_POSTURENUMBER_NAME			"Posture Number"
633 #define SDCA_CTL_POSTUREEXTENSION_NAME			"Posture Extension"
634 #define SDCA_CTL_HORIZONTALBALANCE_NAME			"Horizontal Balance"
635 #define SDCA_CTL_VERTICALBALANCE_NAME			"Vertical Balance"
636 #define SDCA_CTL_TONE_DIVIDER_NAME			"Tone Divider"
637 #define SDCA_CTL_HIDTX_CURRENTOWNER_NAME		"HIDTX Current Owner"
638 #define SDCA_CTL_HIDTX_MESSAGEOFFSET_NAME		"HIDTX Message Offset"
639 #define SDCA_CTL_HIDTX_MESSAGELENGTH_NAME		"HIDTX Message Length"
640 #define SDCA_CTL_HIDRX_CURRENTOWNER_NAME		"HIDRX Current Owner"
641 #define SDCA_CTL_HIDRX_MESSAGEOFFSET_NAME		"HIDRX Message Offset"
642 #define SDCA_CTL_HIDRX_MESSAGELENGTH_NAME		"HIDRX Message Length"
643 #define SDCA_CTL_COMMIT_GROUP_MASK_NAME			"Commit Group Mask"
644 #define SDCA_CTL_FUNCTION_SDCA_VERSION_NAME		"Function SDCA Version"
645 #define SDCA_CTL_FUNCTION_TYPE_NAME			"Function Type"
646 #define SDCA_CTL_FUNCTION_MANUFACTURER_ID_NAME		"Function Manufacturer ID"
647 #define SDCA_CTL_FUNCTION_ID_NAME			"Function ID"
648 #define SDCA_CTL_FUNCTION_VERSION_NAME			"Function Version"
649 #define SDCA_CTL_FUNCTION_EXTENSION_ID_NAME		"Function Extension ID"
650 #define SDCA_CTL_FUNCTION_EXTENSION_VERSION_NAME	"Function Extension Version"
651 #define SDCA_CTL_FUNCTION_STATUS_NAME			"Function Status"
652 #define SDCA_CTL_FUNCTION_ACTION_NAME			"Function Action"
653 #define SDCA_CTL_DEVICE_MANUFACTURER_ID_NAME		"Device Manufacturer ID"
654 #define SDCA_CTL_DEVICE_PART_ID_NAME			"Device Part ID"
655 #define SDCA_CTL_DEVICE_VERSION_NAME			"Device Version"
656 #define SDCA_CTL_DEVICE_SDCA_VERSION_NAME		"Device SDCA Version"
657 
658 /**
659  * enum sdca_control_datatype - SDCA Control Data Types
660  *
661  * Data Types as described in the SDCA specification v1.0 section
662  * 7.3.
663  */
664 enum sdca_control_datatype {
665 	SDCA_CTL_DATATYPE_ONEBIT,
666 	SDCA_CTL_DATATYPE_INTEGER,
667 	SDCA_CTL_DATATYPE_SPEC_ENCODED_VALUE,
668 	SDCA_CTL_DATATYPE_BCD,
669 	SDCA_CTL_DATATYPE_Q7P8DB,
670 	SDCA_CTL_DATATYPE_BYTEINDEX,
671 	SDCA_CTL_DATATYPE_POSTURENUMBER,
672 	SDCA_CTL_DATATYPE_DP_INDEX,
673 	SDCA_CTL_DATATYPE_BITINDEX,
674 	SDCA_CTL_DATATYPE_BITMAP,
675 	SDCA_CTL_DATATYPE_GUID,
676 	SDCA_CTL_DATATYPE_IMPDEF,
677 };
678 
679 /**
680  * enum sdca_access_mode - SDCA Control access mode
681  *
682  * Access modes as described in the SDCA specification v1.0 section
683  * 7.1.8.2.
684  */
685 enum sdca_access_mode {
686 	SDCA_ACCESS_MODE_RW				= 0x0,
687 	SDCA_ACCESS_MODE_DUAL				= 0x1,
688 	SDCA_ACCESS_MODE_RW1C				= 0x2,
689 	SDCA_ACCESS_MODE_RO				= 0x3,
690 	SDCA_ACCESS_MODE_RW1S				= 0x4,
691 	SDCA_ACCESS_MODE_DC				= 0x5,
692 };
693 
694 /**
695  * enum sdca_access_layer - SDCA Control access layer
696  *
697  * Access layers as described in the SDCA specification v1.0 section
698  * 7.1.9.
699  */
700 enum sdca_access_layer {
701 	SDCA_ACCESS_LAYER_USER				= 1 << 0,
702 	SDCA_ACCESS_LAYER_APPLICATION			= 1 << 1,
703 	SDCA_ACCESS_LAYER_CLASS				= 1 << 2,
704 	SDCA_ACCESS_LAYER_PLATFORM			= 1 << 3,
705 	SDCA_ACCESS_LAYER_DEVICE			= 1 << 4,
706 	SDCA_ACCESS_LAYER_EXTENSION			= 1 << 5,
707 };
708 
709 /**
710  * struct sdca_control_range - SDCA Control range table
711  * @cols: Number of columns in the range table.
712  * @rows: Number of rows in the range table.
713  * @data: Array of values contained in the range table.
714  */
715 struct sdca_control_range {
716 	unsigned int cols;
717 	unsigned int rows;
718 	u32 *data;
719 };
720 
721 /**
722  * struct sdca_control - information for one SDCA Control
723  * @label: Name for the Control, from SDCA Specification v1.0, section 7.1.7.
724  * @sel: Identifier used for addressing.
725  * @value: Holds the Control value for constants and defaults.
726  * @nbits: Number of bits used in the Control.
727  * @interrupt_position: SCDA interrupt line that will alert to changes on this
728  * Control.
729  * @cn_list: A bitmask showing the valid Control Numbers within this Control,
730  * Control Numbers typically represent channels.
731  * @range: Buffer describing valid range of values for the Control.
732  * @type: Format of the data in the Control.
733  * @mode: Access mode of the Control.
734  * @layers: Bitmask of access layers of the Control.
735  * @deferrable: Indicates if the access to the Control can be deferred.
736  * @has_default: Indicates the Control has a default value to be written.
737  * @has_fixed: Indicates the Control only supports a single value.
738  */
739 struct sdca_control {
740 	const char *label;
741 	int sel;
742 
743 	int value;
744 	int nbits;
745 	int interrupt_position;
746 	u64 cn_list;
747 
748 	struct sdca_control_range range;
749 	enum sdca_control_datatype type;
750 	enum sdca_access_mode mode;
751 	u8 layers;
752 
753 	bool deferrable;
754 	bool has_default;
755 	bool has_fixed;
756 };
757 
758 /**
759  * enum sdca_terminal_type - SDCA Terminal Types
760  *
761  * Indicate what a Terminal Entity is used for, see in section 6.2.3
762  * of the SDCA v1.0 specification.
763  */
764 enum sdca_terminal_type {
765 	/* Table 77 - Data Port*/
766 	SDCA_TERM_TYPE_GENERIC				= 0x101,
767 	SDCA_TERM_TYPE_ULTRASOUND			= 0x180,
768 	SDCA_TERM_TYPE_CAPTURE_DIRECT_PCM_MIC		= 0x181,
769 	SDCA_TERM_TYPE_RAW_PDM_MIC			= 0x182,
770 	SDCA_TERM_TYPE_SPEECH				= 0x183,
771 	SDCA_TERM_TYPE_VOICE				= 0x184,
772 	SDCA_TERM_TYPE_SECONDARY_PCM_MIC		= 0x185,
773 	SDCA_TERM_TYPE_ACOUSTIC_CONTEXT_AWARENESS	= 0x186,
774 	SDCA_TERM_TYPE_DTOD_STREAM			= 0x187,
775 	SDCA_TERM_TYPE_REFERENCE_STREAM			= 0x188,
776 	SDCA_TERM_TYPE_SENSE_CAPTURE			= 0x189,
777 	SDCA_TERM_TYPE_STREAMING_MIC			= 0x18A,
778 	SDCA_TERM_TYPE_OPTIMIZATION_STREAM		= 0x190,
779 	SDCA_TERM_TYPE_PDM_RENDER_STREAM		= 0x191,
780 	SDCA_TERM_TYPE_COMPANION_DATA			= 0x192,
781 	/* Table 78 - Transducer */
782 	SDCA_TERM_TYPE_MICROPHONE_TRANSDUCER		= 0x201,
783 	SDCA_TERM_TYPE_MICROPHONE_ARRAY_TRANSDUCER	= 0x205,
784 	SDCA_TERM_TYPE_PRIMARY_FULL_RANGE_SPEAKER	= 0x380,
785 	SDCA_TERM_TYPE_PRIMARY_LFE_SPEAKER		= 0x381,
786 	SDCA_TERM_TYPE_PRIMARY_TWEETER_SPEAKER		= 0x382,
787 	SDCA_TERM_TYPE_PRIMARY_ULTRASOUND_SPEAKER	= 0x383,
788 	SDCA_TERM_TYPE_SECONDARY_FULL_RANGE_SPEAKER	= 0x390,
789 	SDCA_TERM_TYPE_SECONDARY_LFE_SPEAKER		= 0x391,
790 	SDCA_TERM_TYPE_SECONDARY_TWEETER_SPEAKER	= 0x392,
791 	SDCA_TERM_TYPE_SECONDARY_ULTRASOUND_SPEAKER	= 0x393,
792 	SDCA_TERM_TYPE_TERTIARY_FULL_RANGE_SPEAKER	= 0x3A0,
793 	SDCA_TERM_TYPE_TERTIARY_LFE_SPEAKER		= 0x3A1,
794 	SDCA_TERM_TYPE_TERTIARY_TWEETER_SPEAKER		= 0x3A2,
795 	SDCA_TERM_TYPE_TERTIARY_ULTRASOUND_SPEAKER	= 0x3A3,
796 	SDCA_TERM_TYPE_SPDIF				= 0x605,
797 	SDCA_TERM_TYPE_NDAI_DISPLAY_AUDIO		= 0x610,
798 	SDCA_TERM_TYPE_NDAI_USB				= 0x612,
799 	SDCA_TERM_TYPE_NDAI_BLUETOOTH_MAIN		= 0x614,
800 	SDCA_TERM_TYPE_NDAI_BLUETOOTH_ALTERNATE		= 0x615,
801 	SDCA_TERM_TYPE_NDAI_BLUETOOTH_BOTH		= 0x616,
802 	SDCA_TERM_TYPE_LINEIN_STEREO			= 0x680,
803 	SDCA_TERM_TYPE_LINEIN_FRONT_LR			= 0x681,
804 	SDCA_TERM_TYPE_LINEIN_CENTER_LFE		= 0x682,
805 	SDCA_TERM_TYPE_LINEIN_SURROUND_LR		= 0x683,
806 	SDCA_TERM_TYPE_LINEIN_REAR_LR			= 0x684,
807 	SDCA_TERM_TYPE_LINEOUT_STEREO			= 0x690,
808 	SDCA_TERM_TYPE_LINEOUT_FRONT_LR			= 0x691,
809 	SDCA_TERM_TYPE_LINEOUT_CENTER_LFE		= 0x692,
810 	SDCA_TERM_TYPE_LINEOUT_SURROUND_LR		= 0x693,
811 	SDCA_TERM_TYPE_LINEOUT_REAR_LR			= 0x694,
812 	SDCA_TERM_TYPE_MIC_JACK				= 0x6A0,
813 	SDCA_TERM_TYPE_STEREO_JACK			= 0x6B0,
814 	SDCA_TERM_TYPE_FRONT_LR_JACK			= 0x6B1,
815 	SDCA_TERM_TYPE_CENTER_LFE_JACK			= 0x6B2,
816 	SDCA_TERM_TYPE_SURROUND_LR_JACK			= 0x6B3,
817 	SDCA_TERM_TYPE_REAR_LR_JACK			= 0x6B4,
818 	SDCA_TERM_TYPE_HEADPHONE_JACK			= 0x6C0,
819 	SDCA_TERM_TYPE_HEADSET_JACK			= 0x6D0,
820 	/* Table 79 - System */
821 	SDCA_TERM_TYPE_SENSE_DATA			= 0x280,
822 	SDCA_TERM_TYPE_PRIVACY_SIGNALING		= 0x741,
823 	SDCA_TERM_TYPE_PRIVACY_INDICATORS		= 0x747,
824 };
825 
826 #define SDCA_TERM_TYPE_LINEIN_STEREO_NAME		"LineIn Stereo"
827 #define SDCA_TERM_TYPE_LINEIN_FRONT_LR_NAME		"LineIn Front-LR"
828 #define SDCA_TERM_TYPE_LINEIN_CENTER_LFE_NAME		"LineIn Center-LFE"
829 #define SDCA_TERM_TYPE_LINEIN_SURROUND_LR_NAME		"LineIn Surround-LR"
830 #define SDCA_TERM_TYPE_LINEIN_REAR_LR_NAME		"LineIn Rear-LR"
831 #define SDCA_TERM_TYPE_LINEOUT_STEREO_NAME		"LineOut Stereo"
832 #define SDCA_TERM_TYPE_LINEOUT_FRONT_LR_NAME		"LineOut Front-LR"
833 #define SDCA_TERM_TYPE_LINEOUT_CENTER_LFE_NAME		"LineOut Center-LFE"
834 #define SDCA_TERM_TYPE_LINEOUT_SURROUND_LR_NAME		"LineOut Surround-LR"
835 #define SDCA_TERM_TYPE_LINEOUT_REAR_LR_NAME		"LineOut Rear-LR"
836 #define SDCA_TERM_TYPE_MIC_JACK_NAME			"Microphone"
837 #define SDCA_TERM_TYPE_STEREO_JACK_NAME			"Speaker Stereo"
838 #define SDCA_TERM_TYPE_FRONT_LR_JACK_NAME		"Speaker Front-LR"
839 #define SDCA_TERM_TYPE_CENTER_LFE_JACK_NAME		"Speaker Center-LFE"
840 #define SDCA_TERM_TYPE_SURROUND_LR_JACK_NAME		"Speaker Surround-LR"
841 #define SDCA_TERM_TYPE_REAR_LR_JACK_NAME		"Speaker Rear-LR"
842 #define SDCA_TERM_TYPE_HEADPHONE_JACK_NAME		"Headphone"
843 #define SDCA_TERM_TYPE_HEADSET_JACK_NAME		"Headset"
844 
845 /**
846  * enum sdca_connector_type - SDCA Connector Types
847  *
848  * Indicate the type of Connector that a Terminal Entity represents,
849  * see section 6.2.4 of the SDCA v1.0 specification.
850  */
851 enum sdca_connector_type {
852 	SDCA_CONN_TYPE_UNKNOWN				= 0x00,
853 	SDCA_CONN_TYPE_2P5MM_JACK			= 0x01,
854 	SDCA_CONN_TYPE_3P5MM_JACK			= 0x02,
855 	SDCA_CONN_TYPE_QUARTER_INCH_JACK		= 0x03,
856 	SDCA_CONN_TYPE_XLR				= 0x05,
857 	SDCA_CONN_TYPE_SPDIF_OPTICAL			= 0x06,
858 	SDCA_CONN_TYPE_RCA				= 0x07,
859 	SDCA_CONN_TYPE_DIN				= 0x0E,
860 	SDCA_CONN_TYPE_MINI_DIN				= 0x0F,
861 	SDCA_CONN_TYPE_EIAJ_OPTICAL			= 0x13,
862 	SDCA_CONN_TYPE_HDMI				= 0x14,
863 	SDCA_CONN_TYPE_DISPLAYPORT			= 0x17,
864 	SDCA_CONN_TYPE_LIGHTNING			= 0x1B,
865 	SDCA_CONN_TYPE_USB_C				= 0x1E,
866 	SDCA_CONN_TYPE_OTHER				= 0xFF,
867 };
868 
869 /**
870  * struct sdca_entity_iot - information specific to Input/Output Entities
871  * @clock: Pointer to the Entity providing this Terminal's clock.
872  * @type: Usage of the Terminal Entity.
873  * @connector: Physical Connector of the Terminal Entity.
874  * @reference: Physical Jack number of the Terminal Entity.
875  * @num_transducer: Number of transducers attached to the Terminal Entity.
876  * @is_dataport: Boolean indicating if this Terminal represents a Dataport.
877  */
878 struct sdca_entity_iot {
879 	struct sdca_entity *clock;
880 
881 	enum sdca_terminal_type type;
882 	enum sdca_connector_type connector;
883 	int reference;
884 	int num_transducer;
885 
886 	bool is_dataport;
887 };
888 
889 /**
890  * enum sdca_clock_type - SDCA Clock Types
891  *
892  * Indicate the synchronicity of an Clock Entity, see section 6.4.1.3
893  * of the SDCA v1.0 specification.
894  */
895 enum sdca_clock_type {
896 	SDCA_CLOCK_TYPE_EXTERNAL			= 0x00,
897 	SDCA_CLOCK_TYPE_INTERNAL_ASYNC			= 0x01,
898 	SDCA_CLOCK_TYPE_INTERNAL_SYNC			= 0x02,
899 	SDCA_CLOCK_TYPE_INTERNAL_SOURCE_SYNC		= 0x03,
900 };
901 
902 /**
903  * struct sdca_entity_cs - information specific to Clock Source Entities
904  * @type: Synchronicity of the Clock Source.
905  * @max_delay: The maximum delay in microseconds before the clock is stable.
906  */
907 struct sdca_entity_cs {
908 	enum sdca_clock_type type;
909 	unsigned int max_delay;
910 };
911 
912 /**
913  * enum sdca_pde_power_state - SDCA Power States
914  *
915  * SDCA Power State values from SDCA specification v1.0 Section 7.12.4.
916  */
917 enum sdca_pde_power_state {
918 	SDCA_PDE_PS0					= 0x0,
919 	SDCA_PDE_PS1					= 0x1,
920 	SDCA_PDE_PS2					= 0x2,
921 	SDCA_PDE_PS3					= 0x3,
922 	SDCA_PDE_PS4					= 0x4,
923 };
924 
925 /**
926  * struct sdca_pde_delay - describes the delay changing between 2 power states
927  * @from_ps: The power state being exited.
928  * @to_ps: The power state being entered.
929  * @us: The delay in microseconds switching between the two states.
930  */
931 struct sdca_pde_delay {
932 	int from_ps;
933 	int to_ps;
934 	unsigned int us;
935 };
936 
937 /**
938  * struct sdca_entity_pde - information specific to Power Domain Entities
939  * @managed: Dynamically allocated array pointing to each Entity
940  * controlled by this PDE.
941  * @max_delay: Dynamically allocated array of delays for switching
942  * between power states.
943  * @num_managed: Number of Entities controlled by this PDE.
944  * @num_max_delay: Number of delays specified for state changes.
945  */
946 struct sdca_entity_pde {
947 	struct sdca_entity **managed;
948 	struct sdca_pde_delay *max_delay;
949 	int num_managed;
950 	int num_max_delay;
951 };
952 
953 /**
954  * enum sdca_entity_type - SDCA Entity Type codes
955  * @SDCA_ENTITY_TYPE_ENTITY_0: Entity 0, not actually from the
956  * specification but useful internally as an Entity structure
957  * is allocated for Entity 0, to hold Entity 0 controls.
958  * @SDCA_ENTITY_TYPE_IT: Input Terminal.
959  * @SDCA_ENTITY_TYPE_OT: Output Terminal.
960  * @SDCA_ENTITY_TYPE_MU: Mixer Unit.
961  * @SDCA_ENTITY_TYPE_SU: Selector Unit.
962  * @SDCA_ENTITY_TYPE_FU: Feature Unit.
963  * @SDCA_ENTITY_TYPE_XU: Extension Unit.
964  * @SDCA_ENTITY_TYPE_CS: Clock Source.
965  * @SDCA_ENTITY_TYPE_CX: Clock selector.
966  * @SDCA_ENTITY_TYPE_PDE: Power-Domain Entity.
967  * @SDCA_ENTITY_TYPE_GE: Group Entity.
968  * @SDCA_ENTITY_TYPE_SPE: Security & Privacy Entity.
969  * @SDCA_ENTITY_TYPE_CRU: Channel Remapping Unit.
970  * @SDCA_ENTITY_TYPE_UDMPU: Up-Down Mixer Processing Unit.
971  * @SDCA_ENTITY_TYPE_MFPU: Multi-Function Processing Unit.
972  * @SDCA_ENTITY_TYPE_SMPU: Smart Microphone Processing Unit.
973  * @SDCA_ENTITY_TYPE_SAPU: Smart Amp Processing Unit.
974  * @SDCA_ENTITY_TYPE_PPU: Posture Processing Unit.
975  * @SDCA_ENTITY_TYPE_TG: Tone Generator.
976  * @SDCA_ENTITY_TYPE_HIDE: Human Interface Device Entity.
977  *
978  * SDCA Entity Types from SDCA specification v1.0 Section 6.1.2
979  * all Entity Types not described are reserved.
980  */
981 enum sdca_entity_type {
982 	SDCA_ENTITY_TYPE_ENTITY_0			= 0x00,
983 	SDCA_ENTITY_TYPE_IT				= 0x02,
984 	SDCA_ENTITY_TYPE_OT				= 0x03,
985 	SDCA_ENTITY_TYPE_MU				= 0x05,
986 	SDCA_ENTITY_TYPE_SU				= 0x06,
987 	SDCA_ENTITY_TYPE_FU				= 0x07,
988 	SDCA_ENTITY_TYPE_XU				= 0x0A,
989 	SDCA_ENTITY_TYPE_CS				= 0x0B,
990 	SDCA_ENTITY_TYPE_CX				= 0x0C,
991 	SDCA_ENTITY_TYPE_PDE				= 0x11,
992 	SDCA_ENTITY_TYPE_GE				= 0x12,
993 	SDCA_ENTITY_TYPE_SPE				= 0x13,
994 	SDCA_ENTITY_TYPE_CRU				= 0x20,
995 	SDCA_ENTITY_TYPE_UDMPU				= 0x21,
996 	SDCA_ENTITY_TYPE_MFPU				= 0x22,
997 	SDCA_ENTITY_TYPE_SMPU				= 0x23,
998 	SDCA_ENTITY_TYPE_SAPU				= 0x24,
999 	SDCA_ENTITY_TYPE_PPU				= 0x25,
1000 	SDCA_ENTITY_TYPE_TG				= 0x30,
1001 	SDCA_ENTITY_TYPE_HIDE				= 0x31,
1002 };
1003 
1004 /**
1005  * struct sdca_ge_control - control entry in the affected controls list
1006  * @id: Entity ID of the Control affected.
1007  * @sel: Control Selector of the Control affected.
1008  * @cn: Control Number of the Control affected.
1009  * @val: Value written to Control for this Mode.
1010  */
1011 struct sdca_ge_control {
1012 	int id;
1013 	int sel;
1014 	int cn;
1015 	int val;
1016 };
1017 
1018 /**
1019  * struct sdca_ge_mode - mode entry in the affected controls list
1020  * @controls: Dynamically allocated array of controls written for this Mode.
1021  * @num_controls: Number of controls written in this Mode.
1022  * @val: GE Selector Mode value.
1023  */
1024 struct sdca_ge_mode {
1025 	struct sdca_ge_control *controls;
1026 	int num_controls;
1027 	int val;
1028 };
1029 
1030 /**
1031  * struct sdca_entity_ge - information specific to Group Entities
1032  * @kctl: ALSA control pointer that can be used by linked Entities.
1033  * @modes: Dynamically allocated array of Modes and the Controls written
1034  * in each mode.
1035  * @num_modes: Number of Modes.
1036  */
1037 struct sdca_entity_ge {
1038 	struct snd_kcontrol_new *kctl;
1039 	struct sdca_ge_mode *modes;
1040 	int num_modes;
1041 };
1042 
1043 /**
1044  * struct sdca_entity - information for one SDCA Entity
1045  * @label: String such as "OT 12".
1046  * @id: Identifier used for addressing.
1047  * @type: Type code for the Entity.
1048  * @group: Pointer to Group Entity controlling this one, NULL if N/A.
1049  * @sources: Dynamically allocated array pointing to each input Entity
1050  * connected to this Entity.
1051  * @controls: Dynamically allocated array of Controls.
1052  * @num_sources: Number of sources for the Entity.
1053  * @num_controls: Number of Controls for the Entity.
1054  * @iot: Input/Output Terminal specific Entity properties.
1055  * @cs: Clock Source specific Entity properties.
1056  * @pde: Power Domain Entity specific Entity properties.
1057  * @ge: Group Entity specific Entity properties.
1058  */
1059 struct sdca_entity {
1060 	const char *label;
1061 	int id;
1062 	enum sdca_entity_type type;
1063 
1064 	struct sdca_entity *group;
1065 	struct sdca_entity **sources;
1066 	struct sdca_control *controls;
1067 	int num_sources;
1068 	int num_controls;
1069 	union {
1070 		struct sdca_entity_iot iot;
1071 		struct sdca_entity_cs cs;
1072 		struct sdca_entity_pde pde;
1073 		struct sdca_entity_ge ge;
1074 	};
1075 };
1076 
1077 /**
1078  * enum sdca_channel_purpose - SDCA Channel Purpose code
1079  *
1080  * Channel Purpose codes as described in the SDCA specification v1.0
1081  * section 11.4.3.
1082  */
1083 enum sdca_channel_purpose {
1084 	/* Table 210 - Purpose */
1085 	SDCA_CHAN_PURPOSE_GENERIC_AUDIO			= 0x01,
1086 	SDCA_CHAN_PURPOSE_VOICE				= 0x02,
1087 	SDCA_CHAN_PURPOSE_SPEECH			= 0x03,
1088 	SDCA_CHAN_PURPOSE_AMBIENT			= 0x04,
1089 	SDCA_CHAN_PURPOSE_REFERENCE			= 0x05,
1090 	SDCA_CHAN_PURPOSE_ULTRASOUND			= 0x06,
1091 	SDCA_CHAN_PURPOSE_SENSE				= 0x08,
1092 	SDCA_CHAN_PURPOSE_SILENCE			= 0xFE,
1093 	SDCA_CHAN_PURPOSE_NON_AUDIO			= 0xFF,
1094 	/* Table 211 - Amp Sense */
1095 	SDCA_CHAN_PURPOSE_SENSE_V1			= 0x09,
1096 	SDCA_CHAN_PURPOSE_SENSE_V2			= 0x0A,
1097 	SDCA_CHAN_PURPOSE_SENSE_V12_INTERLEAVED		= 0x10,
1098 	SDCA_CHAN_PURPOSE_SENSE_V21_INTERLEAVED		= 0x11,
1099 	SDCA_CHAN_PURPOSE_SENSE_V12_PACKED		= 0x12,
1100 	SDCA_CHAN_PURPOSE_SENSE_V21_PACKED		= 0x13,
1101 	SDCA_CHAN_PURPOSE_SENSE_V1212_INTERLEAVED	= 0x14,
1102 	SDCA_CHAN_PURPOSE_SENSE_V2121_INTERLEAVED	= 0x15,
1103 	SDCA_CHAN_PURPOSE_SENSE_V1122_INTERLEAVED	= 0x16,
1104 	SDCA_CHAN_PURPOSE_SENSE_V2211_INTERLEAVED	= 0x17,
1105 	SDCA_CHAN_PURPOSE_SENSE_V1212_PACKED		= 0x18,
1106 	SDCA_CHAN_PURPOSE_SENSE_V2121_PACKED		= 0x19,
1107 	SDCA_CHAN_PURPOSE_SENSE_V1122_PACKED		= 0x1A,
1108 	SDCA_CHAN_PURPOSE_SENSE_V2211_PACKED		= 0x1B,
1109 };
1110 
1111 /**
1112  * enum sdca_channel_relationship - SDCA Channel Relationship code
1113  *
1114  * Channel Relationship codes as described in the SDCA specification
1115  * v1.0 section 11.4.2.
1116  */
1117 enum sdca_channel_relationship {
1118 	/* Table 206 - Streaming */
1119 	SDCA_CHAN_REL_UNDEFINED				= 0x00,
1120 	SDCA_CHAN_REL_GENERIC_MONO			= 0x01,
1121 	SDCA_CHAN_REL_GENERIC_LEFT			= 0x02,
1122 	SDCA_CHAN_REL_GENERIC_RIGHT			= 0x03,
1123 	SDCA_CHAN_REL_GENERIC_TOP			= 0x48,
1124 	SDCA_CHAN_REL_GENERIC_BOTTOM			= 0x49,
1125 	SDCA_CHAN_REL_CAPTURE_DIRECT			= 0x4E,
1126 	SDCA_CHAN_REL_RENDER_DIRECT			= 0x4F,
1127 	SDCA_CHAN_REL_FRONT_LEFT			= 0x0B,
1128 	SDCA_CHAN_REL_FRONT_RIGHT			= 0x0C,
1129 	SDCA_CHAN_REL_FRONT_CENTER			= 0x0D,
1130 	SDCA_CHAN_REL_SIDE_LEFT				= 0x12,
1131 	SDCA_CHAN_REL_SIDE_RIGHT			= 0x13,
1132 	SDCA_CHAN_REL_BACK_LEFT				= 0x16,
1133 	SDCA_CHAN_REL_BACK_RIGHT			= 0x17,
1134 	SDCA_CHAN_REL_LOW_FREQUENCY_EFFECTS		= 0x43,
1135 	SDCA_CHAN_REL_SOUNDWIRE_MIC			= 0x55,
1136 	SDCA_CHAN_REL_SENSE_TRANSDUCER_1		= 0x58,
1137 	SDCA_CHAN_REL_SENSE_TRANSDUCER_2		= 0x59,
1138 	SDCA_CHAN_REL_SENSE_TRANSDUCER_12		= 0x5A,
1139 	SDCA_CHAN_REL_SENSE_TRANSDUCER_21		= 0x5B,
1140 	SDCA_CHAN_REL_ECHOREF_NONE			= 0x70,
1141 	SDCA_CHAN_REL_ECHOREF_1				= 0x71,
1142 	SDCA_CHAN_REL_ECHOREF_2				= 0x72,
1143 	SDCA_CHAN_REL_ECHOREF_3				= 0x73,
1144 	SDCA_CHAN_REL_ECHOREF_4				= 0x74,
1145 	SDCA_CHAN_REL_ECHOREF_ALL			= 0x75,
1146 	SDCA_CHAN_REL_ECHOREF_LFE_ALL			= 0x76,
1147 	/* Table 207 - Speaker */
1148 	SDCA_CHAN_REL_PRIMARY_TRANSDUCER		= 0x50,
1149 	SDCA_CHAN_REL_SECONDARY_TRANSDUCER		= 0x51,
1150 	SDCA_CHAN_REL_TERTIARY_TRANSDUCER		= 0x52,
1151 	SDCA_CHAN_REL_LOWER_LEFT_ALLTRANSDUCER		= 0x60,
1152 	SDCA_CHAN_REL_LOWER_RIGHT_ALLTRANSDUCER		= 0x61,
1153 	SDCA_CHAN_REL_UPPER_LEFT_ALLTRANSDUCER		= 0x62,
1154 	SDCA_CHAN_REL_UPPER_RIGHT_ALLTRANSDUCER		= 0x63,
1155 	SDCA_CHAN_REL_LOWER_LEFT_PRIMARY		= 0x64,
1156 	SDCA_CHAN_REL_LOWER_RIGHT_PRIMARY		= 0x65,
1157 	SDCA_CHAN_REL_UPPER_LEFT_PRIMARY		= 0x66,
1158 	SDCA_CHAN_REL_UPPER_RIGHT_PRIMARY		= 0x67,
1159 	SDCA_CHAN_REL_LOWER_LEFT_SECONDARY		= 0x68,
1160 	SDCA_CHAN_REL_LOWER_RIGHT_SECONDARY		= 0x69,
1161 	SDCA_CHAN_REL_UPPER_LEFT_SECONDARY		= 0x6A,
1162 	SDCA_CHAN_REL_UPPER_RIGHT_SECONDARY		= 0x6B,
1163 	SDCA_CHAN_REL_LOWER_LEFT_TERTIARY		= 0x6C,
1164 	SDCA_CHAN_REL_LOWER_RIGHT_TERTIARY		= 0x6D,
1165 	SDCA_CHAN_REL_UPPER_LEFT_TERTIARY		= 0x6E,
1166 	SDCA_CHAN_REL_UPPER_RIGHT_TERTIARY		= 0x6F,
1167 	SDCA_CHAN_REL_DERIVED_LOWER_LEFT_PRIMARY	= 0x94,
1168 	SDCA_CHAN_REL_DERIVED_LOWER_RIGHT_PRIMARY	= 0x95,
1169 	SDCA_CHAN_REL_DERIVED_UPPER_LEFT_PRIMARY	= 0x96,
1170 	SDCA_CHAN_REL_DERIVED_UPPER_RIGHT_PRIMARY	= 0x97,
1171 	SDCA_CHAN_REL_DERIVED_LOWER_LEFT_SECONDARY	= 0x98,
1172 	SDCA_CHAN_REL_DERIVED_LOWER_RIGHT_SECONDARY	= 0x99,
1173 	SDCA_CHAN_REL_DERIVED_UPPER_LEFT_SECONDARY	= 0x9A,
1174 	SDCA_CHAN_REL_DERIVED_UPPER_RIGHT_SECONDARY	= 0x9B,
1175 	SDCA_CHAN_REL_DERIVED_LOWER_LEFT_TERTIARY	= 0x9C,
1176 	SDCA_CHAN_REL_DERIVED_LOWER_RIGHT_TERTIARY	= 0x9D,
1177 	SDCA_CHAN_REL_DERIVED_UPPER_LEFT_TERTIARY	= 0x9E,
1178 	SDCA_CHAN_REL_DERIVED_UPPER_RIGHT_TERTIARY	= 0x9F,
1179 	SDCA_CHAN_REL_DERIVED_MONO_PRIMARY		= 0xA0,
1180 	SDCA_CHAN_REL_DERIVED_MONO_SECONDARY		= 0xAB,
1181 	SDCA_CHAN_REL_DERIVED_MONO_TERTIARY		= 0xAC,
1182 	/* Table 208 - Equipment */
1183 	SDCA_CHAN_REL_EQUIPMENT_LEFT			= 0x02,
1184 	SDCA_CHAN_REL_EQUIPMENT_RIGHT			= 0x03,
1185 	SDCA_CHAN_REL_EQUIPMENT_COMBINED		= 0x47,
1186 	SDCA_CHAN_REL_EQUIPMENT_TOP			= 0x48,
1187 	SDCA_CHAN_REL_EQUIPMENT_BOTTOM			= 0x49,
1188 	SDCA_CHAN_REL_EQUIPMENT_TOP_LEFT		= 0x4A,
1189 	SDCA_CHAN_REL_EQUIPMENT_BOTTOM_LEFT		= 0x4B,
1190 	SDCA_CHAN_REL_EQUIPMENT_TOP_RIGHT		= 0x4C,
1191 	SDCA_CHAN_REL_EQUIPMENT_BOTTOM_RIGHT		= 0x4D,
1192 	SDCA_CHAN_REL_EQUIPMENT_SILENCED_OUTPUT		= 0x57,
1193 	/* Table 209 - Other */
1194 	SDCA_CHAN_REL_ARRAY				= 0x04,
1195 	SDCA_CHAN_REL_MIC				= 0x53,
1196 	SDCA_CHAN_REL_RAW				= 0x54,
1197 	SDCA_CHAN_REL_SILENCED_MIC			= 0x56,
1198 	SDCA_CHAN_REL_MULTI_SOURCE_1			= 0x78,
1199 	SDCA_CHAN_REL_MULTI_SOURCE_2			= 0x79,
1200 	SDCA_CHAN_REL_MULTI_SOURCE_3			= 0x7A,
1201 	SDCA_CHAN_REL_MULTI_SOURCE_4			= 0x7B,
1202 };
1203 
1204 /**
1205  * struct sdca_channel - a single Channel with a Cluster
1206  * @id: Identifier used for addressing.
1207  * @purpose: Indicates the purpose of the Channel, usually to give
1208  * semantic meaning to the audio, eg. voice, ultrasound.
1209  * @relationship: Indicates the relationship of this Channel to others
1210  * in the Cluster, often used to identify the physical position of the
1211  * Channel eg. left.
1212  */
1213 struct sdca_channel {
1214 	int id;
1215 	enum sdca_channel_purpose purpose;
1216 	enum sdca_channel_relationship relationship;
1217 };
1218 
1219 /**
1220  * struct sdca_cluster - information about an SDCA Channel Cluster
1221  * @id: Identifier used for addressing.
1222  * @num_channels: Number of Channels within this Cluster.
1223  * @channels: Dynamically allocated array of Channels.
1224  */
1225 struct sdca_cluster {
1226 	int id;
1227 	int num_channels;
1228 	struct sdca_channel *channels;
1229 };
1230 
1231 /**
1232  * struct sdca_function_data - top-level information for one SDCA function
1233  * @desc: Pointer to short descriptor from initial parsing.
1234  * @init_table: Pointer to a table of initialization writes.
1235  * @entities: Dynamically allocated array of Entities.
1236  * @clusters: Dynamically allocated array of Channel Clusters.
1237  * @num_init_table: Number of initialization writes.
1238  * @num_entities: Number of Entities reported in this Function.
1239  * @num_clusters: Number of Channel Clusters reported in this Function.
1240  * @busy_max_delay: Maximum Function busy delay in microseconds, before an
1241  * error should be reported.
1242  */
1243 struct sdca_function_data {
1244 	struct sdca_function_desc *desc;
1245 
1246 	struct sdca_init_write *init_table;
1247 	struct sdca_entity *entities;
1248 	struct sdca_cluster *clusters;
1249 	int num_init_table;
1250 	int num_entities;
1251 	int num_clusters;
1252 
1253 	unsigned int busy_max_delay;
1254 };
1255 
1256 static inline u32 sdca_range(struct sdca_control_range *range,
1257 			     unsigned int col, unsigned int row)
1258 {
1259 	return range->data[(row * range->cols) + col];
1260 }
1261 
1262 static inline u32 sdca_range_search(struct sdca_control_range *range,
1263 				    int search_col, int value, int result_col)
1264 {
1265 	int i;
1266 
1267 	for (i = 0; i < range->rows; i++) {
1268 		if (sdca_range(range, search_col, i) == value)
1269 			return sdca_range(range, result_col, i);
1270 	}
1271 
1272 	return 0;
1273 }
1274 
1275 int sdca_parse_function(struct device *dev,
1276 			struct sdca_function_desc *desc,
1277 			struct sdca_function_data *function);
1278 
1279 #endif
1280