man: Update uart decode example syntax
[sigrok-cli.git] / sigrok-cli.h
blob4d2f0f2ffba3fde4bb5c61475bb2ee5b646f369f
1 /*
2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #ifndef SIGROK_CLI_SIGROK_CLI_H
21 #define SIGROK_CLI_SIGROK_CLI_H
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>
30 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
32 /* main.c */
33 int select_probes(struct sr_dev_inst *sdi);
35 /* show.c */
36 void show_version(void);
37 void show_dev_list(void);
38 void show_dev_detail(void);
39 void show_pd_detail(void);
41 /* device.c */
42 GSList *device_scan(void);
43 struct sr_probe_group *select_probe_group(struct sr_dev_inst *sdi);
45 /* session.c */
46 int setup_output_format(void);
47 void datafeed_in(const struct sr_dev_inst *sdi,
48 const struct sr_datafeed_packet *packet, void *cb_data);
49 int opt_to_gvar(char *key, char *value, struct sr_config *src);
50 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
51 void run_session(void);
53 /* input.c */
54 void load_input_file(void);
56 /* decode.c */
57 #ifdef HAVE_SRD
58 int register_pds(const char *opt_pds, char *opt_pd_annotations);
59 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations);
60 int setup_pd_annotations(char *opt_pd_annotations);
61 int setup_pd_meta(char *opt_pd_meta);
62 int setup_pd_binary(char *opt_pd_binary);
63 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
64 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
65 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
66 #endif
68 /* parsers.c */
69 GSList *parse_probestring(struct sr_dev_inst *sdi, const char *probestring);
70 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
71 int canon_cmp(const char *str1, const char *str2);
73 /* anykey.c */
74 void add_anykey(void);
75 void clear_anykey(void);
77 #endif