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