sr: rename hwplugin functions to sr_thing_action format
[sigrok-cli.git] / sigrok-cli.c
index 07dacfee0f67f75ae8a0a3228d20308df6e60600..06aa053b83793495afebfcb0b9f3f9ad8ac9dad4 100644 (file)
@@ -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
@@ -44,6 +44,7 @@ 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},
@@ -91,7 +94,7 @@ static void show_version(void)
 
        printf("sigrok-cli %s\n\n", VERSION);
        printf("Supported hardware drivers:\n");
-       plugins = sr_list_hwplugins();
+       plugins = sr_hwplugins_list();
        for (p = plugins; p; p = p->next) {
                plugin = p->data;
                printf("  %-20s %s\n", plugin->name, plugin->longname);
@@ -111,23 +114,23 @@ static void show_version(void)
        printf("\n");
 
        /* TODO: Error handling. */
-       srd_init();
+       srd_init(NULL);
 
        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");
 
        srd_exit();
 }
 
-static void print_device_line(struct sr_device *device)
+static void print_device_line(const struct sr_device *device)
 {
-       struct sr_device_instance *sdi;
+       const struct sr_device_instance *sdi;
 
-       sdi = device->plugin->get_device_info(device->plugin_index, SR_DI_INSTANCE);
+       sr_dev_get_info(device, SR_DI_INSTANCE, (const void **)&sdi);
 
        if (sdi->vendor && sdi->vendor[0])
                printf("%s ", sdi->vendor);
@@ -147,7 +150,7 @@ static void show_device_list(void)
        int devcnt;
 
        devcnt = 0;
-       devices = sr_device_list();
+       devices = sr_dev_list();
 
        if (g_slist_length(devices) == 0)
                return;
@@ -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_dev_has_hwcap(device, SR_HWCAP_DEMO_DEVICE)) {
                        demo_device = device;
                        continue;
                }
