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