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