X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=decode.c;h=4ddf34afbbaf00db414a041f4ef2e61ddc27bc0f;hp=d27703929fe7d34a7e972627b87a5e0fd7d723e9;hb=HEAD;hpb=69110b5cbe99a54937f108d239592e5afb55d008

diff --git a/decode.c b/decode.c
index d277039..12083a1 100644
--- a/decode.c
+++ b/decode.c
@@ -33,6 +33,10 @@ uint64_t pd_samplerate = 0;
 
 extern struct srd_session *srd_sess;
 
+static const char *keyword_assign = "assign_channels";
+static const char *assign_by_index = "auto_index";
+static const char *assign_by_name = "auto_names";
+
 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
 		GHashTable **options)
 {
@@ -89,7 +93,7 @@ static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
 	return ret;
 }
 
-static int move_hash_element(GHashTable *src, GHashTable *dest, void *key)
+static int move_hash_element(GHashTable *src, GHashTable *dest, const void *key)
 {
 	void *orig_key, *value;
 
@@ -111,6 +115,7 @@ static GHashTable *extract_channel_map(struct srd_decoder *dec, GHashTable *hash
 	channel_map = g_hash_table_new_full(g_str_hash, g_str_equal,
 					  g_free, g_free);
 
+	move_hash_element(hash, channel_map, keyword_assign);
 	for (l = dec->channels; l; l = l->next) {
 		pdch = l->data;
 		move_hash_element(hash, channel_map, pdch->id);
@@ -139,7 +144,7 @@ static int register_pd(char *opt_pds, char *opt_pd_annotations)
 
 	pdtokens = g_strsplit(opt_pds, ",", 0);
 	for (pdtok = pdtokens; *pdtok; pdtok++) {
-		if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
+		if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE, NULL))) {
 			g_critical("Invalid protocol decoder option '%s'.", *pdtok);
 			break;
 		}
@@ -253,11 +258,21 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data)
 	GHashTable *channel_indices;
 	GSList *channel_list;
 	struct srd_decoder_inst *di;
+	struct srd_decoder *pd;
 	GVariant *var;
 	void *channel_id;
 	void *channel_target;
 	struct sr_channel *ch;
 	GHashTableIter iter;
+	enum assign_t {
+		ASSIGN_UNKNOWN,
+		ASSIGN_USER_SPEC,
+		ASSIGN_BY_INDEX,
+		ASSIGN_BY_NAMES,
+	} assign;
+	const char *keyword;
+	GSList *l_pd, *l_pdo, *l_ch;
+	struct srd_channel *pdch;
 
 	channel_map = value;
 	channel_list = user_data;
@@ -271,14 +286,108 @@ static void map_pd_inst_channels(void *key, void *value, void *user_data)
 	channel_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
 					      (GDestroyNotify)g_variant_unref);
 
