X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=sigrok-cli.c;h=07800d2ddd37db760971cb52ffbafa8468564738;hp=1ca2c090eea331bba58938c489cbdbf121c4d3f8;hb=110aa72a47c771ef57e358f0df361451270f3710;hpb=43e5747a59ed92243c217f7e36da2ac35bbcd80d

diff --git a/sigrok-cli.c b/sigrok-cli.c
index 1ca2c09..07800d2 100644
--- a/sigrok-cli.c
+++ b/sigrok-cli.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of the sigrok project.
  *
- * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -38,12 +38,13 @@
 
 extern struct sr_hwcap_option sr_hwcap_options[];
 
-gboolean debug = 0;
-uint64_t limit_samples = 0;
-struct sr_output_format *output_format = NULL;
-int default_output_format = FALSE;
-char *output_format_param = NULL;
-char *input_format_param = NULL;
+static gboolean debug = 0;
+static uint64_t limit_samples = 0;
+static struct sr_output_format *output_format = NULL;
+static int default_output_format = FALSE;
+static char *output_format_param = NULL;
+static char *input_format_param = NULL;
+static GData *pd_ann_visible = NULL;
 
 static gboolean opt_version = FALSE;
 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
@@ -55,6 +56,7 @@ static gchar *opt_device = NULL;
 static gchar *opt_probes = NULL;
 static gchar *opt_triggers = NULL;
 static gchar *opt_pds = NULL;
+static gchar *opt_pd_stack = NULL;
 static gchar *opt_input_format = NULL;
 static gchar *opt_format = NULL;
 static gchar *opt_time = NULL;
