]> sigrok.org Git - libsigrok.git/blame_incremental - include/libsigrok/proto.h
projects / libsigrok.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / include / libsigrok / proto.h
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 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_PROTO_H
21#define LIBSIGROK_PROTO_H
22
23/**
24 * @file
25 *
26 * Header file containing API function prototypes.
27 */
28
29/*--- analog.c --------------------------------------------------------------*/
30
31SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog,
32 float *buf);
33SR_API const char *sr_analog_si_prefix(float *value, int *digits);
34SR_API gboolean sr_analog_si_prefix_friendly(enum sr_unit unit);
35SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
36 char **result);
37SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
38SR_API int sr_rational_eq(const struct sr_rational *a, const struct sr_rational *b);
39SR_API int sr_rational_mult(struct sr_rational *res, const struct sr_rational *a,
40 const struct sr_rational *b);
41SR_API int sr_rational_div(struct sr_rational *res, const struct sr_rational *num,
42 const struct sr_rational *div);
43
44/*--- backend.c -------------------------------------------------------------*/
45
46SR_API int sr_init(struct sr_context **ctx);
47SR_API int sr_exit(struct sr_context *ctx);
48
49SR_API GSList *sr_buildinfo_libs_get(void);
50SR_API char *sr_buildinfo_host_get(void);
51SR_API char *sr_buildinfo_scpi_backends_get(void);
52
53/*--- conversion.c ----------------------------------------------------------*/
54
55SR_API int sr_a2l_threshold(const struct sr_datafeed_analog *analog,
56 float threshold, uint8_t *output, uint64_t count);
57SR_API int sr_a2l_schmitt_trigger(const struct sr_datafeed_analog *analog,
58 float lo_thr, float hi_thr, uint8_t *state, uint8_t *output,
59 uint64_t count);
60
61/*--- log.c -----------------------------------------------------------------*/
62
63typedef int (*sr_log_callback)(void *cb_data, int loglevel,
64 const char *format, va_list args);
65
66SR_API int sr_log_loglevel_set(int loglevel);
67SR_API int sr_log_loglevel_get(void);
68SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
69SR_API int sr_log_callback_set_default(void);
70SR_API int sr_log_callback_get(sr_log_callback *cb, void **cb_data);
71
72/*--- device.c --------------------------------------------------------------*/
73
74SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
75 const char *name);
76SR_API int sr_dev_channel_enable(struct sr_channel *channel,
77 gboolean state);
78SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
79SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
80 const struct sr_channel_group *cg, int key);
81SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
82 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
83SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
84SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
85SR_API int sr_dev_open(struct sr_dev_inst *sdi);
86SR_API int sr_dev_close(struct sr_dev_inst *sdi);
87
88SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
89SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
90SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
91SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
92SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
93SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
94SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
95SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
96
97SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
98 const char *model, const char *version);
99SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
100
101/*--- hwdriver.c ------------------------------------------------------------*/
102
103SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
104SR_API int sr_driver_init(struct sr_context *ctx,
105 struct sr_dev_driver *driver);
106SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver);
107SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
108SR_API int sr_config_get(const struct sr_dev_driver *driver,
109 const struct sr_dev_inst *sdi,
110 const struct sr_channel_group *cg,
111 uint32_t key, GVariant **data);
112SR_API int sr_config_set(const struct sr_dev_inst *sdi,
113 const struct sr_channel_group *cg,
114 uint32_t key, GVariant *data);
115SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
116SR_API int sr_config_list(const struct sr_dev_driver *driver,
117 const struct sr_dev_inst *sdi,
118 const struct sr_channel_group *cg,
119 uint32_t key, GVariant **data);
120SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
121SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
122
123/*--- session.c -------------------------------------------------------------*/
124
125typedef void (*sr_session_stopped_callback)(void *data);
126typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
127 const struct sr_datafeed_packet *packet, void *cb_data);
128
129SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
130
131/* Session setup */
132SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
133 struct sr_session **session);
134SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
135SR_API int sr_session_destroy(struct sr_session *session);
136SR_API int sr_session_dev_remove_all(struct sr_session *session);
137SR_API int sr_session_dev_add(struct sr_session *session,
138 struct sr_dev_inst *sdi);
139SR_API int sr_session_dev_remove(struct sr_session *session,
140 struct sr_dev_inst *sdi);
141SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
142SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
143
144/* Datafeed setup */
145SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
146SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
147 sr_datafeed_callback cb, void *cb_data);
148
149/* Session control */
150SR_API int sr_session_start(struct sr_session *session);
151SR_API int sr_session_run(struct sr_session *session);
152SR_API int sr_session_stop(struct sr_session *session);
153SR_API int sr_session_is_running(struct sr_session *session);
154SR_API int sr_session_stopped_callback_set(struct sr_session *session,
155 sr_session_stopped_callback cb, void *cb_data);
156
157SR_API int sr_packet_copy(const struct sr_datafeed_packet *packet,
158 struct sr_datafeed_packet **copy);
159SR_API void sr_packet_free(struct sr_datafeed_packet *packet);
160
161/*--- input/input.c ---------------------------------------------------------*/
162
163SR_API const struct sr_input_module **sr_input_list(void);
164SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
165SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
166SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
167SR_API const char *const *sr_input_extensions_get(
168 const struct sr_input_module *imod);
169SR_API const struct sr_input_module *sr_input_find(const char *id);
170SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
171SR_API void sr_input_options_free(const struct sr_option **options);
172SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
173 GHashTable *options);
174SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
175SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
176SR_API const struct sr_input_module *sr_input_module_get(const struct sr_input *in);
177SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
178SR_API int sr_input_send(const struct sr_input *in, GString *buf);
179SR_API int sr_input_end(const struct sr_input *in);
180SR_API int sr_input_reset(const struct sr_input *in);
181SR_API void sr_input_free(const struct sr_input *in);
182
183/*--- output/output.c -------------------------------------------------------*/
184
185SR_API const struct sr_output_module **sr_output_list(void);
186SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
187SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
188SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
189SR_API const char *const *sr_output_extensions_get(
190 const struct sr_output_module *omod);
191SR_API const struct sr_output_module *sr_output_find(char *id);
192SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
193SR_API void sr_output_options_free(const struct sr_option **opts);
194SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
195 GHashTable *params, const struct sr_dev_inst *sdi,
196 const char *filename);
197SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
198 uint64_t flag);
199SR_API int sr_output_send(const struct sr_output *o,
200 const struct sr_datafeed_packet *packet, GString **out);
201SR_API int sr_output_free(const struct sr_output *o);
202
203/*--- transform/transform.c -------------------------------------------------*/
204
205SR_API const struct sr_transform_module **sr_transform_list(void);
206SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
207SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
208SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
209SR_API const struct sr_transform_module *sr_transform_find(const char *id);
210SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
211SR_API void sr_transform_options_free(const struct sr_option **opts);
212SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
213 GHashTable *params, const struct sr_dev_inst *sdi);
214SR_API int sr_transform_free(const struct sr_transform *t);
215
216/*--- trigger.c -------------------------------------------------------------*/
217
218SR_API struct sr_trigger *sr_trigger_new(const char *name);
219SR_API void sr_trigger_free(struct sr_trigger *trig);
220SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
221SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
222 struct sr_channel *ch, int trigger_match, float value);
223
224/*--- serial.c --------------------------------------------------------------*/
225
226SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
227SR_API void sr_serial_free(struct sr_serial_port *serial);
228
229/*--- resource.c ------------------------------------------------------------*/
230
231typedef int (*sr_resource_open_callback)(struct sr_resource *res,
232 const char *name, void *cb_data);
233typedef int (*sr_resource_close_callback)(struct sr_resource *res,
234 void *cb_data);
235typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
236 void *buf, size_t count, void *cb_data);
237
238SR_API GSList *sr_resourcepaths_get(int res_type);
239
240SR_API int sr_resource_set_hooks(struct sr_context *ctx,
241 sr_resource_open_callback open_cb,
242 sr_resource_close_callback close_cb,
243 sr_resource_read_callback read_cb, void *cb_data);
244
245/*--- strutil.c -------------------------------------------------------------*/
246
247SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
248SR_API char *sr_samplerate_string(uint64_t samplerate);
249SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q);
250SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
251SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
252SR_API uint64_t sr_parse_timestring(const char *timestring);
253SR_API gboolean sr_parse_boolstring(const char *boolstring);
254SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
255SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
256SR_API char **sr_parse_probe_names(const char *spec,
257 const char **dflt_names, size_t dflt_count,
258 size_t max_count, size_t *ret_count);
259SR_API void sr_free_probe_names(char **names);
260SR_API int sr_sprintf_ascii(char *buf, const char *format, ...);
261SR_API int sr_vsprintf_ascii(char *buf, const char *format, va_list args);
262SR_API int sr_snprintf_ascii(char *buf, size_t buf_size,
263 const char *format, ...);
264SR_API int sr_vsnprintf_ascii(char *buf, size_t buf_size,
265 const char *format, va_list args);
266SR_API int sr_parse_rational(const char *str, struct sr_rational *ret);
267SR_API char *sr_text_trim_spaces(char *s);
268SR_API char *sr_text_next_line(char *s, size_t l, char **next, size_t *taken);
269SR_API char *sr_text_next_word(char *s, char **next);
270
271SR_API int sr_next_power_of_two(size_t value, size_t *bits, size_t *power);
272
273/*--- version.c -------------------------------------------------------------*/
274
275SR_API int sr_package_version_major_get(void);
276SR_API int sr_package_version_minor_get(void);
277SR_API int sr_package_version_micro_get(void);
278SR_API const char *sr_package_version_string_get(void);
279
280SR_API int sr_lib_version_current_get(void);
281SR_API int sr_lib_version_revision_get(void);
282SR_API int sr_lib_version_age_get(void);
283SR_API const char *sr_lib_version_string_get(void);
284
285/*--- error.c ---------------------------------------------------------------*/
286
287SR_API const char *sr_strerror(int error_code);
288SR_API const char *sr_strerror_name(int error_code);
289
290#endif
Hardware access and backend lib