xref: /linux/sound/soc/sdca/sdca_functions.c (revision d061251387903e8502843ac983553f0b2e098ef8)
1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 // Copyright(c) 2024 Intel Corporation
3 
4 /*
5  * The MIPI SDCA specification is available for public downloads at
6  * https://www.mipi.org/mipi-sdca-v1-0-download
7  */
8 
9 #include <linux/acpi.h>
10 #include <linux/byteorder/generic.h>
11 #include <linux/cleanup.h>
12 #include <linux/device.h>
13 #include <linux/dev_printk.h>
14 #include <linux/module.h>
15 #include <linux/property.h>
16 #include <linux/soundwire/sdw.h>
17 #include <linux/string.h>
18 #include <linux/types.h>
19 #include <sound/sdca.h>
20 #include <sound/sdca_function.h>
21 #include <sound/sdca_hid.h>
22 
23 /*
24  * Should be long enough to encompass all the MIPI DisCo properties.
25  */
26 #define SDCA_PROPERTY_LENGTH 64
27 
28 static int patch_sdca_function_type(u32 interface_revision, u32 *function_type)
29 {
30 	/*
31 	 * Unfortunately early SDCA specifications used different indices for Functions,
32 	 * for backwards compatibility we have to reorder the values found.
33 	 */
34 	if (interface_revision < 0x0801) {
35 		switch (*function_type) {
36 		case 1:
37 			*function_type = SDCA_FUNCTION_TYPE_SMART_AMP;
38 			break;
39 		case 2:
40 			*function_type = SDCA_FUNCTION_TYPE_SMART_MIC;
41 			break;
42 		case 3:
43 			*function_type = SDCA_FUNCTION_TYPE_SPEAKER_MIC;
44 			break;
45 		case 4:
46 			*function_type = SDCA_FUNCTION_TYPE_UAJ;
47 			break;
48 		case 5:
49 			*function_type = SDCA_FUNCTION_TYPE_RJ;
50 			break;
51 		case 6:
52 			*function_type = SDCA_FUNCTION_TYPE_HID;
53 			break;
54 		default:
55 			return -EINVAL;
56 		}
57 	}
58 
59 	return 0;
60 }
61 
62 static const char *get_sdca_function_name(u32 function_type)
63 {
64 	switch (function_type) {
65 	case SDCA_FUNCTION_TYPE_SMART_AMP:
66 		return SDCA_FUNCTION_TYPE_SMART_AMP_NAME;
67 	case SDCA_FUNCTION_TYPE_SMART_MIC:
68 		return SDCA_FUNCTION_TYPE_SMART_MIC_NAME;
69 	case SDCA_FUNCTION_TYPE_UAJ:
70 		return SDCA_FUNCTION_TYPE_UAJ_NAME;
71 	case SDCA_FUNCTION_TYPE_HID:
72 		return SDCA_FUNCTION_TYPE_HID_NAME;
73 	case SDCA_FUNCTION_TYPE_SIMPLE_AMP:
74 		return SDCA_FUNCTION_TYPE_SIMPLE_AMP_NAME;
75 	case SDCA_FUNCTION_TYPE_SIMPLE_MIC:
76 		return SDCA_FUNCTION_TYPE_SIMPLE_MIC_NAME;
77 	case SDCA_FUNCTION_TYPE_SPEAKER_MIC:
78 		return SDCA_FUNCTION_TYPE_SPEAKER_MIC_NAME;
79 	case SDCA_FUNCTION_TYPE_RJ:
80 		return SDCA_FUNCTION_TYPE_RJ_NAME;
81 	case SDCA_FUNCTION_TYPE_COMPANION_AMP:
82 		return SDCA_FUNCTION_TYPE_COMPANION_AMP_NAME;
83 	case SDCA_FUNCTION_TYPE_IMP_DEF:
84 		return SDCA_FUNCTION_TYPE_IMP_DEF_NAME;
85 	default:
86 		return NULL;
87 	}
88 }
89 
90 static int find_sdca_function(struct acpi_device *adev, void *data)
91 {
92 	struct fwnode_handle *function_node = acpi_fwnode_handle(adev);
93 	struct sdca_device_data *sdca_data = data;
94 	struct sdw_slave *slave = container_of(sdca_data, struct sdw_slave, sdca_data);
95 	struct device *dev = &adev->dev;
96 	struct fwnode_handle *control5; /* used to identify function type */
97 	const char *function_name;
98 	u32 function_type;
99 	int function_index;
100 	u64 addr;
101 	int ret;
102 
103 	if (sdca_data->num_functions >= SDCA_MAX_FUNCTION_COUNT) {
104 		dev_err(dev, "maximum number of functions exceeded\n");
105 		return -EINVAL;
106 	}
107 
108 	ret = acpi_get_local_u64_address(adev->handle, &addr);
109 	if (ret < 0)
110 		return ret;
111 
112 	if (!addr || addr > 0x7) {
113 		dev_err(dev, "invalid addr: 0x%llx\n", addr);
114 		return -ENODEV;
115 	}
116 
117 	/*
118 	 * Extracting the topology type for an SDCA function is a
119 	 * convoluted process.
120 	 * The Function type is only visible as a result of a read
121 	 * from a control. In theory this would mean reading from the hardware,
122 	 * but the SDCA/DisCo specs defined the notion of "DC value" - a constant
123 	 * represented with a DSD subproperty.
124 	 * Drivers have to query the properties for the control
125 	 * SDCA_CONTROL_ENTITY_0_FUNCTION_TOPOLOGY (0x05)
126 	 */
127 	control5 = fwnode_get_named_child_node(function_node,
128 					       "mipi-sdca-control-0x5-subproperties");
129 	if (!control5)
130 		return -ENODEV;
131 
132 	ret = fwnode_property_read_u32(control5, "mipi-sdca-control-dc-value",
133 				       &function_type);
134 
135 	fwnode_handle_put(control5);
136 
137 	if (ret < 0) {
138 		dev_err(dev, "function type only supported as DisCo constant\n");
139 		return ret;
140 	}
141 
142 	if (!sdca_device_quirk_match(slave, SDCA_QUIRKS_SKIP_FUNC_TYPE_PATCHING)) {
143 		ret = patch_sdca_function_type(sdca_data->interface_revision, &function_type);
144 		if (ret < 0) {
145 			dev_err(dev, "SDCA version %#x invalid function type %d\n",
146 				sdca_data->interface_revision, function_type);
147 			return ret;
148 		}
149 	}
150 
151 	function_name = get_sdca_function_name(function_type);
152 	if (!function_name) {
153 		dev_err(dev, "invalid SDCA function type %d\n", function_type);
154 		return -EINVAL;
155 	}
156 
157 	dev_info(dev, "SDCA function %s (type %d) at 0x%llx\n",
158 		 function_name, function_type, addr);
159 
160 	/* store results */
161 	function_index = sdca_data->num_functions;
162 	sdca_data->function[function_index].adr = addr;
163 	sdca_data->function[function_index].type = function_type;
164 	sdca_data->function[function_index].name = function_name;
165 	sdca_data->function[function_index].node = function_node;
166 	sdca_data->num_functions++;
167 
168 	return 0;
169 }
170 
171 /**
172  * sdca_lookup_functions - Parse sdca_device_desc for each Function
173  * @slave: SoundWire slave device to be processed.
174  *
175  * Iterate through the available SDCA Functions and fill in a short
176  * descriptor (struct sdca_function_desc) for each function, this
177  * information is stored along with the SoundWire slave device and
178  * used for adding drivers and quirks before the devices have fully
179  * probed.
180  */
181 void sdca_lookup_functions(struct sdw_slave *slave)
182 {
183 	struct device *sdev = &slave->dev;
184 	struct acpi_device *adev = to_acpi_device_node(sdev->fwnode);
185 
186 	if (!adev) {
187 		dev_info(sdev, "no matching ACPI device found, ignoring peripheral\n");
188 		return;
189 	}
190 
191 	acpi_dev_for_each_child(adev, find_sdca_function, &slave->sdca_data);
192 }
193 EXPORT_SYMBOL_NS(sdca_lookup_functions, "SND_SOC_SDCA");
194 
195 struct raw_init_write {
196 	__le32 addr;
197 	u8 val;
198 } __packed;
199 
200 static int find_sdca_init_table(struct device *dev,
201 				struct fwnode_handle *function_node,
202 				struct sdca_function_data *function)
203 {
204 	struct raw_init_write *raw __free(kfree) = NULL;
205 	struct sdca_init_write *init_write;
206 	int i, num_init_writes;
207 
208 	num_init_writes = fwnode_property_count_u8(function_node,
209 						   "mipi-sdca-function-initialization-table");
210 	if (!num_init_writes || num_init_writes == -EINVAL) {
211 		return 0;
212 	} else if (num_init_writes < 0) {
213 		dev_err(dev, "%pfwP: failed to read initialization table: %d\n",
214 			function_node, num_init_writes);
215 		return num_init_writes;
216 	} else if (num_init_writes % sizeof(*raw) != 0) {
217 		dev_err(dev, "%pfwP: init table size invalid\n", function_node);
218 		return -EINVAL;
219 	} else if ((num_init_writes / sizeof(*raw)) > SDCA_MAX_INIT_COUNT) {
220 		dev_err(dev, "%pfwP: maximum init table size exceeded\n", function_node);
221 		return -EINVAL;
222 	}
223 
224 	raw = kzalloc(num_init_writes, GFP_KERNEL);
225 	if (!raw)
226 		return -ENOMEM;
227 
228 	fwnode_property_read_u8_array(function_node,
229 				      "mipi-sdca-function-initialization-table",
230 				      (u8 *)raw, num_init_writes);
231 
232 	num_init_writes /= sizeof(*raw);
233 
234 	init_write = devm_kcalloc(dev, num_init_writes, sizeof(*init_write), GFP_KERNEL);
235 	if (!init_write)
236 		return -ENOMEM;
237 
238 	for (i = 0; i < num_init_writes; i++) {
239 		init_write[i].addr = le32_to_cpu(raw[i].addr);
240 		init_write[i].val = raw[i].val;
241 	}
242 
243 	function->num_init_table = num_init_writes;
244 	function->init_table = init_write;
245 
246 	return 0;
247 }
248 
249 static const char *find_sdca_control_label(struct device *dev,
250 					   const struct sdca_entity *entity,
251 					   const struct sdca_control *control)
252 {
253 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
254 	case SDCA_CTL_TYPE_S(IT, MIC_BIAS):
255 		return SDCA_CTL_MIC_BIAS_NAME;
256 	case SDCA_CTL_TYPE_S(IT, USAGE):
257 	case SDCA_CTL_TYPE_S(OT, USAGE):
258 		return SDCA_CTL_USAGE_NAME;
259 	case SDCA_CTL_TYPE_S(IT, LATENCY):
260 	case SDCA_CTL_TYPE_S(OT, LATENCY):
261 	case SDCA_CTL_TYPE_S(MU, LATENCY):
262 	case SDCA_CTL_TYPE_S(SU, LATENCY):
263 	case SDCA_CTL_TYPE_S(FU, LATENCY):
264 	case SDCA_CTL_TYPE_S(XU, LATENCY):
265 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
266 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
267 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
268 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
269 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
270 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
271 		return SDCA_CTL_LATENCY_NAME;
272 	case SDCA_CTL_TYPE_S(IT, CLUSTERINDEX):
273 	case SDCA_CTL_TYPE_S(CRU, CLUSTERINDEX):
274 	case SDCA_CTL_TYPE_S(UDMPU, CLUSTERINDEX):
275 	case SDCA_CTL_TYPE_S(MFPU, CLUSTERINDEX):
276 		return SDCA_CTL_CLUSTERINDEX_NAME;
277 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
278 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
279 		return SDCA_CTL_DATAPORT_SELECTOR_NAME;
280 	case SDCA_CTL_TYPE_S(IT, MATCHING_GUID):
281 	case SDCA_CTL_TYPE_S(OT, MATCHING_GUID):
282 	case SDCA_CTL_TYPE_S(ENTITY_0, MATCHING_GUID):
283 		return SDCA_CTL_MATCHING_GUID_NAME;
284 	case SDCA_CTL_TYPE_S(IT, KEEP_ALIVE):
285 	case SDCA_CTL_TYPE_S(OT, KEEP_ALIVE):
286 		return SDCA_CTL_KEEP_ALIVE_NAME;
287 	case SDCA_CTL_TYPE_S(IT, NDAI_STREAM):
288 	case SDCA_CTL_TYPE_S(OT, NDAI_STREAM):
289 		return SDCA_CTL_NDAI_STREAM_NAME;
290 	case SDCA_CTL_TYPE_S(IT, NDAI_CATEGORY):
291 	case SDCA_CTL_TYPE_S(OT, NDAI_CATEGORY):
292 		return SDCA_CTL_NDAI_CATEGORY_NAME;
293 	case SDCA_CTL_TYPE_S(IT, NDAI_CODINGTYPE):
294 	case SDCA_CTL_TYPE_S(OT, NDAI_CODINGTYPE):
295 		return SDCA_CTL_NDAI_CODINGTYPE_NAME;
296 	case SDCA_CTL_TYPE_S(IT, NDAI_PACKETTYPE):
297 	case SDCA_CTL_TYPE_S(OT, NDAI_PACKETTYPE):
298 		return SDCA_CTL_NDAI_PACKETTYPE_NAME;
299 	case SDCA_CTL_TYPE_S(MU, MIXER):
300 		return SDCA_CTL_MIXER_NAME;
301 	case SDCA_CTL_TYPE_S(SU, SELECTOR):
302 		return SDCA_CTL_SELECTOR_NAME;
303 	case SDCA_CTL_TYPE_S(FU, MUTE):
304 		return SDCA_CTL_MUTE_NAME;
305 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
306 		return SDCA_CTL_CHANNEL_VOLUME_NAME;
307 	case SDCA_CTL_TYPE_S(FU, AGC):
308 		return SDCA_CTL_AGC_NAME;
309 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
310 		return SDCA_CTL_BASS_BOOST_NAME;
311 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
312 		return SDCA_CTL_LOUDNESS_NAME;
313 	case SDCA_CTL_TYPE_S(FU, GAIN):
314 		return SDCA_CTL_GAIN_NAME;
315 	case SDCA_CTL_TYPE_S(XU, BYPASS):
316 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
317 		return SDCA_CTL_BYPASS_NAME;
318 	case SDCA_CTL_TYPE_S(XU, XU_ID):
319 		return SDCA_CTL_XU_ID_NAME;
320 	case SDCA_CTL_TYPE_S(XU, XU_VERSION):
321 		return SDCA_CTL_XU_VERSION_NAME;
322 	case SDCA_CTL_TYPE_S(XU, FDL_CURRENTOWNER):
323 		return SDCA_CTL_FDL_CURRENTOWNER_NAME;
324 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
325 		return SDCA_CTL_FDL_MESSAGEOFFSET_NAME;
326 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
327 		return SDCA_CTL_FDL_MESSAGELENGTH_NAME;
328 	case SDCA_CTL_TYPE_S(XU, FDL_STATUS):
329 		return SDCA_CTL_FDL_STATUS_NAME;
330 	case SDCA_CTL_TYPE_S(XU, FDL_SET_INDEX):
331 		return SDCA_CTL_FDL_SET_INDEX_NAME;
332 	case SDCA_CTL_TYPE_S(XU, FDL_HOST_REQUEST):
333 		return SDCA_CTL_FDL_HOST_REQUEST_NAME;
334 	case SDCA_CTL_TYPE_S(CS, CLOCK_VALID):
335 		return SDCA_CTL_CLOCK_VALID_NAME;
336 	case SDCA_CTL_TYPE_S(CS, SAMPLERATEINDEX):
337 		return SDCA_CTL_SAMPLERATEINDEX_NAME;
338 	case SDCA_CTL_TYPE_S(CX, CLOCK_SELECT):
339 		return SDCA_CTL_CLOCK_SELECT_NAME;
340 	case SDCA_CTL_TYPE_S(PDE, REQUESTED_PS):
341 		return SDCA_CTL_REQUESTED_PS_NAME;
342 	case SDCA_CTL_TYPE_S(PDE, ACTUAL_PS):
343 		return SDCA_CTL_ACTUAL_PS_NAME;
344 	case SDCA_CTL_TYPE_S(GE, SELECTED_MODE):
345 		return SDCA_CTL_SELECTED_MODE_NAME;
346 	case SDCA_CTL_TYPE_S(GE, DETECTED_MODE):
347 		return SDCA_CTL_DETECTED_MODE_NAME;
348 	case SDCA_CTL_TYPE_S(SPE, PRIVATE):
349 		return SDCA_CTL_PRIVATE_NAME;
350 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_POLICY):
351 		return SDCA_CTL_PRIVACY_POLICY_NAME;
352 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_LOCKSTATE):
353 		return SDCA_CTL_PRIVACY_LOCKSTATE_NAME;
354 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_OWNER):
355 		return SDCA_CTL_PRIVACY_OWNER_NAME;
356 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_CURRENTOWNER):
357 		return SDCA_CTL_AUTHTX_CURRENTOWNER_NAME;
358 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
359 		return SDCA_CTL_AUTHTX_MESSAGEOFFSET_NAME;
360 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
361 		return SDCA_CTL_AUTHTX_MESSAGELENGTH_NAME;
362 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_CURRENTOWNER):
363 		return SDCA_CTL_AUTHRX_CURRENTOWNER_NAME;
364 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
365 		return SDCA_CTL_AUTHRX_MESSAGEOFFSET_NAME;
366 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
367 		return SDCA_CTL_AUTHRX_MESSAGELENGTH_NAME;
368 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
369 		return SDCA_CTL_ACOUSTIC_ENERGY_LEVEL_MONITOR_NAME;
370 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
371 		return SDCA_CTL_ULTRASOUND_LOOP_GAIN_NAME;
372 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_0):
373 		return SDCA_CTL_OPAQUESET_0_NAME;
374 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_1):
375 		return SDCA_CTL_OPAQUESET_1_NAME;
376 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_2):
377 		return SDCA_CTL_OPAQUESET_2_NAME;
378 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_3):
379 		return SDCA_CTL_OPAQUESET_3_NAME;
380 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_4):
381 		return SDCA_CTL_OPAQUESET_4_NAME;
382 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_5):
383 		return SDCA_CTL_OPAQUESET_5_NAME;
384 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_6):
385 		return SDCA_CTL_OPAQUESET_6_NAME;
386 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_7):
387 		return SDCA_CTL_OPAQUESET_7_NAME;
388 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_8):
389 		return SDCA_CTL_OPAQUESET_8_NAME;
390 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_9):
391 		return SDCA_CTL_OPAQUESET_9_NAME;
392 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_10):
393 		return SDCA_CTL_OPAQUESET_10_NAME;
394 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_11):
395 		return SDCA_CTL_OPAQUESET_11_NAME;
396 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_12):
397 		return SDCA_CTL_OPAQUESET_12_NAME;
398 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_13):
399 		return SDCA_CTL_OPAQUESET_13_NAME;
400 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_14):
401 		return SDCA_CTL_OPAQUESET_14_NAME;
402 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_15):
403 		return SDCA_CTL_OPAQUESET_15_NAME;
404 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_16):
405 		return SDCA_CTL_OPAQUESET_16_NAME;
406 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_17):
407 		return SDCA_CTL_OPAQUESET_17_NAME;
408 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_18):
409 		return SDCA_CTL_OPAQUESET_18_NAME;
410 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_19):
411 		return SDCA_CTL_OPAQUESET_19_NAME;
412 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_20):
413 		return SDCA_CTL_OPAQUESET_20_NAME;
414 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_21):
415 		return SDCA_CTL_OPAQUESET_21_NAME;
416 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_22):
417 		return SDCA_CTL_OPAQUESET_22_NAME;
418 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_23):
419 		return SDCA_CTL_OPAQUESET_23_NAME;
420 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_READY):
421 		return SDCA_CTL_ALGORITHM_READY_NAME;
422 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_ENABLE):
423 		return SDCA_CTL_ALGORITHM_ENABLE_NAME;
424 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_PREPARE):
425 		return SDCA_CTL_ALGORITHM_PREPARE_NAME;
426 	case SDCA_CTL_TYPE_S(MFPU, CENTER_FREQUENCY_INDEX):
427 		return SDCA_CTL_CENTER_FREQUENCY_INDEX_NAME;
428 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
429 		return SDCA_CTL_ULTRASOUND_LEVEL_NAME;
430 	case SDCA_CTL_TYPE_S(MFPU, AE_NUMBER):
431 		return SDCA_CTL_AE_NUMBER_NAME;
432 	case SDCA_CTL_TYPE_S(MFPU, AE_CURRENTOWNER):
433 		return SDCA_CTL_AE_CURRENTOWNER_NAME;
434 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
435 		return SDCA_CTL_AE_MESSAGEOFFSET_NAME;
436 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
437 		return SDCA_CTL_AE_MESSAGELENGTH_NAME;
438 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_ENABLE):
439 		return SDCA_CTL_TRIGGER_ENABLE_NAME;
440 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_STATUS):
441 		return SDCA_CTL_TRIGGER_STATUS_NAME;
442 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_MODE):
443 		return SDCA_CTL_HIST_BUFFER_MODE_NAME;
444 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_PREAMBLE):
445 		return SDCA_CTL_HIST_BUFFER_PREAMBLE_NAME;
446 	case SDCA_CTL_TYPE_S(SMPU, HIST_ERROR):
447 		return SDCA_CTL_HIST_ERROR_NAME;
448 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_EXTENSION):
449 		return SDCA_CTL_TRIGGER_EXTENSION_NAME;
450 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_READY):
451 		return SDCA_CTL_TRIGGER_READY_NAME;
452 	case SDCA_CTL_TYPE_S(SMPU, HIST_CURRENTOWNER):
453 		return SDCA_CTL_HIST_CURRENTOWNER_NAME;
454 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
455 		return SDCA_CTL_HIST_MESSAGEOFFSET_NAME;
456 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
457 		return SDCA_CTL_HIST_MESSAGELENGTH_NAME;
458 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_CURRENTOWNER):
459 		return SDCA_CTL_DTODTX_CURRENTOWNER_NAME;
460 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
461 		return SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME;
462 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
463 		return SDCA_CTL_DTODTX_MESSAGELENGTH_NAME;
464 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_CURRENTOWNER):
465 		return SDCA_CTL_DTODRX_CURRENTOWNER_NAME;
466 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
467 		return SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME;
468 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
469 		return SDCA_CTL_DTODRX_MESSAGELENGTH_NAME;
470 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_MODE):
471 		return SDCA_CTL_PROTECTION_MODE_NAME;
472 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_STATUS):
473 		return SDCA_CTL_PROTECTION_STATUS_NAME;
474 	case SDCA_CTL_TYPE_S(SAPU, OPAQUESETREQ_INDEX):
475 		return SDCA_CTL_OPAQUESETREQ_INDEX_NAME;
476 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_CURRENTOWNER):
477 		return SDCA_CTL_DTODTX_CURRENTOWNER_NAME;
478 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
479 		return SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME;
480 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
481 		return SDCA_CTL_DTODTX_MESSAGELENGTH_NAME;
482 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_CURRENTOWNER):
483 		return SDCA_CTL_DTODRX_CURRENTOWNER_NAME;
484 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
485 		return SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME;
486 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
487 		return SDCA_CTL_DTODRX_MESSAGELENGTH_NAME;
488 	case SDCA_CTL_TYPE_S(PPU, POSTURENUMBER):
489 		return SDCA_CTL_POSTURENUMBER_NAME;
490 	case SDCA_CTL_TYPE_S(PPU, POSTUREEXTENSION):
491 		return SDCA_CTL_POSTUREEXTENSION_NAME;
492 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
493 		return SDCA_CTL_HORIZONTALBALANCE_NAME;
494 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
495 		return SDCA_CTL_VERTICALBALANCE_NAME;
496 	case SDCA_CTL_TYPE_S(TG, TONE_DIVIDER):
497 		return SDCA_CTL_TONE_DIVIDER_NAME;
498 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_CURRENTOWNER):
499 		return SDCA_CTL_HIDTX_CURRENTOWNER_NAME;
500 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
501 		return SDCA_CTL_HIDTX_MESSAGEOFFSET_NAME;
502 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
503 		return SDCA_CTL_HIDTX_MESSAGELENGTH_NAME;
504 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_CURRENTOWNER):
505 		return SDCA_CTL_HIDRX_CURRENTOWNER_NAME;
506 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
507 		return SDCA_CTL_HIDRX_MESSAGEOFFSET_NAME;
508 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
509 		return SDCA_CTL_HIDRX_MESSAGELENGTH_NAME;
510 	case SDCA_CTL_TYPE_S(ENTITY_0, COMMIT_GROUP_MASK):
511 		return SDCA_CTL_COMMIT_GROUP_MASK_NAME;
512 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_SDCA_VERSION):
513 		return SDCA_CTL_FUNCTION_SDCA_VERSION_NAME;
514 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_TYPE):
515 		return SDCA_CTL_FUNCTION_TYPE_NAME;
516 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
517 		return SDCA_CTL_FUNCTION_MANUFACTURER_ID_NAME;
518 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
519 		return SDCA_CTL_FUNCTION_ID_NAME;
520 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_VERSION):
521 		return SDCA_CTL_FUNCTION_VERSION_NAME;
522 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
523 		return SDCA_CTL_FUNCTION_EXTENSION_ID_NAME;
524 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_VERSION):
525 		return SDCA_CTL_FUNCTION_EXTENSION_VERSION_NAME;
526 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_STATUS):
527 		return SDCA_CTL_FUNCTION_STATUS_NAME;
528 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ACTION):
529 		return SDCA_CTL_FUNCTION_ACTION_NAME;
530 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
531 		return SDCA_CTL_DEVICE_MANUFACTURER_ID_NAME;
532 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
533 		return SDCA_CTL_DEVICE_PART_ID_NAME;
534 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_VERSION):
535 		return SDCA_CTL_DEVICE_VERSION_NAME;
536 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_SDCA_VERSION):
537 		return SDCA_CTL_DEVICE_SDCA_VERSION_NAME;
538 	default:
539 		return devm_kasprintf(dev, GFP_KERNEL, "Imp-Def %#x", control->sel);
540 	}
541 }
542 
543 static unsigned int find_sdca_control_bits(const struct sdca_entity *entity,
544 					   const struct sdca_control *control)
545 {
546 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
547 	case SDCA_CTL_TYPE_S(IT, LATENCY):
548 	case SDCA_CTL_TYPE_S(OT, LATENCY):
549 	case SDCA_CTL_TYPE_S(MU, LATENCY):
550 	case SDCA_CTL_TYPE_S(SU, LATENCY):
551 	case SDCA_CTL_TYPE_S(FU, LATENCY):
552 	case SDCA_CTL_TYPE_S(XU, LATENCY):
553 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
554 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
555 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
556 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
557 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
558 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
559 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
560 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
561 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
562 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
563 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
564 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
565 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
566 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
567 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
568 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
569 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
570 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
571 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
572 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
573 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
574 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
575 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
576 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
577 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
578 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
579 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
580 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
581 		return 32;
582 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
583 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
584 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
585 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
586 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
587 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
588 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
589 	case SDCA_CTL_TYPE_S(MU, MIXER):
590 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
591 	case SDCA_CTL_TYPE_S(FU, GAIN):
592 	case SDCA_CTL_TYPE_S(XU, XU_ID):
593 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
594 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
595 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
596 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
597 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
598 		return 16;
599 	case SDCA_CTL_TYPE_S(FU, MUTE):
600 	case SDCA_CTL_TYPE_S(FU, AGC):
601 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
602 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
603 	case SDCA_CTL_TYPE_S(XU, BYPASS):
604 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
605 		return 1;
606 	default:
607 		return 8;
608 	}
609 }
610 
611 static enum sdca_control_datatype
612 find_sdca_control_datatype(const struct sdca_entity *entity,
613 			   const struct sdca_control *control)
614 {
615 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
616 	case SDCA_CTL_TYPE_S(XU, BYPASS):
617 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
618 	case SDCA_CTL_TYPE_S(FU, MUTE):
619 	case SDCA_CTL_TYPE_S(FU, AGC):
620 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
621 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
622 		return SDCA_CTL_DATATYPE_ONEBIT;
623 	case SDCA_CTL_TYPE_S(IT, LATENCY):
624 	case SDCA_CTL_TYPE_S(OT, LATENCY):
625 	case SDCA_CTL_TYPE_S(MU, LATENCY):
626 	case SDCA_CTL_TYPE_S(SU, LATENCY):
627 	case SDCA_CTL_TYPE_S(FU, LATENCY):
628 	case SDCA_CTL_TYPE_S(XU, LATENCY):
629 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
630 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
631 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
632 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
633 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
634 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
635 	case SDCA_CTL_TYPE_S(SU, SELECTOR):
636 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_0):
637 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_1):
638 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_2):
639 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_3):
640 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_4):
641 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_5):
642 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_6):
643 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_7):
644 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_8):
645 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_9):
646 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_10):
647 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_11):
648 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_12):
649 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_13):
650 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_14):
651 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_15):
652 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_16):
653 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_17):
654 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_18):
655 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_19):
656 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_20):
657 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_21):
658 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_22):
659 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_23):
660 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_MODE):
661 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_PREAMBLE):
662 	case SDCA_CTL_TYPE_S(XU, FDL_HOST_REQUEST):
663 	case SDCA_CTL_TYPE_S(XU, XU_ID):
664 	case SDCA_CTL_TYPE_S(CX, CLOCK_SELECT):
665 	case SDCA_CTL_TYPE_S(TG, TONE_DIVIDER):
666 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
667 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
668 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
669 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
670 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
671 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
672 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
673 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
674 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
675 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
676 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
677 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
678 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
679 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
680 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
681 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
682 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
683 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
684 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
685 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
686 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
687 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
688 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
689 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
690 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
691 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
692 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
693 		return SDCA_CTL_DATATYPE_INTEGER;
694 	case SDCA_CTL_TYPE_S(IT, MIC_BIAS):
695 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_MODE):
696 	case SDCA_CTL_TYPE_S(PDE, REQUESTED_PS):
697 	case SDCA_CTL_TYPE_S(PDE, ACTUAL_PS):
698 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_TYPE):
699 		return SDCA_CTL_DATATYPE_SPEC_ENCODED_VALUE;
700 	case SDCA_CTL_TYPE_S(XU, XU_VERSION):
701 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_SDCA_VERSION):
702 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_VERSION):
703 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_VERSION):
704 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_VERSION):
705 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_SDCA_VERSION):
706 		return SDCA_CTL_DATATYPE_BCD;
707 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
708 	case SDCA_CTL_TYPE_S(FU, GAIN):
709 	case SDCA_CTL_TYPE_S(MU, MIXER):
710 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
711 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
712 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
713 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
714 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
715 		return SDCA_CTL_DATATYPE_Q7P8DB;
716 	case SDCA_CTL_TYPE_S(IT, USAGE):
717 	case SDCA_CTL_TYPE_S(OT, USAGE):
718 	case SDCA_CTL_TYPE_S(IT, CLUSTERINDEX):
719 	case SDCA_CTL_TYPE_S(CRU, CLUSTERINDEX):
720 	case SDCA_CTL_TYPE_S(UDMPU, CLUSTERINDEX):
721 	case SDCA_CTL_TYPE_S(MFPU, CLUSTERINDEX):
722 	case SDCA_CTL_TYPE_S(MFPU, CENTER_FREQUENCY_INDEX):
723 	case SDCA_CTL_TYPE_S(MFPU, AE_NUMBER):
724 	case SDCA_CTL_TYPE_S(SAPU, OPAQUESETREQ_INDEX):
725 	case SDCA_CTL_TYPE_S(XU, FDL_SET_INDEX):
726 	case SDCA_CTL_TYPE_S(CS, SAMPLERATEINDEX):
727 	case SDCA_CTL_TYPE_S(GE, SELECTED_MODE):
728 	case SDCA_CTL_TYPE_S(GE, DETECTED_MODE):
729 		return SDCA_CTL_DATATYPE_BYTEINDEX;
730 	case SDCA_CTL_TYPE_S(PPU, POSTURENUMBER):
731 		return SDCA_CTL_DATATYPE_POSTURENUMBER;
732 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
733 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
734 		return SDCA_CTL_DATATYPE_DP_INDEX;
735 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_READY):
736 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_ENABLE):
737 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_PREPARE):
738 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_STATUS):
739 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_ENABLE):
740 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_STATUS):
741 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_READY):
742 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_POLICY):
743 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_OWNER):
744 		return SDCA_CTL_DATATYPE_BITINDEX;
745 	case SDCA_CTL_TYPE_S(IT, KEEP_ALIVE):
746 	case SDCA_CTL_TYPE_S(OT, KEEP_ALIVE):
747 	case SDCA_CTL_TYPE_S(IT, NDAI_STREAM):
748 	case SDCA_CTL_TYPE_S(OT, NDAI_STREAM):
749 	case SDCA_CTL_TYPE_S(IT, NDAI_CATEGORY):
750 	case SDCA_CTL_TYPE_S(OT, NDAI_CATEGORY):
751 	case SDCA_CTL_TYPE_S(IT, NDAI_CODINGTYPE):
752 	case SDCA_CTL_TYPE_S(OT, NDAI_CODINGTYPE):
753 	case SDCA_CTL_TYPE_S(IT, NDAI_PACKETTYPE):
754 	case SDCA_CTL_TYPE_S(OT, NDAI_PACKETTYPE):
755 	case SDCA_CTL_TYPE_S(SMPU, HIST_ERROR):
756 	case SDCA_CTL_TYPE_S(XU, FDL_STATUS):
757 	case SDCA_CTL_TYPE_S(CS, CLOCK_VALID):
758 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_LOCKSTATE):
759 	case SDCA_CTL_TYPE_S(ENTITY_0, COMMIT_GROUP_MASK):
760 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_STATUS):
761 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ACTION):
762 	case SDCA_CTL_TYPE_S(XU, FDL_CURRENTOWNER):
763 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_CURRENTOWNER):
764 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_CURRENTOWNER):
765 	case SDCA_CTL_TYPE_S(MFPU, AE_CURRENTOWNER):
766 	case SDCA_CTL_TYPE_S(SMPU, HIST_CURRENTOWNER):
767 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_CURRENTOWNER):
768 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_CURRENTOWNER):
769 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_CURRENTOWNER):
770 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_CURRENTOWNER):
771 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_CURRENTOWNER):
772 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_CURRENTOWNER):
773 		return SDCA_CTL_DATATYPE_BITMAP;
774 	case SDCA_CTL_TYPE_S(IT, MATCHING_GUID):
775 	case SDCA_CTL_TYPE_S(OT, MATCHING_GUID):
776 	case SDCA_CTL_TYPE_S(ENTITY_0, MATCHING_GUID):
777 		return SDCA_CTL_DATATYPE_GUID;
778 	default:
779 		return SDCA_CTL_DATATYPE_IMPDEF;
780 	}
781 }
782 
783 static bool find_sdca_control_volatile(const struct sdca_entity *entity,
784 				       const struct sdca_control *control)
785 {
786 	switch (control->mode) {
787 	case SDCA_ACCESS_MODE_DC:
788 		return false;
789 	case SDCA_ACCESS_MODE_RO:
790 	case SDCA_ACCESS_MODE_RW1S:
791 	case SDCA_ACCESS_MODE_RW1C:
792 		return true;
793 	default:
794 		break;
795 	}
796 
797 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
798 	case SDCA_CTL_TYPE_S(XU, FDL_CURRENTOWNER):
799 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
800 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
801 	case SDCA_CTL_TYPE_S(XU, FDL_STATUS):
802 	case SDCA_CTL_TYPE_S(XU, FDL_HOST_REQUEST):
803 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_CURRENTOWNER):
804 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
805 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
806 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_CURRENTOWNER):
807 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
808 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
809 	case SDCA_CTL_TYPE_S(MFPU, AE_CURRENTOWNER):
810 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
811 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
812 	case SDCA_CTL_TYPE_S(SMPU, HIST_CURRENTOWNER):
813 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
814 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
815 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_CURRENTOWNER):
816 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
817 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
818 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_CURRENTOWNER):
819 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
820 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
821 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_CURRENTOWNER):
822 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
823 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
824 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_CURRENTOWNER):
825 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
826 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
827 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_CURRENTOWNER):
828 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
829 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
830 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_CURRENTOWNER):
831 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
832 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
833 		return true;
834 	default:
835 		return false;
836 	}
837 }
838 
839 static int find_sdca_control_range(struct device *dev,
840 				   struct fwnode_handle *control_node,
841 				   struct sdca_control_range *range)
842 {
843 	u8 *range_list;
844 	int num_range;
845 	u16 *limits;
846 	int i;
847 
848 	num_range = fwnode_property_count_u8(control_node, "mipi-sdca-control-range");
849 	if (!num_range || num_range == -EINVAL)
850 		return 0;
851 	else if (num_range < 0)
852 		return num_range;
853 
854 	range_list = devm_kcalloc(dev, num_range, sizeof(*range_list), GFP_KERNEL);
855 	if (!range_list)
856 		return -ENOMEM;
857 
858 	fwnode_property_read_u8_array(control_node, "mipi-sdca-control-range",
859 				      range_list, num_range);
860 
861 	limits = (u16 *)range_list;
862 
863 	range->cols = le16_to_cpu(limits[0]);
864 	range->rows = le16_to_cpu(limits[1]);
865 	range->data = (u32 *)&limits[2];
866 
867 	num_range = (num_range - (2 * sizeof(*limits))) / sizeof(*range->data);
868 	if (num_range != range->cols * range->rows)
869 		return -EINVAL;
870 
871 	for (i = 0; i < num_range; i++)
872 		range->data[i] = le32_to_cpu(range->data[i]);
873 
874 	return 0;
875 }
876 
877 static int find_sdca_control_value(struct device *dev, struct sdca_entity *entity,
878 				   struct fwnode_handle *control_node,
879 				   struct sdca_control *control,
880 				   const char * const label)
881 {
882 	char property[SDCA_PROPERTY_LENGTH];
883 	bool global = true;
884 	int ret, cn, i;
885 	u32 tmp;
886 
887 	snprintf(property, sizeof(property), "mipi-sdca-control-%s", label);
888 
889 	ret = fwnode_property_read_u32(control_node, property, &tmp);
890 	if (ret == -EINVAL)
891 		global = false;
892 	else if (ret)
893 		return ret;
894 
895 	i = 0;
896 	for_each_set_bit(cn, (unsigned long *)&control->cn_list,
897 			 BITS_PER_TYPE(control->cn_list)) {
898 		if (!global) {
899 			snprintf(property, sizeof(property),
900 				 "mipi-sdca-control-cn-%d-%s", cn, label);
901 
902 			ret = fwnode_property_read_u32(control_node, property, &tmp);
903 			if (ret)
904 				return ret;
905 		}
906 
907 		control->values[i] = tmp;
908 		i++;
909 	}
910 
911 	return 0;
912 }
913 
914 static int find_sdca_control_reset(const struct sdca_entity *entity,
915 				   struct sdca_control *control)
916 {
917 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
918 	case SDCA_CTL_TYPE_S(FU, AGC):
919 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
920 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
921 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_ENABLE):
922 	case SDCA_CTL_TYPE_S(GE, SELECTED_MODE):
923 	case SDCA_CTL_TYPE_S(TG, TONE_DIVIDER):
924 	case SDCA_CTL_TYPE_S(ENTITY_0, COMMIT_GROUP_MASK):
925 		control->has_reset = true;
926 		control->reset = 0;
927 		break;
928 	case SDCA_CTL_TYPE_S(XU, BYPASS):
929 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
930 	case SDCA_CTL_TYPE_S(FU, MUTE):
931 	case SDCA_CTL_TYPE_S(CX, CLOCK_SELECT):
932 		control->has_reset = true;
933 		control->reset = 1;
934 		break;
935 	case SDCA_CTL_TYPE_S(PDE, REQUESTED_PS):
936 		control->has_reset = true;
937 		control->reset = 3;
938 		break;
939 	default:
940 		break;
941 	}
942 
943 	return 0;
944 }
945 
946 static int find_sdca_entity_control(struct device *dev, struct sdca_entity *entity,
947 				    struct fwnode_handle *control_node,
948 				    struct sdca_control *control)
949 {
950 	u32 tmp;
951 	int ret;
952 
953 	ret = fwnode_property_read_u32(control_node, "mipi-sdca-control-access-mode", &tmp);
954 	if (ret) {
955 		dev_err(dev, "%s: control %#x: access mode missing: %d\n",
956 			entity->label, control->sel, ret);
957 		return ret;
958 	}
959 
960 	control->mode = tmp;
961 
962 	ret = fwnode_property_read_u32(control_node, "mipi-sdca-control-access-layer", &tmp);
963 	if (ret) {
964 		dev_err(dev, "%s: control %#x: access layer missing: %d\n",
965 			entity->label, control->sel, ret);
966 		return ret;
967 	}
968 
969 	control->layers = tmp;
970 
971 	ret = fwnode_property_read_u64(control_node, "mipi-sdca-control-cn-list",
972 				       &control->cn_list);
973 	if (ret == -EINVAL) {
974 		/* Spec allows not specifying cn-list if only the first number is used */
975 		control->cn_list = 0x1;
976 	} else if (ret || !control->cn_list) {
977 		dev_err(dev, "%s: control %#x: cn list missing: %d\n",
978 			entity->label, control->sel, ret);
979 		return ret;
980 	}
981 
982 	control->values = devm_kcalloc(dev, hweight64(control->cn_list),
983 				       sizeof(*control->values), GFP_KERNEL);
984 	if (!control->values)
985 		return -ENOMEM;
986 
987 	switch (control->mode) {
988 	case SDCA_ACCESS_MODE_DC:
989 		ret = find_sdca_control_value(dev, entity, control_node, control,
990 					      "dc-value");
991 		if (ret) {
992 			dev_err(dev, "%s: control %#x: dc value missing: %d\n",
993 				entity->label, control->sel, ret);
994 			return ret;
995 		}
996 
997 		control->has_fixed = true;
998 		break;
999 	case SDCA_ACCESS_MODE_RW:
1000 	case SDCA_ACCESS_MODE_DUAL:
1001 		ret = find_sdca_control_value(dev, entity, control_node, control,
1002 					      "default-value");
1003 		if (!ret)
1004 			control->has_default = true;
1005 
1006 		ret = find_sdca_control_value(dev, entity, control_node, control,
1007 					      "fixed-value");
1008 		if (!ret)
1009 			control->has_fixed = true;
1010 		fallthrough;
1011 	case SDCA_ACCESS_MODE_RO:
1012 		control->deferrable = fwnode_property_read_bool(control_node,
1013 								"mipi-sdca-control-deferrable");
1014 		break;
1015 	default:
1016 		break;
1017 	}
1018 
1019 	control->is_volatile = find_sdca_control_volatile(entity, control);
1020 
1021 	ret = find_sdca_control_reset(entity, control);
1022 	if (ret)
1023 		return ret;
1024 
1025 	ret = find_sdca_control_range(dev, control_node, &control->range);
1026 	if (ret) {
1027 		dev_err(dev, "%s: control %#x: range missing: %d\n",
1028 			entity->label, control->sel, ret);
1029 		return ret;
1030 	}
1031 
1032 	ret = fwnode_property_read_u32(control_node,
1033 				       "mipi-sdca-control-interrupt-position",
1034 				       &tmp);
1035 	if (!ret)
1036 		control->interrupt_position = tmp;
1037 	else
1038 		control->interrupt_position = SDCA_NO_INTERRUPT;
1039 
1040 	control->label = find_sdca_control_label(dev, entity, control);
1041 	if (!control->label)
1042 		return -ENOMEM;
1043 
1044 	control->type = find_sdca_control_datatype(entity, control);
1045 	control->nbits = find_sdca_control_bits(entity, control);
1046 
1047 	dev_dbg(dev, "%s: %s: control %#x mode %#x layers %#x cn %#llx int %d %s\n",
1048 		entity->label, control->label, control->sel,
1049 		control->mode, control->layers, control->cn_list,
1050 		control->interrupt_position, control->deferrable ? "deferrable" : "");
1051 
1052 	return 0;
1053 }
1054 
1055 static int find_sdca_entity_controls(struct device *dev,
1056 				     struct fwnode_handle *entity_node,
1057 				     struct sdca_entity *entity)
1058 {
1059 	struct sdca_control *controls;
1060 	int num_controls;
1061 	u64 control_list;
1062 	int control_sel;
1063 	int i, ret;
1064 
1065 	ret = fwnode_property_read_u64(entity_node, "mipi-sdca-control-list", &control_list);
1066 	if (ret == -EINVAL) {
1067 		/* Allow missing control lists, assume no controls. */
1068 		dev_warn(dev, "%s: missing control list\n", entity->label);
1069 		return 0;
1070 	} else if (ret) {
1071 		dev_err(dev, "%s: failed to read control list: %d\n", entity->label, ret);
1072 		return ret;
1073 	} else if (!control_list) {
1074 		return 0;
1075 	}
1076 
1077 	num_controls = hweight64(control_list);
1078 	controls = devm_kcalloc(dev, num_controls, sizeof(*controls), GFP_KERNEL);
1079 	if (!controls)
1080 		return -ENOMEM;
1081 
1082 	i = 0;
1083 	for_each_set_bit(control_sel, (unsigned long *)&control_list,
1084 			 BITS_PER_TYPE(control_list)) {
1085 		struct fwnode_handle *control_node;
1086 		char control_property[SDCA_PROPERTY_LENGTH];
1087 
1088 		/* DisCo uses upper-case for hex numbers */
1089 		snprintf(control_property, sizeof(control_property),
1090 			 "mipi-sdca-control-0x%X-subproperties", control_sel);
1091 
1092 		control_node = fwnode_get_named_child_node(entity_node, control_property);
1093 		if (!control_node) {
1094 			dev_err(dev, "%s: control node %s not found\n",
1095 				entity->label, control_property);
1096 			return -EINVAL;
1097 		}
1098 
1099 		controls[i].sel = control_sel;
1100 
1101 		ret = find_sdca_entity_control(dev, entity, control_node, &controls[i]);
1102 		fwnode_handle_put(control_node);
1103 		if (ret)
1104 			return ret;
1105 
1106 		i++;
1107 	}
1108 
1109 	entity->num_controls = num_controls;
1110 	entity->controls = controls;
1111 
1112 	return 0;
1113 }
1114 
1115 static bool find_sdca_iot_dataport(struct sdca_entity_iot *terminal)
1116 {
1117 	switch (terminal->type) {
1118 	case SDCA_TERM_TYPE_GENERIC:
1119 	case SDCA_TERM_TYPE_ULTRASOUND:
1120 	case SDCA_TERM_TYPE_CAPTURE_DIRECT_PCM_MIC:
1121 	case SDCA_TERM_TYPE_RAW_PDM_MIC:
1122 	case SDCA_TERM_TYPE_SPEECH:
1123 	case SDCA_TERM_TYPE_VOICE:
1124 	case SDCA_TERM_TYPE_SECONDARY_PCM_MIC:
1125 	case SDCA_TERM_TYPE_ACOUSTIC_CONTEXT_AWARENESS:
1126 	case SDCA_TERM_TYPE_DTOD_STREAM:
1127 	case SDCA_TERM_TYPE_REFERENCE_STREAM:
1128 	case SDCA_TERM_TYPE_SENSE_CAPTURE:
1129 	case SDCA_TERM_TYPE_STREAMING_MIC:
1130 	case SDCA_TERM_TYPE_OPTIMIZATION_STREAM:
1131 	case SDCA_TERM_TYPE_PDM_RENDER_STREAM:
1132 	case SDCA_TERM_TYPE_COMPANION_DATA:
1133 		return true;
1134 	default:
1135 		return false;
1136 	}
1137 }
1138 
1139 static int find_sdca_entity_iot(struct device *dev,
1140 				struct fwnode_handle *entity_node,
1141 				struct sdca_entity *entity)
1142 {
1143 	struct sdca_entity_iot *terminal = &entity->iot;
1144 	u32 tmp;
1145 	int ret;
1146 
1147 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-terminal-type", &tmp);
1148 	if (ret) {
1149 		dev_err(dev, "%s: terminal type missing: %d\n", entity->label, ret);
1150 		return ret;
1151 	}
1152 
1153 	terminal->type = tmp;
1154 	terminal->is_dataport = find_sdca_iot_dataport(terminal);
1155 
1156 	if (!terminal->is_dataport) {
1157 		const char *type_name = sdca_find_terminal_name(terminal->type);
1158 
1159 		if (type_name)
1160 			entity->label = devm_kasprintf(dev, GFP_KERNEL, "%s %s",
1161 						       entity->label, type_name);
1162 	}
1163 
1164 	ret = fwnode_property_read_u32(entity_node,
1165 				       "mipi-sdca-terminal-reference-number", &tmp);
1166 	if (!ret)
1167 		terminal->reference = tmp;
1168 
1169 	ret = fwnode_property_read_u32(entity_node,
1170 				       "mipi-sdca-terminal-connector-type", &tmp);
1171 	if (!ret)
1172 		terminal->connector = tmp;
1173 
1174 	ret = fwnode_property_read_u32(entity_node,
1175 				       "mipi-sdca-terminal-transducer-count", &tmp);
1176 	if (!ret)
1177 		terminal->num_transducer = tmp;
1178 
1179 	dev_dbg(dev, "%s: terminal type %#x ref %#x conn %#x count %d\n",
1180 		entity->label, terminal->type, terminal->reference,
1181 		terminal->connector, terminal->num_transducer);
1182 
1183 	return 0;
1184 }
1185 
1186 static int find_sdca_entity_cs(struct device *dev,
1187 			       struct fwnode_handle *entity_node,
1188 			       struct sdca_entity *entity)
1189 {
1190 	struct sdca_entity_cs *clock = &entity->cs;
1191 	u32 tmp;
1192 	int ret;
1193 
1194 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-cs-type", &tmp);
1195 	if (ret) {
1196 		dev_err(dev, "%s: clock type missing: %d\n", entity->label, ret);
1197 		return ret;
1198 	}
1199 
1200 	clock->type = tmp;
1201 
1202 	ret = fwnode_property_read_u32(entity_node,
1203 				       "mipi-sdca-clock-valid-max-delay", &tmp);
1204 	if (!ret)
1205 		clock->max_delay = tmp;
1206 
1207 	dev_dbg(dev, "%s: clock type %#x delay %d\n", entity->label,
1208 		clock->type, clock->max_delay);
1209 
1210 	return 0;
1211 }
1212 
1213 static int find_sdca_entity_pde(struct device *dev,
1214 				struct fwnode_handle *entity_node,
1215 				struct sdca_entity *entity)
1216 {
1217 	static const int mult_delay = 3;
1218 	struct sdca_entity_pde *power = &entity->pde;
1219 	struct sdca_pde_delay *delays;
1220 	int num_delays;
1221 	int i, j;
1222 
1223 	num_delays = fwnode_property_count_u32(entity_node,
1224 					       "mipi-sdca-powerdomain-transition-max-delay");
1225 	if (num_delays <= 0) {
1226 		dev_err(dev, "%s: max delay list missing: %d\n",
1227 			entity->label, num_delays);
1228 		return -EINVAL;
1229 	} else if (num_delays % mult_delay != 0) {
1230 		dev_err(dev, "%s: delays not multiple of %d\n",
1231 			entity->label, mult_delay);
1232 		return -EINVAL;
1233 	} else if (num_delays > SDCA_MAX_DELAY_COUNT) {
1234 		dev_err(dev, "%s: maximum number of transition delays exceeded\n",
1235 			entity->label);
1236 		return -EINVAL;
1237 	}
1238 
1239 	u32 *delay_list __free(kfree) = kcalloc(num_delays, sizeof(*delay_list),
1240 						GFP_KERNEL);
1241 	if (!delay_list)
1242 		return -ENOMEM;
1243 
1244 	fwnode_property_read_u32_array(entity_node,
1245 				       "mipi-sdca-powerdomain-transition-max-delay",
1246 				       delay_list, num_delays);
1247 
1248 	num_delays /= mult_delay;
1249 
1250 	delays = devm_kcalloc(dev, num_delays, sizeof(*delays), GFP_KERNEL);
1251 	if (!delays)
1252 		return -ENOMEM;
1253 
1254 	for (i = 0, j = 0; i < num_delays; i++) {
1255 		delays[i].from_ps = delay_list[j++];
1256 		delays[i].to_ps = delay_list[j++];
1257 		delays[i].us = delay_list[j++];
1258 
1259 		dev_dbg(dev, "%s: from %#x to %#x delay %dus\n", entity->label,
1260 			delays[i].from_ps, delays[i].to_ps, delays[i].us);
1261 	}
1262 
1263 	power->num_max_delay = num_delays;
1264 	power->max_delay = delays;
1265 
1266 	return 0;
1267 }
1268 
1269 struct raw_ge_mode {
1270 	u8 val;
1271 	u8 num_controls;
1272 	struct {
1273 		u8 id;
1274 		u8 sel;
1275 		u8 cn;
1276 		__le32 val;
1277 	} __packed controls[] __counted_by(num_controls);
1278 } __packed;
1279 
1280 static int find_sdca_entity_ge(struct device *dev,
1281 			       struct fwnode_handle *entity_node,
1282 			       struct sdca_entity *entity)
1283 {
1284 	struct sdca_entity_ge *group = &entity->ge;
1285 	u8 *affected_iter;
1286 	int num_affected;
1287 	int i, j;
1288 
1289 	num_affected = fwnode_property_count_u8(entity_node,
1290 						"mipi-sdca-ge-selectedmode-controls-affected");
1291 	if (!num_affected) {
1292 		return 0;
1293 	} else if (num_affected < 0) {
1294 		dev_err(dev, "%s: failed to read affected controls: %d\n",
1295 			entity->label, num_affected);
1296 		return num_affected;
1297 	} else if (num_affected > SDCA_MAX_AFFECTED_COUNT) {
1298 		dev_err(dev, "%s: maximum affected controls size exceeded\n",
1299 			entity->label);
1300 		return -EINVAL;
1301 	}
1302 
1303 	u8 *affected_list __free(kfree) = kcalloc(num_affected, sizeof(*affected_list),
1304 						  GFP_KERNEL);
1305 	if (!affected_list)
1306 		return -ENOMEM;
1307 
1308 	fwnode_property_read_u8_array(entity_node,
1309 				      "mipi-sdca-ge-selectedmode-controls-affected",
1310 				      affected_list, num_affected);
1311 
1312 	group->num_modes = *affected_list;
1313 	affected_iter = affected_list + 1;
1314 
1315 	group->modes = devm_kcalloc(dev, group->num_modes, sizeof(*group->modes),
1316 				    GFP_KERNEL);
1317 	if (!group->modes)
1318 		return -ENOMEM;
1319 
1320 	for (i = 0; i < group->num_modes; i++) {
1321 		struct raw_ge_mode *raw = (struct raw_ge_mode *)affected_iter;
1322 		struct sdca_ge_mode *mode = &group->modes[i];
1323 
1324 		affected_iter += sizeof(*raw);
1325 		if (affected_iter > affected_list + num_affected)
1326 			goto bad_list;
1327 
1328 		mode->val = raw->val;
1329 		mode->num_controls = raw->num_controls;
1330 
1331 		affected_iter += mode->num_controls * sizeof(raw->controls[0]);
1332 		if (affected_iter > affected_list + num_affected)
1333 			goto bad_list;
1334 
1335 		mode->controls = devm_kcalloc(dev, mode->num_controls,
1336 					      sizeof(*mode->controls), GFP_KERNEL);
1337 		if (!mode->controls)
1338 			return -ENOMEM;
1339 
1340 		for (j = 0; j < mode->num_controls; j++) {
1341 			mode->controls[j].id = raw->controls[j].id;
1342 			mode->controls[j].sel = raw->controls[j].sel;
1343 			mode->controls[j].cn = raw->controls[j].cn;
1344 			mode->controls[j].val = le32_to_cpu(raw->controls[j].val);
1345 		}
1346 	}
1347 
1348 	return 0;
1349 
1350 bad_list:
1351 	dev_err(dev, "%s: malformed affected controls list\n", entity->label);
1352 	return -EINVAL;
1353 }
1354 
1355 static int
1356 find_sdca_entity_hide(struct device *dev, struct sdw_slave *sdw,
1357 		      struct fwnode_handle *function_node,
1358 		      struct fwnode_handle *entity_node, struct sdca_entity *entity)
1359 {
1360 	struct sdca_entity_hide *hide = &entity->hide;
1361 	unsigned int delay, *af_list = hide->af_number_list;
1362 	int nval, ret;
1363 	unsigned char *report_desc = NULL;
1364 
1365 	ret = fwnode_property_read_u32(entity_node,
1366 				       "mipi-sdca-RxUMP-ownership-transition-max-delay", &delay);
1367 	if (!ret)
1368 		hide->max_delay = delay;
1369 
1370 	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-HIDTx-supported-report-ids");
1371 	if (nval > 0) {
1372 		hide->num_hidtx_ids = nval;
1373 		hide->hidtx_ids = devm_kcalloc(dev, hide->num_hidtx_ids,
1374 					       sizeof(*hide->hidtx_ids), GFP_KERNEL);
1375 		if (!hide->hidtx_ids)
1376 			return -ENOMEM;
1377 
1378 		ret = fwnode_property_read_u32_array(entity_node,
1379 						     "mipi-sdca-HIDTx-supported-report-ids",
1380 						     hide->hidtx_ids,
1381 						     hide->num_hidtx_ids);
1382 		if (ret < 0)
1383 			return ret;
1384 	}
1385 
1386 	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-HIDRx-supported-report-ids");
1387 	if (nval > 0) {
1388 		hide->num_hidrx_ids = nval;
1389 		hide->hidrx_ids = devm_kcalloc(dev, hide->num_hidrx_ids,
1390 					       sizeof(*hide->hidrx_ids), GFP_KERNEL);
1391 		if (!hide->hidrx_ids)
1392 			return -ENOMEM;
1393 
1394 		ret = fwnode_property_read_u32_array(entity_node,
1395 						     "mipi-sdca-HIDRx-supported-report-ids",
1396 						     hide->hidrx_ids,
1397 						     hide->num_hidrx_ids);
1398 		if (ret < 0)
1399 			return ret;
1400 	}
1401 
1402 	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-hide-related-audio-function-list");
1403 	if (nval <= 0) {
1404 		dev_err(dev, "%pfwP: audio function numbers list missing: %d\n",
1405 			entity_node, nval);
1406 		return -EINVAL;
1407 	} else if (nval > SDCA_MAX_FUNCTION_COUNT) {
1408 		dev_err(dev, "%pfwP: maximum number of audio function exceeded\n", entity_node);
1409 		return -EINVAL;
1410 	}
1411 
1412 	hide->hide_reside_function_num = nval;
1413 	fwnode_property_read_u32_array(entity_node,
1414 				       "mipi-sdca-hide-related-audio-function-list", af_list, nval);
1415 
1416 	nval = fwnode_property_count_u8(function_node, "mipi-sdca-hid-descriptor");
1417 	if (nval)
1418 		fwnode_property_read_u8_array(function_node, "mipi-sdca-hid-descriptor",
1419 					      (u8 *)&hide->hid_desc, nval);
1420 
1421 	if (hide->hid_desc.bNumDescriptors) {
1422 		nval = fwnode_property_count_u8(function_node, "mipi-sdca-report-descriptor");
1423 		if (nval) {
1424 			report_desc = devm_kzalloc(dev, nval, GFP_KERNEL);
1425 			if (!report_desc)
1426 				return -ENOMEM;
1427 			hide->hid_report_desc = report_desc;
1428 			fwnode_property_read_u8_array(function_node, "mipi-sdca-report-descriptor",
1429 						      report_desc, nval);
1430 
1431 			/* add HID device */
1432 			ret = sdca_add_hid_device(dev, sdw, entity);
1433 			if (ret) {
1434 				dev_err(dev, "%pfwP: failed to add HID device: %d\n", entity_node, ret);
1435 				return ret;
1436 			}
1437 		}
1438 	}
1439 
1440 	return 0;
1441 }
1442 
1443 static int find_sdca_entity_xu(struct device *dev,
1444 			       struct fwnode_handle *entity_node,
1445 			       struct sdca_entity *entity)
1446 {
1447 	struct sdca_entity_xu *xu = &entity->xu;
1448 	u32 tmp;
1449 	int ret;
1450 
1451 	ret = fwnode_property_read_u32(entity_node,
1452 				       "mipi-sdca-RxUMP-ownership-transition-max-delay",
1453 				       &tmp);
1454 	if (!ret)
1455 		xu->max_delay = tmp;
1456 
1457 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-FDL-reset-mechanism",
1458 				       &tmp);
1459 	if (!ret)
1460 		xu->reset_mechanism = tmp;
1461 
1462 	return 0;
1463 }
1464 
1465 static int find_sdca_entity(struct device *dev, struct sdw_slave *sdw,
1466 			    struct fwnode_handle *function_node,
1467 			    struct fwnode_handle *entity_node,
1468 			    struct sdca_entity *entity)
1469 {
1470 	u32 tmp;
1471 	int ret;
1472 
1473 	ret = fwnode_property_read_string(entity_node, "mipi-sdca-entity-label",
1474 					  &entity->label);
1475 	if (ret) {
1476 		dev_err(dev, "%pfwP: entity %#x: label missing: %d\n",
1477 			function_node, entity->id, ret);
1478 		return ret;
1479 	}
1480 
1481 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-entity-type", &tmp);
1482 	if (ret) {
1483 		dev_err(dev, "%s: type missing: %d\n", entity->label, ret);
1484 		return ret;
1485 	}
1486 
1487 	entity->type = tmp;
1488 
1489 	dev_dbg(dev, "%s: entity %#x type %#x\n",
1490 		entity->label, entity->id, entity->type);
1491 
1492 	switch (entity->type) {
1493 	case SDCA_ENTITY_TYPE_IT:
1494 	case SDCA_ENTITY_TYPE_OT:
1495 		ret = find_sdca_entity_iot(dev, entity_node, entity);
1496 		break;
1497 	case SDCA_ENTITY_TYPE_XU:
1498 		ret = find_sdca_entity_xu(dev, entity_node, entity);
1499 		break;
1500 	case SDCA_ENTITY_TYPE_CS:
1501 		ret = find_sdca_entity_cs(dev, entity_node, entity);
1502 		break;
1503 	case SDCA_ENTITY_TYPE_PDE:
1504 		ret = find_sdca_entity_pde(dev, entity_node, entity);
1505 		break;
1506 	case SDCA_ENTITY_TYPE_GE:
1507 		ret = find_sdca_entity_ge(dev, entity_node, entity);
1508 		break;
1509 	case SDCA_ENTITY_TYPE_HIDE:
1510 		ret = find_sdca_entity_hide(dev, sdw, function_node,
1511 					    entity_node, entity);
1512 		break;
1513 	default:
1514 		break;
1515 	}
1516 	if (ret)
1517 		return ret;
1518 
1519 	ret = find_sdca_entity_controls(dev, entity_node, entity);
1520 	if (ret)
1521 		return ret;
1522 
1523 	return 0;
1524 }
1525 
1526 static int find_sdca_entities(struct device *dev, struct sdw_slave *sdw,
1527 			      struct fwnode_handle *function_node,
1528 			      struct sdca_function_data *function)
1529 {
1530 	struct sdca_entity *entities;
1531 	int num_entities;
1532 	int i, ret;
1533 
1534 	num_entities = fwnode_property_count_u32(function_node,
1535 						 "mipi-sdca-entity-id-list");
1536 	if (num_entities <= 0) {
1537 		dev_err(dev, "%pfwP: entity id list missing: %d\n",
1538 			function_node, num_entities);
1539 		return -EINVAL;
1540 	} else if (num_entities > SDCA_MAX_ENTITY_COUNT) {
1541 		dev_err(dev, "%pfwP: maximum number of entities exceeded\n",
1542 			function_node);
1543 		return -EINVAL;
1544 	}
1545 
1546 	/* Add 1 to make space for Entity 0 */
1547 	entities = devm_kcalloc(dev, num_entities + 1, sizeof(*entities), GFP_KERNEL);
1548 	if (!entities)
1549 		return -ENOMEM;
1550 
1551 	u32 *entity_list __free(kfree) = kcalloc(num_entities, sizeof(*entity_list),
1552 						 GFP_KERNEL);
1553 	if (!entity_list)
1554 		return -ENOMEM;
1555 
1556 	fwnode_property_read_u32_array(function_node, "mipi-sdca-entity-id-list",
1557 				       entity_list, num_entities);
1558 
1559 	for (i = 0; i < num_entities; i++)
1560 		entities[i].id = entity_list[i];
1561 
1562 	/* now read subproperties */
1563 	for (i = 0; i < num_entities; i++) {
1564 		char entity_property[SDCA_PROPERTY_LENGTH];
1565 		struct fwnode_handle *entity_node;
1566 
1567 		/* DisCo uses upper-case for hex numbers */
1568 		snprintf(entity_property, sizeof(entity_property),
1569 			 "mipi-sdca-entity-id-0x%X-subproperties", entities[i].id);
1570 
1571 		entity_node = fwnode_get_named_child_node(function_node, entity_property);
1572 		if (!entity_node) {
1573 			dev_err(dev, "%pfwP: entity node %s not found\n",
1574 				function_node, entity_property);
1575 			return -EINVAL;
1576 		}
1577 
1578 		ret = find_sdca_entity(dev, sdw, function_node,
1579 				       entity_node, &entities[i]);
1580 		fwnode_handle_put(entity_node);
1581 		if (ret)
1582 			return ret;
1583 	}
1584 
1585 	/*
1586 	 * Add Entity 0 at end of the array, makes it easy to skip during
1587 	 * all the Entity searches involved in creating connections.
1588 	 */
1589 	entities[num_entities].label = "entity0";
1590 
1591 	ret = find_sdca_entity_controls(dev, function_node, &entities[num_entities]);
1592 	if (ret)
1593 		return ret;
1594 
1595 	function->num_entities = num_entities + 1;
1596 	function->entities = entities;
1597 
1598 	return 0;
1599 }
1600 
1601 static struct sdca_entity *find_sdca_entity_by_label(struct sdca_function_data *function,
1602 						     const char *entity_label)
1603 {
1604 	int i;
1605 
1606 	for (i = 0; i < function->num_entities; i++) {
1607 		struct sdca_entity *entity = &function->entities[i];
1608 
1609 		if (!strncmp(entity->label, entity_label, strlen(entity_label)))
1610 			return entity;
1611 	}
1612 
1613 	return NULL;
1614 }
1615 
1616 static struct sdca_entity *find_sdca_entity_by_id(struct sdca_function_data *function,
1617 						  const int id)
1618 {
1619 	int i;
1620 
1621 	for (i = 0; i < function->num_entities; i++) {
1622 		struct sdca_entity *entity = &function->entities[i];
1623 
1624 		if (entity->id == id)
1625 			return entity;
1626 	}
1627 
1628 	return NULL;
1629 }
1630 
1631 static int find_sdca_entity_connection_iot(struct device *dev,
1632 					   struct sdca_function_data *function,
1633 					   struct fwnode_handle *entity_node,
1634 					   struct sdca_entity *entity)
1635 {
1636 	struct sdca_entity_iot *terminal = &entity->iot;
1637 	struct fwnode_handle *clock_node;
1638 	struct sdca_entity *clock_entity;
1639 	const char *clock_label;
1640 	int ret;
1641 
1642 	clock_node = fwnode_get_named_child_node(entity_node,
1643 						 "mipi-sdca-terminal-clock-connection");
1644 	if (!clock_node)
1645 		return 0;
1646 
1647 	ret = fwnode_property_read_string(clock_node, "mipi-sdca-entity-label",
1648 					  &clock_label);
1649 	if (ret) {
1650 		dev_err(dev, "%s: clock label missing: %d\n", entity->label, ret);
1651 		fwnode_handle_put(clock_node);
1652 		return ret;
1653 	}
1654 
1655 	clock_entity = find_sdca_entity_by_label(function, clock_label);
1656 	if (!clock_entity) {
1657 		dev_err(dev, "%s: failed to find clock with label %s\n",
1658 			entity->label, clock_label);
1659 		fwnode_handle_put(clock_node);
1660 		return -EINVAL;
1661 	}
1662 
1663 	terminal->clock = clock_entity;
1664 
1665 	dev_dbg(dev, "%s -> %s\n", clock_entity->label, entity->label);
1666 
1667 	fwnode_handle_put(clock_node);
1668 	return 0;
1669 }
1670 
1671 static int find_sdca_entity_connection_pde(struct device *dev,
1672 					   struct sdca_function_data *function,
1673 					   struct fwnode_handle *entity_node,
1674 					   struct sdca_entity *entity)
1675 {
1676 	struct sdca_entity_pde *power = &entity->pde;
1677 	struct sdca_entity **managed;
1678 	int num_managed;
1679 	int i;
1680 
1681 	num_managed = fwnode_property_count_u32(entity_node,
1682 						"mipi-sdca-powerdomain-managed-list");
1683 	if (!num_managed) {
1684 		return 0;
1685 	} else if (num_managed < 0) {
1686 		dev_err(dev, "%s: managed list missing: %d\n", entity->label, num_managed);
1687 		return num_managed;
1688 	} else if (num_managed > SDCA_MAX_ENTITY_COUNT) {
1689 		dev_err(dev, "%s: maximum number of managed entities exceeded\n",
1690 			entity->label);
1691 		return -EINVAL;
1692 	}
1693 
1694 	managed = devm_kcalloc(dev, num_managed, sizeof(*managed), GFP_KERNEL);
1695 	if (!managed)
1696 		return -ENOMEM;
1697 
1698 	u32 *managed_list __free(kfree) = kcalloc(num_managed, sizeof(*managed_list),
1699 						  GFP_KERNEL);
1700 	if (!managed_list)
1701 		return -ENOMEM;
1702 
1703 	fwnode_property_read_u32_array(entity_node,
1704 				       "mipi-sdca-powerdomain-managed-list",
1705 				       managed_list, num_managed);
1706 
1707 	for (i = 0; i < num_managed; i++) {
1708 		managed[i] = find_sdca_entity_by_id(function, managed_list[i]);
1709 		if (!managed[i]) {
1710 			dev_err(dev, "%s: failed to find entity with id %#x\n",
1711 				entity->label, managed_list[i]);
1712 			return -EINVAL;
1713 		}
1714 
1715 		dev_dbg(dev, "%s -> %s\n", managed[i]->label, entity->label);
1716 	}
1717 
1718 	power->num_managed = num_managed;
1719 	power->managed = managed;
1720 
1721 	return 0;
1722 }
1723 
1724 static int find_sdca_entity_connection_ge(struct device *dev,
1725 					  struct sdca_function_data *function,
1726 					  struct fwnode_handle *entity_node,
1727 					  struct sdca_entity *entity)
1728 {
1729 	int i, j;
1730 
1731 	for (i = 0; i < entity->ge.num_modes; i++) {
1732 		struct sdca_ge_mode *mode = &entity->ge.modes[i];
1733 
1734 		for (j = 0; j < mode->num_controls; j++) {
1735 			struct sdca_ge_control *affected = &mode->controls[j];
1736 			struct sdca_entity *managed;
1737 
1738 			managed = find_sdca_entity_by_id(function, affected->id);
1739 			if (!managed) {
1740 				dev_err(dev, "%s: failed to find entity with id %#x\n",
1741 					entity->label, affected->id);
1742 				return -EINVAL;
1743 			}
1744 
1745 			if (managed->group && managed->group != entity) {
1746 				dev_err(dev,
1747 					"%s: entity controlled by two groups %s, %s\n",
1748 					managed->label, managed->group->label,
1749 					entity->label);
1750 				return -EINVAL;
1751 			}
1752 
1753 			managed->group = entity;
1754 		}
1755 	}
1756 
1757 	return 0;
1758 }
1759 
1760 static int find_sdca_entity_connection(struct device *dev,
1761 				       struct sdca_function_data *function,
1762 				       struct fwnode_handle *entity_node,
1763 				       struct sdca_entity *entity)
1764 {
1765 	struct sdca_entity **pins;
1766 	int num_pins, pin;
1767 	u64 pin_list;
1768 	int i, ret;
1769 
1770 	switch (entity->type) {
1771 	case SDCA_ENTITY_TYPE_IT:
1772 	case SDCA_ENTITY_TYPE_OT:
1773 		ret = find_sdca_entity_connection_iot(dev, function,
1774 						      entity_node, entity);
1775 		break;
1776 	case SDCA_ENTITY_TYPE_PDE:
1777 		ret = find_sdca_entity_connection_pde(dev, function,
1778 						      entity_node, entity);
1779 		break;
1780 	case SDCA_ENTITY_TYPE_GE:
1781 		ret = find_sdca_entity_connection_ge(dev, function,
1782 						     entity_node, entity);
1783 		break;
1784 	default:
1785 		ret = 0;
1786 		break;
1787 	}
1788 	if (ret)
1789 		return ret;
1790 
1791 	ret = fwnode_property_read_u64(entity_node, "mipi-sdca-input-pin-list", &pin_list);
1792 	if (ret == -EINVAL) {
1793 		/* Allow missing pin lists, assume no pins. */
1794 		return 0;
1795 	} else if (ret) {
1796 		dev_err(dev, "%s: failed to read pin list: %d\n", entity->label, ret);
1797 		return ret;
1798 	} else if (pin_list & BIT(0)) {
1799 		/*
1800 		 * Each bit set in the pin-list refers to an entity_id in this
1801 		 * Function. Entity 0 is an illegal connection since it is used
1802 		 * for Function-level configurations.
1803 		 */
1804 		dev_err(dev, "%s: pin 0 used as input\n", entity->label);
1805 		return -EINVAL;
1806 	} else if (!pin_list) {
1807 		return 0;
1808 	}
1809 
1810 	num_pins = hweight64(pin_list);
1811 	pins = devm_kcalloc(dev, num_pins, sizeof(*pins), GFP_KERNEL);
1812 	if (!pins)
1813 		return -ENOMEM;
1814 
1815 	i = 0;
1816 	for_each_set_bit(pin, (unsigned long *)&pin_list, BITS_PER_TYPE(pin_list)) {
1817 		char pin_property[SDCA_PROPERTY_LENGTH];
1818 		struct fwnode_handle *connected_node;
1819 		struct sdca_entity *connected_entity;
1820 		const char *connected_label;
1821 
1822 		snprintf(pin_property, sizeof(pin_property), "mipi-sdca-input-pin-%d", pin);
1823 
1824 		connected_node = fwnode_get_named_child_node(entity_node, pin_property);
1825 		if (!connected_node) {
1826 			dev_err(dev, "%s: pin node %s not found\n",
1827 				entity->label, pin_property);
1828 			return -EINVAL;
1829 		}
1830 
1831 		ret = fwnode_property_read_string(connected_node, "mipi-sdca-entity-label",
1832 						  &connected_label);
1833 		if (ret) {
1834 			dev_err(dev, "%s: pin %d label missing: %d\n",
1835 				entity->label, pin, ret);
1836 			fwnode_handle_put(connected_node);
1837 			return ret;
1838 		}
1839 
1840 		connected_entity = find_sdca_entity_by_label(function, connected_label);
1841 		if (!connected_entity) {
1842 			dev_err(dev, "%s: failed to find entity with label %s\n",
1843 				entity->label, connected_label);
1844 			fwnode_handle_put(connected_node);
1845 			return -EINVAL;
1846 		}
1847 
1848 		pins[i] = connected_entity;
1849 
1850 		dev_dbg(dev, "%s -> %s\n", connected_entity->label, entity->label);
1851 
1852 		i++;
1853 		fwnode_handle_put(connected_node);
1854 	}
1855 
1856 	entity->num_sources = num_pins;
1857 	entity->sources = pins;
1858 
1859 	return 0;
1860 }
1861 
1862 static int find_sdca_connections(struct device *dev,
1863 				 struct fwnode_handle *function_node,
1864 				 struct sdca_function_data *function)
1865 {
1866 	int i;
1867 
1868 	/* Entity 0 cannot have connections */
1869 	for (i = 0; i < function->num_entities - 1; i++) {
1870 		struct sdca_entity *entity = &function->entities[i];
1871 		char entity_property[SDCA_PROPERTY_LENGTH];
1872 		struct fwnode_handle *entity_node;
1873 		int ret;
1874 
1875 		/* DisCo uses upper-case for hex numbers */
1876 		snprintf(entity_property, sizeof(entity_property),
1877 			 "mipi-sdca-entity-id-0x%X-subproperties",
1878 			 entity->id);
1879 
1880 		entity_node = fwnode_get_named_child_node(function_node, entity_property);
1881 		if (!entity_node) {
1882 			dev_err(dev, "%pfwP: entity node %s not found\n",
1883 				function_node, entity_property);
1884 			return -EINVAL;
1885 		}
1886 
1887 		ret = find_sdca_entity_connection(dev, function, entity_node, entity);
1888 		fwnode_handle_put(entity_node);
1889 		if (ret)
1890 			return ret;
1891 	}
1892 
1893 	return 0;
1894 }
1895 
1896 static int find_sdca_cluster_channel(struct device *dev,
1897 				     struct sdca_cluster *cluster,
1898 				     struct fwnode_handle *channel_node,
1899 				     struct sdca_channel *channel)
1900 {
1901 	u32 tmp;
1902 	int ret;
1903 
1904 	ret = fwnode_property_read_u32(channel_node, "mipi-sdca-cluster-channel-id", &tmp);
1905 	if (ret) {
1906 		dev_err(dev, "cluster %#x: missing channel id: %d\n",
1907 			cluster->id, ret);
1908 		return ret;
1909 	}
1910 
1911 	channel->id = tmp;
1912 
1913 	ret = fwnode_property_read_u32(channel_node,
1914 				       "mipi-sdca-cluster-channel-purpose",
1915 				       &tmp);
1916 	if (ret) {
1917 		dev_err(dev, "cluster %#x: channel %#x: missing purpose: %d\n",
1918 			cluster->id, channel->id, ret);
1919 		return ret;
1920 	}
1921 
1922 	channel->purpose = tmp;
1923 
1924 	ret = fwnode_property_read_u32(channel_node,
1925 				       "mipi-sdca-cluster-channel-relationship",
1926 				       &tmp);
1927 	if (ret) {
1928 		dev_err(dev, "cluster %#x: channel %#x: missing relationship: %d\n",
1929 			cluster->id, channel->id, ret);
1930 		return ret;
1931 	}
1932 
1933 	channel->relationship = tmp;
1934 
1935 	dev_dbg(dev, "cluster %#x: channel id %#x purpose %#x relationship %#x\n",
1936 		cluster->id, channel->id, channel->purpose, channel->relationship);
1937 
1938 	return 0;
1939 }
1940 
1941 static int find_sdca_cluster_channels(struct device *dev,
1942 				      struct fwnode_handle *cluster_node,
1943 				      struct sdca_cluster *cluster)
1944 {
1945 	struct sdca_channel *channels;
1946 	u32 num_channels;
1947 	int i, ret;
1948 
1949 	ret = fwnode_property_read_u32(cluster_node, "mipi-sdca-channel-count",
1950 				       &num_channels);
1951 	if (ret < 0) {
1952 		dev_err(dev, "cluster %#x: failed to read channel list: %d\n",
1953 			cluster->id, ret);
1954 		return ret;
1955 	} else if (num_channels > SDCA_MAX_CHANNEL_COUNT) {
1956 		dev_err(dev, "cluster %#x: maximum number of channels exceeded\n",
1957 			cluster->id);
1958 		return -EINVAL;
1959 	}
1960 
1961 	channels = devm_kcalloc(dev, num_channels, sizeof(*channels), GFP_KERNEL);
1962 	if (!channels)
1963 		return -ENOMEM;
1964 
1965 	for (i = 0; i < num_channels; i++) {
1966 		char channel_property[SDCA_PROPERTY_LENGTH];
1967 		struct fwnode_handle *channel_node;
1968 
1969 		/* DisCo uses upper-case for hex numbers */
1970 		snprintf(channel_property, sizeof(channel_property),
1971 			 "mipi-sdca-channel-%d-subproperties", i + 1);
1972 
1973 		channel_node = fwnode_get_named_child_node(cluster_node, channel_property);
1974 		if (!channel_node) {
1975 			dev_err(dev, "cluster %#x: channel node %s not found\n",
1976 				cluster->id, channel_property);
1977 			return -EINVAL;
1978 		}
1979 
1980 		ret = find_sdca_cluster_channel(dev, cluster, channel_node, &channels[i]);
1981 		fwnode_handle_put(channel_node);
1982 		if (ret)
1983 			return ret;
1984 	}
1985 
1986 	cluster->num_channels = num_channels;
1987 	cluster->channels = channels;
1988 
1989 	return 0;
1990 }
1991 
1992 static int find_sdca_clusters(struct device *dev,
1993 			      struct fwnode_handle *function_node,
1994 			      struct sdca_function_data *function)
1995 {
1996 	struct sdca_cluster *clusters;
1997 	int num_clusters;
1998 	int i, ret;
1999 
2000 	num_clusters = fwnode_property_count_u32(function_node, "mipi-sdca-cluster-id-list");
2001 	if (!num_clusters || num_clusters == -EINVAL) {
2002 		return 0;
2003 	} else if (num_clusters < 0) {
2004 		dev_err(dev, "%pfwP: failed to read cluster id list: %d\n",
2005 			function_node, num_clusters);
2006 		return num_clusters;
2007 	} else if (num_clusters > SDCA_MAX_CLUSTER_COUNT) {
2008 		dev_err(dev, "%pfwP: maximum number of clusters exceeded\n", function_node);
2009 		return -EINVAL;
2010 	}
2011 
2012 	clusters = devm_kcalloc(dev, num_clusters, sizeof(*clusters), GFP_KERNEL);
2013 	if (!clusters)
2014 		return -ENOMEM;
2015 
2016 	u32 *cluster_list __free(kfree) = kcalloc(num_clusters, sizeof(*cluster_list),
2017 						  GFP_KERNEL);
2018 	if (!cluster_list)
2019 		return -ENOMEM;
2020 
2021 	fwnode_property_read_u32_array(function_node, "mipi-sdca-cluster-id-list",
2022 				       cluster_list, num_clusters);
2023 
2024 	for (i = 0; i < num_clusters; i++)
2025 		clusters[i].id = cluster_list[i];
2026 
2027 	/* now read subproperties */
2028 	for (i = 0; i < num_clusters; i++) {
2029 		char cluster_property[SDCA_PROPERTY_LENGTH];
2030 		struct fwnode_handle *cluster_node;
2031 
2032 		/* DisCo uses upper-case for hex numbers */
2033 		snprintf(cluster_property, sizeof(cluster_property),
2034 			 "mipi-sdca-cluster-id-0x%X-subproperties", clusters[i].id);
2035 
2036 		cluster_node = fwnode_get_named_child_node(function_node, cluster_property);
2037 		if (!cluster_node) {
2038 			dev_err(dev, "%pfwP: cluster node %s not found\n",
2039 				function_node, cluster_property);
2040 			return -EINVAL;
2041 		}
2042 
2043 		ret = find_sdca_cluster_channels(dev, cluster_node, &clusters[i]);
2044 		fwnode_handle_put(cluster_node);
2045 		if (ret)
2046 			return ret;
2047 	}
2048 
2049 	function->num_clusters = num_clusters;
2050 	function->clusters = clusters;
2051 
2052 	return 0;
2053 }
2054 
2055 static int find_sdca_filesets(struct device *dev, struct sdw_slave *sdw,
2056 			      struct fwnode_handle *function_node,
2057 			      struct sdca_function_data *function)
2058 {
2059 	static const int mult_fileset = 3;
2060 	char fileset_name[SDCA_PROPERTY_LENGTH];
2061 	struct sdca_fdl_set *sets;
2062 	int num_sets;
2063 	int i, j;
2064 
2065 	num_sets = fwnode_property_count_u32(function_node,
2066 					     "mipi-sdca-file-set-id-list");
2067 	if (num_sets == 0 || num_sets == -EINVAL) {
2068 		dev_dbg(dev, "%pfwP: file set id list missing\n", function_node);
2069 		return 0;
2070 	} else if (num_sets < 0) {
2071 		dev_err(dev, "%pfwP: failed to read file set list: %d\n",
2072 			function_node, num_sets);
2073 		return num_sets;
2074 	}
2075 
2076 	u32 *filesets_list __free(kfree) = kcalloc(num_sets, sizeof(u32),
2077 						   GFP_KERNEL);
2078 	if (!filesets_list)
2079 		return -ENOMEM;
2080 
2081 	fwnode_property_read_u32_array(function_node, "mipi-sdca-file-set-id-list",
2082 				       filesets_list, num_sets);
2083 
2084 	sets = devm_kcalloc(dev, num_sets, sizeof(*sets), GFP_KERNEL);
2085 	if (!sets)
2086 		return -ENOMEM;
2087 
2088 	for (i = 0; i < num_sets; i++) {
2089 		struct sdca_fdl_set *set = &sets[i];
2090 		struct sdca_fdl_file *files;
2091 		int num_files, num_entries;
2092 
2093 		snprintf(fileset_name, sizeof(fileset_name),
2094 			 "mipi-sdca-file-set-id-0x%X", filesets_list[i]);
2095 
2096 		num_entries = fwnode_property_count_u32(function_node, fileset_name);
2097 		if (num_entries <= 0) {
2098 			dev_err(dev, "%pfwP: file set %d missing entries: %d\n",
2099 				function_node, filesets_list[i], num_entries);
2100 			return -EINVAL;
2101 		} else if (num_entries % mult_fileset != 0) {
2102 			dev_err(dev, "%pfwP: file set %d files not multiple of %d\n",
2103 				function_node, filesets_list[i], mult_fileset);
2104 			return -EINVAL;
2105 		}
2106 
2107 		dev_dbg(dev, "fileset: %#x\n", filesets_list[i]);
2108 
2109 		files = devm_kcalloc(dev, num_entries / mult_fileset,
2110 				     sizeof(*files), GFP_KERNEL);
2111 		if (!files)
2112 			return -ENOMEM;
2113 
2114 		u32 *fileset_entries __free(kfree) = kcalloc(num_entries, sizeof(u32),
2115 							     GFP_KERNEL);
2116 		if (!fileset_entries)
2117 			return -ENOMEM;
2118 
2119 		fwnode_property_read_u32_array(function_node, fileset_name,
2120 					       fileset_entries, num_entries);
2121 
2122 		for (j = 0, num_files = 0; j < num_entries; num_files++) {
2123 			struct sdca_fdl_file *file = &files[num_files];
2124 
2125 			file->vendor_id = fileset_entries[j++];
2126 			file->file_id = fileset_entries[j++];
2127 			file->fdl_offset = fileset_entries[j++];
2128 
2129 			dev_dbg(dev, "file: %#x, vendor: %#x, offset: %#x\n",
2130 				file->file_id, file->vendor_id, file->fdl_offset);
2131 		}
2132 
2133 		set->id = filesets_list[i];
2134 		set->num_files = num_files;
2135 		set->files = files;
2136 	}
2137 
2138 	function->fdl_data.swft = sdw->sdca_data.swft;
2139 	function->fdl_data.num_sets = num_sets;
2140 	function->fdl_data.sets = sets;
2141 
2142 	return 0;
2143 }
2144 
2145 /**
2146  * sdca_parse_function - parse ACPI DisCo for a Function
2147  * @dev: Pointer to device against which function data will be allocated.
2148  * @sdw: SoundWire slave device to be processed.
2149  * @function_desc: Pointer to the Function short descriptor.
2150  * @function: Pointer to the Function information, to be populated.
2151  *
2152  * Return: Returns 0 for success.
2153  */
2154 int sdca_parse_function(struct device *dev, struct sdw_slave *sdw,
2155 			struct sdca_function_desc *function_desc,
2156 			struct sdca_function_data *function)
2157 {
2158 	u32 tmp;
2159 	int ret;
2160 
2161 	function->desc = function_desc;
2162 
2163 	ret = fwnode_property_read_u32(function_desc->node,
2164 				       "mipi-sdca-function-busy-max-delay", &tmp);
2165 	if (!ret)
2166 		function->busy_max_delay = tmp;
2167 
2168 	ret = fwnode_property_read_u32(function_desc->node,
2169 				       "mipi-sdca-function-reset-max-delay", &tmp);
2170 	if (!ret)
2171 		function->reset_max_delay = tmp;
2172 
2173 	dev_dbg(dev, "%pfwP: name %s busy delay %dus reset delay %dus\n",
2174 		function->desc->node, function->desc->name,
2175 		function->busy_max_delay, function->reset_max_delay);
2176 
2177 	ret = find_sdca_init_table(dev, function_desc->node, function);
2178 	if (ret)
2179 		return ret;
2180 
2181 	ret = find_sdca_entities(dev, sdw, function_desc->node, function);
2182 	if (ret)
2183 		return ret;
2184 
2185 	ret = find_sdca_connections(dev, function_desc->node, function);
2186 	if (ret)
2187 		return ret;
2188 
2189 	ret = find_sdca_clusters(dev, function_desc->node, function);
2190 	if (ret < 0)
2191 		return ret;
2192 
2193 	ret = find_sdca_filesets(dev, sdw, function_desc->node, function);
2194 	if (ret)
2195 		return ret;
2196 
2197 	return 0;
2198 }
2199 EXPORT_SYMBOL_NS(sdca_parse_function, "SND_SOC_SDCA");
2200 
2201 const char *sdca_find_terminal_name(enum sdca_terminal_type type)
2202 {
2203 	switch (type) {
2204 	case SDCA_TERM_TYPE_LINEIN_STEREO:
2205 		return SDCA_TERM_TYPE_LINEIN_STEREO_NAME;
2206 	case SDCA_TERM_TYPE_LINEIN_FRONT_LR:
2207 		return SDCA_TERM_TYPE_LINEIN_FRONT_LR_NAME;
2208 	case SDCA_TERM_TYPE_LINEIN_CENTER_LFE:
2209 		return SDCA_TERM_TYPE_LINEIN_CENTER_LFE_NAME;
2210 	case SDCA_TERM_TYPE_LINEIN_SURROUND_LR:
2211 		return SDCA_TERM_TYPE_LINEIN_SURROUND_LR_NAME;
2212 	case SDCA_TERM_TYPE_LINEIN_REAR_LR:
2213 		return SDCA_TERM_TYPE_LINEIN_REAR_LR_NAME;
2214 	case SDCA_TERM_TYPE_LINEOUT_STEREO:
2215 		return SDCA_TERM_TYPE_LINEOUT_STEREO_NAME;
2216 	case SDCA_TERM_TYPE_LINEOUT_FRONT_LR:
2217 		return SDCA_TERM_TYPE_LINEOUT_FRONT_LR_NAME;
2218 	case SDCA_TERM_TYPE_LINEOUT_CENTER_LFE:
2219 		return SDCA_TERM_TYPE_LINEOUT_CENTER_LFE_NAME;
2220 	case SDCA_TERM_TYPE_LINEOUT_SURROUND_LR:
2221 		return SDCA_TERM_TYPE_LINEOUT_SURROUND_LR_NAME;
2222 	case SDCA_TERM_TYPE_LINEOUT_REAR_LR:
2223 		return SDCA_TERM_TYPE_LINEOUT_REAR_LR_NAME;
2224 	case SDCA_TERM_TYPE_MIC_JACK:
2225 		return SDCA_TERM_TYPE_MIC_JACK_NAME;
2226 	case SDCA_TERM_TYPE_STEREO_JACK:
2227 		return SDCA_TERM_TYPE_STEREO_JACK_NAME;
2228 	case SDCA_TERM_TYPE_FRONT_LR_JACK:
2229 		return SDCA_TERM_TYPE_FRONT_LR_JACK_NAME;
2230 	case SDCA_TERM_TYPE_CENTER_LFE_JACK:
2231 		return SDCA_TERM_TYPE_CENTER_LFE_JACK_NAME;
2232 	case SDCA_TERM_TYPE_SURROUND_LR_JACK:
2233 		return SDCA_TERM_TYPE_SURROUND_LR_JACK_NAME;
2234 	case SDCA_TERM_TYPE_REAR_LR_JACK:
2235 		return SDCA_TERM_TYPE_REAR_LR_JACK_NAME;
2236 	case SDCA_TERM_TYPE_HEADPHONE_JACK:
2237 		return SDCA_TERM_TYPE_HEADPHONE_JACK_NAME;
2238 	case SDCA_TERM_TYPE_HEADSET_JACK:
2239 		return SDCA_TERM_TYPE_HEADSET_JACK_NAME;
2240 	default:
2241 		return NULL;
2242 	}
2243 }
2244 EXPORT_SYMBOL_NS(sdca_find_terminal_name, "SND_SOC_SDCA");
2245 
2246 struct sdca_control *sdca_selector_find_control(struct device *dev,
2247 						struct sdca_entity *entity,
2248 						const int sel)
2249 {
2250 	int i;
2251 
2252 	for (i = 0; i < entity->num_controls; i++) {
2253 		struct sdca_control *control = &entity->controls[i];
2254 
2255 		if (control->sel == sel)
2256 			return control;
2257 	}
2258 
2259 	dev_err(dev, "%s: control %#x: missing\n", entity->label, sel);
2260 	return NULL;
2261 }
2262 EXPORT_SYMBOL_NS(sdca_selector_find_control, "SND_SOC_SDCA");
2263 
2264 struct sdca_control_range *sdca_control_find_range(struct device *dev,
2265 						   struct sdca_entity *entity,
2266 						   struct sdca_control *control,
2267 						   int cols, int rows)
2268 {
2269 	struct sdca_control_range *range = &control->range;
2270 
2271 	if ((cols && range->cols != cols) || (rows && range->rows != rows) ||
2272 	    !range->data) {
2273 		dev_err(dev, "%s: control %#x: ranges invalid (%d,%d)\n",
2274 			entity->label, control->sel, range->cols, range->rows);
2275 		return NULL;
2276 	}
2277 
2278 	return range;
2279 }
2280 EXPORT_SYMBOL_NS(sdca_control_find_range, "SND_SOC_SDCA");
2281 
2282 struct sdca_control_range *sdca_selector_find_range(struct device *dev,
2283 						    struct sdca_entity *entity,
2284 						    int sel, int cols, int rows)
2285 {
2286 	struct sdca_control *control;
2287 
2288 	control = sdca_selector_find_control(dev, entity, sel);
2289 	if (!control)
2290 		return NULL;
2291 
2292 	return sdca_control_find_range(dev, entity, control, cols, rows);
2293 }
2294 EXPORT_SYMBOL_NS(sdca_selector_find_range, "SND_SOC_SDCA");
2295 
2296 struct sdca_cluster *sdca_id_find_cluster(struct device *dev,
2297 					  struct sdca_function_data *function,
2298 					  const int id)
2299 {
2300 	int i;
2301 
2302 	for (i = 0; i < function->num_clusters; i++) {
2303 		struct sdca_cluster *cluster = &function->clusters[i];
2304 
2305 		if (cluster->id == id)
2306 			return cluster;
2307 	}
2308 
2309 	dev_err(dev, "%s: cluster %#x: missing\n", function->desc->name, id);
2310 	return NULL;
2311 }
2312 EXPORT_SYMBOL_NS(sdca_id_find_cluster, "SND_SOC_SDCA");
2313 
2314 MODULE_LICENSE("Dual BSD/GPL");
2315 MODULE_DESCRIPTION("SDCA library");
2316