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