xref: /linux/sound/soc/sdca/sdca_functions.c (revision a9e6060bb2a6cae6d43a98ec0794844ad01273d3)
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 #define dev_fmt(fmt) "%s: " fmt, __func__
10 
11 #include <linux/acpi.h>
12 #include <linux/byteorder/generic.h>
13 #include <linux/cleanup.h>
14 #include <linux/device.h>
15 #include <linux/dev_printk.h>
16 #include <linux/module.h>
17 #include <linux/property.h>
18 #include <linux/soundwire/sdw.h>
19 #include <linux/types.h>
20 #include <sound/sdca.h>
21 #include <sound/sdca_function.h>
22 
23 /*
24  * Should be long enough to encompass all the MIPI DisCo properties.
25  */
26 #define SDCA_PROPERTY_LENGTH 64
27 
patch_sdca_function_type(u32 interface_revision,u32 * function_type)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 
get_sdca_function_name(u32 function_type)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_IMP_DEF:
82 		return SDCA_FUNCTION_TYPE_IMP_DEF_NAME;
83 	default:
84 		return NULL;
85 	}
86 }
87 
find_sdca_function(struct acpi_device * adev,void * data)88 static int find_sdca_function(struct acpi_device *adev, void *data)
89 {
90 	struct fwnode_handle *function_node = acpi_fwnode_handle(adev);
91 	struct sdca_device_data *sdca_data = data;
92 	struct device *dev = &adev->dev;
93 	struct fwnode_handle *control5; /* used to identify function type */
94 	const char *function_name;
95 	u32 function_type;
96 	int function_index;
97 	u64 addr;
98 	int ret;
99 
100 	if (sdca_data->num_functions >= SDCA_MAX_FUNCTION_COUNT) {
101 		dev_err(dev, "maximum number of functions exceeded\n");
102 		return -EINVAL;
103 	}
104 
105 	ret = acpi_get_local_u64_address(adev->handle, &addr);
106 	if (ret < 0)
107 		return ret;
108 
109 	if (!addr || addr > 0x7) {
110 		dev_err(dev, "invalid addr: 0x%llx\n", addr);
111 		return -ENODEV;
112 	}
113 
114 	/*
115 	 * Extracting the topology type for an SDCA function is a
116 	 * convoluted process.
117 	 * The Function type is only visible as a result of a read
118 	 * from a control. In theory this would mean reading from the hardware,
119 	 * but the SDCA/DisCo specs defined the notion of "DC value" - a constant
120 	 * represented with a DSD subproperty.
121 	 * Drivers have to query the properties for the control
122 	 * SDCA_CONTROL_ENTITY_0_FUNCTION_TOPOLOGY (0x05)
123 	 */
124 	control5 = fwnode_get_named_child_node(function_node,
125 					       "mipi-sdca-control-0x5-subproperties");
126 	if (!control5)
127 		return -ENODEV;
128 
129 	ret = fwnode_property_read_u32(control5, "mipi-sdca-control-dc-value",
130 				       &function_type);
131 
132 	fwnode_handle_put(control5);
133 
134 	if (ret < 0) {
135 		dev_err(dev, "function type only supported as DisCo constant\n");
136 		return ret;
137 	}
138 
139 	ret = patch_sdca_function_type(sdca_data->interface_revision, &function_type);
140 	if (ret < 0) {
141 		dev_err(dev, "SDCA version %#x invalid function type %d\n",
142 			sdca_data->interface_revision, function_type);
143 		return ret;
144 	}
145 
146 	function_name = get_sdca_function_name(function_type);
147 	if (!function_name) {
148 		dev_err(dev, "invalid SDCA function type %d\n", function_type);
149 		return -EINVAL;
150 	}
151 
152 	dev_info(dev, "SDCA function %s (type %d) at 0x%llx\n",
153 		 function_name, function_type, addr);
154 
155 	/* store results */
156 	function_index = sdca_data->num_functions;
157 	sdca_data->function[function_index].adr = addr;
158 	sdca_data->function[function_index].type = function_type;
159 	sdca_data->function[function_index].name = function_name;
160 	sdca_data->function[function_index].node = function_node;
161 	sdca_data->num_functions++;
162 
163 	return 0;
164 }
165 
166 /**
167  * sdca_lookup_functions - Parse sdca_device_desc for each Function
168  * @slave: SoundWire slave device to be processed.
169  *
170  * Iterate through the available SDCA Functions and fill in a short
171  * descriptor (struct sdca_function_desc) for each function, this
172  * information is stored along with the SoundWire slave device and
173  * used for adding drivers and quirks before the devices have fully
174  * probed.
175  */
sdca_lookup_functions(struct sdw_slave * slave)176 void sdca_lookup_functions(struct sdw_slave *slave)
177 {
178 	struct device *dev = &slave->dev;
179 	struct acpi_device *adev = to_acpi_device_node(dev->fwnode);
180 
181 	if (!adev) {
182 		dev_info(dev, "no matching ACPI device found, ignoring peripheral\n");
183 		return;
184 	}
185 
186 	acpi_dev_for_each_child(adev, find_sdca_function, &slave->sdca_data);
187 }
188 EXPORT_SYMBOL_NS(sdca_lookup_functions, "SND_SOC_SDCA");
189 
190 struct raw_init_write {
191 	__le32 addr;
192 	u8 val;
193 } __packed;
194 
find_sdca_init_table(struct device * dev,struct fwnode_handle * function_node,struct sdca_function_data * function)195 static int find_sdca_init_table(struct device *dev,
196 				struct fwnode_handle *function_node,
197 				struct sdca_function_data *function)
198 {
199 	struct raw_init_write *raw __free(kfree) = NULL;
200 	struct sdca_init_write *init_write;
201 	int i, num_init_writes;
202 
203 	num_init_writes = fwnode_property_count_u8(function_node,
204 						   "mipi-sdca-function-initialization-table");
205 	if (!num_init_writes || num_init_writes == -EINVAL) {
206 		return 0;
207 	} else if (num_init_writes < 0) {
208 		dev_err(dev, "%pfwP: failed to read initialization table: %d\n",
209 			function_node, num_init_writes);
210 		return num_init_writes;
211 	} else if (num_init_writes % sizeof(*raw) != 0) {
212 		dev_err(dev, "%pfwP: init table size invalid\n", function_node);
213 		return -EINVAL;
214 	} else if (num_init_writes > SDCA_MAX_INIT_COUNT) {
215 		dev_err(dev, "%pfwP: maximum init table size exceeded\n", function_node);
216 		return -EINVAL;
217 	}
218 
219 	raw = kzalloc(num_init_writes, GFP_KERNEL);
220 	if (!raw)
221 		return -ENOMEM;
222 
223 	fwnode_property_read_u8_array(function_node,
224 				      "mipi-sdca-function-initialization-table",
225 				      (u8 *)raw, num_init_writes);
226 
227 	num_init_writes /= sizeof(*raw);
228 
229 	init_write = devm_kcalloc(dev, num_init_writes, sizeof(*init_write), GFP_KERNEL);
230 	if (!init_write)
231 		return -ENOMEM;
232 
233 	for (i = 0; i < num_init_writes; i++) {
234 		init_write[i].addr = le32_to_cpu(raw[i].addr);
235 		init_write[i].val = raw[i].val;
236 	}
237 
238 	function->num_init_table = num_init_writes;
239 	function->init_table = init_write;
240 
241 	return 0;
242 }
243 
find_sdca_control_label(struct device * dev,const struct sdca_entity * entity,const struct sdca_control * control)244 static const char *find_sdca_control_label(struct device *dev,
245 					   const struct sdca_entity *entity,
246 					   const struct sdca_control *control)
247 {
248 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
249 	case SDCA_CTL_TYPE_S(IT, MIC_BIAS):
250 		return SDCA_CTL_MIC_BIAS_NAME;
251 	case SDCA_CTL_TYPE_S(IT, USAGE):
252 	case SDCA_CTL_TYPE_S(OT, USAGE):
253 		return SDCA_CTL_USAGE_NAME;
254 	case SDCA_CTL_TYPE_S(IT, LATENCY):
255 	case SDCA_CTL_TYPE_S(OT, LATENCY):
256 	case SDCA_CTL_TYPE_S(MU, LATENCY):
257 	case SDCA_CTL_TYPE_S(SU, LATENCY):
258 	case SDCA_CTL_TYPE_S(FU, LATENCY):
259 	case SDCA_CTL_TYPE_S(XU, LATENCY):
260 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
261 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
262 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
263 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
264 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
265 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
266 		return SDCA_CTL_LATENCY_NAME;
267 	case SDCA_CTL_TYPE_S(IT, CLUSTERINDEX):
268 	case SDCA_CTL_TYPE_S(CRU, CLUSTERINDEX):
269 	case SDCA_CTL_TYPE_S(UDMPU, CLUSTERINDEX):
270 	case SDCA_CTL_TYPE_S(MFPU, CLUSTERINDEX):
271 		return SDCA_CTL_CLUSTERINDEX_NAME;
272 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
273 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
274 		return SDCA_CTL_DATAPORT_SELECTOR_NAME;
275 	case SDCA_CTL_TYPE_S(IT, MATCHING_GUID):
276 	case SDCA_CTL_TYPE_S(OT, MATCHING_GUID):
277 	case SDCA_CTL_TYPE_S(ENTITY_0, MATCHING_GUID):
278 		return SDCA_CTL_MATCHING_GUID_NAME;
279 	case SDCA_CTL_TYPE_S(IT, KEEP_ALIVE):
280 	case SDCA_CTL_TYPE_S(OT, KEEP_ALIVE):
281 		return SDCA_CTL_KEEP_ALIVE_NAME;
282 	case SDCA_CTL_TYPE_S(IT, NDAI_STREAM):
283 	case SDCA_CTL_TYPE_S(OT, NDAI_STREAM):
284 		return SDCA_CTL_NDAI_STREAM_NAME;
285 	case SDCA_CTL_TYPE_S(IT, NDAI_CATEGORY):
286 	case SDCA_CTL_TYPE_S(OT, NDAI_CATEGORY):
287 		return SDCA_CTL_NDAI_CATEGORY_NAME;
288 	case SDCA_CTL_TYPE_S(IT, NDAI_CODINGTYPE):
289 	case SDCA_CTL_TYPE_S(OT, NDAI_CODINGTYPE):
290 		return SDCA_CTL_NDAI_CODINGTYPE_NAME;
291 	case SDCA_CTL_TYPE_S(IT, NDAI_PACKETTYPE):
292 	case SDCA_CTL_TYPE_S(OT, NDAI_PACKETTYPE):
293 		return SDCA_CTL_NDAI_PACKETTYPE_NAME;
294 	case SDCA_CTL_TYPE_S(MU, MIXER):
295 		return SDCA_CTL_MIXER_NAME;
296 	case SDCA_CTL_TYPE_S(SU, SELECTOR):
297 		return SDCA_CTL_SELECTOR_NAME;
298 	case SDCA_CTL_TYPE_S(FU, MUTE):
299 		return SDCA_CTL_MUTE_NAME;
300 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
301 		return SDCA_CTL_CHANNEL_VOLUME_NAME;
302 	case SDCA_CTL_TYPE_S(FU, AGC):
303 		return SDCA_CTL_AGC_NAME;
304 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
305 		return SDCA_CTL_BASS_BOOST_NAME;
306 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
307 		return SDCA_CTL_LOUDNESS_NAME;
308 	case SDCA_CTL_TYPE_S(FU, GAIN):
309 		return SDCA_CTL_GAIN_NAME;
310 	case SDCA_CTL_TYPE_S(XU, BYPASS):
311 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
312 		return SDCA_CTL_BYPASS_NAME;
313 	case SDCA_CTL_TYPE_S(XU, XU_ID):
314 		return SDCA_CTL_XU_ID_NAME;
315 	case SDCA_CTL_TYPE_S(XU, XU_VERSION):
316 		return SDCA_CTL_XU_VERSION_NAME;
317 	case SDCA_CTL_TYPE_S(XU, FDL_CURRENTOWNER):
318 		return SDCA_CTL_FDL_CURRENTOWNER_NAME;
319 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
320 		return SDCA_CTL_FDL_MESSAGEOFFSET_NAME;
321 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
322 		return SDCA_CTL_FDL_MESSAGELENGTH_NAME;
323 	case SDCA_CTL_TYPE_S(XU, FDL_STATUS):
324 		return SDCA_CTL_FDL_STATUS_NAME;
325 	case SDCA_CTL_TYPE_S(XU, FDL_SET_INDEX):
326 		return SDCA_CTL_FDL_SET_INDEX_NAME;
327 	case SDCA_CTL_TYPE_S(XU, FDL_HOST_REQUEST):
328 		return SDCA_CTL_FDL_HOST_REQUEST_NAME;
329 	case SDCA_CTL_TYPE_S(CS, CLOCK_VALID):
330 		return SDCA_CTL_CLOCK_VALID_NAME;
331 	case SDCA_CTL_TYPE_S(CS, SAMPLERATEINDEX):
332 		return SDCA_CTL_SAMPLERATEINDEX_NAME;
333 	case SDCA_CTL_TYPE_S(CX, CLOCK_SELECT):
334 		return SDCA_CTL_CLOCK_SELECT_NAME;
335 	case SDCA_CTL_TYPE_S(PDE, REQUESTED_PS):
336 		return SDCA_CTL_REQUESTED_PS_NAME;
337 	case SDCA_CTL_TYPE_S(PDE, ACTUAL_PS):
338 		return SDCA_CTL_ACTUAL_PS_NAME;
339 	case SDCA_CTL_TYPE_S(GE, SELECTED_MODE):
340 		return SDCA_CTL_SELECTED_MODE_NAME;
341 	case SDCA_CTL_TYPE_S(GE, DETECTED_MODE):
342 		return SDCA_CTL_DETECTED_MODE_NAME;
343 	case SDCA_CTL_TYPE_S(SPE, PRIVATE):
344 		return SDCA_CTL_PRIVATE_NAME;
345 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_POLICY):
346 		return SDCA_CTL_PRIVACY_POLICY_NAME;
347 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_LOCKSTATE):
348 		return SDCA_CTL_PRIVACY_LOCKSTATE_NAME;
349 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_OWNER):
350 		return SDCA_CTL_PRIVACY_OWNER_NAME;
351 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_CURRENTOWNER):
352 		return SDCA_CTL_AUTHTX_CURRENTOWNER_NAME;
353 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
354 		return SDCA_CTL_AUTHTX_MESSAGEOFFSET_NAME;
355 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
356 		return SDCA_CTL_AUTHTX_MESSAGELENGTH_NAME;
357 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_CURRENTOWNER):
358 		return SDCA_CTL_AUTHRX_CURRENTOWNER_NAME;
359 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
360 		return SDCA_CTL_AUTHRX_MESSAGEOFFSET_NAME;
361 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
362 		return SDCA_CTL_AUTHRX_MESSAGELENGTH_NAME;
363 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
364 		return SDCA_CTL_ACOUSTIC_ENERGY_LEVEL_MONITOR_NAME;
365 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
366 		return SDCA_CTL_ULTRASOUND_LOOP_GAIN_NAME;
367 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_0):
368 		return SDCA_CTL_OPAQUESET_0_NAME;
369 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_1):
370 		return SDCA_CTL_OPAQUESET_1_NAME;
371 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_2):
372 		return SDCA_CTL_OPAQUESET_2_NAME;
373 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_3):
374 		return SDCA_CTL_OPAQUESET_3_NAME;
375 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_4):
376 		return SDCA_CTL_OPAQUESET_4_NAME;
377 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_5):
378 		return SDCA_CTL_OPAQUESET_5_NAME;
379 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_6):
380 		return SDCA_CTL_OPAQUESET_6_NAME;
381 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_7):
382 		return SDCA_CTL_OPAQUESET_7_NAME;
383 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_8):
384 		return SDCA_CTL_OPAQUESET_8_NAME;
385 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_9):
386 		return SDCA_CTL_OPAQUESET_9_NAME;
387 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_10):
388 		return SDCA_CTL_OPAQUESET_10_NAME;
389 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_11):
390 		return SDCA_CTL_OPAQUESET_11_NAME;
391 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_12):
392 		return SDCA_CTL_OPAQUESET_12_NAME;
393 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_13):
394 		return SDCA_CTL_OPAQUESET_13_NAME;
395 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_14):
396 		return SDCA_CTL_OPAQUESET_14_NAME;
397 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_15):
398 		return SDCA_CTL_OPAQUESET_15_NAME;
399 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_16):
400 		return SDCA_CTL_OPAQUESET_16_NAME;
401 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_17):
402 		return SDCA_CTL_OPAQUESET_17_NAME;
403 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_18):
404 		return SDCA_CTL_OPAQUESET_18_NAME;
405 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_19):
406 		return SDCA_CTL_OPAQUESET_19_NAME;
407 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_20):
408 		return SDCA_CTL_OPAQUESET_20_NAME;
409 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_21):
410 		return SDCA_CTL_OPAQUESET_21_NAME;
411 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_22):
412 		return SDCA_CTL_OPAQUESET_22_NAME;
413 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_23):
414 		return SDCA_CTL_OPAQUESET_23_NAME;
415 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_READY):
416 		return SDCA_CTL_ALGORITHM_READY_NAME;
417 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_ENABLE):
418 		return SDCA_CTL_ALGORITHM_ENABLE_NAME;
419 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_PREPARE):
420 		return SDCA_CTL_ALGORITHM_PREPARE_NAME;
421 	case SDCA_CTL_TYPE_S(MFPU, CENTER_FREQUENCY_INDEX):
422 		return SDCA_CTL_CENTER_FREQUENCY_INDEX_NAME;
423 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
424 		return SDCA_CTL_ULTRASOUND_LEVEL_NAME;
425 	case SDCA_CTL_TYPE_S(MFPU, AE_NUMBER):
426 		return SDCA_CTL_AE_NUMBER_NAME;
427 	case SDCA_CTL_TYPE_S(MFPU, AE_CURRENTOWNER):
428 		return SDCA_CTL_AE_CURRENTOWNER_NAME;
429 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
430 		return SDCA_CTL_AE_MESSAGEOFFSET_NAME;
431 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
432 		return SDCA_CTL_AE_MESSAGELENGTH_NAME;
433 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_ENABLE):
434 		return SDCA_CTL_TRIGGER_ENABLE_NAME;
435 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_STATUS):
436 		return SDCA_CTL_TRIGGER_STATUS_NAME;
437 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_MODE):
438 		return SDCA_CTL_HIST_BUFFER_MODE_NAME;
439 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_PREAMBLE):
440 		return SDCA_CTL_HIST_BUFFER_PREAMBLE_NAME;
441 	case SDCA_CTL_TYPE_S(SMPU, HIST_ERROR):
442 		return SDCA_CTL_HIST_ERROR_NAME;
443 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_EXTENSION):
444 		return SDCA_CTL_TRIGGER_EXTENSION_NAME;
445 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_READY):
446 		return SDCA_CTL_TRIGGER_READY_NAME;
447 	case SDCA_CTL_TYPE_S(SMPU, HIST_CURRENTOWNER):
448 		return SDCA_CTL_HIST_CURRENTOWNER_NAME;
449 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
450 		return SDCA_CTL_HIST_MESSAGEOFFSET_NAME;
451 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
452 		return SDCA_CTL_HIST_MESSAGELENGTH_NAME;
453 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_CURRENTOWNER):
454 		return SDCA_CTL_DTODTX_CURRENTOWNER_NAME;
455 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
456 		return SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME;
457 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
458 		return SDCA_CTL_DTODTX_MESSAGELENGTH_NAME;
459 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_CURRENTOWNER):
460 		return SDCA_CTL_DTODRX_CURRENTOWNER_NAME;
461 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
462 		return SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME;
463 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
464 		return SDCA_CTL_DTODRX_MESSAGELENGTH_NAME;
465 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_MODE):
466 		return SDCA_CTL_PROTECTION_MODE_NAME;
467 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_STATUS):
468 		return SDCA_CTL_PROTECTION_STATUS_NAME;
469 	case SDCA_CTL_TYPE_S(SAPU, OPAQUESETREQ_INDEX):
470 		return SDCA_CTL_OPAQUESETREQ_INDEX_NAME;
471 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_CURRENTOWNER):
472 		return SDCA_CTL_DTODTX_CURRENTOWNER_NAME;
473 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
474 		return SDCA_CTL_DTODTX_MESSAGEOFFSET_NAME;
475 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
476 		return SDCA_CTL_DTODTX_MESSAGELENGTH_NAME;
477 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_CURRENTOWNER):
478 		return SDCA_CTL_DTODRX_CURRENTOWNER_NAME;
479 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
480 		return SDCA_CTL_DTODRX_MESSAGEOFFSET_NAME;
481 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
482 		return SDCA_CTL_DTODRX_MESSAGELENGTH_NAME;
483 	case SDCA_CTL_TYPE_S(PPU, POSTURENUMBER):
484 		return SDCA_CTL_POSTURENUMBER_NAME;
485 	case SDCA_CTL_TYPE_S(PPU, POSTUREEXTENSION):
486 		return SDCA_CTL_POSTUREEXTENSION_NAME;
487 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
488 		return SDCA_CTL_HORIZONTALBALANCE_NAME;
489 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
490 		return SDCA_CTL_VERTICALBALANCE_NAME;
491 	case SDCA_CTL_TYPE_S(TG, TONE_DIVIDER):
492 		return SDCA_CTL_TONE_DIVIDER_NAME;
493 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_CURRENTOWNER):
494 		return SDCA_CTL_HIDTX_CURRENTOWNER_NAME;
495 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
496 		return SDCA_CTL_HIDTX_MESSAGEOFFSET_NAME;
497 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
498 		return SDCA_CTL_HIDTX_MESSAGELENGTH_NAME;
499 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_CURRENTOWNER):
500 		return SDCA_CTL_HIDRX_CURRENTOWNER_NAME;
501 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
502 		return SDCA_CTL_HIDRX_MESSAGEOFFSET_NAME;
503 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
504 		return SDCA_CTL_HIDRX_MESSAGELENGTH_NAME;
505 	case SDCA_CTL_TYPE_S(ENTITY_0, COMMIT_GROUP_MASK):
506 		return SDCA_CTL_COMMIT_GROUP_MASK_NAME;
507 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_SDCA_VERSION):
508 		return SDCA_CTL_FUNCTION_SDCA_VERSION_NAME;
509 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_TYPE):
510 		return SDCA_CTL_FUNCTION_TYPE_NAME;
511 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
512 		return SDCA_CTL_FUNCTION_MANUFACTURER_ID_NAME;
513 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
514 		return SDCA_CTL_FUNCTION_ID_NAME;
515 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_VERSION):
516 		return SDCA_CTL_FUNCTION_VERSION_NAME;
517 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
518 		return SDCA_CTL_FUNCTION_EXTENSION_ID_NAME;
519 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_VERSION):
520 		return SDCA_CTL_FUNCTION_EXTENSION_VERSION_NAME;
521 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_STATUS):
522 		return SDCA_CTL_FUNCTION_STATUS_NAME;
523 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ACTION):
524 		return SDCA_CTL_FUNCTION_ACTION_NAME;
525 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
526 		return SDCA_CTL_DEVICE_MANUFACTURER_ID_NAME;
527 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
528 		return SDCA_CTL_DEVICE_PART_ID_NAME;
529 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_VERSION):
530 		return SDCA_CTL_DEVICE_VERSION_NAME;
531 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_SDCA_VERSION):
532 		return SDCA_CTL_DEVICE_SDCA_VERSION_NAME;
533 	default:
534 		return devm_kasprintf(dev, GFP_KERNEL, "Imp-Def %#x", control->sel);
535 	}
536 }
537 
find_sdca_control_bits(const struct sdca_entity * entity,const struct sdca_control * control)538 static unsigned int find_sdca_control_bits(const struct sdca_entity *entity,
539 					   const struct sdca_control *control)
540 {
541 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
542 	case SDCA_CTL_TYPE_S(IT, LATENCY):
543 	case SDCA_CTL_TYPE_S(OT, LATENCY):
544 	case SDCA_CTL_TYPE_S(MU, LATENCY):
545 	case SDCA_CTL_TYPE_S(SU, LATENCY):
546 	case SDCA_CTL_TYPE_S(FU, LATENCY):
547 	case SDCA_CTL_TYPE_S(XU, LATENCY):
548 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
549 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
550 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
551 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
552 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
553 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
554 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
555 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
556 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
557 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
558 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
559 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
560 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
561 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
562 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
563 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
564 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
565 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
566 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
567 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
568 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
569 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
570 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
571 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
572 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
573 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
574 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
575 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
576 		return 32;
577 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
578 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
579 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
580 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
581 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
582 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
583 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
584 	case SDCA_CTL_TYPE_S(MU, MIXER):
585 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
586 	case SDCA_CTL_TYPE_S(FU, GAIN):
587 	case SDCA_CTL_TYPE_S(XU, XU_ID):
588 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
589 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
590 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
591 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
592 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
593 		return 16;
594 	case SDCA_CTL_TYPE_S(FU, MUTE):
595 	case SDCA_CTL_TYPE_S(FU, AGC):
596 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
597 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
598 	case SDCA_CTL_TYPE_S(XU, BYPASS):
599 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
600 		return 1;
601 	default:
602 		return 8;
603 	}
604 }
605 
606 static enum sdca_control_datatype
find_sdca_control_datatype(const struct sdca_entity * entity,const struct sdca_control * control)607 find_sdca_control_datatype(const struct sdca_entity *entity,
608 			   const struct sdca_control *control)
609 {
610 	switch (SDCA_CTL_TYPE(entity->type, control->sel)) {
611 	case SDCA_CTL_TYPE_S(XU, BYPASS):
612 	case SDCA_CTL_TYPE_S(MFPU, BYPASS):
613 	case SDCA_CTL_TYPE_S(FU, MUTE):
614 	case SDCA_CTL_TYPE_S(FU, AGC):
615 	case SDCA_CTL_TYPE_S(FU, BASS_BOOST):
616 	case SDCA_CTL_TYPE_S(FU, LOUDNESS):
617 		return SDCA_CTL_DATATYPE_ONEBIT;
618 	case SDCA_CTL_TYPE_S(IT, LATENCY):
619 	case SDCA_CTL_TYPE_S(OT, LATENCY):
620 	case SDCA_CTL_TYPE_S(MU, LATENCY):
621 	case SDCA_CTL_TYPE_S(SU, LATENCY):
622 	case SDCA_CTL_TYPE_S(FU, LATENCY):
623 	case SDCA_CTL_TYPE_S(XU, LATENCY):
624 	case SDCA_CTL_TYPE_S(CRU, LATENCY):
625 	case SDCA_CTL_TYPE_S(UDMPU, LATENCY):
626 	case SDCA_CTL_TYPE_S(MFPU, LATENCY):
627 	case SDCA_CTL_TYPE_S(SMPU, LATENCY):
628 	case SDCA_CTL_TYPE_S(SAPU, LATENCY):
629 	case SDCA_CTL_TYPE_S(PPU, LATENCY):
630 	case SDCA_CTL_TYPE_S(SU, SELECTOR):
631 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_0):
632 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_1):
633 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_2):
634 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_3):
635 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_4):
636 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_5):
637 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_6):
638 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_7):
639 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_8):
640 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_9):
641 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_10):
642 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_11):
643 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_12):
644 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_13):
645 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_14):
646 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_15):
647 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_16):
648 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_17):
649 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_18):
650 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_19):
651 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_20):
652 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_21):
653 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_22):
654 	case SDCA_CTL_TYPE_S(UDMPU, OPAQUESET_23):
655 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_MODE):
656 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_PREAMBLE):
657 	case SDCA_CTL_TYPE_S(XU, FDL_HOST_REQUEST):
658 	case SDCA_CTL_TYPE_S(XU, XU_ID):
659 	case SDCA_CTL_TYPE_S(CX, CLOCK_SELECT):
660 	case SDCA_CTL_TYPE_S(TG, TONE_DIVIDER):
661 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_MANUFACTURER_ID):
662 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ID):
663 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_ID):
664 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_MANUFACTURER_ID):
665 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_PART_ID):
666 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGEOFFSET):
667 	case SDCA_CTL_TYPE_S(XU, FDL_MESSAGELENGTH):
668 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGEOFFSET):
669 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_MESSAGELENGTH):
670 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGEOFFSET):
671 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_MESSAGELENGTH):
672 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGEOFFSET):
673 	case SDCA_CTL_TYPE_S(MFPU, AE_MESSAGELENGTH):
674 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGEOFFSET):
675 	case SDCA_CTL_TYPE_S(SMPU, HIST_MESSAGELENGTH):
676 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGEOFFSET):
677 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_MESSAGELENGTH):
678 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGEOFFSET):
679 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_MESSAGELENGTH):
680 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGEOFFSET):
681 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_MESSAGELENGTH):
682 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGEOFFSET):
683 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_MESSAGELENGTH):
684 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGEOFFSET):
685 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_MESSAGELENGTH):
686 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGEOFFSET):
687 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_MESSAGELENGTH):
688 		return SDCA_CTL_DATATYPE_INTEGER;
689 	case SDCA_CTL_TYPE_S(IT, MIC_BIAS):
690 	case SDCA_CTL_TYPE_S(SMPU, HIST_BUFFER_MODE):
691 	case SDCA_CTL_TYPE_S(PDE, REQUESTED_PS):
692 	case SDCA_CTL_TYPE_S(PDE, ACTUAL_PS):
693 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_TYPE):
694 		return SDCA_CTL_DATATYPE_SPEC_ENCODED_VALUE;
695 	case SDCA_CTL_TYPE_S(XU, XU_VERSION):
696 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_SDCA_VERSION):
697 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_VERSION):
698 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_EXTENSION_VERSION):
699 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_VERSION):
700 	case SDCA_CTL_TYPE_S(ENTITY_0, DEVICE_SDCA_VERSION):
701 		return SDCA_CTL_DATATYPE_BCD;
702 	case SDCA_CTL_TYPE_S(FU, CHANNEL_VOLUME):
703 	case SDCA_CTL_TYPE_S(FU, GAIN):
704 	case SDCA_CTL_TYPE_S(MU, MIXER):
705 	case SDCA_CTL_TYPE_S(PPU, HORIZONTALBALANCE):
706 	case SDCA_CTL_TYPE_S(PPU, VERTICALBALANCE):
707 	case SDCA_CTL_TYPE_S(MFPU, ULTRASOUND_LEVEL):
708 	case SDCA_CTL_TYPE_S(UDMPU, ACOUSTIC_ENERGY_LEVEL_MONITOR):
709 	case SDCA_CTL_TYPE_S(UDMPU, ULTRASOUND_LOOP_GAIN):
710 		return SDCA_CTL_DATATYPE_Q7P8DB;
711 	case SDCA_CTL_TYPE_S(IT, USAGE):
712 	case SDCA_CTL_TYPE_S(OT, USAGE):
713 	case SDCA_CTL_TYPE_S(IT, CLUSTERINDEX):
714 	case SDCA_CTL_TYPE_S(CRU, CLUSTERINDEX):
715 	case SDCA_CTL_TYPE_S(UDMPU, CLUSTERINDEX):
716 	case SDCA_CTL_TYPE_S(MFPU, CLUSTERINDEX):
717 	case SDCA_CTL_TYPE_S(MFPU, CENTER_FREQUENCY_INDEX):
718 	case SDCA_CTL_TYPE_S(MFPU, AE_NUMBER):
719 	case SDCA_CTL_TYPE_S(SAPU, OPAQUESETREQ_INDEX):
720 	case SDCA_CTL_TYPE_S(XU, FDL_SET_INDEX):
721 	case SDCA_CTL_TYPE_S(CS, SAMPLERATEINDEX):
722 	case SDCA_CTL_TYPE_S(GE, SELECTED_MODE):
723 	case SDCA_CTL_TYPE_S(GE, DETECTED_MODE):
724 		return SDCA_CTL_DATATYPE_BYTEINDEX;
725 	case SDCA_CTL_TYPE_S(PPU, POSTURENUMBER):
726 		return SDCA_CTL_DATATYPE_POSTURENUMBER;
727 	case SDCA_CTL_TYPE_S(IT, DATAPORT_SELECTOR):
728 	case SDCA_CTL_TYPE_S(OT, DATAPORT_SELECTOR):
729 		return SDCA_CTL_DATATYPE_DP_INDEX;
730 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_READY):
731 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_ENABLE):
732 	case SDCA_CTL_TYPE_S(MFPU, ALGORITHM_PREPARE):
733 	case SDCA_CTL_TYPE_S(SAPU, PROTECTION_STATUS):
734 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_ENABLE):
735 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_STATUS):
736 	case SDCA_CTL_TYPE_S(SMPU, TRIGGER_READY):
737 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_POLICY):
738 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_OWNER):
739 		return SDCA_CTL_DATATYPE_BITINDEX;
740 	case SDCA_CTL_TYPE_S(IT, KEEP_ALIVE):
741 	case SDCA_CTL_TYPE_S(OT, KEEP_ALIVE):
742 	case SDCA_CTL_TYPE_S(IT, NDAI_STREAM):
743 	case SDCA_CTL_TYPE_S(OT, NDAI_STREAM):
744 	case SDCA_CTL_TYPE_S(IT, NDAI_CATEGORY):
745 	case SDCA_CTL_TYPE_S(OT, NDAI_CATEGORY):
746 	case SDCA_CTL_TYPE_S(IT, NDAI_CODINGTYPE):
747 	case SDCA_CTL_TYPE_S(OT, NDAI_CODINGTYPE):
748 	case SDCA_CTL_TYPE_S(IT, NDAI_PACKETTYPE):
749 	case SDCA_CTL_TYPE_S(OT, NDAI_PACKETTYPE):
750 	case SDCA_CTL_TYPE_S(SMPU, HIST_ERROR):
751 	case SDCA_CTL_TYPE_S(XU, FDL_STATUS):
752 	case SDCA_CTL_TYPE_S(CS, CLOCK_VALID):
753 	case SDCA_CTL_TYPE_S(SPE, PRIVACY_LOCKSTATE):
754 	case SDCA_CTL_TYPE_S(ENTITY_0, COMMIT_GROUP_MASK):
755 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_STATUS):
756 	case SDCA_CTL_TYPE_S(ENTITY_0, FUNCTION_ACTION):
757 	case SDCA_CTL_TYPE_S(XU, FDL_CURRENTOWNER):
758 	case SDCA_CTL_TYPE_S(SPE, AUTHTX_CURRENTOWNER):
759 	case SDCA_CTL_TYPE_S(SPE, AUTHRX_CURRENTOWNER):
760 	case SDCA_CTL_TYPE_S(MFPU, AE_CURRENTOWNER):
761 	case SDCA_CTL_TYPE_S(SMPU, HIST_CURRENTOWNER):
762 	case SDCA_CTL_TYPE_S(SMPU, DTODTX_CURRENTOWNER):
763 	case SDCA_CTL_TYPE_S(SMPU, DTODRX_CURRENTOWNER):
764 	case SDCA_CTL_TYPE_S(SAPU, DTODTX_CURRENTOWNER):
765 	case SDCA_CTL_TYPE_S(SAPU, DTODRX_CURRENTOWNER):
766 	case SDCA_CTL_TYPE_S(HIDE, HIDTX_CURRENTOWNER):
767 	case SDCA_CTL_TYPE_S(HIDE, HIDRX_CURRENTOWNER):
768 		return SDCA_CTL_DATATYPE_BITMAP;
769 	case SDCA_CTL_TYPE_S(IT, MATCHING_GUID):
770 	case SDCA_CTL_TYPE_S(OT, MATCHING_GUID):
771 	case SDCA_CTL_TYPE_S(ENTITY_0, MATCHING_GUID):
772 		return SDCA_CTL_DATATYPE_GUID;
773 	default:
774 		return SDCA_CTL_DATATYPE_IMPDEF;
775 	}
776 }
777 
find_sdca_control_range(struct device * dev,struct fwnode_handle * control_node,struct sdca_control_range * range)778 static int find_sdca_control_range(struct device *dev,
779 				   struct fwnode_handle *control_node,
780 				   struct sdca_control_range *range)
781 {
782 	u8 *range_list;
783 	int num_range;
784 	u16 *limits;
785 	int i;
786 
787 	num_range = fwnode_property_count_u8(control_node, "mipi-sdca-control-range");
788 	if (!num_range || num_range == -EINVAL)
789 		return 0;
790 	else if (num_range < 0)
791 		return num_range;
792 
793 	range_list = devm_kcalloc(dev, num_range, sizeof(*range_list), GFP_KERNEL);
794 	if (!range_list)
795 		return -ENOMEM;
796 
797 	fwnode_property_read_u8_array(control_node, "mipi-sdca-control-range",
798 				      range_list, num_range);
799 
800 	limits = (u16 *)range_list;
801 
802 	range->cols = le16_to_cpu(limits[0]);
803 	range->rows = le16_to_cpu(limits[1]);
804 	range->data = (u32 *)&limits[2];
805 
806 	num_range = (num_range - (2 * sizeof(*limits))) / sizeof(*range->data);
807 	if (num_range != range->cols * range->rows)
808 		return -EINVAL;
809 
810 	for (i = 0; i < num_range; i++)
811 		range->data[i] = le32_to_cpu(range->data[i]);
812 
813 	return 0;
814 }
815 
816 /*
817  * TODO: Add support for -cn- properties, allowing different channels to have
818  * different defaults etc.
819  */
find_sdca_entity_control(struct device * dev,struct sdca_entity * entity,struct fwnode_handle * control_node,struct sdca_control * control)820 static int find_sdca_entity_control(struct device *dev, struct sdca_entity *entity,
821 				    struct fwnode_handle *control_node,
822 				    struct sdca_control *control)
823 {
824 	u32 tmp;
825 	int ret;
826 
827 	ret = fwnode_property_read_u32(control_node, "mipi-sdca-control-access-mode", &tmp);
828 	if (ret) {
829 		dev_err(dev, "%s: control %#x: access mode missing: %d\n",
830 			entity->label, control->sel, ret);
831 		return ret;
832 	}
833 
834 	control->mode = tmp;
835 
836 	ret = fwnode_property_read_u32(control_node, "mipi-sdca-control-access-layer", &tmp);
837 	if (ret) {
838 		dev_err(dev, "%s: control %#x: access layer missing: %d\n",
839 			entity->label, control->sel, ret);
840 		return ret;
841 	}
842 
843 	control->layers = tmp;
844 
845 	switch (control->mode) {
846 	case SDCA_ACCESS_MODE_DC:
847 		ret = fwnode_property_read_u32(control_node,
848 					       "mipi-sdca-control-dc-value",
849 					       &tmp);
850 		if (ret) {
851 			dev_err(dev, "%s: control %#x: dc value missing: %d\n",
852 				entity->label, control->sel, ret);
853 			return ret;
854 		}
855 
856 		control->value = tmp;
857 		control->has_fixed = true;
858 		break;
859 	case SDCA_ACCESS_MODE_RW:
860 	case SDCA_ACCESS_MODE_DUAL:
861 		ret = fwnode_property_read_u32(control_node,
862 					       "mipi-sdca-control-default-value",
863 					       &tmp);
864 		if (!ret) {
865 			control->value = tmp;
866 			control->has_default = true;
867 		}
868 
869 		ret = fwnode_property_read_u32(control_node,
870 					       "mipi-sdca-control-fixed-value",
871 					       &tmp);
872 		if (!ret) {
873 			if (control->has_default && control->value != tmp) {
874 				dev_err(dev,
875 					"%s: control %#x: default and fixed value don't match\n",
876 					entity->label, control->sel);
877 				return -EINVAL;
878 			}
879 
880 			control->value = tmp;
881 			control->has_fixed = true;
882 		}
883 
884 		control->deferrable = fwnode_property_read_bool(control_node,
885 								"mipi-sdca-control-deferrable");
886 		break;
887 	default:
888 		break;
889 	}
890 
891 	ret = find_sdca_control_range(dev, control_node, &control->range);
892 	if (ret) {
893 		dev_err(dev, "%s: control %#x: range missing: %d\n",
894 			entity->label, control->sel, ret);
895 		return ret;
896 	}
897 
898 	ret = fwnode_property_read_u64(control_node, "mipi-sdca-control-cn-list",
899 				       &control->cn_list);
900 	if (ret == -EINVAL) {
901 		/* Spec allows not specifying cn-list if only the first number is used */
902 		control->cn_list = 0x1;
903 	} else if (ret || !control->cn_list) {
904 		dev_err(dev, "%s: control %#x: cn list missing: %d\n",
905 			entity->label, control->sel, ret);
906 		return ret;
907 	}
908 
909 	ret = fwnode_property_read_u32(control_node,
910 				       "mipi-sdca-control-interrupt-position",
911 				       &tmp);
912 	if (!ret)
913 		control->interrupt_position = tmp;
914 
915 	control->label = find_sdca_control_label(dev, entity, control);
916 	if (!control->label)
917 		return -ENOMEM;
918 
919 	control->type = find_sdca_control_datatype(entity, control);
920 	control->nbits = find_sdca_control_bits(entity, control);
921 
922 	dev_info(dev, "%s: %s: control %#x mode %#x layers %#x cn %#llx int %d value %#x %s\n",
923 		 entity->label, control->label, control->sel,
924 		 control->mode, control->layers, control->cn_list,
925 		 control->interrupt_position, control->value,
926 		 control->deferrable ? "deferrable" : "");
927 
928 	return 0;
929 }
930 
find_sdca_entity_controls(struct device * dev,struct fwnode_handle * entity_node,struct sdca_entity * entity)931 static int find_sdca_entity_controls(struct device *dev,
932 				     struct fwnode_handle *entity_node,
933 				     struct sdca_entity *entity)
934 {
935 	struct sdca_control *controls;
936 	int num_controls;
937 	u64 control_list;
938 	int control_sel;
939 	int i, ret;
940 
941 	ret = fwnode_property_read_u64(entity_node, "mipi-sdca-control-list", &control_list);
942 	if (ret == -EINVAL) {
943 		/* Allow missing control lists, assume no controls. */
944 		dev_warn(dev, "%s: missing control list\n", entity->label);
945 		return 0;
946 	} else if (ret) {
947 		dev_err(dev, "%s: failed to read control list: %d\n", entity->label, ret);
948 		return ret;
949 	} else if (!control_list) {
950 		return 0;
951 	}
952 
953 	num_controls = hweight64(control_list);
954 	controls = devm_kcalloc(dev, num_controls, sizeof(*controls), GFP_KERNEL);
955 	if (!controls)
956 		return -ENOMEM;
957 
958 	i = 0;
959 	for_each_set_bit(control_sel, (unsigned long *)&control_list,
960 			 BITS_PER_TYPE(control_list)) {
961 		struct fwnode_handle *control_node;
962 		char control_property[SDCA_PROPERTY_LENGTH];
963 
964 		/* DisCo uses upper-case for hex numbers */
965 		snprintf(control_property, sizeof(control_property),
966 			 "mipi-sdca-control-0x%X-subproperties", control_sel);
967 
968 		control_node = fwnode_get_named_child_node(entity_node, control_property);
969 		if (!control_node) {
970 			dev_err(dev, "%s: control node %s not found\n",
971 				entity->label, control_property);
972 			return -EINVAL;
973 		}
974 
975 		controls[i].sel = control_sel;
976 
977 		ret = find_sdca_entity_control(dev, entity, control_node, &controls[i]);
978 		fwnode_handle_put(control_node);
979 		if (ret)
980 			return ret;
981 
982 		i++;
983 	}
984 
985 	entity->num_controls = num_controls;
986 	entity->controls = controls;
987 
988 	return 0;
989 }
990 
find_sdca_iot_dataport(struct sdca_entity_iot * terminal)991 static bool find_sdca_iot_dataport(struct sdca_entity_iot *terminal)
992 {
993 	switch (terminal->type) {
994 	case SDCA_TERM_TYPE_GENERIC:
995 	case SDCA_TERM_TYPE_ULTRASOUND:
996 	case SDCA_TERM_TYPE_CAPTURE_DIRECT_PCM_MIC:
997 	case SDCA_TERM_TYPE_RAW_PDM_MIC:
998 	case SDCA_TERM_TYPE_SPEECH:
999 	case SDCA_TERM_TYPE_VOICE:
1000 	case SDCA_TERM_TYPE_SECONDARY_PCM_MIC:
1001 	case SDCA_TERM_TYPE_ACOUSTIC_CONTEXT_AWARENESS:
1002 	case SDCA_TERM_TYPE_DTOD_STREAM:
1003 	case SDCA_TERM_TYPE_REFERENCE_STREAM:
1004 	case SDCA_TERM_TYPE_SENSE_CAPTURE:
1005 	case SDCA_TERM_TYPE_STREAMING_MIC:
1006 	case SDCA_TERM_TYPE_OPTIMIZATION_STREAM:
1007 	case SDCA_TERM_TYPE_PDM_RENDER_STREAM:
1008 	case SDCA_TERM_TYPE_COMPANION_DATA:
1009 		return true;
1010 	default:
1011 		return false;
1012 	}
1013 }
1014 
find_sdca_entity_iot(struct device * dev,struct fwnode_handle * entity_node,struct sdca_entity * entity)1015 static int find_sdca_entity_iot(struct device *dev,
1016 				struct fwnode_handle *entity_node,
1017 				struct sdca_entity *entity)
1018 {
1019 	struct sdca_entity_iot *terminal = &entity->iot;
1020 	u32 tmp;
1021 	int ret;
1022 
1023 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-terminal-type", &tmp);
1024 	if (ret) {
1025 		dev_err(dev, "%s: terminal type missing: %d\n", entity->label, ret);
1026 		return ret;
1027 	}
1028 
1029 	terminal->type = tmp;
1030 	terminal->is_dataport = find_sdca_iot_dataport(terminal);
1031 
1032 	ret = fwnode_property_read_u32(entity_node,
1033 				       "mipi-sdca-terminal-reference-number", &tmp);
1034 	if (!ret)
1035 		terminal->reference = tmp;
1036 
1037 	ret = fwnode_property_read_u32(entity_node,
1038 				       "mipi-sdca-terminal-connector-type", &tmp);
1039 	if (!ret)
1040 		terminal->connector = tmp;
1041 
1042 	ret = fwnode_property_read_u32(entity_node,
1043 				       "mipi-sdca-terminal-transducer-count", &tmp);
1044 	if (!ret)
1045 		terminal->num_transducer = tmp;
1046 
1047 	dev_info(dev, "%s: terminal type %#x ref %#x conn %#x count %d\n",
1048 		 entity->label, terminal->type, terminal->reference,
1049 		 terminal->connector, terminal->num_transducer);
1050 
1051 	return 0;
1052 }
1053 
find_sdca_entity_cs(struct device * dev,struct fwnode_handle * entity_node,struct sdca_entity * entity)1054 static int find_sdca_entity_cs(struct device *dev,
1055 			       struct fwnode_handle *entity_node,
1056 			       struct sdca_entity *entity)
1057 {
1058 	struct sdca_entity_cs *clock = &entity->cs;
1059 	u32 tmp;
1060 	int ret;
1061 
1062 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-cs-type", &tmp);
1063 	if (ret) {
1064 		dev_err(dev, "%s: clock type missing: %d\n", entity->label, ret);
1065 		return ret;
1066 	}
1067 
1068 	clock->type = tmp;
1069 
1070 	ret = fwnode_property_read_u32(entity_node,
1071 				       "mipi-sdca-clock-valid-max-delay", &tmp);
1072 	if (!ret)
1073 		clock->max_delay = tmp;
1074 
1075 	dev_info(dev, "%s: clock type %#x delay %d\n", entity->label,
1076 		 clock->type, clock->max_delay);
1077 
1078 	return 0;
1079 }
1080 
find_sdca_entity_pde(struct device * dev,struct fwnode_handle * entity_node,struct sdca_entity * entity)1081 static int find_sdca_entity_pde(struct device *dev,
1082 				struct fwnode_handle *entity_node,
1083 				struct sdca_entity *entity)
1084 {
1085 	static const int mult_delay = 3;
1086 	struct sdca_entity_pde *power = &entity->pde;
1087 	u32 *delay_list __free(kfree) = NULL;
1088 	struct sdca_pde_delay *delays;
1089 	int num_delays;
1090 	int i, j;
1091 
1092 	num_delays = fwnode_property_count_u32(entity_node,
1093 					       "mipi-sdca-powerdomain-transition-max-delay");
1094 	if (num_delays <= 0) {
1095 		dev_err(dev, "%s: max delay list missing: %d\n",
1096 			entity->label, num_delays);
1097 		return -EINVAL;
1098 	} else if (num_delays % mult_delay != 0) {
1099 		dev_err(dev, "%s: delays not multiple of %d\n",
1100 			entity->label, mult_delay);
1101 		return -EINVAL;
1102 	} else if (num_delays > SDCA_MAX_DELAY_COUNT) {
1103 		dev_err(dev, "%s: maximum number of transition delays exceeded\n",
1104 			entity->label);
1105 		return -EINVAL;
1106 	}
1107 
1108 	delay_list = kcalloc(num_delays, sizeof(*delay_list), GFP_KERNEL);
1109 	if (!delay_list)
1110 		return -ENOMEM;
1111 
1112 	fwnode_property_read_u32_array(entity_node,
1113 				       "mipi-sdca-powerdomain-transition-max-delay",
1114 				       delay_list, num_delays);
1115 
1116 	num_delays /= mult_delay;
1117 
1118 	delays = devm_kcalloc(dev, num_delays, sizeof(*delays), GFP_KERNEL);
1119 	if (!delays)
1120 		return -ENOMEM;
1121 
1122 	for (i = 0, j = 0; i < num_delays; i++) {
1123 		delays[i].from_ps = delay_list[j++];
1124 		delays[i].to_ps = delay_list[j++];
1125 		delays[i].us = delay_list[j++];
1126 
1127 		dev_info(dev, "%s: from %#x to %#x delay %dus\n", entity->label,
1128 			 delays[i].from_ps, delays[i].to_ps, delays[i].us);
1129 	}
1130 
1131 	power->num_max_delay = num_delays;
1132 	power->max_delay = delays;
1133 
1134 	return 0;
1135 }
1136 
1137 struct raw_ge_mode {
1138 	u8 val;
1139 	u8 num_controls;
1140 	struct {
1141 		u8 id;
1142 		u8 sel;
1143 		u8 cn;
1144 		__le32 val;
1145 	} __packed controls[] __counted_by(num_controls);
1146 } __packed;
1147 
find_sdca_entity_ge(struct device * dev,struct fwnode_handle * entity_node,struct sdca_entity * entity)1148 static int find_sdca_entity_ge(struct device *dev,
1149 			       struct fwnode_handle *entity_node,
1150 			       struct sdca_entity *entity)
1151 {
1152 	struct sdca_entity_ge *group = &entity->ge;
1153 	u8 *affected_list __free(kfree) = NULL;
1154 	u8 *affected_iter;
1155 	int num_affected;
1156 	int i, j;
1157 
1158 	num_affected = fwnode_property_count_u8(entity_node,
1159 						"mipi-sdca-ge-selectedmode-controls-affected");
1160 	if (!num_affected) {
1161 		return 0;
1162 	} else if (num_affected < 0) {
1163 		dev_err(dev, "%s: failed to read affected controls: %d\n",
1164 			entity->label, num_affected);
1165 		return num_affected;
1166 	} else if (num_affected > SDCA_MAX_AFFECTED_COUNT) {
1167 		dev_err(dev, "%s: maximum affected controls size exceeded\n",
1168 			entity->label);
1169 		return -EINVAL;
1170 	}
1171 
1172 	affected_list = kcalloc(num_affected, sizeof(*affected_list), GFP_KERNEL);
1173 	if (!affected_list)
1174 		return -ENOMEM;
1175 
1176 	fwnode_property_read_u8_array(entity_node,
1177 				      "mipi-sdca-ge-selectedmode-controls-affected",
1178 				      affected_list, num_affected);
1179 
1180 	group->num_modes = *affected_list;
1181 	affected_iter = affected_list + 1;
1182 
1183 	group->modes = devm_kcalloc(dev, group->num_modes, sizeof(*group->modes),
1184 				    GFP_KERNEL);
1185 	if (!group->modes)
1186 		return -ENOMEM;
1187 
1188 	for (i = 0; i < group->num_modes; i++) {
1189 		struct raw_ge_mode *raw = (struct raw_ge_mode *)affected_iter;
1190 		struct sdca_ge_mode *mode = &group->modes[i];
1191 
1192 		affected_iter += sizeof(*raw);
1193 		if (affected_iter > affected_list + num_affected)
1194 			goto bad_list;
1195 
1196 		mode->val = raw->val;
1197 		mode->num_controls = raw->num_controls;
1198 
1199 		affected_iter += mode->num_controls * sizeof(raw->controls[0]);
1200 		if (affected_iter > affected_list + num_affected)
1201 			goto bad_list;
1202 
1203 		mode->controls = devm_kcalloc(dev, mode->num_controls,
1204 					      sizeof(*mode->controls), GFP_KERNEL);
1205 		if (!mode->controls)
1206 			return -ENOMEM;
1207 
1208 		for (j = 0; j < mode->num_controls; j++) {
1209 			mode->controls[j].id = raw->controls[j].id;
1210 			mode->controls[j].sel = raw->controls[j].sel;
1211 			mode->controls[j].cn = raw->controls[j].cn;
1212 			mode->controls[j].val = le32_to_cpu(raw->controls[j].val);
1213 		}
1214 	}
1215 
1216 	return 0;
1217 
1218 bad_list:
1219 	dev_err(dev, "%s: malformed affected controls list\n", entity->label);
1220 	return -EINVAL;
1221 }
1222 
find_sdca_entity(struct device * dev,struct fwnode_handle * function_node,struct fwnode_handle * entity_node,struct sdca_entity * entity)1223 static int find_sdca_entity(struct device *dev,
1224 			    struct fwnode_handle *function_node,
1225 			    struct fwnode_handle *entity_node,
1226 			    struct sdca_entity *entity)
1227 {
1228 	u32 tmp;
1229 	int ret;
1230 
1231 	ret = fwnode_property_read_string(entity_node, "mipi-sdca-entity-label",
1232 					  &entity->label);
1233 	if (ret) {
1234 		dev_err(dev, "%pfwP: entity %#x: label missing: %d\n",
1235 			function_node, entity->id, ret);
1236 		return ret;
1237 	}
1238 
1239 	ret = fwnode_property_read_u32(entity_node, "mipi-sdca-entity-type", &tmp);
1240 	if (ret) {
1241 		dev_err(dev, "%s: type missing: %d\n", entity->label, ret);
1242 		return ret;
1243 	}
1244 
1245 	entity->type = tmp;
1246 
1247 	dev_info(dev, "%s: entity %#x type %#x\n",
1248 		 entity->label, entity->id, entity->type);
1249 
1250 	switch (entity->type) {
1251 	case SDCA_ENTITY_TYPE_IT:
1252 	case SDCA_ENTITY_TYPE_OT:
1253 		ret = find_sdca_entity_iot(dev, entity_node, entity);
1254 		break;
1255 	case SDCA_ENTITY_TYPE_CS:
1256 		ret = find_sdca_entity_cs(dev, entity_node, entity);
1257 		break;
1258 	case SDCA_ENTITY_TYPE_PDE:
1259 		ret = find_sdca_entity_pde(dev, entity_node, entity);
1260 		break;
1261 	case SDCA_ENTITY_TYPE_GE:
1262 		ret = find_sdca_entity_ge(dev, entity_node, entity);
1263 		break;
1264 	default:
1265 		break;
1266 	}
1267 	if (ret)
1268 		return ret;
1269 
1270 	ret = find_sdca_entity_controls(dev, entity_node, entity);
1271 	if (ret)
1272 		return ret;
1273 
1274 	return 0;
1275 }
1276 
find_sdca_entities(struct device * dev,struct fwnode_handle * function_node,struct sdca_function_data * function)1277 static int find_sdca_entities(struct device *dev,
1278 			      struct fwnode_handle *function_node,
1279 			      struct sdca_function_data *function)
1280 {
1281 	u32 *entity_list __free(kfree) = NULL;
1282 	struct sdca_entity *entities;
1283 	int num_entities;
1284 	int i, ret;
1285 
1286 	num_entities = fwnode_property_count_u32(function_node,
1287 						 "mipi-sdca-entity-id-list");
1288 	if (num_entities <= 0) {
1289 		dev_err(dev, "%pfwP: entity id list missing: %d\n",
1290 			function_node, num_entities);
1291 		return -EINVAL;
1292 	} else if (num_entities > SDCA_MAX_ENTITY_COUNT) {
1293 		dev_err(dev, "%pfwP: maximum number of entities exceeded\n",
1294 			function_node);
1295 		return -EINVAL;
1296 	}
1297 
1298 	/* Add 1 to make space for Entity 0 */
1299 	entities = devm_kcalloc(dev, num_entities + 1, sizeof(*entities), GFP_KERNEL);
1300 	if (!entities)
1301 		return -ENOMEM;
1302 
1303 	entity_list = kcalloc(num_entities, sizeof(*entity_list), GFP_KERNEL);
1304 	if (!entity_list)
1305 		return -ENOMEM;
1306 
1307 	fwnode_property_read_u32_array(function_node, "mipi-sdca-entity-id-list",
1308 				       entity_list, num_entities);
1309 
1310 	for (i = 0; i < num_entities; i++)
1311 		entities[i].id = entity_list[i];
1312 
1313 	/* now read subproperties */
1314 	for (i = 0; i < num_entities; i++) {
1315 		char entity_property[SDCA_PROPERTY_LENGTH];
1316 		struct fwnode_handle *entity_node;
1317 
1318 		/* DisCo uses upper-case for hex numbers */
1319 		snprintf(entity_property, sizeof(entity_property),
1320 			 "mipi-sdca-entity-id-0x%X-subproperties", entities[i].id);
1321 
1322 		entity_node = fwnode_get_named_child_node(function_node, entity_property);
1323 		if (!entity_node) {
1324 			dev_err(dev, "%pfwP: entity node %s not found\n",
1325 				function_node, entity_property);
1326 			return -EINVAL;
1327 		}
1328 
1329 		ret = find_sdca_entity(dev, function_node, entity_node, &entities[i]);
1330 		fwnode_handle_put(entity_node);
1331 		if (ret)
1332 			return ret;
1333 	}
1334 
1335 	/*
1336 	 * Add Entity 0 at end of the array, makes it easy to skip during
1337 	 * all the Entity searches involved in creating connections.
1338 	 */
1339 	entities[num_entities].label = "entity0";
1340 
1341 	ret = find_sdca_entity_controls(dev, function_node, &entities[num_entities]);
1342 	if (ret)
1343 		return ret;
1344 
1345 	function->num_entities = num_entities + 1;
1346 	function->entities = entities;
1347 
1348 	return 0;
1349 }
1350 
find_sdca_entity_by_label(struct sdca_function_data * function,const char * entity_label)1351 static struct sdca_entity *find_sdca_entity_by_label(struct sdca_function_data *function,
1352 						     const char *entity_label)
1353 {
1354 	int i;
1355 
1356 	for (i = 0; i < function->num_entities; i++) {
1357 		struct sdca_entity *entity = &function->entities[i];
1358 
1359 		if (!strcmp(entity->label, entity_label))
1360 			return entity;
1361 	}
1362 
1363 	return NULL;
1364 }
1365 
find_sdca_entity_by_id(struct sdca_function_data * function,const int id)1366 static struct sdca_entity *find_sdca_entity_by_id(struct sdca_function_data *function,
1367 						  const int id)
1368 {
1369 	int i;
1370 
1371 	for (i = 0; i < function->num_entities; i++) {
1372 		struct sdca_entity *entity = &function->entities[i];
1373 
1374 		if (entity->id == id)
1375 			return entity;
1376 	}
1377 
1378 	return NULL;
1379 }
1380 
find_sdca_entity_connection_iot(struct device * dev,struct sdca_function_data * function,struct fwnode_handle * entity_node,struct sdca_entity * entity)1381 static int find_sdca_entity_connection_iot(struct device *dev,
1382 					   struct sdca_function_data *function,
1383 					   struct fwnode_handle *entity_node,
1384 					   struct sdca_entity *entity)
1385 {
1386 	struct sdca_entity_iot *terminal = &entity->iot;
1387 	struct fwnode_handle *clock_node;
1388 	struct sdca_entity *clock_entity;
1389 	const char *clock_label;
1390 	int ret;
1391 
1392 	clock_node = fwnode_get_named_child_node(entity_node,
1393 						 "mipi-sdca-terminal-clock-connection");
1394 	if (!clock_node)
1395 		return 0;
1396 
1397 	ret = fwnode_property_read_string(clock_node, "mipi-sdca-entity-label",
1398 					  &clock_label);
1399 	if (ret) {
1400 		dev_err(dev, "%s: clock label missing: %d\n", entity->label, ret);
1401 		fwnode_handle_put(clock_node);
1402 		return ret;
1403 	}
1404 
1405 	clock_entity = find_sdca_entity_by_label(function, clock_label);
1406 	if (!clock_entity) {
1407 		dev_err(dev, "%s: failed to find clock with label %s\n",
1408 			entity->label, clock_label);
1409 		fwnode_handle_put(clock_node);
1410 		return -EINVAL;
1411 	}
1412 
1413 	terminal->clock = clock_entity;
1414 
1415 	dev_info(dev, "%s -> %s\n", clock_entity->label, entity->label);
1416 
1417 	fwnode_handle_put(clock_node);
1418 	return 0;
1419 }
1420 
find_sdca_entity_connection_pde(struct device * dev,struct sdca_function_data * function,struct fwnode_handle * entity_node,struct sdca_entity * entity)1421 static int find_sdca_entity_connection_pde(struct device *dev,
1422 					   struct sdca_function_data *function,
1423 					   struct fwnode_handle *entity_node,
1424 					   struct sdca_entity *entity)
1425 {
1426 	struct sdca_entity_pde *power = &entity->pde;
1427 	u32 *managed_list __free(kfree) = NULL;
1428 	struct sdca_entity **managed;
1429 	int num_managed;
1430 	int i;
1431 
1432 	num_managed = fwnode_property_count_u32(entity_node,
1433 						"mipi-sdca-powerdomain-managed-list");
1434 	if (!num_managed) {
1435 		return 0;
1436 	} else if (num_managed < 0) {
1437 		dev_err(dev, "%s: managed list missing: %d\n", entity->label, num_managed);
1438 		return num_managed;
1439 	} else if (num_managed > SDCA_MAX_ENTITY_COUNT) {
1440 		dev_err(dev, "%s: maximum number of managed entities exceeded\n",
1441 			entity->label);
1442 		return -EINVAL;
1443 	}
1444 
1445 	managed = devm_kcalloc(dev, num_managed, sizeof(*managed), GFP_KERNEL);
1446 	if (!managed)
1447 		return -ENOMEM;
1448 
1449 	managed_list = kcalloc(num_managed, sizeof(*managed_list), GFP_KERNEL);
1450 	if (!managed_list)
1451 		return -ENOMEM;
1452 
1453 	fwnode_property_read_u32_array(entity_node,
1454 				       "mipi-sdca-powerdomain-managed-list",
1455 				       managed_list, num_managed);
1456 
1457 	for (i = 0; i < num_managed; i++) {
1458 		managed[i] = find_sdca_entity_by_id(function, managed_list[i]);
1459 		if (!managed[i]) {
1460 			dev_err(dev, "%s: failed to find entity with id %#x\n",
1461 				entity->label, managed_list[i]);
1462 			return -EINVAL;
1463 		}
1464 
1465 		dev_info(dev, "%s -> %s\n", managed[i]->label, entity->label);
1466 	}
1467 
1468 	power->num_managed = num_managed;
1469 	power->managed = managed;
1470 
1471 	return 0;
1472 }
1473 
find_sdca_entity_connection_ge(struct device * dev,struct sdca_function_data * function,struct fwnode_handle * entity_node,struct sdca_entity * entity)1474 static int find_sdca_entity_connection_ge(struct device *dev,
1475 					  struct sdca_function_data *function,
1476 					  struct fwnode_handle *entity_node,
1477 					  struct sdca_entity *entity)
1478 {
1479 	int i, j;
1480 
1481 	for (i = 0; i < entity->ge.num_modes; i++) {
1482 		struct sdca_ge_mode *mode = &entity->ge.modes[i];
1483 
1484 		for (j = 0; j < mode->num_controls; j++) {
1485 			struct sdca_ge_control *affected = &mode->controls[j];
1486 			struct sdca_entity *managed;
1487 
1488 			managed = find_sdca_entity_by_id(function, affected->id);
1489 			if (!managed) {
1490 				dev_err(dev, "%s: failed to find entity with id %#x\n",
1491 					entity->label, affected->id);
1492 				return -EINVAL;
1493 			}
1494 
1495 			if (managed->group && managed->group != entity) {
1496 				dev_err(dev,
1497 					"%s: entity controlled by two groups %s, %s\n",
1498 					managed->label, managed->group->label,
1499 					entity->label);
1500 				return -EINVAL;
1501 			}
1502 
1503 			managed->group = entity;
1504 		}
1505 	}
1506 
1507 	return 0;
1508 }
1509 
find_sdca_entity_connection(struct device * dev,struct sdca_function_data * function,struct fwnode_handle * entity_node,struct sdca_entity * entity)1510 static int find_sdca_entity_connection(struct device *dev,
1511 				       struct sdca_function_data *function,
1512 				       struct fwnode_handle *entity_node,
1513 				       struct sdca_entity *entity)
1514 {
1515 	struct sdca_entity **pins;
1516 	int num_pins, pin;
1517 	u64 pin_list;
1518 	int i, ret;
1519 
1520 	switch (entity->type) {
1521 	case SDCA_ENTITY_TYPE_IT:
1522 	case SDCA_ENTITY_TYPE_OT:
1523 		ret = find_sdca_entity_connection_iot(dev, function,
1524 						      entity_node, entity);
1525 		break;
1526 	case SDCA_ENTITY_TYPE_PDE:
1527 		ret = find_sdca_entity_connection_pde(dev, function,
1528 						      entity_node, entity);
1529 		break;
1530 	case SDCA_ENTITY_TYPE_GE:
1531 		ret = find_sdca_entity_connection_ge(dev, function,
1532 						     entity_node, entity);
1533 		break;
1534 	default:
1535 		ret = 0;
1536 		break;
1537 	}
1538 	if (ret)
1539 		return ret;
1540 
1541 	ret = fwnode_property_read_u64(entity_node, "mipi-sdca-input-pin-list", &pin_list);
1542 	if (ret == -EINVAL) {
1543 		/* Allow missing pin lists, assume no pins. */
1544 		dev_warn(dev, "%s: missing pin list\n", entity->label);
1545 		return 0;
1546 	} else if (ret) {
1547 		dev_err(dev, "%s: failed to read pin list: %d\n", entity->label, ret);
1548 		return ret;
1549 	} else if (pin_list & BIT(0)) {
1550 		/*
1551 		 * Each bit set in the pin-list refers to an entity_id in this
1552 		 * Function. Entity 0 is an illegal connection since it is used
1553 		 * for Function-level configurations.
1554 		 */
1555 		dev_err(dev, "%s: pin 0 used as input\n", entity->label);
1556 		return -EINVAL;
1557 	} else if (!pin_list) {
1558 		return 0;
1559 	}
1560 
1561 	num_pins = hweight64(pin_list);
1562 	pins = devm_kcalloc(dev, num_pins, sizeof(*pins), GFP_KERNEL);
1563 	if (!pins)
1564 		return -ENOMEM;
1565 
1566 	i = 0;
1567 	for_each_set_bit(pin, (unsigned long *)&pin_list, BITS_PER_TYPE(pin_list)) {
1568 		char pin_property[SDCA_PROPERTY_LENGTH];
1569 		struct fwnode_handle *connected_node;
1570 		struct sdca_entity *connected_entity;
1571 		const char *connected_label;
1572 
1573 		snprintf(pin_property, sizeof(pin_property), "mipi-sdca-input-pin-%d", pin);
1574 
1575 		connected_node = fwnode_get_named_child_node(entity_node, pin_property);
1576 		if (!connected_node) {
1577 			dev_err(dev, "%s: pin node %s not found\n",
1578 				entity->label, pin_property);
1579 			return -EINVAL;
1580 		}
1581 
1582 		ret = fwnode_property_read_string(connected_node, "mipi-sdca-entity-label",
1583 						  &connected_label);
1584 		if (ret) {
1585 			dev_err(dev, "%s: pin %d label missing: %d\n",
1586 				entity->label, pin, ret);
1587 			fwnode_handle_put(connected_node);
1588 			return ret;
1589 		}
1590 
1591 		connected_entity = find_sdca_entity_by_label(function, connected_label);
1592 		if (!connected_entity) {
1593 			dev_err(dev, "%s: failed to find entity with label %s\n",
1594 				entity->label, connected_label);
1595 			fwnode_handle_put(connected_node);
1596 			return -EINVAL;
1597 		}
1598 
1599 		pins[i] = connected_entity;
1600 
1601 		dev_info(dev, "%s -> %s\n", connected_entity->label, entity->label);
1602 
1603 		i++;
1604 		fwnode_handle_put(connected_node);
1605 	}
1606 
1607 	entity->num_sources = num_pins;
1608 	entity->sources = pins;
1609 
1610 	return 0;
1611 }
1612 
find_sdca_connections(struct device * dev,struct fwnode_handle * function_node,struct sdca_function_data * function)1613 static int find_sdca_connections(struct device *dev,
1614 				 struct fwnode_handle *function_node,
1615 				 struct sdca_function_data *function)
1616 {
1617 	int i;
1618 
1619 	/* Entity 0 cannot have connections */
1620 	for (i = 0; i < function->num_entities - 1; i++) {
1621 		struct sdca_entity *entity = &function->entities[i];
1622 		char entity_property[SDCA_PROPERTY_LENGTH];
1623 		struct fwnode_handle *entity_node;
1624 		int ret;
1625 
1626 		/* DisCo uses upper-case for hex numbers */
1627 		snprintf(entity_property, sizeof(entity_property),
1628 			 "mipi-sdca-entity-id-0x%X-subproperties",
1629 			 entity->id);
1630 
1631 		entity_node = fwnode_get_named_child_node(function_node, entity_property);
1632 		if (!entity_node) {
1633 			dev_err(dev, "%pfwP: entity node %s not found\n",
1634 				function_node, entity_property);
1635 			return -EINVAL;
1636 		}
1637 
1638 		ret = find_sdca_entity_connection(dev, function, entity_node, entity);
1639 		fwnode_handle_put(entity_node);
1640 		if (ret)
1641 			return ret;
1642 	}
1643 
1644 	return 0;
1645 }
1646 
find_sdca_cluster_channel(struct device * dev,struct sdca_cluster * cluster,struct fwnode_handle * channel_node,struct sdca_channel * channel)1647 static int find_sdca_cluster_channel(struct device *dev,
1648 				     struct sdca_cluster *cluster,
1649 				     struct fwnode_handle *channel_node,
1650 				     struct sdca_channel *channel)
1651 {
1652 	u32 tmp;
1653 	int ret;
1654 
1655 	ret = fwnode_property_read_u32(channel_node, "mipi-sdca-cluster-channel-id", &tmp);
1656 	if (ret) {
1657 		dev_err(dev, "cluster %#x: missing channel id: %d\n",
1658 			cluster->id, ret);
1659 		return ret;
1660 	}
1661 
1662 	channel->id = tmp;
1663 
1664 	ret = fwnode_property_read_u32(channel_node,
1665 				       "mipi-sdca-cluster-channel-purpose",
1666 				       &tmp);
1667 	if (ret) {
1668 		dev_err(dev, "cluster %#x: channel %#x: missing purpose: %d\n",
1669 			cluster->id, channel->id, ret);
1670 		return ret;
1671 	}
1672 
1673 	channel->purpose = tmp;
1674 
1675 	ret = fwnode_property_read_u32(channel_node,
1676 				       "mipi-sdca-cluster-channel-relationship",
1677 				       &tmp);
1678 	if (ret) {
1679 		dev_err(dev, "cluster %#x: channel %#x: missing relationship: %d\n",
1680 			cluster->id, channel->id, ret);
1681 		return ret;
1682 	}
1683 
1684 	channel->relationship = tmp;
1685 
1686 	dev_info(dev, "cluster %#x: channel id %#x purpose %#x relationship %#x\n",
1687 		 cluster->id, channel->id, channel->purpose, channel->relationship);
1688 
1689 	return 0;
1690 }
1691 
find_sdca_cluster_channels(struct device * dev,struct fwnode_handle * cluster_node,struct sdca_cluster * cluster)1692 static int find_sdca_cluster_channels(struct device *dev,
1693 				      struct fwnode_handle *cluster_node,
1694 				      struct sdca_cluster *cluster)
1695 {
1696 	struct sdca_channel *channels;
1697 	u32 num_channels;
1698 	int i, ret;
1699 
1700 	ret = fwnode_property_read_u32(cluster_node, "mipi-sdca-channel-count",
1701 				       &num_channels);
1702 	if (ret < 0) {
1703 		dev_err(dev, "cluster %#x: failed to read channel list: %d\n",
1704 			cluster->id, ret);
1705 		return ret;
1706 	} else if (num_channels > SDCA_MAX_CHANNEL_COUNT) {
1707 		dev_err(dev, "cluster %#x: maximum number of channels exceeded\n",
1708 			cluster->id);
1709 		return -EINVAL;
1710 	}
1711 
1712 	channels = devm_kcalloc(dev, num_channels, sizeof(*channels), GFP_KERNEL);
1713 	if (!channels)
1714 		return -ENOMEM;
1715 
1716 	for (i = 0; i < num_channels; i++) {
1717 		char channel_property[SDCA_PROPERTY_LENGTH];
1718 		struct fwnode_handle *channel_node;
1719 
1720 		/* DisCo uses upper-case for hex numbers */
1721 		snprintf(channel_property, sizeof(channel_property),
1722 			 "mipi-sdca-channel-%d-subproperties", i + 1);
1723 
1724 		channel_node = fwnode_get_named_child_node(cluster_node, channel_property);
1725 		if (!channel_node) {
1726 			dev_err(dev, "cluster %#x: channel node %s not found\n",
1727 				cluster->id, channel_property);
1728 			return -EINVAL;
1729 		}
1730 
1731 		ret = find_sdca_cluster_channel(dev, cluster, channel_node, &channels[i]);
1732 		fwnode_handle_put(channel_node);
1733 		if (ret)
1734 			return ret;
1735 	}
1736 
1737 	cluster->num_channels = num_channels;
1738 	cluster->channels = channels;
1739 
1740 	return 0;
1741 }
1742 
find_sdca_clusters(struct device * dev,struct fwnode_handle * function_node,struct sdca_function_data * function)1743 static int find_sdca_clusters(struct device *dev,
1744 			      struct fwnode_handle *function_node,
1745 			      struct sdca_function_data *function)
1746 {
1747 	u32 *cluster_list __free(kfree) = NULL;
1748 	struct sdca_cluster *clusters;
1749 	int num_clusters;
1750 	int i, ret;
1751 
1752 	num_clusters = fwnode_property_count_u32(function_node, "mipi-sdca-cluster-id-list");
1753 	if (!num_clusters || num_clusters == -EINVAL) {
1754 		return 0;
1755 	} else if (num_clusters < 0) {
1756 		dev_err(dev, "%pfwP: failed to read cluster id list: %d\n",
1757 			function_node, num_clusters);
1758 		return num_clusters;
1759 	} else if (num_clusters > SDCA_MAX_CLUSTER_COUNT) {
1760 		dev_err(dev, "%pfwP: maximum number of clusters exceeded\n", function_node);
1761 		return -EINVAL;
1762 	}
1763 
1764 	clusters = devm_kcalloc(dev, num_clusters, sizeof(*clusters), GFP_KERNEL);
1765 	if (!clusters)
1766 		return -ENOMEM;
1767 
1768 	cluster_list = kcalloc(num_clusters, sizeof(*cluster_list), GFP_KERNEL);
1769 	if (!cluster_list)
1770 		return -ENOMEM;
1771 
1772 	fwnode_property_read_u32_array(function_node, "mipi-sdca-cluster-id-list",
1773 				       cluster_list, num_clusters);
1774 
1775 	for (i = 0; i < num_clusters; i++)
1776 		clusters[i].id = cluster_list[i];
1777 
1778 	/* now read subproperties */
1779 	for (i = 0; i < num_clusters; i++) {
1780 		char cluster_property[SDCA_PROPERTY_LENGTH];
1781 		struct fwnode_handle *cluster_node;
1782 
1783 		/* DisCo uses upper-case for hex numbers */
1784 		snprintf(cluster_property, sizeof(cluster_property),
1785 			 "mipi-sdca-cluster-id-0x%X-subproperties", clusters[i].id);
1786 
1787 		cluster_node = fwnode_get_named_child_node(function_node, cluster_property);
1788 		if (!cluster_node) {
1789 			dev_err(dev, "%pfwP: cluster node %s not found\n",
1790 				function_node, cluster_property);
1791 			return -EINVAL;
1792 		}
1793 
1794 		ret = find_sdca_cluster_channels(dev, cluster_node, &clusters[i]);
1795 		fwnode_handle_put(cluster_node);
1796 		if (ret)
1797 			return ret;
1798 	}
1799 
1800 	function->num_clusters = num_clusters;
1801 	function->clusters = clusters;
1802 
1803 	return 0;
1804 }
1805 
1806 /**
1807  * sdca_parse_function - parse ACPI DisCo for a Function
1808  * @dev: Pointer to device against which function data will be allocated.
1809  * @function_desc: Pointer to the Function short descriptor.
1810  * @function: Pointer to the Function information, to be populated.
1811  *
1812  * Return: Returns 0 for success.
1813  */
sdca_parse_function(struct device * dev,struct sdca_function_desc * function_desc,struct sdca_function_data * function)1814 int sdca_parse_function(struct device *dev,
1815 			struct sdca_function_desc *function_desc,
1816 			struct sdca_function_data *function)
1817 {
1818 	u32 tmp;
1819 	int ret;
1820 
1821 	function->desc = function_desc;
1822 
1823 	ret = fwnode_property_read_u32(function_desc->node,
1824 				       "mipi-sdca-function-busy-max-delay", &tmp);
1825 	if (!ret)
1826 		function->busy_max_delay = tmp;
1827 
1828 	dev_info(dev, "%pfwP: name %s delay %dus\n", function->desc->node,
1829 		 function->desc->name, function->busy_max_delay);
1830 
1831 	ret = find_sdca_init_table(dev, function_desc->node, function);
1832 	if (ret)
1833 		return ret;
1834 
1835 	ret = find_sdca_entities(dev, function_desc->node, function);
1836 	if (ret)
1837 		return ret;
1838 
1839 	ret = find_sdca_connections(dev, function_desc->node, function);
1840 	if (ret)
1841 		return ret;
1842 
1843 	ret = find_sdca_clusters(dev, function_desc->node, function);
1844 	if (ret < 0)
1845 		return ret;
1846 
1847 	return 0;
1848 }
1849 EXPORT_SYMBOL_NS(sdca_parse_function, "SND_SOC_SDCA");
1850 
1851 MODULE_LICENSE("Dual BSD/GPL");
1852 MODULE_DESCRIPTION("SDCA library");
1853