]> sigrok.org Git - libsigrok.git/blame - include/libsigrok/proto.h
session-file: Remove old session save API
[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
144f6660 101typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
2726474a 102 const struct sr_datafeed_packet *packet, void *cb_data);
0812c40e 103SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
10509bc2
BV
104
105/* Session setup */
61e6e2da
ML
106SR_API int sr_session_load(struct sr_context *ctx, const char *filename,
107 struct sr_session **session);
108SR_API int sr_session_new(struct sr_context *ctx, struct sr_session **session);
0812c40e
ML
109SR_API int sr_session_destroy(struct sr_session *session);
110SR_API int sr_session_dev_remove_all(struct sr_session *session);
111SR_API int sr_session_dev_add(struct sr_session *session,
112 struct sr_dev_inst *sdi);
113SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
114SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
10509bc2 115
10509bc2 116/* Datafeed setup */
0812c40e
ML
117SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
118SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
119 sr_datafeed_callback cb, void *cb_data);
10509bc2
BV
120
121/* Session control */
0812c40e
ML
122SR_API int sr_session_start(struct sr_session *session);
123SR_API int sr_session_run(struct sr_session *session);
124SR_API int sr_session_stop(struct sr_session *session);
0812c40e
ML
125SR_API int sr_session_source_add(struct sr_session *session, int fd,
126 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
127SR_API int sr_session_source_add_pollfd(struct sr_session *session,
128 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
129 void *cb_data);
130SR_API int sr_session_source_add_channel(struct sr_session *session,
131 GIOChannel *channel, int events, int timeout,
144f6660 132 sr_receive_data_callback cb, void *cb_data);
0812c40e
ML
133SR_API int sr_session_source_remove(struct sr_session *session, int fd);
134SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
135 GPollFD *pollfd);
136SR_API int sr_session_source_remove_channel(struct sr_session *session,
137 GIOChannel *channel);
10509bc2 138
aa0b6b20 139/*--- input/input.c ---------------------------------------------------------*/
10509bc2 140
17bfaca6 141SR_API const struct sr_input_module **sr_input_list(void);
4fb0a5f8
UH
142SR_API const char *sr_input_id_get(const struct sr_input_module *imod);
143SR_API const char *sr_input_name_get(const struct sr_input_module *imod);
144SR_API const char *sr_input_description_get(const struct sr_input_module *imod);
c7bc82ff 145SR_API const char *const *sr_input_extensions_get(
4fb0a5f8 146 const struct sr_input_module *imod);
17bfaca6 147SR_API const struct sr_input_module *sr_input_find(char *id);
4fb0a5f8 148SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *imod);
3cd4b381
SA
149SR_API gboolean sr_output_test_flag(const struct sr_output_module *omod,
150 uint64_t flag);
bd0bfaaf 151SR_API void sr_input_options_free(const struct sr_option **options);
17bfaca6
BV
152SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
153 GHashTable *options);
4f979115
BV
154SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
155SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
17bfaca6
BV
156SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
157SR_API int sr_input_send(const struct sr_input *in, GString *buf);
7066fd46 158SR_API int sr_input_end(const struct sr_input *in);
d5cc282f 159SR_API void sr_input_free(const struct sr_input *in);
aa0b6b20
UH
160
161/*--- output/output.c -------------------------------------------------------*/
162
a755b0e1 163SR_API const struct sr_output_module **sr_output_list(void);
4fb0a5f8
UH
164SR_API const char *sr_output_id_get(const struct sr_output_module *omod);
165SR_API const char *sr_output_name_get(const struct sr_output_module *omod);
166SR_API const char *sr_output_description_get(const struct sr_output_module *omod);
8a174d23 167SR_API const char *const *sr_output_extensions_get(
4fb0a5f8 168 const struct sr_output_module *omod);
a755b0e1 169SR_API const struct sr_output_module *sr_output_find(char *id);
4fb0a5f8 170SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *omod);
fc746430 171SR_API void sr_output_options_free(const struct sr_option **opts);
4fb0a5f8 172SR_API const struct sr_output *sr_output_new(const struct sr_output_module *omod,
81b3ce37
SA
173 GHashTable *params, const struct sr_dev_inst *sdi,
174 const char *filename);
a755b0e1 175SR_API int sr_output_send(const struct sr_output *o,
dba3e682 176 const struct sr_datafeed_packet *packet, GString **out);
a755b0e1 177SR_API int sr_output_free(const struct sr_output *o);
aa0b6b20 178
988357ca
UH
179/*--- transform/transform.c -------------------------------------------------*/
180
181SR_API const struct sr_transform_module **sr_transform_list(void);
182SR_API const char *sr_transform_id_get(const struct sr_transform_module *tmod);
183SR_API const char *sr_transform_name_get(const struct sr_transform_module *tmod);
184SR_API const char *sr_transform_description_get(const struct sr_transform_module *tmod);
185SR_API const struct sr_transform_module *sr_transform_find(const char *id);
186SR_API const struct sr_option **sr_transform_options_get(const struct sr_transform_module *tmod);
187SR_API void sr_transform_options_free(const struct sr_option **opts);
188SR_API const struct sr_transform *sr_transform_new(const struct sr_transform_module *tmod,
189 GHashTable *params, const struct sr_dev_inst *sdi);
190SR_API int sr_transform_free(const struct sr_transform *t);
191
7b5e6d29
BV
192/*--- trigger.c -------------------------------------------------------------*/
193
00ebcbf4 194SR_API struct sr_trigger *sr_trigger_new(const char *name);
7b5e6d29 195SR_API void sr_trigger_free(struct sr_trigger *trig);
a153d6b8 196SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
7b5e6d29
BV
197SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
198 struct sr_channel *ch, int trigger_match, float value);
199
24287ea9
AJ
200/*--- serial.c --------------------------------------------------------------*/
201
202SR_API GSList *sr_serial_list(const struct sr_dev_driver *driver);
203SR_API void sr_serial_free(struct sr_serial_port *serial);
204
bb7ef793 205/*--- strutil.c -------------------------------------------------------------*/
aa0b6b20 206
4cc9aea1 207SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
1a081ca6
UH
208SR_API char *sr_samplerate_string(uint64_t samplerate);
209SR_API char *sr_period_string(uint64_t frequency);
e0e15067 210SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
1a081ca6
UH
211SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
212SR_API uint64_t sr_parse_timestring(const char *timestring);
213SR_API gboolean sr_parse_boolstring(const char *boolstring);
76e107d6
BV
214SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
215SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
10509bc2 216
787c4390
UH
217/*--- version.c -------------------------------------------------------------*/
218
219SR_API int sr_package_version_major_get(void);
220SR_API int sr_package_version_minor_get(void);
221SR_API int sr_package_version_micro_get(void);
222SR_API const char *sr_package_version_string_get(void);
223
224SR_API int sr_lib_version_current_get(void);
225SR_API int sr_lib_version_revision_get(void);
226SR_API int sr_lib_version_age_get(void);
227SR_API const char *sr_lib_version_string_get(void);
228
b5a8e848
UH
229/*--- error.c ---------------------------------------------------------------*/
230
231SR_API const char *sr_strerror(int error_code);
232SR_API const char *sr_strerror_name(int error_code);
233
c2bd92ec 234#endif