]>
Commit | Line | Data |
---|---|---|
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 | ||
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 | 46 | /*--- device.c --------------------------------------------------------------*/ |
10509bc2 | 47 | |
37e8b4c4 BV |
48 | SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi, |
49 | int probenum, const char *name); | |
be5bf44d BV |
50 | SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum, |
51 | gboolean state); | |
58453e58 BV |
52 | SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum, |
53 | const char *trigger); | |
4d15e5c9 | 54 | SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key); |
f99e32af BV |
55 | SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver); |
56 | SR_API int sr_dev_clear(const struct sr_dev_driver *driver); | |
efdecf4c BV |
57 | SR_API int sr_dev_open(struct sr_dev_inst *sdi); |
58 | SR_API int sr_dev_close(struct sr_dev_inst *sdi); | |
10509bc2 | 59 | |
aa0b6b20 UH |
60 | /*--- filter.c --------------------------------------------------------------*/ |
61 | ||
305de92e BV |
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, | |
054e6709 | 64 | uint64_t length_in, uint8_t **data_out, |
1a081ca6 | 65 | uint64_t *length_out); |
aa0b6b20 | 66 | |
c09f0b57 | 67 | /*--- hwdriver.c ------------------------------------------------------------*/ |
aa0b6b20 | 68 | |
cfe064d8 | 69 | SR_API struct sr_dev_driver **sr_driver_list(void); |
44fc870c PS |
70 | SR_API int sr_driver_init(struct sr_context *ctx, |
71 | struct sr_dev_driver *driver); | |
80bf0426 | 72 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options); |
8f996b89 ML |
73 | SR_API int sr_config_get(const struct sr_dev_driver *driver, |
74 | const struct sr_dev_inst *sdi, | |
75 | const struct sr_probe_group *probe_group, | |
76 | int key, GVariant **data); | |
77 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, | |
78 | const struct sr_probe_group *probe_group, | |
79 | int key, GVariant *data); | |
80 | SR_API int sr_config_list(const struct sr_dev_driver *driver, | |
81 | const struct sr_dev_inst *sdi, | |
82 | const struct sr_probe_group *probe_group, | |
83 | int key, GVariant **data); | |
c89c1c9c BV |
84 | SR_API const struct sr_config_info *sr_config_info_get(int key); |
85 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname); | |
10509bc2 BV |
86 | |
87 | /*--- session.c -------------------------------------------------------------*/ | |
88 | ||
ff14f01b | 89 | typedef void (*sr_datafeed_callback_t)(const struct sr_dev_inst *sdi, |
2726474a | 90 | const struct sr_datafeed_packet *packet, void *cb_data); |
10509bc2 BV |
91 | |
92 | /* Session setup */ | |
1a081ca6 UH |
93 | SR_API int sr_session_load(const char *filename); |
94 | SR_API struct sr_session *sr_session_new(void); | |
95 | SR_API int sr_session_destroy(void); | |
01c3e9db | 96 | SR_API int sr_session_dev_remove_all(void); |
de4d3f99 | 97 | SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi); |
c542391f | 98 | SR_API int sr_session_dev_list(GSList **devlist); |
10509bc2 | 99 | |
10509bc2 | 100 | /* Datafeed setup */ |
01c3e9db | 101 | SR_API int sr_session_datafeed_callback_remove_all(void); |
2726474a ML |
102 | SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, |
103 | void *cb_data); | |
10509bc2 BV |
104 | |
105 | /* Session control */ | |
1a081ca6 UH |
106 | SR_API int sr_session_start(void); |
107 | SR_API int sr_session_run(void); | |
1a081ca6 | 108 | SR_API int sr_session_stop(void); |
18bc2704 BV |
109 | SR_API int sr_session_save(const char *filename, const struct sr_dev_inst *sdi, |
110 | unsigned char *buf, int unitsize, int units); | |
f438e0c9 BV |
111 | SR_API int sr_session_append(const char *filename, unsigned char *buf, |
112 | int unitsize, int units); | |
1a081ca6 | 113 | SR_API int sr_session_source_add(int fd, int events, int timeout, |
1f9813eb | 114 | sr_receive_data_callback_t cb, void *cb_data); |
aac0ea25 LPC |
115 | SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, |
116 | sr_receive_data_callback_t cb, void *cb_data); | |
117 | SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, | |
118 | int timeout, sr_receive_data_callback_t cb, void *cb_data); | |
1a081ca6 | 119 | SR_API int sr_session_source_remove(int fd); |
aac0ea25 LPC |
120 | SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd); |
121 | SR_API int sr_session_source_remove_channel(GIOChannel *channel); | |
10509bc2 | 122 | |
aa0b6b20 | 123 | /*--- input/input.c ---------------------------------------------------------*/ |
10509bc2 | 124 | |
1a081ca6 | 125 | SR_API struct sr_input_format **sr_input_list(void); |
aa0b6b20 UH |
126 | |
127 | /*--- output/output.c -------------------------------------------------------*/ | |
128 | ||
1a081ca6 | 129 | SR_API struct sr_output_format **sr_output_list(void); |
aa0b6b20 | 130 | |
bb7ef793 | 131 | /*--- strutil.c -------------------------------------------------------------*/ |
aa0b6b20 | 132 | |
4cc9aea1 | 133 | SR_API char *sr_si_string_u64(uint64_t x, const char *unit); |
1a081ca6 UH |
134 | SR_API char *sr_samplerate_string(uint64_t samplerate); |
135 | SR_API char *sr_period_string(uint64_t frequency); | |
e0e15067 | 136 | SR_API char *sr_voltage_string(uint64_t v_p, uint64_t v_q); |
92ae7984 BV |
137 | SR_API char **sr_parse_triggerstring(const struct sr_dev_inst *sdi, |
138 | const char *triggerstring); | |
1a081ca6 UH |
139 | SR_API int sr_parse_sizestring(const char *sizestring, uint64_t *size); |
140 | SR_API uint64_t sr_parse_timestring(const char *timestring); | |
141 | SR_API gboolean sr_parse_boolstring(const char *boolstring); | |
76e107d6 BV |
142 | SR_API int sr_parse_period(const char *periodstr, uint64_t *p, uint64_t *q); |
143 | SR_API int sr_parse_voltage(const char *voltstr, uint64_t *p, uint64_t *q); | |
10509bc2 | 144 | |
787c4390 UH |
145 | /*--- version.c -------------------------------------------------------------*/ |
146 | ||
147 | SR_API int sr_package_version_major_get(void); | |
148 | SR_API int sr_package_version_minor_get(void); | |
149 | SR_API int sr_package_version_micro_get(void); | |
150 | SR_API const char *sr_package_version_string_get(void); | |
151 | ||
152 | SR_API int sr_lib_version_current_get(void); | |
153 | SR_API int sr_lib_version_revision_get(void); | |
154 | SR_API int sr_lib_version_age_get(void); | |
155 | SR_API const char *sr_lib_version_string_get(void); | |
156 | ||
b5a8e848 UH |
157 | /*--- error.c ---------------------------------------------------------------*/ |
158 | ||
159 | SR_API const char *sr_strerror(int error_code); | |
160 | SR_API const char *sr_strerror_name(int error_code); | |
161 | ||
c2bd92ec | 162 | #endif |