37746e3b8b25c3a38d09ecbe0b2e5fa22c7a0cfc
[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 #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 struct df_arg_desc {
62         struct sr_session *session;
63         int do_props;
64         struct input_stream_props {
65                 uint64_t samplerate;
66                 GSList *channels;
67                 const struct sr_channel *first_analog_channel;
68                 size_t unitsize;
69                 uint64_t sample_count_logic;
70                 uint64_t sample_count_analog;
71                 uint64_t frame_count;
72                 uint64_t triggered;
73         } props;
74 };
75 void datafeed_in(const struct sr_dev_inst *sdi,
76                 const struct sr_datafeed_packet *packet, void *cb_data);
77 int opt_to_gvar(char *key, char *value, struct sr_config *src);
78 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
79 void run_session(void);
80
81 /* input.c */
82 void load_input_file(gboolean do_props);
83
84 /* decode.c */
85 #ifdef HAVE_SRD
86 int register_pds(gchar **all_pds, char *opt_pd_annotations);
87 int setup_pd_annotations(char *opt_pd_annotations);
88 int setup_pd_meta(char *opt_pd_meta);
89 int setup_pd_binary(char *opt_pd_binary);
90 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
91 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
92 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
93 void map_pd_channels(struct sr_dev_inst *sdi);
94 #endif
95
96 /* parsers.c */
97 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
98 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
99 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
100                 struct sr_trigger **trigger);
101 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
102 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
103 int canon_cmp(const char *str1, const char *str2);
104 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
105
106 /* anykey.c */
107 void add_anykey(struct sr_session *session);
108 void clear_anykey(void);
109
110 /* options.c */
111 extern gboolean opt_version;
112 extern gboolean opt_list_supported;
113 extern gboolean opt_list_supported_wiki;
114 extern gint opt_loglevel;
115 extern gboolean opt_scan_devs;
116 extern gboolean opt_dont_scan;
117 extern gboolean opt_wait_trigger;
118 extern gchar *opt_input_file;
119 extern gchar *opt_output_file;
120 extern gchar *opt_drv;
121 extern gchar *opt_config;
122 extern gchar *opt_channels;
123 extern gchar *opt_channel_group;
124 extern gchar *opt_triggers;
125 extern gchar **opt_pds;
126 #ifdef HAVE_SRD
127 extern gchar *opt_pd_annotations;
128 extern gchar *opt_pd_meta;
129 extern gchar *opt_pd_binary;
130 extern gboolean opt_pd_samplenum;
131 #endif
132 extern gchar *opt_input_format;
133 extern gchar *opt_output_format;
134 extern gchar *opt_transform_module;
135 extern gboolean opt_show;
136 extern gchar *opt_time;
137 extern gchar *opt_samples;
138 extern gchar *opt_frames;
139 extern gboolean opt_continuous;
140 extern gchar *opt_get;
141 extern gboolean opt_set;
142 int parse_options(int argc, char **argv);
143 void show_help(void);
144
145 #endif