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