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