]> sigrok.org Git - libsigrok.git/blame - include/libsigrok/proto.h
session: Make sr_session_run() optional
[libsigrok.git] / include / libsigrok / proto.h
CommitLineData
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
31SR_API int sr_analog_to_float(const struct sr_datafeed_analog2 *analog,
32 float *buf);
a24da9a8 33SR_API int sr_analog_float_to_string(float value, int digits, char **result);
a5892391 34SR_API int sr_analog_unit_to_string(const struct sr_datafeed_analog2 *analog,
a24da9a8 35 char **result);
53e5d3d1 36SR_API void sr_rational_set(struct sr_rational *r, int64_t p, uint64_t q);
fb019a0e 37
10509bc2
BV
38/*--- backend.c -------------------------------------------------------------*/
39
b8072700
PS
40SR_API int sr_init(struct sr_context **ctx);
41SR_API int sr_exit(struct sr_context *ctx);
10509bc2 42
1352eedd
UH
43/*--- log.c -----------------------------------------------------------------*/
44
144f6660
UH
45typedef int (*sr_log_callback)(void *cb_data, int loglevel,
46 const char *format, va_list args);
0ae67ff7
UH
47
48SR_API int sr_log_loglevel_set(int loglevel);
49SR_API int sr_log_loglevel_get(void);
144f6660 50SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
b5118d6c 51SR_API int sr_log_callback_set_default(void);
1352eedd 52
aa0b6b20 53/*--- device.c --------------------------------------------------------------*/
10509bc2 54
6f1346fb
ML
55SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
56 const char *name);
57SR_API int sr_dev_channel_enable(struct sr_channel *channel,
be5bf44d 58 gboolean state);
4d15e5c9 59SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
f99e32af
BV
60SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
61SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
efdecf4c
BV
62SR_API int sr_dev_open(struct sr_dev_inst *sdi);
63SR_API int sr_dev_close(struct sr_dev_inst *sdi);
10509bc2 64
2f5f9705
UH
65SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi);
66SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi);
67SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi);
68SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi);
69SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi);
70SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi);
71SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi);
72SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi);
0157fdce 73
e705ce3b
UH
74SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
75 const char *model, const char *version);
76SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name);
77
c09f0b57 78/*--- hwdriver.c ------------------------------------------------------------*/
aa0b6b20 79
032da34b 80SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx);
44fc870c
PS
81SR_API int sr_driver_init(struct sr_context *ctx,
82 struct sr_dev_driver *driver);
80bf0426 83SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
8f996b89
ML
84SR_API int sr_config_get(const struct sr_dev_driver *driver,
85 const struct sr_dev_inst *sdi,
53b4680f 86 const struct sr_channel_group *cg,
584560f1 87 uint32_t key, GVariant **data);
8f996b89 88SR_API int sr_config_set(const struct sr_dev_inst *sdi,
53b4680f 89 const struct sr_channel_group *cg,
584560f1 90 uint32_t key, GVariant *data);
2a854d71 91SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
8f996b89
ML
92SR_API int sr_config_list(const struct sr_dev_driver *driver,
93 const struct sr_dev_inst *sdi,
53b4680f 94 const struct sr_channel_group *cg,
584560f1 95 uint32_t key, GVariant **data);
2fb60e23
BV
96SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key);
97SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid);
10509bc2
BV
98
99/*--- session.c -------------------------------------------------------------*/
100
5de0fc55 101typedef void (*sr_session_stopped_callback)(void *data);
144f6660 102typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
2726474a 103 const struct sr_datafeed_packet *packet, void *cb_data);
5de0fc55 104
0812c40e 105SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
10509bc2
BV
106
107/* Session setup */
61e6e2da
ML
108SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
109 struct sr_session **session);
110SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
0812c40e
ML
111SR_API int sr_session_destroy(struct sr_session *session);
112SR_API int sr_session_dev_remove_all(struct sr_session *session);
113SR_API int sr_session_dev_add(struct sr_session *session,
114 struct sr_dev_inst *sdi);
115SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
116SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
10509bc2 117
10509bc2 118/* Datafeed setup */
0812c40e
ML
119SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
120SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
121 sr_datafeed_callback cb, void *cb_data);
10509bc2
BV
122
123/* Session control */
0812c40e
ML
124SR_API int sr_session_start(struct sr_session *session);
125SR_API int sr_session_run(struct sr_session *session);
126SR_API int sr_session_stop(struct sr_session *session);
5de0fc55
DE
127SR_API int sr_session_is_running(struct sr_session *session);
128SR_API int sr_session_stopped_callback_set(struct sr_session *session,
129 sr_session_stopped_callback cb, void *cb_data);
130
0812c40e
ML
131SR_API int sr_session_source_add(struct sr_session *session, int fd,
132 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
133SR_API int sr_session_source_add_pollfd(struct sr_session *session,
134 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
135 void *cb_data);
136SR_API int sr_session_source_add_channel(struct sr_session *session,
137 GIOChannel *channel, int events, int timeout,
144f6660 138 sr_receive_data_callback cb, void *cb_data);
0812c40e
ML
139SR_API int sr_session_source_remove(struct sr_session *session, int fd);
140SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
141 GPollFD *pollfd);
142SR_API int sr_session_source_remove_channel(struct sr_session *session,
143 GIOChannel *channel);
10509bc2 144
aa0b6b20 145/*--- input/input.c ---------------------------------------------------------*/
10509bc2 146
17bfaca6 147SR_API const struct sr_input_module **sr_input_list(void);
4fb0a5f8
UH
148SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
149SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
150SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
c7bc82ff 151SR_API const char *const *sr_input_extensions_get(
4fb0a5f8 152 const struct sr_input_module *imod);
17bfaca6 153SR_API const struct sr_input_module *sr_input_find(char *id);
4fb0a5f8 154SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
3cd4b381
SA
155SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
156 uint64_t flag);
bd0bfaaf 157SR_API void sr_input_options_free(const struct sr_option **options);
17bfaca6
BV
158SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
159 GHashTable *options);
4f979115
BV
160SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
161SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
17bfaca6
BV
162SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
163SR_API int sr_input_send(const struct sr_input *in, GString *buf);
7066fd46 164SR_API int sr_input_end(const struct sr_input *in);
d5cc282f 165SR_API void sr_input_free(const struct sr_input *in);
aa0b6b20
UH
166
167/*--- output/output.c -------------------------------------------------------*/
168
a755b0e1 169SR_API const struct sr_output_module **sr_output_list(void);
4fb0a5f8
UH
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);
8a174d23 173SR_API const char *const *sr_output_extensions_get(
4fb0a5f8 174 const struct sr_output_module *omod);
a755b0e1 175SR_API const struct sr_output_module *sr_output_find(char *id);
4fb0a5f8 176SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
fc746430 177SR_API void sr_output_options_free(const struct sr_option **opts);
4fb0a5f8 178SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
81b3ce37
SA
179 GHashTable *params, const struct sr_dev_inst *sdi,
180 const char *filename);
a755b0e1 181SR_API int sr_output_send(const struct sr_output *o,
dba3e682 182 const struct sr_datafeed_packet *packet, GString **out);
a755b0e1 183SR_API int sr_output_free(const struct sr_output *o);
aa0b6b20 184
988357ca
UH
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
7b5e6d29
BV
198/*--- trigger.c -------------------------------------------------------------*/
199
00ebcbf4 200SR_API struct sr_trigger *sr_trigger_new(const char *name);
7b5e6d29 201SR_API void sr_trigger_free(struct sr_trigger *trig);
a153d6b8 202SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
7b5e6d29
BV
203SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
204 struct sr_channel *ch, int trigger_match, float value);
205
24287ea9
AJ
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
bee24666
DE
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 ssize_t (*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
bb7ef793 225/*--- strutil.c -------------------------------------------------------------*/
aa0b6b20 226
4cc9aea1 227SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
1a081ca6
UH
228SR_API char *sr_samplerate_string(uint64_t samplerate);
229SR_API char *sr_period_string(uint64_t frequency);
e0e15067 230SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
1a081ca6
UH
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);
76e107d6
BV
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);
10509bc2 236
787c4390
UH
237/*--- version.c -------------------------------------------------------------*/
238
239SR_API int sr_package_version_major_get(void);
240SR_API int sr_package_version_minor_get(void);
241SR_API int sr_package_version_micro_get(void);
242SR_API const char *sr_package_version_string_get(void);
243
244SR_API int sr_lib_version_current_get(void);
245SR_API int sr_lib_version_revision_get(void);
246SR_API int sr_lib_version_age_get(void);
247SR_API const char *sr_lib_version_string_get(void);
248
b5a8e848
UH
249/*--- error.c ---------------------------------------------------------------*/
250
251SR_API const char *sr_strerror(int error_code);
252SR_API const char *sr_strerror_name(int error_code);
253
c2bd92ec 254#endif