]> sigrok.org Git - sigrok-cli.git/blame_incremental - sigrok-cli.h
show: add support for -i <fn> --show, provide details on input stream
[sigrok-cli.git] / sigrok-cli.h
... / ...
CommitLineData
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 */
33extern struct sr_context *sr_ctx;
34int select_channels(struct sr_dev_inst *sdi);
35int 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);
38int 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);
41int 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 */
46void show_version(void);
47void show_supported(void);
48void show_supported_wiki(void);
49void show_dev_list(void);
50void show_dev_detail(void);
51void show_pd_detail(void);
52void show_input(void);
53void show_output(void);
54void show_transform(void);
55
56/* device.c */
57GSList *device_scan(void);
58struct sr_channel_group *select_channel_group(struct sr_dev_inst *sdi);
59
60/* session.c */
61struct 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};
75void datafeed_in(const struct sr_dev_inst *sdi,
76 const struct sr_datafeed_packet *packet, void *cb_data);
77int opt_to_gvar(char *key, char *value, struct sr_config *src);
78int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
79void run_session(void);
80
81/* input.c */
82void load_input_file(gboolean do_props);
83
84/* decode.c */
85#ifdef HAVE_SRD
86int register_pds(gchar **all_pds, char *opt_pd_annotations);
87int setup_pd_annotations(char *opt_pd_annotations);
88int setup_pd_meta(char *opt_pd_meta);
89int setup_pd_binary(char *opt_pd_binary);
90void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
91void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
92void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
93void map_pd_channels(struct sr_dev_inst *sdi);
94#endif
95
96/* parsers.c */
97struct sr_channel *find_channel(GSList *channellist, const char *channelname);
98GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
99int parse_triggerstring(const struct sr_dev_inst *sdi, const char *s,
100 struct sr_trigger **trigger);
101GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
102GHashTable *generic_arg_to_opt(const struct sr_option **opts, GHashTable *genargs);
103int canon_cmp(const char *str1, const char *str2);
104int parse_driver(char *arg, struct sr_dev_driver **driver, GSList **drvopts);
105
106/* anykey.c */
107void add_anykey(struct sr_session *session);
108void clear_anykey(void);
109
110/* options.c */
111extern gboolean opt_version;
112extern gboolean opt_list_supported;
113extern gboolean opt_list_supported_wiki;
114extern gint opt_loglevel;
115extern gboolean opt_scan_devs;
116extern gboolean opt_dont_scan;
117extern gboolean opt_wait_trigger;
118extern gchar *opt_input_file;
119extern gchar *opt_output_file;
120extern gchar *opt_drv;
121extern gchar *opt_config;
122extern gchar *opt_channels;
123extern gchar *opt_channel_group;
124extern gchar *opt_triggers;
125extern gchar **opt_pds;
126#ifdef HAVE_SRD
127extern gchar *opt_pd_annotations;
128extern gchar *opt_pd_meta;
129extern gchar *opt_pd_binary;
130extern gboolean opt_pd_samplenum;
131#endif
132extern gchar *opt_input_format;
133extern gchar *opt_output_format;
134extern gchar *opt_transform_module;
135extern gboolean opt_show;
136extern gchar *opt_time;
137extern gchar *opt_samples;
138extern gchar *opt_frames;
139extern gboolean opt_continuous;
140extern gchar *opt_get;
141extern gboolean opt_set;
142int parse_options(int argc, char **argv);
143void show_help(void);
144
145#endif