Tools: Testbench: Add sof-ctl simulation to control scripts

With this change sof-ctl commands can be executed during
sof-testbench4 simulation, e.g.

sof-ctl -c name='Post Mixer Analog Playback IIR Eq bytes' \
-s tools/ctl/ipc4/eq_iir/loudness.txt

No other than switches -c and -s are supported for simulated
sof-ctl. The blob file must be in normal comma separated ASCII
uint32_t numbers format with nothing else in it.

With this change the SOF processing components can be tested
extensively for their controls during simulated audio streaming.

Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Author: singalsu

tools/testbench/include/testbench/utils.h

@@ -23,6 +23,8 @@
 #define TB_MAX_CTL_NAME_CHARS		128
 #define TB_MAX_VOLUME_SIZE		120
 #define TB_MAX_BYTES_DATA_SIZE		8192
+#define TB_MAX_BLOB_NAME_CHARS		128
+#define TB_MAX_BLOB_CONTENT_CHARS	32768
 
 /* number of widgets types supported in testbench */
 #define TB_NUM_WIDGETS_SUPPORTED	16
@@ -159,6 +161,7 @@ int tb_pipeline_reset(struct ipc *ipc, struct pipeline *p);
 int tb_pipeline_start(struct ipc *ipc, struct pipeline *p);
 int tb_pipeline_stop(struct ipc *ipc, struct pipeline *p);
 int tb_read_controls(struct testbench_prm *tp, int64_t *sleep_ns);
+int tb_set_bytes_control(struct testbench_prm *tp, struct tb_ctl *ctl, uint32_t *data);
 int tb_set_enum_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *control_params);
 int tb_set_reset_state(struct testbench_prm *tp);
 int tb_set_mixer_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *control_params);

tools/testbench/utils.c

@@ -9,6 +9,7 @@
 #include <sof/lib/notifier.h>
 
 #include <ctype.h>
+#include <errno.h>
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -388,10 +389,121 @@ static int tb_parse_amixer(struct testbench_prm *tp, char *line)
 	return ret;
 }
 
