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 #define SAVE_CHUNK_SIZE (512 * 1024)
  32
  33 /* main.c */
  34 extern struct sr_context *sr_ctx;
  35 int select_channels(struct sr_dev_inst *sdi);
  36 gboolean config_key_has_cap(struct sr_dev_driver *driver,
  37                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  38                 uint32_t key, uint32_t capability);
  39 int maybe_config_get(struct sr_dev_driver *driver,
  40                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  41                 uint32_t key, GVariant **gvar);
  42 int maybe_config_set(struct sr_dev_driver *driver,
  43                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  44                 uint32_t key, GVariant *gvar);
  45 int maybe_config_list(struct sr_dev_driver *driver,
  46                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
  47                 uint32_t key, GVariant **gvar);
  48
  49 /* show.c */
  50 void show_version(void);
  51 void show_supported(void);
  52 void show_dev_list(void);
  53 void show_dev_detail(void);
  54 void show_pd_detail(void);
  55 void show_input(void);
  56 void show_output(void);
  57 void show_transform(void);
  58
  59 /* device.c */
  60 GSList *device_scan(void);
  61 struct sr_channel_group *select_channel_group(struct sr_dev_inst *sdi);
  62
  63 /* session.c */
  64 void datafeed_in(const struct sr_dev_inst *sdi,
  65                 const struct sr_datafeed_packet *packet, void *cb_data);
  66 int opt_to_gvar(char *key, char *value, struct sr_config *src);
  67 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
  68 void run_session(void);
  69 void save_chunk_logic(struct sr_session *session, uint8_t *data,
  70                 uint64_t data_len, int unitsize);
  71
  72 /* input.c */
  73 void load_input_file(void);
  74
  75 /* decode.c */
  76 #ifdef HAVE_SRD
  77 int register_pds(gchar **all_pds, char *opt_pd_annotations);
  78 int setup_pd_annotations(char *opt_pd_annotations);
  79 int setup_pd_meta(char *opt_pd_meta);
  80 int setup_pd_binary(char *opt_pd_binary);
  81 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
  82 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
  83 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
  84 void map_pd_channels(struct sr_dev_inst *sdi);
  85 #endif
  86
  87 /* parsers.c */
  88 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
  89 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
  90 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
  91                 struct sr_trigger **trigger);
  92 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
  93 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
  94 int canon_cmp(const char *str1, const char *str2);
  95 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
  96
  97 /* anykey.c */
  98 void add_anykey(struct sr_session *session);
  99 void clear_anykey(void);
 100
 101 /* options.c */
 102 extern gboolean opt_version;
 103 extern gboolean opt_list_supported;
 104 extern gint opt_loglevel;
 105 extern gboolean opt_scan_devs;
 106 extern gboolean opt_wait_trigger;
 107 extern gchar *opt_input_file;
 108 extern gchar *opt_output_file;
 109 extern gchar *opt_drv;
 110 extern gchar *opt_config;
 111 extern gchar *opt_channels;
 112 extern gchar *opt_channel_group;
 113 extern gchar *opt_triggers;
 114 extern gchar **opt_pds;
 115 #ifdef HAVE_SRD
 116 extern gchar *opt_pd_annotations;
 117 extern gchar *opt_pd_meta;
 118 extern gchar *opt_pd_binary;
 119 #endif
 120 extern gchar *opt_input_format;
 121 extern gchar *opt_output_format;
 122 extern gchar *opt_transform_module;
 123 extern gboolean opt_show;
 124 extern gchar *opt_time;
 125 extern gchar *opt_samples;
 126 extern gchar *opt_frames;
 127 extern gboolean opt_continuous;
 128 extern gchar *opt_get;
 129 extern gboolean opt_set;
 130 int parse_options(int argc, char **argv);
 131 void show_help(void);
 132
 133 #endif