Rename 'probe' to 'channel' in most places.
[sigrok-cli.git] / sigrok-cli.h
blob754c58b4d6f0f0affc2cd630469ddeabe04bc2ca
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"
31 #define SAVE_CHUNK_SIZE 524288
33 /* main.c */
34 int select_channels(struct sr_dev_inst *sdi);
36 /* show.c */
37 void show_version(void);
38 void show_dev_list(void);
39 void show_dev_detail(void);
40 void show_pd_detail(void);
42 /* device.c */
43 GSList *device_scan(void);
44 struct sr_channel_group *select_channel_group(struct sr_dev_inst *sdi);
46 /* session.c */
47 int setup_output_format(void);
48 void datafeed_in(const struct sr_dev_inst *sdi,
49 const struct sr_datafeed_packet *packet, void *cb_data);
50 int opt_to_gvar(char *key, char *value, struct sr_config *src);
51 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args);
52 void run_session(void);
53 void save_chunk_logic(uint8_t *data, uint64_t data_len, int unitsize);
55 /* input.c */
56 void load_input_file(void);
58 /* decode.c */
59 #ifdef HAVE_SRD
60 int register_pds(const char *opt_pds, char *opt_pd_annotations);
61 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations);
62 int setup_pd_annotations(char *opt_pd_annotations);
63 int setup_pd_meta(char *opt_pd_meta);
64 int setup_pd_binary(char *opt_pd_binary);
65 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data);
66 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data);
67 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data);
68 void map_pd_probes(struct sr_dev_inst *sdi);
69 #endif
71 /* parsers.c */
72 struct sr_channel *find_channel(GSList *channellist, const char *channelname);
73 GSList *parse_channelstring(struct sr_dev_inst *sdi, const char *channelstring);
74 GHashTable *parse_generic_arg(const char *arg, gboolean sep_first);
75 int canon_cmp(const char *str1, const char *str2);
77 /* anykey.c */
78 void add_anykey(void);
79 void clear_anykey(void);
81 #endif