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