c07d6cb9ee494742460e0c335701a7f6aea377b7
[sigrok-cli.git] / 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 #include "config.h"
24 #ifdef HAVE_SRD
25 /* First, so we avoid a _POSIX_C_SOURCE warning. */
26 #include <libsigrokdecode/libsigrokdecode.h>
27 #endif
28 #include <libsigrok/libsigrok.h>
29
30 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
31 #define SAVE_CHUNK_SIZE 524288
32
33 /* main.c */
34 int select_channels(struct sr_dev_inst *sdi);
35 gboolean config_key_has_cap(struct sr_dev_driver *driver,
36                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
37                 uint32_t key, uint32_t capability);
38 int maybe_config_get(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_set(struct sr_dev_driver *driver,
42                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
43                 uint32_t key, GVariant *gvar);
44 int maybe_config_list(struct sr_dev_driver *driver,
45                 const struct sr_dev_inst *sdi, struct sr_channel_group *cg,
46                 uint32_t key, GVariant **gvar);
47
48 /* show.c */
49 void show_version(void);
50 void show_dev_list(void);
51 void show_dev_detail(void);
52 void show_pd_detail(void);
53 void show_input(void);
54 void show_output(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 void save_chunk_logic(struct sr_session *session, uint8_t *data,
67                 uint64_t data_len, int unitsize);
68
69 /* input.c */
70 void load_input_file(void);
71
72 /* decode.c */
73 #ifdef HAVE_SRD
74 int register_pds(const char *opt_pds, char *opt_pd_annotations);
75 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations);
76 int setup_pd_annotations(char *opt_pd_annotations);
77 int setup_pd_meta(char *opt_pd_meta);
78 int setup_pd_binary(char *opt_pd_binary);
79 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
80 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
81 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
82 void map_pd_channels(struct sr_dev_inst *sdi);
83 #endif
84
85 /* parsers.c */
86 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
87 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
88 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
89                 struct sr_trigger **trigger);
90 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
91 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
92 int canon_cmp(const char *str1, const char *str2);
93 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
94
95 /* anykey.c */
96 void add_anykey(struct sr_session *session);
97 void clear_anykey(void);
98
99 /* options.c */
100 extern gboolean opt_version;
101 extern gint opt_loglevel;
102 extern gboolean opt_scan_devs;
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_stack;
114 extern gchar *opt_pd_annotations;
115 extern gchar *opt_pd_meta;
116 extern gchar *opt_pd_binary;
117 #endif
118 extern gchar *opt_input_format;
119 extern gchar *opt_output_format;
120 extern gchar *opt_show;
121 extern gchar *opt_time;
122 extern gchar *opt_samples;
123 extern gchar *opt_frames;
124 extern gchar *opt_continuous;
125 extern gchar *opt_get;
126 extern gchar *opt_set;
127 int parse_options(int argc, char **argv);
128 void show_help(void);
129
130 #endif