]>
Commit | Line | Data |
---|---|---|
10509bc2 BV |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 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 | ||
0f8522bf UH |
20 | #ifndef LIBSIGROK_SIGROK_PROTO_H |
21 | #define LIBSIGROK_SIGROK_PROTO_H | |
10509bc2 | 22 | |
393fb9cb UH |
23 | /** |
24 | * @file | |
25 | * | |
26 | * Header file containing API function prototypes. | |
27 | */ | |
28 | ||
10509bc2 BV |
29 | /*--- backend.c -------------------------------------------------------------*/ |
30 | ||
b8072700 PS |
31 | SR_API int sr_init(struct sr_context **ctx); |
32 | SR_API int sr_exit(struct sr_context *ctx); | |
10509bc2 | 33 | |
1352eedd UH |
34 | /*--- log.c -----------------------------------------------------------------*/ |
35 | ||
b5118d6c UH |
36 | typedef int (*sr_log_callback_t)(void *cb_data, int loglevel, |
37 | const char *format, va_list args); | |
0ae67ff7 UH |
38 | |
39 | SR_API int sr_log_loglevel_set(int loglevel); | |
40 | SR_API int sr_log_loglevel_get(void); | |
b5118d6c UH |
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); | |
0ae67ff7 UH |
43 | SR_API int sr_log_logdomain_set(const char *logdomain); |
44 | SR_API char *sr_log_logdomain_get(void); | |
1352eedd | 45 | |
aa0b6b20 UH |
46 | /*--- datastore.c -----------------------------------------------------------*/ |
47 | ||
1a081ca6 UH |
48 | SR_API int sr_datastore_new(int unitsize, struct sr_datastore **ds); |
49 | SR_API int sr_datastore_destroy(struct sr_datastore *ds); | |
50 | SR_API int sr_datastore_put(struct sr_datastore *ds, void *data, | |
51 | unsigned int length, int in_unitsize, | |
8ec95d22 | 52 | const int *probelist); |
aa0b6b20 | 53 | |
aa0b6b20 | 54 | /*--- device.c --------------------------------------------------------------*/ |
10509bc2 | 55 | |
37e8b4c4 BV |
56 | SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, |
57 | int probenum, const char *name); | |
be5bf44d BV |
58 | SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, |
59 | gboolean state); | |
58453e58 BV |
60 | SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, |
61 | const char *trigger); | |
a5b35a16 | 62 | SR_API gboolean sr_dev_has_hwcap(const struct sr_dev_inst *sdi, int hwcap); |
a56f1480 BV |
63 | SR_API int sr_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, |
64 | const void *value); | |
811deee4 BV |
65 | SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver); |
66 | SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver); | |
10509bc2 | 67 | |
aa0b6b20 UH |
68 | /*--- filter.c --------------------------------------------------------------*/ |
69 | ||
1a081ca6 | 70 | SR_API int sr_filter_probes(int in_unitsize, int out_unitsize, |
054e6709 UH |
71 | const int *probelist, const uint8_t *data_in, |
72 | uint64_t length_in, uint8_t **data_out, | |
1a081ca6 | 73 | uint64_t *length_out); |
aa0b6b20 | 74 | |
c09f0b57 | 75 | /*--- hwdriver.c ------------------------------------------------------------*/ |
aa0b6b20 | 76 | |
cfe064d8 | 77 | SR_API struct sr_dev_driver **sr_driver_list(void); |
44fc870c PS |
78 | SR_API int sr_driver_init(struct sr_context *ctx, |
79 | struct sr_dev_driver *driver); | |
80bf0426 | 80 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options); |
48a486cd BV |
81 | SR_API int sr_info_get(struct sr_dev_driver *driver, int id, |
82 | const void **data, const struct sr_dev_inst *sdi); | |
cfe064d8 | 83 | SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap); |
15cb43d6 BV |
84 | SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt); |
85 | SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname); | |
86 | SR_API const struct sr_hwcap_option *sr_devopt_get(int opt); | |
87 | SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname); | |
10509bc2 BV |
88 | |
89 | /*--- session.c -------------------------------------------------------------*/ | |
90 | ||
ff14f01b BV |
91 | typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi, |
92 | struct sr_datafeed_packet *packet); | |
10509bc2 BV |
93 | |
94 | /* Session setup */ | |
1a081ca6 UH |
95 | SR_API int sr_session_load(const char *filename); |
96 | SR_API struct sr_session *sr_session_new(void); | |
97 | SR_API int sr_session_destroy(void); | |
01c3e9db | 98 | SR_API int sr_session_dev_remove_all(void); |
de4d3f99 | 99 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi); |
10509bc2 | 100 | |
10509bc2 | 101 | /* Datafeed setup */ |
01c3e9db | 102 | SR_API int sr_session_datafeed_callback_remove_all(void); |
d08490aa | 103 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb); |
10509bc2 BV |
104 | |
105 | /* Session control */ | |
1a081ca6 UH |
106 | SR_API int sr_session_start(void); |
107 | SR_API int sr_session_run(void); | |
108 | SR_API int sr_session_halt(void); | |
109 | SR_API int sr_session_stop(void); | |
056be071 BV |
110 | SR_API int sr_session_save(const char *filename, |
111 | const struct sr_dev_inst *sdi, struct sr_datastore *ds); | |
1a081ca6 | 112 | SR_API int sr_session_source_add(int fd, int events, int timeout, |
1f9813eb | 113 | sr_receive_data_callback_t cb, void *cb_data); |
aac0ea25 LPC |
114 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, |
115 | sr_receive_data_callback_t cb, void *cb_data); | |
116 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, | |
117 | int timeout, sr_receive_data_callback_t cb, void *cb_data); | |
1a081ca6 | 118 | SR_API int sr_session_source_remove(int fd); |
aac0ea25 LPC |
119 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd); |
120 | SR_API int sr_session_source_remove_channel(GIOChannel *channel); | |
10509bc2 | 121 | |
aa0b6b20 | 122 | /*--- input/input.c ---------------------------------------------------------*/ |
10509bc2 | 123 | |
1a081ca6 | 124 | SR_API struct sr_input_format **sr_input_list(void); |
aa0b6b20 UH |
125 | |
126 | /*--- output/output.c -------------------------------------------------------*/ | |
127 | ||
1a081ca6 | 128 | SR_API struct sr_output_format **sr_output_list(void); |
aa0b6b20 | 129 | |
bb7ef793 | 130 | /*--- strutil.c -------------------------------------------------------------*/ |
aa0b6b20 | 131 | |
4cc9aea1 | 132 | SR_API char *sr_si_string_u64(uint64_t x, const char *unit); |
1a081ca6 UH |
133 | SR_API char *sr_samplerate_string(uint64_t samplerate); |
134 | SR_API char *sr_period_string(uint64_t frequency); | |
79afc8ca | 135 | SR_API char *sr_voltage_string(struct sr_rational *voltage); |
92ae7984 BV |
136 | SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, |
137 | const char *triggerstring); | |
1a081ca6 UH |
138 | SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size); |
139 | SR_API uint64_t sr_parse_timestring(const char *timestring); | |
140 | SR_API gboolean sr_parse_boolstring(const char *boolstring); | |
76f4c610 | 141 | SR_API int sr_parse_period(const char *periodstr, struct sr_rational *r); |
79afc8ca | 142 | SR_API int sr_parse_voltage(const char *voltstr, struct sr_rational *r); |
10509bc2 | 143 | |
787c4390 UH |
144 | /*--- version.c -------------------------------------------------------------*/ |
145 | ||
146 | SR_API int sr_package_version_major_get(void); | |
147 | SR_API int sr_package_version_minor_get(void); | |
148 | SR_API int sr_package_version_micro_get(void); | |
149 | SR_API const char *sr_package_version_string_get(void); | |
150 | ||
151 | SR_API int sr_lib_version_current_get(void); | |
152 | SR_API int sr_lib_version_revision_get(void); | |
153 | SR_API int sr_lib_version_age_get(void); | |
154 | SR_API const char *sr_lib_version_string_get(void); | |
155 | ||
b5a8e848 UH |
156 | /*--- error.c ---------------------------------------------------------------*/ |
157 | ||
158 | SR_API const char *sr_strerror(int error_code); | |
159 | SR_API const char *sr_strerror_name(int error_code); | |
160 | ||
c2bd92ec | 161 | #endif |