main.c

   1 /*
   2  * This file is part of the sigrok-cli project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "sigrok-cli.h"
  21 #include "config.h"
  22 #include <glib.h>
  23
  24 struct sr_context *sr_ctx = NULL;
  25 #ifdef HAVE_SRD
  26 struct srd_session *srd_sess = NULL;
  27 #endif
  28
  29 static gboolean opt_version = FALSE;
  30 gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */
  31 static gboolean opt_scan_devs = FALSE;
  32 gboolean opt_wait_trigger = FALSE;
  33 gchar *opt_input_file = NULL;
  34 gchar *opt_output_file = NULL;
  35 gchar *opt_drv = NULL;
  36 gchar *opt_config = NULL;
  37 static gchar *opt_probes = NULL;
  38 gchar *opt_probe_group = NULL;
  39 gchar *opt_triggers = NULL;
  40 gchar *opt_pds = NULL;
  41 #ifdef HAVE_SRD
  42 static gchar *opt_pd_stack = NULL;
  43 static gchar *opt_pd_annotations = NULL;
  44 static gchar *opt_pd_meta = NULL;
  45 static gchar *opt_pd_binary = NULL;
  46 #endif
  47 gchar *opt_input_format = NULL;
  48 gchar *opt_output_format = NULL;
  49 static gchar *opt_show = NULL;
  50 gchar *opt_time = NULL;
  51 gchar *opt_samples = NULL;
  52 gchar *opt_frames = NULL;
  53 gchar *opt_continuous = NULL;
  54 static gchar *opt_set = NULL;
  55
  56 static GOptionEntry optargs[] = {
  57         {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
  58                         "Show version and support list", NULL},
  59         {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
  60                         "Set loglevel (5 is most verbose)", NULL},
  61         {"driver", 'd', 0, G_OPTION_ARG_STRING, &opt_drv,
  62                         "The driver to use", NULL},
  63         {"config", 'c', 0, G_OPTION_ARG_STRING, &opt_config,
  64                         "Specify device configuration options", NULL},
  65         {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
  66                         "Load input from file", NULL},
  67         {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
  68                         "Input format", NULL},
  69         {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
  70                         "Save output to file", NULL},
  71         {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
  72                         "Output format", NULL},
  73         {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
  74                         "Probes to use", NULL},
  75         {"probe-group", 'g', 0, G_OPTION_ARG_STRING, &opt_probe_group,
  76                         "Probe groups", NULL},
  77         {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
  78                         "Trigger configuration", NULL},
  79         {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
  80                         "Wait for trigger", NULL},
  81 #ifdef HAVE_SRD
  82         {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING, &opt_pds,
  83                         "Protocol decoders to run", NULL},
  84         {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
  85                         "Protocol decoder stack", NULL},
  86         {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
  87                         "Protocol decoder annotation(s) to show", NULL},
  88         {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_STRING, &opt_pd_meta,
  89                         "Protocol decoder meta output to show", NULL},
  90         {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_STRING, &opt_pd_binary,
  91                         "Protocol decoder binary output to show", NULL},
  92 #endif
  93         {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
  94                         "Scan for devices", NULL},
  95         {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
  96                         "Show device detail", NULL},
  97         {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
  98                         "How long to sample (ms)", NULL},
  99         {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
 100                         "Number of samples to acquire", NULL},
 101         {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
 102                         "Number of frames to acquire", NULL},
 103         {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
 104                         "Sample continuously", NULL},
 105         {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
 106         {NULL, 0, 0, 0, NULL, NULL, NULL}
 107 };
 108
 109
 110 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
 111                    const gchar *message, gpointer cb_data)
 112 {
 113         (void)log_domain;
 114         (void)cb_data;
 115
 116         /*
 117          * All messages, warnings, errors etc. go to stderr (not stdout) in
 118          * order to not mess up the CLI tool data output, e.g. VCD output.
 119          */
 120         if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
 121                         || opt_loglevel > SR_LOG_WARN) {
 122                 fprintf(stderr, "%s\n", message);
 123                 fflush(stderr);
 124         }
 125
 126         if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL))
 127                 exit(1);
 128
 129 }
 130
 131 int select_probes(struct sr_dev_inst *sdi)
 132 {
 133         struct sr_probe *probe;
 134         GSList *selected_probes, *l;
 135
 136         if (!opt_probes)
 137                 return SR_OK;
 138
 139         if (!(selected_probes = parse_probestring(sdi, opt_probes)))
 140                 return SR_ERR;
 141
 142         for (l = sdi->probes; l; l = l->next) {
 143                 probe = l->data;
 144                 if (g_slist_find(selected_probes, probe))
 145                         probe->enabled = TRUE;
 146                 else
 147                         probe->enabled = FALSE;
 148         }
 149         g_slist_free(selected_probes);
 150
 151         return SR_OK;
 152 }
 153
 154 static void set_options(void)
 155 {
 156         struct sr_dev_inst *sdi;
 157         GSList *devices;
 158         GHashTable *devargs;
 159
 160         if (!opt_config) {
 161                 g_critical("No setting specified.");
 162                 return;
 163         }
 164
 165         if (!(devargs = parse_generic_arg(opt_config, FALSE)))
 166                 return;
 167
 168         if (!(devices = device_scan())) {
 169                 g_critical("No devices found.");
 170                 return;
 171         }
 172         sdi = devices->data;
 173
 174         if (sr_dev_open(sdi) != SR_OK) {
 175                 g_critical("Failed to open device.");
 176                 return;
 177         }
 178
 179         set_dev_options(sdi, devargs);
 180
 181         sr_dev_close(sdi);
 182         g_slist_free(devices);
 183         g_hash_table_destroy(devargs);
 184
 185 }
 186
 187 int main(int argc, char **argv)
 188 {
 189         GOptionContext *context;
 190         GError *error;
 191         int ret;
 192         char *help;
 193
 194         g_log_set_default_handler(logger, NULL);
 195
 196         context = g_option_context_new(NULL);
 197         g_option_context_add_main_entries(context, optargs, NULL);
 198
 199         ret = 1;
 200         error = NULL;
 201         if (!g_option_context_parse(context, &argc, &argv, &error)) {
 202                 g_critical("%s", error->message);
 203                 goto done;
 204         }
 205
 206         /* Set the loglevel (amount of messages to output) for libsigrok. */
 207         if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
 208                 goto done;
 209
 210         if (sr_init(&sr_ctx) != SR_OK)
 211                 goto done;
 212
 213 #ifdef HAVE_SRD
 214         /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
 215         if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
 216                 goto done;
 217
 218         if (opt_pds) {
 219                 if (srd_init(NULL) != SRD_OK)
 220                         goto done;
 221                 if (srd_session_new(&srd_sess) != SRD_OK) {
 222                         g_critical("Failed to create new decode session.");
 223                         goto done;
 224                 }
 225                 if (register_pds(opt_pds, opt_pd_annotations) != 0)
 226                         goto done;
 227                 if (setup_pd_stack(opt_pds, opt_pd_stack, opt_pd_annotations) != 0)
 228                         goto done;
 229
 230                 /* Only one output type is ever shown. */
 231                 if (opt_pd_binary) {
 232                         if (setup_pd_binary(opt_pd_binary) != 0)
 233                                 goto done;
 234                         if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_BINARY,
 235                                         show_pd_binary, NULL) != SRD_OK)
 236                                 goto done;
 237                 } else if (opt_pd_meta) {
 238                         if (setup_pd_meta(opt_pd_meta) != 0)
 239                                 goto done;
 240                         if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_META,
 241                                         show_pd_meta, NULL) != SRD_OK)
 242                                 goto done;
 243                 } else {
 244                         if (opt_pd_annotations)
 245                                 if (setup_pd_annotations(opt_pd_annotations) != 0)
 246                                         goto done;
 247                         if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_ANN,
 248                                         show_pd_annotations, NULL) != SRD_OK)
 249                                 goto done;
 250                 }
 251         }
 252 #endif
 253
 254         if (setup_output_format() != 0)
 255                 goto done;
 256
 257         if (opt_version)
 258                 show_version();
 259         else if (opt_scan_devs)
 260                 show_dev_list();
 261 #ifdef HAVE_SRD
 262         else if (opt_pds && opt_show)
 263                 show_pd_detail();
 264 #endif
 265         else if (opt_show)
 266                 show_dev_detail();
 267         else if (opt_input_file)
 268                 load_input_file();
 269         else if (opt_set)
 270                 set_options();
 271         else if (opt_samples || opt_time || opt_frames || opt_continuous)
 272                 run_session();
 273         else {
 274                 help = g_option_context_get_help(context, TRUE, NULL);
 275                 printf("%s", help);
 276                 g_free(help);
 277         }
 278
 279 #ifdef HAVE_SRD
 280         if (opt_pds)
 281                 srd_exit();
 282 #endif
 283
 284         ret = 0;
 285
 286 done:
 287         if (sr_ctx)
 288                 sr_exit(sr_ctx);
 289
 290         g_option_context_free(context);
 291
 292         return ret;
 293 }