]> 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
Bindings: constify data pointer
[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/*--- log.c -----------------------------------------------------------------*/
54
55typedef int (*sr_log_callback)(void *cb_data, int loglevel,
56 const char *format, va_list args);
57
58SR_API int sr_log_loglevel_set(int loglevel);
59SR_API int sr_log_loglevel_get(void);
60SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
61SR_API int sr_log_callback_set_default(void);
62
63/*--- device.c --------------------------------------------------------------*/
64
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,
68 gboolean state);
69SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
70SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
71 const struct sr_channel_group *cg, int key);
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);
74SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
75SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
76SR_API int sr_dev_open(struct sr_dev_inst *sdi);
77SR_API int sr_dev_close(struct sr_dev_inst *sdi);
78
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);
87
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
92/*--- hwdriver.c ------------------------------------------------------------*/
93
94SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
95SR_API int sr_driver_init(struct sr_context *ctx,
96 struct sr_dev_driver *driver);
97SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver);
98SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
99SR_API int sr_config_get(const struct sr_dev_driver *driver,
100 const struct sr_dev_inst *sdi,
101 const struct sr_channel_group *cg,
102 uint32_t key, GVariant **data);
103SR_API int sr_config_set(const struct sr_dev_inst *sdi,
104 const struct sr_channel_group *cg,
105 uint32_t key, GVariant *data);
106SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
107SR_API int sr_config_list(const struct sr_dev_driver *driver,
108 const struct sr_dev_inst *sdi,
109 const struct sr_channel_group *cg,
110 uint32_t key, GVariant **data);
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);
113
114/*--- session.c -------------------------------------------------------------*/
115
116typedef void (*sr_session_stopped_callback)(void *data);
117typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
118 const struct sr_datafeed_packet *packet, void *cb_data);
119
120SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
121
122/* Session setup */
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);
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);
130SR_API int sr_session_dev_remove(struct sr_session *session,
131 struct sr_dev_inst *sdi);
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);
134
135/* Datafeed setup */
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);
139
140/* Session control */
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);
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
148/*--- input/input.c ---------------------------------------------------------*/
149
150SR_API const struct sr_input_module **sr_input_list(void);
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);
154SR_API const char *const *sr_input_extensions_get(
155 const struct sr_input_module *imod);
156SR_API const struct sr_input_module *sr_input_find(char *id);
157SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
158SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
159 uint64_t flag);
160SR_API void sr_input_options_free(const struct sr_option **options);
161SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
162 GHashTable *options);
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);
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);
167SR_API int sr_input_end(const struct sr_input *in);
168SR_API int sr_input_reset(const struct sr_input *in);
169SR_API void sr_input_free(const struct sr_input *in);
170
171/*--- output/output.c -------------------------------------------------------*/
172
173SR_API const struct sr_output_module **sr_output_list(void);
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);
177SR_API const char *const *sr_output_extensions_get(
178 const struct sr_output_module *omod);
179SR_API const struct sr_output_module *sr_output_find(char *id);
180SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
181SR_API void sr_output_options_free(const struct sr_option **opts);
182SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
183 GHashTable *params, const struct sr_dev_inst *sdi,
184 const char *filename);
185SR_API int sr_output_send(const struct sr_output *o,
186 const struct sr_datafeed_packet *packet, GString **out);
187SR_API int sr_output_free(const struct sr_output *o);
188
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
202/*--- trigger.c -------------------------------------------------------------*/
203
204SR_API struct sr_trigger *sr_trigger_new(const char *name);
205SR_API void sr_trigger_free(struct sr_trigger *trig);
206SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
207SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
208 struct sr_channel *ch, int trigger_match, float value);
209
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
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);
221typedef gssize (*sr_resource_read_callback)(const struct sr_resource *res,
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
229/*--- strutil.c -------------------------------------------------------------*/
230
231SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
232SR_API char *sr_samplerate_string(uint64_t samplerate);
233SR_API char *sr_period_string(uint64_t v_p, uint64_t v_q);
234SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
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);
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);
240SR_API int sr_parse_rational(const char *str, struct sr_rational *ret);
241
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
254/*--- error.c ---------------------------------------------------------------*/
255
256SR_API const char *sr_strerror(int error_code);
257SR_API const char *sr_strerror_name(int error_code);
258
259#endif
Hardware access and backend lib