2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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_SIGROK_PROTO_H
21 #define LIBSIGROK_SIGROK_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_t)(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_t 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_probe_name_set(const struct sr_dev_inst *sdi,
49 int probenum, const char *name);
50 SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
52 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
54 SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap);
55 SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
57 SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver);
58 SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver);
60 /*--- filter.c --------------------------------------------------------------*/
62 SR_API int sr_filter_probes(unsigned int in_unitsize, unsigned int out_unitsize,
63 const GArray *probe_array, const uint8_t *data_in,
64 uint64_t length_in, uint8_t **data_out,
65 uint64_t *length_out);
67 /*--- hwdriver.c ------------------------------------------------------------*/
69 SR_API struct sr_dev_driver **sr_driver_list(void);
70 SR_API int sr_driver_init(struct sr_context *ctx,
71 struct sr_dev_driver *driver);
72 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options);
73 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
74 const void **data, const struct sr_dev_inst *sdi);
75 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap);
76 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt);
77 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname);
78 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt);
79 SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname);
81 /*--- session.c -------------------------------------------------------------*/
83 typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi,
84 const struct sr_datafeed_packet *packet);
87 SR_API int sr_session_load(const char *filename);
88 SR_API struct sr_session *sr_session_new(void);
89 SR_API int sr_session_destroy(void);
90 SR_API int sr_session_dev_remove_all(void);
91 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi);
94 SR_API int sr_session_datafeed_callback_remove_all(void);
95 SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb);
98 SR_API int sr_session_start(void);
99 SR_API int sr_session_run(void);
100 SR_API int sr_session_halt(void);
101 SR_API int sr_session_stop(void);
102 SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi,
103 unsigned char *buf, int unitsize, int units);
104 SR_API int sr_session_source_add(int fd, int events, int timeout,
105 sr_receive_data_callback_t cb, void *cb_data);
106 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
107 sr_receive_data_callback_t cb, void *cb_data);
108 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
109 int timeout, sr_receive_data_callback_t cb, void *cb_data);
110 SR_API int sr_session_source_remove(int fd);
111 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd);
112 SR_API int sr_session_source_remove_channel(GIOChannel *channel);
114 /*--- input/input.c ---------------------------------------------------------*/
116 SR_API struct sr_input_format **sr_input_list(void);
118 /*--- output/output.c -------------------------------------------------------*/
120 SR_API struct sr_output_format **sr_output_list(void);
122 /*--- strutil.c -------------------------------------------------------------*/
124 SR_API char *sr_si_string_u64(uint64_t x, const char *unit);
125 SR_API char *sr_samplerate_string(uint64_t samplerate);
126 SR_API char *sr_period_string(uint64_t frequency);
127 SR_API char *sr_voltage_string(struct sr_rational *voltage);
128 SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi,
129 const char *triggerstring);
130 SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size);
131 SR_API uint64_t sr_parse_timestring(const char *timestring);
132 SR_API gboolean sr_parse_boolstring(const char *boolstring);
133 SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r);
134 SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r);
136 /*--- version.c -------------------------------------------------------------*/
138 SR_API int sr_package_version_major_get(void);
139 SR_API int sr_package_version_minor_get(void);
140 SR_API int sr_package_version_micro_get(void);
141 SR_API const char *sr_package_version_string_get(void);
143 SR_API int sr_lib_version_current_get(void);
144 SR_API int sr_lib_version_revision_get(void);
145 SR_API int sr_lib_version_age_get(void);
146 SR_API const char *sr_lib_version_string_get(void);
148 /*--- error.c ---------------------------------------------------------------*/
150 SR_API const char *sr_strerror(int error_code);
151 SR_API const char *sr_strerror_name(int error_code);