+	/*
+	 * The typical mode of operation is to apply a user specified
+	 * mapping of sigrok channels to decoder inputs. Lack of mapping
+	 * specs will assign no signals (compatible behaviour to earlier
+	 * implementations).
+	 *
+	 * Alternatively we can assign sigrok logic channels to decoder
+	 * inputs in the strict order of channel indices, or when their
+	 * names match. Users need to request this automatic assignment
+	 * though, because this behaviour differs from earlier versions.
+	 *
+	 * Even more sophisticated heuristics of mapping sigrok channels
+	 * to decoder inputs are not implemented here. Later versions
+	 * could translate the Pulseview approach to the C language, but
+	 * it's better to stabilize that logic first before porting it.
+	 */
+	assign = ASSIGN_USER_SPEC;
+	keyword = g_hash_table_lookup(channel_map, keyword_assign);
+	if (g_hash_table_size(channel_map) != 1) {
+		assign = ASSIGN_USER_SPEC;
+	} else if (!keyword) {
+		assign = ASSIGN_USER_SPEC;
+	} else if (strcmp(keyword, assign_by_index) == 0) {
+		assign = ASSIGN_BY_INDEX;
+	} else if (strcmp(keyword, assign_by_name) == 0) {
+		assign = ASSIGN_BY_NAMES;
+	} else {
+		g_critical("Unknown type of decoder channel assignment: %s.",
+			keyword);
+		return;
+	}
+
+	pd = di->decoder;
+	if (assign == ASSIGN_BY_INDEX) {
+		/*
+		 * Iterate the protocol decoder's list of input signals
+		 * (mandatory and optional, never more than the decoder's
+		 * total channels count). Assign sigrok logic channels
+		 * until either is exhausted. Use sigrok channels in the
+		 * very order of their declaration in the input stream.
+		 */
+		l_ch = channel_list;
+		l_pd = pd->channels;
+		while (l_ch && l_pd) {
+			ch = l_ch->data;
+			l_ch = l_ch->next;
+			if (ch->type != SR_CHANNEL_LOGIC)
+				break;
+			if (ch->index >= di->dec_num_channels)
+				break;
+			pdch = l_pd->data;
+			l_pd = l_pd->next;
+			if (!l_pd)
+				l_pd = pd->opt_channels;
+			/* TODO Emit an INFO message. */
+			g_hash_table_insert(channel_map,
+				g_strdup(pdch->id), g_strdup(ch->name));
+		}
+	} else if (assign == ASSIGN_BY_NAMES) {
+		/*
+		 * Iterate the protocol decoder's list of input signals.
+		 * Search for sigrok logic channels that have matching
+		 * names (case insensitive comparison). Not finding a
+		 * sigrok channel of a given name is non-fatal (could be
+		 * an optional channel, the decoder will check later for
+		 * all mandatory channels to be assigned).
+		 */
+		l_pd = pd->channels;
+		l_pdo = pd->opt_channels;
+		while (l_pd) {
+			pdch = l_pd->data;
+			l_pd = l_pd->next;
+			if (!l_pd) {
+				l_pd = l_pdo;
+				l_pdo = NULL;
+			}
+			ch = find_channel(channel_list, pdch->id, FALSE);
+			if (!ch) {
+				/* TODO Emit a WARN message. */
+				/* if (l_pdo) ...; */
+				continue;
+			}
+			if (ch->type != SR_CHANNEL_LOGIC) {
+				/* TODO Emit a WARN message. */
+				continue;
+			}
+			/* TODO Emit an INFO message. */
+			g_hash_table_insert(channel_map,
+				g_strdup(pdch->id), g_strdup(ch->name));
+		}
+	}
+
 	g_hash_table_iter_init(&iter, channel_map);
 	while (g_hash_table_iter_next(&iter, &channel_id, &channel_target)) {
+		if (strcmp(channel_id, keyword_assign) == 0)
+			continue;
 		if (!channel_target) {
 			g_printerr("cli: Channel name for \"%s\" missing.\n",
 				   (char *)channel_id);
 			continue;
 		}
-		ch = find_channel(channel_list, channel_target);
+		ch = find_channel(channel_list, channel_target, TRUE);
 		if (!ch) {
 			g_printerr("cli: No channel with name \"%s\" found.\n",
 				   (char *)channel_target);
@@ -480,6 +589,147 @@ int setup_pd_binary(char *opt_pd_binary)
 	return 0;
 }
 
+/*
+ * Balance JSON object and array parentheses, and separate array items.
+ * Somewhat convoluted API to re-use the routine for individual items as
+ * well as the surrounding array and object, including deferred start of
+ * the output and late flush (and to keep the state strictly local to the
+ * routine). Some additional complexity due to JSON's inability to handle
+ * a trailing comma at the last item. Code phrased such that text literals
+ * are kept in their order of appearance in the output (where possible).
+ */
+static void jsontrace_open_close(gboolean is_close_req,
+	gboolean open_item, gboolean close_item)
+{
+	static gboolean is_file_open;
+	static gboolean is_item_open;
+
+	if (is_close_req && is_item_open)
+		close_item = TRUE;
+
+	/* Automatic file header, and array item separation. */
+	if (open_item) {
+		if (!is_file_open)
+			printf("{\"traceEvents\": [\n");
+		if (is_item_open) {
+			printf("}");
+			is_item_open = FALSE;
+		}
+		if (is_file_open) {
+			printf(",\n");
+		}
+		is_file_open = TRUE;
+	}
+
+	/* Array item open/append/close. */
+	if (open_item) {
+		printf("{");
+		is_item_open = TRUE;
+	}
+	if (!open_item && !close_item && !is_close_req) {
+		printf(", ");
+		is_item_open = TRUE;
+	}
+	if (close_item) {
+		printf("}");
+		is_item_open = FALSE;
+	}
+
+	/* Automatic file footer on shutdown. */
+	if (is_close_req && is_file_open) {
+		printf("\n");
+		printf("]}\n");
+	}
+	if (is_close_req)
+		is_file_open = FALSE;
+
+	/* Flush at end of lines, or end of file. */
+	if (close_item || is_close_req)
+		fflush(stdout);
+}
+
+/* Convert uint64 sample number to double timestamp in microseconds. */
+static double jsontrace_ts_usec(uint64_t snum)
+{
+	double ts_usec;
+
+	ts_usec = snum;
+	ts_usec *= 1e6;
+	ts_usec /= pd_samplerate;
+	return ts_usec;
+}
+
+/* Emit two Google Trace Events (JSON) for one PD annotation (ss, es). */
+static void jsontrace_annotation(struct srd_decoder *dec,
+	struct srd_proto_data_annotation *pda, struct srd_proto_data *pdata)
+{
+	char *row_text;
+	GSList *lrow, *lcls;
+	struct srd_decoder_annotation_row *row;
+	int cls;
+	char **ann_descr;
+
+	/*
+	 * Search for an annotation row for this index, or use the
+	 * annotation's descriptor.
+	 */
+	row_text = NULL;
+	if (dec->annotation_rows) {
+		for (lrow = dec->annotation_rows; lrow; lrow = lrow->next) {
+			row = lrow->data;
+			for (lcls = row->ann_classes; lcls; lcls = lcls->next) {
+				cls = GPOINTER_TO_INT(lcls->data);
+				if (cls == pda->ann_class) {
+					row_text = row->desc;
+					break;
+				}
+			}
+			if (row_text)
+				break;
+		}
+	}
+	if (!row_text) {
+		ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class);
+		row_text = ann_descr[0];
+	}
+
+	/*
+	 * Emit two Google Trace Events for the start and end times.
+	 * Set the 'pid' (process ID) to the decoder name to group a
+	 * decoder's annotations. Set the 'tid' (thread ID) to the
+	 * annotation row's description. The 'ts' (timestamp) is in
+	 * microseconds. Set 'name' to the longest annotation text.
+	 *
+	 * BEWARE of the unfortunate JSON format limitation, which
+	 * clutters data output calls with format helper calls.
+	 * TODO Want to introduce a cJSON dependency to delegate the
+	 * construction of output text?
+	 */
+	jsontrace_open_close(FALSE, TRUE, FALSE);
+	printf("\"%s\": \"%s\"", "ph", "B");
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": %lf", "ts", jsontrace_ts_usec(pdata->start_sample));
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "pid", pdata->pdo->proto_id);
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "tid", row_text);
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "name", pda->ann_text[0]);
+
+	jsontrace_open_close(FALSE, TRUE, FALSE);
+	printf("\"%s\": \"%s\"", "ph", "E");
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": %lf", "ts", jsontrace_ts_usec(pdata->end_sample));
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "pid", pdata->pdo->proto_id);
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "tid", row_text);
+	jsontrace_open_close(FALSE, FALSE, FALSE);
+	printf("\"%s\": \"%s\"", "name", pda->ann_text[0]);
+
+	jsontrace_open_close(FALSE, FALSE, TRUE);
+}
+
 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 {
 	struct srd_decoder *dec;
@@ -514,6 +764,12 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 	if (!show_ann)
 		return;
 
+	/* Google Trace Events are rather special. Use a separate code path. */
+	if (opt_pd_jsontrace) {
+		jsontrace_annotation(dec, pda, pdata);
+		return;
+	}
+
 	/*
 	 * Determine which fields of the annotation to display. Inspect
 	 * user specified options as well as the verbosity of the log level:
@@ -537,6 +793,8 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 		show_class = TRUE;
 		show_abbrev = TRUE;
 	}
+	if (opt_pd_ann_class)
+		show_class = TRUE;
 
 	/*
 	 * Display the annotation's fields after the layout was
@@ -601,4 +859,16 @@ void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
 	fwrite(pdb->data, pdb->size, 1, stdout);
 	fflush(stdout);
 }
+
+void show_pd_prepare(void)
+{
+	if (opt_pd_jsontrace)
+		jsontrace_open_close(TRUE, FALSE, FALSE);
+}
+
+void show_pd_close(void)
+{
+	if (opt_pd_jsontrace)
+		jsontrace_open_close(TRUE, FALSE, FALSE);
+}
 #endif