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