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