sr: add sr_dev_probe_enable(), abstraction wrapper around device probes
[sigrok:sigrok.git] / libsigrok / proto.h
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010-2012 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 LIBSIGROK_SIGROK_PROTO_H
21 #define LIBSIGROK_SIGROK_PROTO_H
22
23 /*--- backend.c -------------------------------------------------------------*/
24
25 SR_API int sr_init(void);
26 SR_API int sr_exit(void);
27
28 /*--- log.c -----------------------------------------------------------------*/
29
30 typedef int (*sr_log_callback_t)(void *cb_data, int loglevel,
31                                  const char *format, va_list args);
32
33 SR_API int sr_log_loglevel_set(int loglevel);
34 SR_API int sr_log_loglevel_get(void);
35 SR_API int sr_log_callback_set(sr_log_callback_t cb, void *cb_data);
36 SR_API int sr_log_callback_set_default(void);
37 SR_API int sr_log_logdomain_set(const char *logdomain);
38 SR_API char *sr_log_logdomain_get(void);
39
40 /*--- datastore.c -----------------------------------------------------------*/
41
42 SR_API int sr_datastore_new(int unitsize, struct sr_datastore **ds);
43 SR_API int sr_datastore_destroy(struct sr_datastore *ds);
44 SR_API int sr_datastore_put(struct sr_datastore *ds, void *data,
45                             unsigned int length, int in_unitsize,
46                             const int *probelist);
47
48 /*--- device.c --------------------------------------------------------------*/
49
50 SR_API int sr_dev_scan(void);
51 SR_API GSList *sr_dev_list(void);
52 SR_API struct sr_dev *sr_dev_new(const struct sr_dev_driver *driver,
53                                  int driver_index);
54 SR_API int sr_dev_probe_add(struct sr_dev *dev, const char *name);
55 SR_API struct sr_probe *sr_dev_probe_find(const struct sr_dev *dev,
56                                           int probenum);
57 SR_API int sr_dev_probe_name_set(struct sr_dev *dev, int probenum,
58                                  const char *name);
59 SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
60                 gboolean state);
61 SR_API int sr_dev_trigger_remove_all(struct sr_dev *dev);
62 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
63                 const char *trigger);
64 SR_API gboolean sr_dev_has_hwcap(const struct sr_dev *dev, int hwcap);
65 SR_API int sr_dev_info_get(const struct sr_dev *dev, int id, const void **data);
66
67 /*--- filter.c --------------------------------------------------------------*/
68
69 SR_API int sr_filter_probes(int in_unitsize, int out_unitsize,
70                             const int *probelist, const uint8_t *data_in,
71                             uint64_t length_in, uint8_t **data_out,
72                             uint64_t *length_out);
73
74 /*--- hwdriver.c ------------------------------------------------------------*/
75
76 SR_API struct sr_dev_driver **sr_driver_list(void);
77 SR_API int sr_driver_init(struct sr_dev_driver *driver);
78 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
79 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
80 SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt);
81 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap);
82 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
83                 const void **data, const struct sr_dev_inst *sdi);
84
85 /*--- session.c -------------------------------------------------------------*/
86
87 typedef void (*sr_datafeed_callback_t)(struct sr_dev *dev,
88                                        struct sr_datafeed_packet *packet);
89
90 /* Session setup */
91 SR_API int sr_session_load(const char *filename);
92 SR_API struct sr_session *sr_session_new(void);
93 SR_API int sr_session_destroy(void);
94 SR_API int sr_session_dev_remove_all(void);
95 SR_API int sr_session_dev_add(struct sr_dev *dev);
96
97 /* Datafeed setup */
98 SR_API int sr_session_datafeed_callback_remove_all(void);
99 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
100
101 /* Session control */
102 SR_API int sr_session_start(void);
103 SR_API int sr_session_run(void);
104 SR_API int sr_session_halt(void);
105 SR_API int sr_session_stop(void);
106 SR_API int sr_session_save(const char *filename);
107 SR_API int sr_session_source_add(int fd, int events, int timeout,
108                 sr_receive_data_callback_t cb, void *cb_data);
109 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
110                 sr_receive_data_callback_t cb, void *cb_data);
111 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
112                 int timeout, sr_receive_data_callback_t cb, void *cb_data);
113 SR_API int sr_session_source_remove(int fd);
114 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
115 SR_API int sr_session_source_remove_channel(GIOChannel *channel);
116
117 /*--- input/input.c ---------------------------------------------------------*/
118
119 SR_API struct sr_input_format **sr_input_list(void);
120
121 /*--- output/output.c -------------------------------------------------------*/
122
123 SR_API struct sr_output_format **sr_output_list(void);
124
125 /*--- strutil.c -------------------------------------------------------------*/
126
127 SR_API char *sr_samplerate_string(uint64_t samplerate);
128 SR_API char *sr_period_string(uint64_t frequency);
129 SR_API char *sr_voltage_string(struct sr_rational *voltage);
130 SR_API char **sr_parse_triggerstring(struct sr_dev *dev,
131                                      const char *triggerstring);
132 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
133 SR_API uint64_t sr_parse_timestring(const char *timestring);
134 SR_API gboolean sr_parse_boolstring(const char *boolstring);
135 SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r);
136 SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r);
137
138 /*--- version.c -------------------------------------------------------------*/
139
140 SR_API int sr_package_version_major_get(void);
141 SR_API int sr_package_version_minor_get(void);
142 SR_API int sr_package_version_micro_get(void);
143 SR_API const char *sr_package_version_string_get(void);
144
145 SR_API int sr_lib_version_current_get(void);
146 SR_API int sr_lib_version_revision_get(void);
147 SR_API int sr_lib_version_age_get(void);
148 SR_API const char *sr_lib_version_string_get(void);
149
150 /*--- error.c ---------------------------------------------------------------*/
151
152 SR_API const char *sr_strerror(int error_code);
153 SR_API const char *sr_strerror_name(int error_code);
154
155 #endif