@@ -72,6 +74,7 @@ static GOptionEntry optargs[] = {
 	{"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL},
 	{"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL},
 	{"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoder sequence", NULL},
+	{"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL},
 	{"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL},
 	{"format", 'f', 0, G_OPTION_ARG_STRING, &opt_format, "Output format", NULL},
 	{"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL},
@@ -116,7 +119,7 @@ static void show_version(void)
 	printf("Supported protocol decoders:\n");
 	for (l = srd_list_decoders(); l; l = l->next) {
 		dec = l->data;
-		printf("  %-20s %s\n", dec->id, dec->desc);
+		printf("  %-20s %s\n", dec->id, dec->longname);
 	}
 	printf("\n");
 
@@ -156,7 +159,7 @@ static void show_device_list(void)
 	demo_device = NULL;
 	for (l = devices; l; l = l->next) {
 		device = l->data;
-		if (strstr(device->plugin->name, "demo")) {
+		if (sr_device_has_hwcap(device, SR_HWCAP_DEMO_DEVICE)) {
 			demo_device = device;
 			continue;
 		}
@@ -255,10 +258,42 @@ static void show_device_detail(void)
 	}
 }
 
+static void show_pd_detail(void)
+{
+	GSList *l;
+	struct srd_decoder *dec;
+	char **pdtokens, **pdtok, **ann, *doc;
+
+	pdtokens = g_strsplit(opt_pds, ",", -1);
+	for (pdtok = pdtokens; *pdtok; pdtok++) {
+		if (!(dec = srd_get_decoder_by_id(*pdtok))) {
+			printf("Protocol decoder %s not found.", *pdtok);
+			return;
+		}
+		printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
+				dec->id, dec->name, dec->longname, dec->desc);
+		printf("License: %s\n", dec->license);
+		if (dec->annotations) {
+			printf("Annotations:\n");
+			for (l = dec->annotations; l; l = l->next) {
+				ann = l->data;
+				printf("- %s\n  %s\n", ann[0], ann[1]);
+			}
+		}
+		if ((doc = srd_decoder_doc(dec))) {
+			printf("Documentation:\n%s\n", doc[0] == '\n' ? doc+1 : doc);
+			g_free(doc);
+		}
+	}
+
+	g_strfreev(pdtokens);
+
+}
+
 static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *packet)
 {
 	static struct sr_output *o = NULL;
-	static int probelist[65] = { 0 };
+	static int probelist[SR_MAX_NUM_PROBES] = { 0 };
 	static uint64_t received_samples = 0;
 	static int unitsize = 0;
 	static int triggered = 0;
@@ -322,8 +357,8 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
 			}
 		}
 		if (opt_pds)
-			srd_session_start(device->plugin->name, unitsize, 
-					  time(NULL), header->samplerate);
+			srd_session_start(num_enabled_probes, unitsize,
+					header->samplerate);
 		break;
 	case SR_DF_END:
 		g_message("cli: Received SR_DF_END");
@@ -409,8 +444,8 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
 		goto cleanup;
 
 	if (opt_pds) {
-		if (srd_session_feed(packet->timeoffset, packet->duration,
-				(uint8_t*)filter_out, filter_out_len) != SRD_OK)
+		if (srd_session_feed(received_samples, (uint8_t*)filter_out,
+				filter_out_len) != SRD_OK)
 			abort();
 	} else {
 		output_len = 0;
@@ -428,53 +463,82 @@ cleanup:
 
 }
 
-/* Register the given PDs for this session. */
-/* Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5" 
+/* Register the given PDs for this session.
+ * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
  * That will instantiate two SPI decoders on the clock but different data
  * lines.
  */
-/* TODO: Support both serial PDs and nested PDs. Parallel PDs even? */
-/* TODO: Only register here, run in streaming fashion later/elsewhere. */
 static int register_pds(struct sr_device *device, const char *pdstring)
 {
-	char **pdtokens, **pdtok;
+	GHashTable *pd;
+	struct srd_decoder_instance *di;
+	char **pdtokens, **pdtok, *pd_name;
 
 	/* Avoid compiler warnings. */
 	(void)device;
 
+	g_datalist_init(&pd_ann_visible);
 	pdtokens = g_strsplit(pdstring, ",", -1);
+	pd = NULL;
+	pd_name = NULL;
 
 	for (pdtok = pdtokens; *pdtok; pdtok++) {
-		struct srd_decoder_instance *di;
-
-		/* Configure probes from command line */
-		char **optokens, **optok;
-		optokens = g_strsplit(*pdtok, ":", -1);
-		di = srd_instance_new(optokens[0]);
-		if(!di) {
-			fprintf(stderr, "Failed to instantiate PD: %s\n",
-					optokens[0]);
-			g_strfreev(optokens);
-			g_strfreev(pdtokens);
-			return -1;
+		if (!(pd = parse_generic_arg(*pdtok))) {
+			fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
+			goto err_out;
 		}
-		for (optok = optokens+1; *optok; optok++) {
-			char probe[strlen(*optok)];
-			int num;
-			if(sscanf(*optok, "%[^=]=%d", probe, &num) == 2)
-				srd_instance_set_probe(di, probe, num);
-				/* TODO: else fail somehow */
-		}
-		g_strfreev(optokens);
 
-		/* TODO: Handle errors. */
+		pd_name = g_strdup(g_hash_table_lookup(pd, "sigrok_key"));
+		g_hash_table_remove(pd, "sigrok_key");
+		if (!(di = srd_instance_new(pd_name, pd))) {
+			fprintf(stderr, "Failed to instantiate PD %s\n", pd_name);
+			goto err_out;
+		}
+		g_datalist_set_data(&pd_ann_visible, pd_name, pd_name);
 	}
 
+	/* Any keys left in the options hash are probes, where the key
+	 * is the probe name as specified in the decoder class, and the
+	 * value is the probe number i.e. the order in which the PD's
+	 * incoming samples are arranged. */
+	if (srd_instance_set_probes(di, pd) != SRD_OK)
+		return 1;
+
+err_out:
 	g_strfreev(pdtokens);
+	if (pd)
+		g_hash_table_destroy(pd);
+	if (pd_name)
+		g_free(pd_name);
 
 	return 0;
 }
 
+void show_pd_annotation(struct srd_proto_data *pdata)
+{
+	int i;
+	char **annotations;
+
+	annotations = pdata->data;
+	if (pdata->ann_format != 0) {
+		/* CLI only shows the default annotation format */
+		return;
+	}
+
+	if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->proto_id)) {
+		/* not in the list of PDs whose annotations we're showing */
+		return;
+	}
+
+	if (opt_loglevel > SR_LOG_WARN)
+		printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
+	printf("%s: ", pdata->pdo->proto_id);
+	for (i = 0; annotations[i]; i++)
+		printf("\"%s\" ", annotations[i]);
+	printf("\n");
+
+}
+
 static int select_probes(struct sr_device *device)
 {
 	struct sr_probe *probe;
@@ -646,14 +710,14 @@ int num_real_devices(void)
 	devices = sr_device_list();
 	for (l = devices; l; l = l->next) {
 		device = l->data;
-		if (!strstr(device->plugin->name, "demo"))
+		if (!sr_device_has_hwcap(device, SR_HWCAP_DEMO_DEVICE))
 			num_devices++;
 	}
 
 	return num_devices;
 }
 
-int set_device_options(struct sr_device *device, GHashTable *args)
+static int set_device_options(struct sr_device *device, GHashTable *args)
 {
 	GHashTableIter iter;
 	gpointer key, value;
@@ -900,14 +964,15 @@ static void logger(const gchar *log_domain, GLogLevelFlags log_level,
 
 int main(int argc, char **argv)
 {
-	struct sr_output_format **outputs;
 	GOptionContext *context;
 	GError *error;
 	GHashTable *fmtargs;
 	GHashTableIter iter;
 	gpointer key, value;
-	int i;
-	char *fmtspec;
+	struct sr_output_format **outputs;
+	struct srd_decoder_instance *di_from, *di_to;
+	int i, ret;
+	char *fmtspec, **pds;
 
 	g_log_set_default_handler(logger, NULL);
 	if (getenv("SIGROK_DEBUG"))
@@ -929,18 +994,64 @@ int main(int argc, char **argv)
 		return 1;
 	}
 
+	/* Set the loglevel (amount of messages to output) for libsigrokdecode. */
+	if (srd_set_loglevel(opt_loglevel) != SRD_OK) {
+		fprintf(stderr, "cli: %s: srd_set_loglevel(%d) failed\n",
+			__func__, opt_loglevel);
+		return 1;
+	}
+
 	if (sr_init() != SR_OK)
 		return 1;
 
 	if (opt_pds) {
-		/* TODO: Error handling. */
-		srd_init();
-		register_pds(NULL, opt_pds);
+		if (srd_init() != SRD_OK) {
+			printf("Failed to initialize sigrokdecode\n");
+			return 1;
+		}
+		if (register_pds(NULL, opt_pds) != 0) {
+			printf("Failed to register protocol decoders\n");
+			return 1;
+		}
+		if (srd_register_callback(SRD_OUTPUT_ANN,
+				show_pd_annotation) != SRD_OK) {
+			printf("Failed to register protocol decoder callback\n");
+			return 1;
+		}
+	}
+
+	if (opt_pd_stack) {
+		pds = g_strsplit(opt_pd_stack, ":", 0);
+		if (g_strv_length(pds) < 2) {
+			printf("Specify at least two protocol decoders to stack.\n");
+			return 1;
+		}
+
+		if (!(di_from = srd_instance_find(pds[0]))) {
+			printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[0]);
+			return 1;
+		}
+		for (i = 1; pds[i]; i++) {
+			if (!(di_to = srd_instance_find(pds[i]))) {
+				printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
+				return 1;
+			}
+			if ((ret = srd_instance_stack(di_from, di_to) != SRD_OK))
+				return ret;
+
+			/* Don't show annotation from this PD. Only the last PD in
+			 * the stack will be left on the annotation list.
+			 */
+			g_datalist_remove_data(&pd_ann_visible, di_from->instance_id);
+
+			di_from = di_to;
+		}
+		g_strfreev(pds);
 	}
 
 	if (!opt_format) {
 		opt_format = DEFAULT_OUTPUT_FORMAT;
-		/* we'll need to remember this, so when saving to an file
+		/* we'll need to remember this so when saving to a file
 		 * later, sigrok session format will be used.
 		 */
 		default_output_format = TRUE;
@@ -981,6 +1092,8 @@ int main(int argc, char **argv)
 		run_session();
 	else if (opt_device)
 		show_device_detail();
+	else if (opt_pds)
+		show_pd_detail();
 	else
 		printf("%s", g_option_context_get_help(context, TRUE, NULL));