+static int tb_parse_sofctl(struct testbench_prm *tp, char *line)
+{
+	char control_name[TB_MAX_CTL_NAME_CHARS] = {0};
+	char blob_name[TB_MAX_BLOB_NAME_CHARS] = {0};
+	struct tb_ctl *ctl;
+	uint32_t *blob_bin;
+	char *blob_str;
+	char *end;
+	char *find_ctl_name_str = "-c name=\"";
+	char *find_end_str = "\" ";
+	char *find_set_switch_str = "-s";
+	char *name_str;
+	char *rest;
+	char *token;
+	int copy_len;
+	int find_len = strlen(find_ctl_name_str);
+	int n = 0;
+	int ret = 0;
+	FILE *fh;
+
+	name_str = strstr(line, find_ctl_name_str);
+	if (!name_str) {
+		fprintf(stderr, "error: no control name in script line: %s\n", line);
+		return -EINVAL;
+	}
+
+	end = strstr(&name_str[find_len], find_end_str);
+	if (!end) {
+		fprintf(stderr, "error: no control name end quote in script line: %s\n", line);
+		return -EINVAL;
+	}
+
+	copy_len = end - name_str - find_len;
+	memcpy(control_name, name_str + find_len, copy_len);
+
+	name_str = strstr(line, find_set_switch_str);
+	if (!name_str) {
+		fprintf(stderr, "error: no sof-ctl control set switch in command: %s.\n",
+			line);
+		return -EINVAL;
+	}
+
+	name_str += strlen(find_set_switch_str) + 1;
+	end = line + strlen(line);
+	copy_len = end - name_str;
+	memcpy(blob_name, name_str, copy_len);
+	blob_name[copy_len] = '\0';
+
+	ctl = tb_find_control_by_name(tp, control_name);
+	if (!ctl) {
+		fprintf(stderr, "error: control %s not found in topology.\n", control_name);
+		return -EINVAL;
+	}
+
+	if (ctl->type != SND_SOC_TPLG_TYPE_BYTES) {
+		fprintf(stderr, "error: control %s type %d is not supported.\n",
+			control_name, ctl->type);
+		return -EINVAL;
+	}
+
+	blob_str = malloc(TB_MAX_BLOB_CONTENT_CHARS);
+	if (!blob_str) {
+		fprintf(stderr, "error: failed to allocate memory for blob file content.\n");
+		return -ENOMEM;
+	}
+
+	blob_bin = malloc(TB_MAX_BYTES_DATA_SIZE);
+	if (!blob_bin) {
+		fprintf(stderr, "error: failed to allocate memory for blob data.\n");
+		free(blob_str);
+		return -ENOMEM;
+	}
+
+	printf("Info: Setting control name '%s' to blob '%s'\n", control_name, blob_name);
+	fh = fopen(blob_name, "r");
+	if (!fh) {
+		fprintf(stderr, "error: could not open file.\n");
+		ret = errno;
+		goto err;
+	}
+
+	end = fgets(blob_str, TB_MAX_BLOB_CONTENT_CHARS, fh);
+	fclose(fh);
+	if (!end) {
+		fprintf(stderr, "error: failed to read data from blob file.\n");
+		ret = -ENODATA;
+		goto err;
+	}
+
+	rest = blob_str;
+	while ((token = strtok_r(rest, ",", &rest))) {
+		if (n == TB_MAX_BYTES_DATA_SIZE) {
+			fprintf(stderr, "error: data read exceeds max control data size.\n");
+			ret = -EINVAL;
+			goto err;
+		}
+
+		blob_bin[n] = atoi(token);
+		n++;
+	}
+
+	/* Ignore TLV header from beginning. */
+	ret = tb_set_bytes_control(tp, ctl, &blob_bin[2]);
+
+err:
+	free(blob_str);
+	free(blob_bin);
+	return ret;
+}
+
 int tb_read_controls(struct testbench_prm *tp, int64_t *sleep_ns)
 {
 	char *sleep_cmd = "sleep ";
 	char *amixer_cmd = "amixer ";
+	char *sofctl_cmd = "sof-ctl ";
 	char *raw_line;
 	char *line;
 	int ret = 0;
@@ -411,7 +523,7 @@ int tb_read_controls(struct testbench_prm *tp, int64_t *sleep_ns)
 		if (line[0] == '#' || strlen(line) == 0)
 			continue;
 
-		if (strncmp(line, sleep_cmd, sizeof(*sleep_cmd)) == 0) {
+		if (strncmp(line, sleep_cmd, strlen(sleep_cmd)) == 0) {
 			ret = tb_parse_sleep(line, sleep_ns);
 			if (ret) {
 				fprintf(stderr, "error: failed parse of sleep command.\n");
@@ -420,12 +532,22 @@ int tb_read_controls(struct testbench_prm *tp, int64_t *sleep_ns)
 			break;
 		}
 
-		if (strncmp(line, amixer_cmd, sizeof(*amixer_cmd)) == 0) {
+		if (strncmp(line, amixer_cmd, strlen(amixer_cmd)) == 0) {
 			ret = tb_parse_amixer(tp, line);
 			if (ret) {
 				fprintf(stderr, "error: failed parse of amixer command.\n");
 				break;
 			}
+			continue;
+		}
+
+		if (strncmp(line, sofctl_cmd, strlen(sofctl_cmd)) == 0) {
+			ret = tb_parse_sofctl(tp, line);
+			if (ret) {
+				fprintf(stderr, "error: failed parse of sof-ctl command.\n");
+				break;
+			}
+			continue;
 		}
 	}
 

tools/testbench/utils_ipc3.c

@@ -435,4 +435,9 @@ int tb_set_mixer_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *con
 	return 0;
 }
 
+int tb_set_bytes_control(struct testbench_prm *tp, struct tb_ctl *ctl, uint32_t *data)
+{
+	return 0;
+}
+
 #endif /* CONFIG_IPC_MAJOR_3 */

tools/testbench/utils_ipc4.c

@@ -691,4 +691,11 @@ int tb_set_mixer_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *con
 	return ret;
 }
 
+int tb_set_bytes_control(struct testbench_prm *tp, struct tb_ctl *ctl, uint32_t *data)
+{
+	return tb_send_bytes_data(&tp->ipc_tx, &tp->ipc_rx,
+				  ctl->module_id, ctl->instance_id,
+				  (struct sof_abi_hdr *)data);
+}
+
 #endif /* CONFIG_IPC_MAJOR_4 */