@@ -173,9 +176,10 @@ static void show_device_detail(void)
 {
        struct sr_device *device;
        struct sr_hwcap_option *hwo;
-       struct sr_samplerates *samplerates;
+       const struct sr_samplerates *samplerates;
        int cap, *capabilities, i;
-       char *s, *title, *charopts, **stropts;
+       char *s, *title;
+       const char *charopts, **stropts;
 
        device = parse_devicestring(opt_device);
        if (!device) {
@@ -185,8 +189,8 @@ static void show_device_detail(void)
 
        print_device_line(device);
 
-       if ((charopts = (char *)device->plugin->get_device_info(
-                       device->plugin_index, SR_DI_TRIGGER_TYPES))) {
+       if (sr_dev_get_info(device, SR_DI_TRIGGER_TYPES,
+                                       (const void **)&charopts) == SR_OK) {
                printf("Supported triggers: ");
                while (*charopts) {
                        printf("%c ", *charopts);
@@ -208,21 +212,19 @@ static void show_device_detail(void)
 
                if (hwo->capability == SR_HWCAP_PATTERN_MODE) {
                        printf("    %s", hwo->shortname);
-                       stropts = (char **)device->plugin->get_device_info(
-                                       device->plugin_index, SR_DI_PATTERNMODES);
-                       if (!stropts) {
+                       if (sr_dev_get_info(device, SR_DI_PATTERNMODES,
+                                       (const void **)&stropts) == SR_OK) {
+                               printf(" - supported modes:\n");
+                               for (i = 0; stropts[i]; i++)
+                                       printf("      %s\n", stropts[i]);
+                       } else {
                                printf("\n");
-                               continue;
                        }
-                       printf(" - supported modes:\n");
-                       for (i = 0; stropts[i]; i++)
-                               printf("      %s\n", stropts[i]);
                } else if (hwo->capability == SR_HWCAP_SAMPLERATE) {
                        printf("    %s", hwo->shortname);
                        /* Supported samplerates */
-                       samplerates = device->plugin->get_device_info(
-                               device->plugin_index, SR_DI_SAMPLERATES);
-                       if (!samplerates) {
+                       if (sr_dev_get_info(device, SR_DI_SAMPLERATES,
+                                       (const void **)&samplerates) != SR_OK) {
                                printf("\n");
                                continue;
                        }
@@ -232,17 +234,17 @@ static void show_device_detail(void)
                                if (!(s = sr_samplerate_string(samplerates->low)))
                                        continue;
                                printf(" (%s", s);
-                               free(s);
+                               g_free(s);
                                /* high */
                                if (!(s = sr_samplerate_string(samplerates->high)))
                                        continue;
                                printf(" - %s", s);
-                               free(s);
+                               g_free(s);
                                /* step */
                                if (!(s = sr_samplerate_string(samplerates->step)))
                                        continue;
                                printf(" in steps of %s)\n", s);
-                               free(s);
+                               g_free(s);
                        } else {
                                printf(" - supported samplerates:\n");
                                for (i = 0; samplerates->list[i]; i++) {
@@ -255,6 +257,38 @@ 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;
@@ -279,7 +313,7 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
        case SR_DF_HEADER:
                g_message("cli: Received SR_DF_HEADER");
                /* Initialize the output module. */
-               if (!(o = malloc(sizeof(struct sr_output)))) {
+               if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
                        printf("Output module malloc failed.\n");
                        exit(1);
                }
@@ -336,7 +370,7 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
                        if (output_len) {
                                if (outfile)
                                        fwrite(output_buf, 1, output_len, outfile);
-                               free(output_buf);
+                               g_free(output_buf);
                                output_len = 0;
                        }
                }
@@ -349,12 +383,11 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
                sr_session_halt();
                if (outfile && outfile != stdout)
                        fclose(outfile);
-               free(o);
+               g_free(o);
                o = NULL;
                break;
        case SR_DF_TRIGGER:
-               g_message("cli: received SR_DF_TRIGGER at %"PRIu64" ms",
-                               packet->timeoffset / 1000000);
+               g_message("cli: received SR_DF_TRIGGER");
                if (o->format->event)
                        o->format->event(o, SR_DF_TRIGGER, &output_buf,
                                         &output_len);
@@ -363,11 +396,7 @@ static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *pac
        case SR_DF_LOGIC:
                logic = packet->payload;
                sample_size = logic->unitsize;
-               g_message("cli: received SR_DF_LOGIC at %f ms duration %f ms, %"PRIu64" bytes",
-                               packet->timeoffset / 1000000.0, packet->duration / 1000000.0,
-                               logic->length);
-               break;
-       case SR_DF_ANALOG:
+               g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
                break;
        }
 
@@ -409,16 +438,16 @@ 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)
-                       abort();
+               if (srd_session_feed(received_samples, (uint8_t*)filter_out,
+                               filter_out_len) != SRD_OK)
+                       sr_session_halt();
        } else {
                output_len = 0;
                if (o->format->data && packet->type == o->format->df_type)
                        o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
                if (output_len) {
                        fwrite(output_buf, 1, output_len, outfile);
-                       free(output_buf);
+                       g_free(output_buf);
                }
        }
 
@@ -428,73 +457,83 @@ 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_opthash;
+       struct srd_decoder_inst *di;
+       char **pdtokens, **pdtok, *pd_name;
 
        /* Avoid compiler warnings. */
        (void)device;
 
+       g_datalist_init(&pd_ann_visible);
        pdtokens = g_strsplit(pdstring, ",", -1);
+       pd_opthash = 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_opthash = 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) {
-                               printf("Setting probe '%s' to %d\n", probe, num);
-                               srd_instance_set_probe(di, probe, num);
-                       } else {
-                               fprintf(stderr, "Error: Couldn't parse decoder "
-                                       "options correctly! Aborting.\n");
-                               /* FIXME: Better error handling. */
-                               exit(EXIT_FAILURE);
-                       }
-               }
-               g_strfreev(optokens);
 
-               /* TODO: Handle errors. */
+               pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
+               g_hash_table_remove(pd_opthash, "sigrok_key");
+               if (!(di = srd_inst_new(pd_name, pd_opthash))) {
+                       fprintf(stderr, "Failed to instantiate PD %s\n", pd_name);
+                       goto err_out;
+               }
+               g_datalist_set_data(&pd_ann_visible, di->inst_id, 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_inst_set_probes(di, pd_opthash) != SRD_OK)
+                       goto err_out;
+               g_hash_table_destroy(pd_opthash);
+               pd_opthash = NULL;
        }
 
+err_out:
        g_strfreev(pdtokens);
+       if (pd_opthash)
+               g_hash_table_destroy(pd_opthash);
+       if (pd_name)
+               g_free(pd_name);
 
        return 0;
 }
 
-void show_pd_annotation(struct srd_protocol_data *pdata)
+void show_pd_annotation(struct srd_proto_data *pdata, void *user_data)
 {
        int i;
-       char **annotation;
+       char **annotations;
 
-       annotation = pdata->data;
-       if (pdata->annotation_format != 0) {
-               /* CLI only shows the default annotation format */
+       /* 'user_data' is not used in this specific callback. */
+       (void)user_data;
+
+       if (pdata->ann_format != 0) {
+               /* CLI only shows the default annotation format. */
+               return;
+       }
+
+       if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->inst_id)) {
+               /* Not in the list of PDs whose annotations we're showing. */
                return;
        }
 
-       printf("%s: ", pdata->pdo->protocol_id);
-       for (i = 0; annotation[i]; i++)
-               printf("\"%s\" ", annotation[i]);
+       annotations = pdata->data;
+       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");
 
 }
@@ -520,10 +559,10 @@ static int select_probes(struct sr_device *device)
 
        for (i = 0; i < max_probes; i++) {
                if (probelist[i]) {
-                       sr_device_probe_name(device, i + 1, probelist[i]);
+                       sr_dev_probe_name(device, i + 1, probelist[i]);
                        g_free(probelist[i]);
                } else {
-                       probe = sr_device_probe_find(device, i + 1);
+                       probe = sr_dev_probe_find(device, i + 1);
                        probe->enabled = FALSE;
                }
        }
