2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #ifndef LIBSIGROK_PROTO_H
21 #define LIBSIGROK_PROTO_H
26 * Header file containing API function prototypes.
29 /*--- backend.c -------------------------------------------------------------*/
31 SR_API int sr_init(struct sr_context **ctx);
32 SR_API int sr_exit(struct sr_context *ctx);
34 /*--- log.c -----------------------------------------------------------------*/
36 typedef int (*sr_log_callback)(void *cb_data, int loglevel,
37 const char *format, va_list args);
39 SR_API int sr_log_loglevel_set(int loglevel);
40 SR_API int sr_log_loglevel_get(void);
41 SR_API int sr_log_callback_set(sr_log_callback cb, void *cb_data);
42 SR_API int sr_log_callback_set_default(void);
43 SR_API int sr_log_logdomain_set(const char *logdomain);
44 SR_API char *sr_log_logdomain_get(void);
46 /*--- device.c --------------------------------------------------------------*/
48 SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
49 int channelnum, const char *name);
50 SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
52 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key);
53 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver);
54 SR_API int sr_dev_clear(const struct sr_dev_driver *driver);
55 SR_API int sr_dev_open(struct sr_dev_inst *sdi);
56 SR_API int sr_dev_close(struct sr_dev_inst *sdi);
58 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(struct sr_dev_inst *sdi);
59 SR_API const char *sr_dev_inst_vendor_get(struct sr_dev_inst *sdi);
60 SR_API const char *sr_dev_inst_model_get(struct sr_dev_inst *sdi);
61 SR_API const char *sr_dev_inst_version_get(struct sr_dev_inst *sdi);
62 SR_API const char *sr_dev_inst_sernum_get(struct sr_dev_inst *sdi);
63 SR_API const char *sr_dev_inst_connid_get(struct sr_dev_inst *sdi);
65 /*--- hwdriver.c ------------------------------------------------------------*/
67 SR_API struct sr_dev_driver **sr_driver_list(void);
68 SR_API int sr_driver_init(struct sr_context *ctx,
69 struct sr_dev_driver *driver);
70 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
71 SR_API int sr_config_get(const struct sr_dev_driver *driver,
72 const struct sr_dev_inst *sdi,
73 const struct sr_channel_group *cg,
74 uint32_t key, GVariant **data);
75 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
76 const struct sr_channel_group *cg,
77 uint32_t key, GVariant *data);
78 SR_API int sr_config_commit(const struct sr_dev_inst *sdi);
79 SR_API int sr_config_list(const struct sr_dev_driver *driver,
80 const struct sr_dev_inst *sdi,
81 const struct sr_channel_group *cg,
82 uint32_t key, GVariant **data);
83 SR_API const struct sr_config_info *sr_config_info_get(uint32_t key);
84 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname);
86 /*--- session.c -------------------------------------------------------------*/
88 typedef void (*sr_datafeed_callback)(const struct sr_dev_inst *sdi,
89 const struct sr_datafeed_packet *packet, void *cb_data);
90 SR_API struct sr_trigger *sr_session_trigger_get(struct sr_session *session);
93 SR_API int sr_session_load(const char *filename, struct sr_session **session);
94 SR_API int sr_session_new(struct sr_session **session);
95 SR_API int sr_session_destroy(struct sr_session *session);
96 SR_API int sr_session_dev_remove_all(struct sr_session *session);
97 SR_API int sr_session_dev_add(struct sr_session *session,
98 struct sr_dev_inst *sdi);
99 SR_API int sr_session_dev_list(struct sr_session *session, GSList **devlist);
100 SR_API int sr_session_trigger_set(struct sr_session *session, struct sr_trigger *trig);
103 SR_API int sr_session_datafeed_callback_remove_all(struct sr_session *session);
104 SR_API int sr_session_datafeed_callback_add(struct sr_session *session,
105 sr_datafeed_callback cb, void *cb_data);
107 /* Session control */
108 SR_API int sr_session_start(struct sr_session *session);
109 SR_API int sr_session_run(struct sr_session *session);
110 SR_API int sr_session_stop(struct sr_session *session);
111 SR_API int sr_session_save(struct sr_session *session, const char *filename,
112 const struct sr_dev_inst *sdi, unsigned char *buf, int unitsize,
114 SR_API int sr_session_save_init(struct sr_session *session,
115 const char *filename, uint64_t samplerate, char **channels);
116 SR_API int sr_session_append(struct sr_session *session,
117 const char *filename, unsigned char *buf, int unitsize, int units);
118 SR_API int sr_session_source_add(struct sr_session *session, int fd,
119 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
120 SR_API int sr_session_source_add_pollfd(struct sr_session *session,
121 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
123 SR_API int sr_session_source_add_channel(struct sr_session *session,
124 GIOChannel *channel, int events, int timeout,
125 sr_receive_data_callback cb, void *cb_data);
126 SR_API int sr_session_source_remove(struct sr_session *session, int fd);
127 SR_API int sr_session_source_remove_pollfd(struct sr_session *session,
129 SR_API int sr_session_source_remove_channel(struct sr_session *session,
130 GIOChannel *channel);
132 /*--- input/input.c ---------------------------------------------------------*/
134 SR_API const struct sr_input_module **sr_input_list(void);
135 SR_API const char *sr_input_id_get(const struct sr_input_module *in);
136 SR_API const char *sr_input_name_get(const struct sr_input_module *in);
137 SR_API const char *sr_input_description_get(const struct sr_input_module *in);
138 SR_API const struct sr_input_module *sr_input_find(char *id);
139 SR_API const struct sr_option **sr_input_options_get(const struct sr_input_module *in);
140 SR_API void sr_input_options_free(const struct sr_option **options);
141 SR_API struct sr_input *sr_input_new(const struct sr_input_module *imod,
142 GHashTable *options);
143 SR_API int sr_input_scan_buffer(GString *buf, const struct sr_input **in);
144 SR_API int sr_input_scan_file(const char *filename, const struct sr_input **in);
145 SR_API struct sr_dev_inst *sr_input_dev_inst_get(const struct sr_input *in);
146 SR_API int sr_input_send(const struct sr_input *in, GString *buf);
147 SR_API int sr_input_end(const struct sr_input *in);
148 SR_API void sr_input_free(const struct sr_input *in);
150 /*--- output/output.c -------------------------------------------------------*/
152 SR_API const struct sr_output_module **sr_output_list(void);
153 SR_API const char *sr_output_id_get(const struct sr_output_module *o);
154 SR_API const char *sr_output_name_get(const struct sr_output_module *o);
155 SR_API const char *sr_output_description_get(const struct sr_output_module *o);
156 SR_API const struct sr_output_module *sr_output_find(char *id);
157 SR_API const struct sr_option **sr_output_options_get(const struct sr_output_module *o);
158 SR_API void sr_output_options_free(const struct sr_option **opts);
159 SR_API const struct sr_output *sr_output_new(const struct sr_output_module *o,
160 GHashTable *params, const struct sr_dev_inst *sdi);
161 SR_API int sr_output_send(const struct sr_output *o,
162 const struct sr_datafeed_packet *packet, GString **out);
163 SR_API int sr_output_free(const struct sr_output *o);
165 /*--- trigger.c -------------------------------------------------------------*/
167 SR_API struct sr_trigger *sr_trigger_new(const char *name);
168 SR_API void sr_trigger_free(struct sr_trigger *trig);
169 SR_API struct sr_trigger_stage *sr_trigger_stage_add(struct sr_trigger *trig);
170 SR_API int sr_trigger_match_add(struct sr_trigger_stage *stage,
171 struct sr_channel *ch, int trigger_match, float value);
173 /*--- strutil.c -------------------------------------------------------------*/
175 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
176 SR_API char *sr_samplerate_string(uint64_t samplerate);
177 SR_API char *sr_period_string(uint64_t frequency);
178 SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q);
179 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
180 SR_API uint64_t sr_parse_timestring(const char *timestring);
181 SR_API gboolean sr_parse_boolstring(const char *boolstring);
182 SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q);
183 SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q);
185 /*--- version.c -------------------------------------------------------------*/
187 SR_API int sr_package_version_major_get(void);
188 SR_API int sr_package_version_minor_get(void);
189 SR_API int sr_package_version_micro_get(void);
190 SR_API const char *sr_package_version_string_get(void);
192 SR_API int sr_lib_version_current_get(void);
193 SR_API int sr_lib_version_revision_get(void);
194 SR_API int sr_lib_version_age_get(void);
195 SR_API const char *sr_lib_version_string_get(void);
197 /*--- error.c ---------------------------------------------------------------*/
199 SR_API const char *sr_strerror(int error_code);
200 SR_API const char *sr_strerror_name(int error_code);