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