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