@@ -610,7 +649,7 @@ static void load_input_file_format(void)
        }
 
        /* Initialize the input module. */
-       if (!(in = malloc(sizeof(struct sr_input)))) {
+       if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
                printf("Failed to allocate input module.\n");
                exit(1);
        }
@@ -667,10 +706,10 @@ int num_real_devices(void)
        int num_devices;
 
        num_devices = 0;
-       devices = sr_device_list();
+       devices = sr_dev_list();
        for (l = devices; l; l = l->next) {
                device = l->data;
-               if (!strstr(device->plugin->name, "demo"))
+               if (!sr_dev_has_hwcap(device, SR_HWCAP_DEMO_DEVICE))
                        num_devices++;
        }
 
@@ -744,7 +783,7 @@ static void run_session(void)
        struct sr_device *device;
        GHashTable *devargs;
        int num_devices, max_probes, *capabilities, i;
-       uint64_t tmp_u64, time_msec;
+       uint64_t time_msec;
        char **probelist, *devspec;
 
        devargs = NULL;
@@ -794,7 +833,7 @@ static void run_session(void)
 
        if (opt_continuous) {
                capabilities = device->plugin->get_capabilities();
-               if (!sr_find_hwcap(capabilities, SR_HWCAP_CONTINUOUS)) {
+               if (!sr_has_hwcap(capabilities, SR_HWCAP_CONTINUOUS)) {
                        printf("This device does not support continuous sampling.");
                        sr_session_destroy();
                        return;
@@ -811,7 +850,7 @@ static void run_session(void)
                max_probes = g_slist_length(device->probes);
                for (i = 0; i < max_probes; i++) {
                        if (probelist[i]) {
-                               sr_device_trigger_set(device, i + 1, probelist[i]);
+                               sr_dev_trigger_set(device, i + 1, probelist[i]);
                                g_free(probelist[i]);
                        }
                }
@@ -827,7 +866,7 @@ static void run_session(void)
                }
 
                capabilities = device->plugin->get_capabilities();
-               if (sr_find_hwcap(capabilities, SR_HWCAP_LIMIT_MSEC)) {
+               if (sr_has_hwcap(capabilities, SR_HWCAP_LIMIT_MSEC)) {
                        if (device->plugin->set_configuration(device->plugin_index,
                                                          SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
                                printf("Failed to configure time limit.\n");
@@ -840,10 +879,12 @@ static void run_session(void)
                         * convert to samples based on the samplerate.
                         */
                        limit_samples = 0;
-                       if (sr_device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) {
-                               tmp_u64 = *((uint64_t *) device->plugin->get_device_info(
-                                               device->plugin_index, SR_DI_CUR_SAMPLERATE));
-                               limit_samples = tmp_u64 * time_msec / (uint64_t) 1000;
+                       if (sr_dev_has_hwcap(device, SR_HWCAP_SAMPLERATE)) {
+                               const uint64_t *samplerate;
+
+                               sr_dev_get_info(device, SR_DI_CUR_SAMPLERATE,
+                                               (const void **)&samplerate);
+                               limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
                        }
                        if (limit_samples == 0) {
                                printf("Not enough time at this samplerate.\n");
@@ -924,14 +965,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_inst *di_from, *di_to;
+       int i, ret;
+       char *fmtspec, **pds;
 
        g_log_set_default_handler(logger, NULL);
        if (getenv("SIGROK_DEBUG"))
@@ -947,15 +989,15 @@ int main(int argc, char **argv)
        }
 
        /* Set the loglevel (amount of messages to output) for libsigrok. */
-       if (sr_set_loglevel(opt_loglevel) != SR_OK) {
-               fprintf(stderr, "cli: %s: sr_set_loglevel(%d) failed\n",
+       if (sr_log_loglevel_set(opt_loglevel) != SR_OK) {
+               fprintf(stderr, "cli: %s: sr_log_loglevel_set(%d) failed\n",
                        __func__, opt_loglevel);
                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",
+       if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) {
+               fprintf(stderr, "cli: %s: srd_log_loglevel_set(%d) failed\n",
                        __func__, opt_loglevel);
                return 1;
        }
@@ -964,7 +1006,7 @@ int main(int argc, char **argv)
                return 1;
 
        if (opt_pds) {
-               if (srd_init() != SRD_OK) {
+               if (srd_init(NULL) != SRD_OK) {
                        printf("Failed to initialize sigrokdecode\n");
                        return 1;
                }
@@ -972,16 +1014,45 @@ int main(int argc, char **argv)
                        printf("Failed to register protocol decoders\n");
                        return 1;
                }
-               if (srd_register_callback(SRD_OUTPUT_ANNOTATION,
-                               show_pd_annotation) != SRD_OK) {
+               if (srd_register_callback(SRD_OUTPUT_ANN,
+                               show_pd_annotation, NULL) != 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_inst_find_by_id(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_inst_find_by_id(pds[i]))) {
+                               printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
+                               return 1;
+                       }
+                       if ((ret = srd_inst_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->inst_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;
@@ -1022,6 +1093,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));