Add -T|--transform-module and show transform modules in -V output.
[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 void show_transform(void);
56
57 /* device.c */
58 GSList *device_scan(void);
59 struct sr_channel_group *select_channel_group(struct sr_dev_inst *sdi);
60
61 /* session.c */
62 void datafeed_in(const struct sr_dev_inst *sdi,
63                 const struct sr_datafeed_packet *packet, void *cb_data);
64 int opt_to_gvar(char *key, char *value, struct sr_config *src);
65 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
66 void run_session(void);
67 void save_chunk_logic(struct sr_session *session, uint8_t *data,
68                 uint64_t data_len, int unitsize);
69
70 /* input.c */
71 void load_input_file(void);
72
73 /* decode.c */
74 #ifdef HAVE_SRD
75 int register_pds(const char *opt_pds, char *opt_pd_annotations);
76 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations);
77 int setup_pd_annotations(char *opt_pd_annotations);
78 int setup_pd_meta(char *opt_pd_meta);
79 int setup_pd_binary(char *opt_pd_binary);
80 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
81 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
82 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
83 void map_pd_channels(struct sr_dev_inst *sdi);
84 #endif
85
86 /* parsers.c */
87 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
88 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
89 int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
90                 struct sr_trigger **trigger);
91 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
92 GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
93 int canon_cmp(const char *str1, const char *str2);
94 int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
95
96 /* anykey.c */
97 void add_anykey(struct sr_session *session);
98 void clear_anykey(void);
99
100 /* options.c */
101 extern gboolean opt_version;
102 extern gint opt_loglevel;
103 extern gboolean opt_scan_devs;
104 extern gboolean opt_wait_trigger;
105 extern gchar *opt_input_file;
106 extern gchar *opt_output_file;
107 extern gchar *opt_drv;
108 extern gchar *opt_config;
109 extern gchar *opt_channels;
110 extern gchar *opt_channel_group;
111 extern gchar *opt_triggers;
112 extern gchar *opt_pds;
113 #ifdef HAVE_SRD
114 extern gchar *opt_pd_stack;
115 extern gchar *opt_pd_annotations;
116 extern gchar *opt_pd_meta;
117 extern gchar *opt_pd_binary;
118 #endif
119 extern gchar *opt_input_format;
120 extern gchar *opt_output_format;
121 extern gchar *opt_transform_module;
122 extern gchar *opt_show;
123 extern gchar *opt_time;
124 extern gchar *opt_samples;
125 extern gchar *opt_frames;
126 extern gchar *opt_continuous;
127 extern gchar *opt_get;
128 extern gchar *opt_set;
129 int parse_options(int argc, char **argv);
130 void show_help(void);
131
132 #endif