]> sigrok.org Git - libsigrok.git/blame - include/libsigrok/proto.h
Bindings: constify data pointer
[libsigrok.git] / include / libsigrok / proto.h
CommitLineData
10509bc2 1/*
50985c20 2 * This file is part of the libsigrok project.
10509bc2 3 *
13d8e03c 4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
10509bc2
BV
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
a5827886
UH
20#ifndef LIBSIGROK_PROTO_H
21#define LIBSIGROK_PROTO_H
10509bc2 22
393fb9cb
UH
23/**
24 * @file
25 *
26 * Header file containing API function prototypes.
27 */
28
fb019a0e
BV
29/*--- analog.c --------------------------------------------------------------*/
30
edb691fc 31SR_API int sr_analog_to_float(const struct sr_datafeed_analog *analog,
fb019a0e 32 float *buf);
962172e4 33SR_API const char *sr_analog_si_prefix(float *value, int *digits);
5728718b 34SR_API gboolean sr_analog_si_prefix_friendly(enum sr_unit unit);
edb691fc 35SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog *analog,
a24da9a8 36 char **result);
53e5d3d1 37SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
bdba3626 38SR_API int sr_rational_eq(const struct sr_rational *a, const struct sr_rational *b);
ee1b6054
SB
39SR_API int sr_rational_mult(struct sr_rational *res, const struct sr_rational *a,
40 const struct sr_rational *b);
17d5a11c
SB
41SR_API int sr_rational_div(struct sr_rational *res, const struct sr_rational *num,
42 const struct sr_rational *div);
fb019a0e 43
10509bc2
BV
44/*--- backend.c -------------------------------------------------------------*/
45
b8072700
PS
46SR_API int sr_init(struct sr_context **ctx);
47SR_API int sr_exit(struct sr_context *ctx);
10509bc2 48
42be2adb
UH
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
1352eedd
UH
53/*--- log.c -----------------------------------------------------------------*/
54
144f6660
UH
55typedef int (*sr_log_callback)(void *cb_data, int loglevel,
56 const char *format, va_list args);
0ae67ff7
UH
57
58SR_API int sr_log_loglevel_set(int loglevel);
59SR_API int sr_log_loglevel_get(void);
144f6660 60SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
b5118d6c 61SR_API int sr_log_callback_set_default(void);
1352eedd 62
aa0b6b20 63/*--- device.c --------------------------------------------------------------*/
10509bc2 64
6f1346fb
ML
65SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
66 const char *name);
67SR_API int sr_dev_channel_enable(struct sr_channel *channel,
be5bf44d 68 gboolean state);
4d15e5c9 69SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
0c697a4b 70SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
71e9c54d 71 const struct sr_channel_group *cg, int key);
e7136c62
ML
72SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
73 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
f99e32af
BV
74SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
75SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
efdecf4c
BV
76SR_API int sr_dev_open(struct sr_dev_inst *sdi);
77SR_API int sr_dev_close(struct sr_dev_inst *sdi);
10509bc2 78
2f5f9705
UH
79SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
80SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
81SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
82SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
83SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
84SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
85SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
86SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
0157fdce 87
e705ce3b
UH
88SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
89 const char *model, const char *version);
90SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
91
c09f0b57 92/*--- hwdriver.c ------------------------------------------------------------*/
aa0b6b20 93
032da34b 94SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
44fc870c
PS
95SR_API int sr_driver_init(struct sr_context *ctx,
96 struct sr_dev_driver *driver);
8141a032 97SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver);
80bf0426 98SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
8f996b89
ML
99SR_API int sr_config_get(const struct sr_dev_driver *driver,
100 const struct sr_dev_inst *sdi,
53b4680f 101 const struct sr_channel_group *cg,
584560f1 102 uint32_t key, GVariant **data);
8f996b89 103SR_API int sr_config_set(const struct sr_dev_inst *sdi,
53b4680f 104 const struct sr_channel_group *cg,
584560f1 105 uint32_t key, GVariant *data);
2a854d71 106SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
8f996b89
ML
107SR_API int sr_config_list(const struct sr_dev_driver *driver,
108 const struct sr_dev_inst *sdi,
53b4680f 109 const struct sr_channel_group *cg,
584560f1 110 uint32_t key, GVariant **data);
2fb60e23
BV
111SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
112SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
10509bc2
BV
113
114/*--- session.c -------------------------------------------------------------*/
115
5de0fc55 116typedef void (*sr_session_stopped_callback)(void *data);
144f6660 117typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
2726474a 118 const struct sr_datafeed_packet *packet, void *cb_data);
5de0fc55 119
0812c40e 120SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
10509bc2
BV
121
122/* Session setup */
61e6e2da
ML
123SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
124 struct sr_session **session);
125SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
0812c40e
ML
126SR_API int sr_session_destroy(struct sr_session *session);
127SR_API int sr_session_dev_remove_all(struct sr_session *session);
128SR_API int sr_session_dev_add(struct sr_session *session,
129 struct sr_dev_inst *sdi);
fe7b8efc
SB
130SR_API int sr_session_dev_remove(struct sr_session *session,
131 struct sr_dev_inst *sdi);
0812c40e
ML
132SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
133SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
10509bc2 134
10509bc2 135/* Datafeed setup */
0812c40e
ML
136SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
137SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
138 sr_datafeed_callback cb, void *cb_data);
10509bc2
BV
139
140/* Session control */
0812c40e
ML
141SR_API int sr_session_start(struct sr_session *session);
142SR_API int sr_session_run(struct sr_session *session);
143SR_API int sr_session_stop(struct sr_session *session);
5de0fc55
DE
144SR_API int sr_session_is_running(struct sr_session *session);
145SR_API int sr_session_stopped_callback_set(struct sr_session *session,
146 sr_session_stopped_callback cb, void *cb_data);
147
aa0b6b20 148/*--- input/input.c ---------------------------------------------------------*/
10509bc2 149
17bfaca6 150SR_API const struct sr_input_module **sr_input_list(void);
4fb0a5f8
UH
151SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
152SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
153SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
c7bc82ff 154SR_API const char *const *sr_input_extensions_get(
4fb0a5f8 155 const struct sr_input_module *imod);
17bfaca6 156SR_API const struct sr_input_module *sr_input_find(char *id);
4fb0a5f8 157SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
3cd4b381
SA
158SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
159 uint64_t flag);
bd0bfaaf 160SR_API void sr_input_options_free(const struct sr_option **options);
17bfaca6
BV
161SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
162 GHashTable *options);
4f979115
BV
163SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
164SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
17bfaca6
BV
165SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
166SR_API int sr_input_send(const struct sr_input *in, GString *buf);
7066fd46 167SR_API int sr_input_end(const struct sr_input *in);
b6b4f03e 168SR_API int sr_input_reset(const struct sr_input *in);
d5cc282f 169SR_API void sr_input_free(const struct sr_input *in);
aa0b6b20
UH
170
171/*--- output/output.c -------------------------------------------------------*/
172
a755b0e1 173SR_API const struct sr_output_module **sr_output_list(void);
4fb0a5f8
UH
174SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
175SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
176SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
8a174d23 177SR_API const char *const *sr_output_extensions_get(
4fb0a5f8 178 const struct sr_output_module *omod);
a755b0e1 179SR_API const struct sr_output_module *sr_output_find(char *id);
4fb0a5f8 180SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
fc746430 181SR_API void sr_output_options_free(const struct sr_option **opts);
4fb0a5f8 182SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
81b3ce37
SA
183 GHashTable *params, const struct sr_dev_inst *sdi,
184 const char *filename);
a755b0e1 185SR_API int sr_output_send(const struct sr_output *o,
dba3e682 186 const struct sr_datafeed_packet *packet, GString **out);
a755b0e1 187SR_API int sr_output_free(const struct sr_output *o);
aa0b6b20 188
988357ca
UH
189/*--- transform/transform.c -------------------------------------------------*/
190
191SR_API const struct sr_transform_module **sr_transform_list(void);
192SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
193SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
194SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
195SR_API const struct sr_transform_module *sr_transform_find(const char *id);
196SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
197SR_API void sr_transform_options_free(const struct sr_option **opts);
198SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
199 GHashTable *params, const struct sr_dev_inst *sdi);
200SR_API int sr_transform_free(const struct sr_transform *t);
201
7b5e6d29
BV
202/*--- trigger.c -------------------------------------------------------------*/
203
00ebcbf4 204SR_API struct sr_trigger *sr_trigger_new(const char *name);
7b5e6d29 205SR_API void sr_trigger_free(struct sr_trigger *trig);
a153d6b8 206SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
7b5e6d29
BV
207SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
208 struct sr_channel *ch, int trigger_match, float value);
209
24287ea9
AJ
210/*--- serial.c --------------------------------------------------------------*/
211
212SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
213SR_API void sr_serial_free(struct sr_serial_port *serial);
214
bee24666
DE
215/*--- resource.c ------------------------------------------------------------*/
216
217typedef int (*sr_resource_open_callback)(struct sr_resource *res,
218 const char *name, void *cb_data);
219typedef int (*sr_resource_close_callback)(struct sr_resource *res,
220 void *cb_data);
32ba0d80 221typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
bee24666
DE
222 void *buf, size_t count, void *cb_data);
223
224SR_API int sr_resource_set_hooks(struct sr_context *ctx,
225 sr_resource_open_callback open_cb,
226 sr_resource_close_callback close_cb,
227 sr_resource_read_callback read_cb, void *cb_data);
228
bb7ef793 229/*--- strutil.c -------------------------------------------------------------*/
aa0b6b20 230
4cc9aea1 231SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
1a081ca6 232SR_API char *sr_samplerate_string(uint64_t samplerate);
6984cfb2 233SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q);
e0e15067 234SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
1a081ca6
UH
235SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
236SR_API uint64_t sr_parse_timestring(const char *timestring);
237SR_API gboolean sr_parse_boolstring(const char *boolstring);
76e107d6
BV
238SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
239SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
5ec172d7 240SR_API int sr_parse_rational(const char *str, struct sr_rational *ret);
10509bc2 241
787c4390
UH
242/*--- version.c -------------------------------------------------------------*/
243
244SR_API int sr_package_version_major_get(void);
245SR_API int sr_package_version_minor_get(void);
246SR_API int sr_package_version_micro_get(void);
247SR_API const char *sr_package_version_string_get(void);
248
249SR_API int sr_lib_version_current_get(void);
250SR_API int sr_lib_version_revision_get(void);
251SR_API int sr_lib_version_age_get(void);
252SR_API const char *sr_lib_version_string_get(void);
253
b5a8e848
UH
254/*--- error.c ---------------------------------------------------------------*/
255
256SR_API const char *sr_strerror(int error_code);
257SR_API const char *sr_strerror_name(int error_code);
258
c2bd92ec 259#endif