sigrok-cli.h

   1 /*
   2  * This file is part of the sigrok-cli project.
   3  *
   4  * Copyright (C) 2011 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 #ifndef SIGROK_CLI_SIGROK_CLI_H
  21 #define SIGROK_CLI_SIGROK_CLI_H
  22
  23 #ifdef HAVE_SRD
  24 /* First, so we avoid a _POSIX_C_SOURCE warning. */
  25 #include <libsigrokdecode/libsigrokdecode.h>
  26 #endif
  27 #include <libsigrok/libsigrok.h>
  28
  29 #define DEFAULT_OUTPUT_FORMAT_FILE "srzip"
  30 #define DEFAULT_OUTPUT_FORMAT_NOFILE "bits:width=64"
  31
  32 /* main.c */
  33 extern struct sr_context *sr_ctx;
  34 int select_channels(struct sr_dev_inst *sdi);
  35 int maybe_config_get(struct sr_dev_driver *driver,
  36                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  37                 uint32_t key, GVariant **gvar);
  38 int maybe_config_set(struct sr_dev_driver *driver,
  39                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  40                 uint32_t key, GVariant *gvar);
  41 int maybe_config_list(struct sr_dev_driver *driver,
  42                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  43                 uint32_t key, GVariant **gvar);
  44
  45 /* show.c */
  46 void show_version(void);
  47 void show_supported(void);
  48 void show_supported_wiki(void);
  49 void show_dev_list(void);
  50 void show_dev_detail(void);
  51 void show_pd_detail(void);
  52 void show_input(void);
  53 void show_output(void);
  54 void show_transform(void);
  55
  56 /* device.c */
  57 GSList *device_scan(void);
  58 struct sr_channel_group *select_channel_group(struct sr_dev_inst *sdi);
  59
  60 /* session.c */
  61 void datafeed_in(const struct sr_dev_inst *sdi,
  62                 const struct sr_datafeed_packet *packet, void *cb_data);
  63 int opt_to_gvar(char *key, char *value, struct sr_config *src);
  64 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
  65 void run_session(void);
  66
  67 /* input.c */
  68 void load_input_file(void);
  69
  70 /* decode.c */
  71 #ifdef HAVE_SRD
  72 int register_pds(gchar **all_pds, char *opt_pd_annotations);
  73 int setup_pd_annotations(char *opt_pd_annotations);
  74 int setup_pd_meta(char *opt_pd_meta);
  75 int setup_pd_binary(char *opt_pd_binary);
  76 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
  77 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
  78 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
  79 void map_pd_channels(struct sr_dev_inst *sdi);
  80 #endif
  81
  82 /* parsers.c */
  83 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
  84 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
  85 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
  86                 struct sr_trigger **trigger);
  87 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
  88 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
  89 int canon_cmp(const char *str1, const char *str2);
  90 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
  91
  92 /* anykey.c */
  93 void add_anykey(struct sr_session *session);
  94 void clear_anykey(void);
  95
  96 /* options.c */
  97 extern gboolean opt_version;
  98 extern gboolean opt_list_supported;
  99 extern gboolean opt_list_supported_wiki;
 100 extern gint opt_loglevel;
 101 extern gboolean opt_scan_devs;
 102 extern gboolean opt_dont_scan;
 103 extern gboolean opt_wait_trigger;
 104 extern gchar *opt_input_file;
 105 extern gchar *opt_output_file;
 106 extern gchar *opt_drv;
 107 extern gchar *opt_config;
 108 extern gchar *opt_channels;
 109 extern gchar *opt_channel_group;
 110 extern gchar *opt_triggers;
 111 extern gchar **opt_pds;
 112 #ifdef HAVE_SRD
 113 extern gchar *opt_pd_annotations;
 114 extern gchar *opt_pd_meta;
 115 extern gchar *opt_pd_binary;
 116 extern gboolean opt_pd_samplenum;
 117 #endif
 118 extern gchar *opt_input_format;
 119 extern gchar *opt_output_format;
 120 extern gchar *opt_transform_module;
 121 extern gboolean opt_show;
 122 extern gchar *opt_time;
 123 extern gchar *opt_samples;
 124 extern gchar *opt_frames;
 125 extern gboolean opt_continuous;
 126 extern gchar *opt_get;
 127 extern gboolean opt_set;
 128 int parse_options(int argc, char **argv);
 129 void show_help(void);
 130
 131 #endif