]>
Commit | Line | Data |
---|---|---|
1c6fa20f | 1 | /* |
50bd5d25 | 2 | * This file is part of the libsigrokdecode project. |
1c6fa20f UH |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
1c6fa20f UH |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | */ | |
21 | ||
3b5839d5 UH |
22 | #ifndef LIBSIGROKDECODE_SIGROKDECODE_H |
23 | #define LIBSIGROKDECODE_SIGROKDECODE_H | |
1c6fa20f | 24 | |
1c6fa20f | 25 | #include <stdint.h> |
5c55017c | 26 | #include <glib.h> |
1c6fa20f | 27 | |
253f9603 UH |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
32cfb920 BV |
32 | struct srd_session; |
33 | ||
54fdeeef UH |
34 | /** |
35 | * @file | |
36 | * | |
37 | * The public libsigrokdecode header file to be used by frontends. | |
38 | * | |
39 | * This is the only file that libsigrokdecode users (frontends) are supposed | |
40 | * to use and include. There are other header files which get installed with | |
41 | * libsigrokdecode, but those are not meant to be used directly by frontends. | |
42 | * | |
43 | * The correct way to get/use the libsigrokdecode API functions is: | |
44 | * | |
45 | * @code{.c} | |
c1f86f02 | 46 | * #include <libsigrokdecode/libsigrokdecode.h> |
54fdeeef UH |
47 | * @endcode |
48 | */ | |
49 | ||
a4898be7 | 50 | /* |
a4898be7 UH |
51 | * All possible return codes of libsigrokdecode functions must be listed here. |
52 | * Functions should never return hardcoded numbers as status, but rather | |
47dfa77d | 53 | * use these enum values. All error codes are negative numbers. |
a4898be7 UH |
54 | * |
55 | * The error codes are globally unique in libsigrokdecode, i.e. if one of the | |
56 | * libsigrokdecode functions returns a "malloc error" it must be exactly the | |
57 | * same return value as used by all other functions to indicate "malloc error". | |
58 | * There must be no functions which indicate two different errors via the | |
59 | * same return code. | |
60 | * | |
61 | * Also, for compatibility reasons, no defined return codes are ever removed | |
47dfa77d | 62 | * or reused for different errors later. You can only add new entries and |
a4898be7 UH |
63 | * return codes, but never remove or redefine existing ones. |
64 | */ | |
47dfa77d UH |
65 | |
66 | /** Status/error codes returned by libsigrokdecode functions. */ | |
af9527d1 | 67 | enum srd_error_code { |
47dfa77d UH |
68 | SRD_OK = 0, /**< No error */ |
69 | SRD_ERR = -1, /**< Generic/unspecified error */ | |
70 | SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */ | |
71 | SRD_ERR_ARG = -3, /**< Function argument error */ | |
72 | SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */ | |
73 | SRD_ERR_PYTHON = -5, /**< Python C API error */ | |
74 | SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */ | |
75 | ||
76 | /* | |
77 | * Note: When adding entries here, don't forget to also update the | |
78 | * srd_strerror() and srd_strerror_name() functions in error.c. | |
79 | */ | |
80 | }; | |
7c24d086 | 81 | |
43c0a640 | 82 | /* libsigrokdecode loglevels. */ |
af9527d1 | 83 | enum srd_loglevel { |
47dfa77d UH |
84 | SRD_LOG_NONE = 0, /**< Output no messages at all. */ |
85 | SRD_LOG_ERR = 1, /**< Output error messages. */ | |
86 | SRD_LOG_WARN = 2, /**< Output warnings. */ | |
87 | SRD_LOG_INFO = 3, /**< Output informational messages. */ | |
88 | SRD_LOG_DBG = 4, /**< Output debug messages. */ | |
89 | SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */ | |
90 | }; | |
43c0a640 | 91 | |
55c3c5f4 UH |
92 | /* |
93 | * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols. | |
94 | * | |
95 | * Variables and functions marked 'static' are private already and don't | |
d523eae6 | 96 | * need SRD_PRIV. However, functions which are not static (because they need |
55c3c5f4 UH |
97 | * to be used in other libsigrokdecode-internal files) but are also not |
98 | * meant to be part of the public libsigrokdecode API, must use SRD_PRIV. | |
99 | * | |
100 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
101 | * | |
a4cb05f7 UH |
102 | * This feature is not available on MinGW/Windows, as it is a feature of |
103 | * ELF files and MinGW/Windows uses PE files. | |
104 | * | |
55c3c5f4 UH |
105 | * Details: http://gcc.gnu.org/wiki/Visibility |
106 | */ | |
107 | ||
108 | /* Marks public libsigrokdecode API symbols. */ | |
a4cb05f7 | 109 | #ifndef _WIN32 |
55c3c5f4 | 110 | #define SRD_API __attribute__((visibility("default"))) |
a4cb05f7 UH |
111 | #else |
112 | #define SRD_API | |
113 | #endif | |
55c3c5f4 UH |
114 | |
115 | /* Marks private, non-public libsigrokdecode symbols (not part of the API). */ | |
a4cb05f7 | 116 | #ifndef _WIN32 |
55c3c5f4 | 117 | #define SRD_PRIV __attribute__((visibility("hidden"))) |
a4cb05f7 UH |
118 | #else |
119 | #define SRD_PRIV | |
120 | #endif | |
55c3c5f4 | 121 | |
c9bfccc6 UH |
122 | /* |
123 | * When adding an output type, don't forget to... | |
124 | * - expose it to PDs in controller.c:PyInit_sigrokdecode() | |
125 | * - add a check in module_sigrokdecode.c:Decoder_put() | |
126 | * - add a debug string in type_decoder.c:OUTPUT_TYPES | |
127 | */ | |
af9527d1 | 128 | enum srd_output_type { |
94d43b37 | 129 | SRD_OUTPUT_ANN, |
f2a5df42 | 130 | SRD_OUTPUT_PYTHON, |
15969949 | 131 | SRD_OUTPUT_BINARY, |
7ee0c40b | 132 | SRD_OUTPUT_META, |
e5080882 BV |
133 | }; |
134 | ||
af9527d1 | 135 | enum srd_configkey { |
ed416497 | 136 | SRD_CONF_SAMPLERATE = 10000, |
32cfb920 BV |
137 | }; |
138 | ||
d752b12b | 139 | struct srd_decoder { |
775dda7a | 140 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 141 | char *id; |
775dda7a | 142 | |
361fdcaa | 143 | /** The (short) decoder name. Must be non-NULL. */ |
31b82285 | 144 | char *name; |
775dda7a | 145 | |
122e9a90 | 146 | /** The (long) decoder name. Must be non-NULL. */ |
75a282e5 | 147 | char *longname; |
775dda7a | 148 | |
361fdcaa | 149 | /** A (short, one-line) description of the decoder. Must be non-NULL. */ |
5c55017c | 150 | char *desc; |
775dda7a | 151 | |
361fdcaa UH |
152 | /** |
153 | * The license of the decoder. Valid values: "gplv2+", "gplv3+". | |
154 | * Other values are currently not allowed. Must be non-NULL. | |
155 | */ | |
75a282e5 UH |
156 | char *license; |
157 | ||
6a15597a UH |
158 | /** List of channels required by this decoder. */ |
159 | GSList *channels; | |
f38ec285 | 160 | |
6a15597a UH |
161 | /** List of optional channels for this decoder. */ |
162 | GSList *opt_channels; | |
f38ec285 | 163 | |
361fdcaa | 164 | /** |
c9bfccc6 | 165 | * List of NULL-terminated char[], containing descriptions of the |
15969949 BV |
166 | * supported annotation output. |
167 | */ | |
e97b6ef5 | 168 | GSList *annotations; |
15969949 | 169 | |
1ce46817 UH |
170 | /** |
171 | * List of annotation rows (row items: id, description, and a list | |
172 | * of annotation classes belonging to this row). | |
173 | */ | |
174 | GSList *annotation_rows; | |
175 | ||
d75d8a7c BV |
176 | /** |
177 | * List of NULL-terminated char[], containing descriptions of the | |
178 | * supported binary output. | |
179 | */ | |
180 | GSList *binary; | |
181 | ||
2f395bff BV |
182 | /** List of decoder options. */ |
183 | GSList *options; | |
184 | ||
361fdcaa | 185 | /** Python module. */ |
f6c7eade | 186 | void *py_mod; |
b2c19614 | 187 | |
361fdcaa | 188 | /** sigrokdecode.Decoder class. */ |
f6c7eade | 189 | void *py_dec; |
74911b4c GM |
190 | }; |
191 | ||
361fdcaa | 192 | /** |
6a15597a UH |
193 | * Structure which contains information about one protocol decoder channel. |
194 | * For example, I2C has two channels, SDA and SCL. | |
361fdcaa | 195 | */ |
6a15597a UH |
196 | struct srd_channel { |
197 | /** The ID of the channel. Must be non-NULL. */ | |
f38ec285 | 198 | char *id; |
6a15597a | 199 | /** The name of the channel. Must not be NULL. */ |
f38ec285 | 200 | char *name; |
6a15597a | 201 | /** The description of the channel. Must not be NULL. */ |
f38ec285 | 202 | char *desc; |
6a15597a | 203 | /** The index of the channel, i.e. its order in the list of channels. */ |
f38ec285 BV |
204 | int order; |
205 | }; | |
206 | ||
2f395bff BV |
207 | struct srd_decoder_option { |
208 | char *id; | |
209 | char *desc; | |
210 | GVariant *def; | |
84c1c0b5 | 211 | GSList *values; |
2f395bff BV |
212 | }; |
213 | ||
1ce46817 UH |
214 | struct srd_decoder_annotation_row { |
215 | char *id; | |
216 | char *desc; | |
217 | GSList *ann_classes; | |
218 | }; | |
219 | ||
a8b72b05 | 220 | struct srd_decoder_inst { |
b2c19614 | 221 | struct srd_decoder *decoder; |
32cfb920 | 222 | struct srd_session *sess; |
f6c7eade | 223 | void *py_inst; |
a8b72b05 | 224 | char *inst_id; |
b2c19614 | 225 | GSList *pd_output; |
6a15597a UH |
226 | int dec_num_channels; |
227 | int *dec_channelmap; | |
f38ec285 | 228 | int data_unitsize; |
6a15597a | 229 | uint8_t *channel_samples; |
7ce7775c | 230 | GSList *next_di; |
31b82285 | 231 | }; |
232 | ||
e5080882 BV |
233 | struct srd_pd_output { |
234 | int pdo_id; | |
235 | int output_type; | |
a8b72b05 | 236 | struct srd_decoder_inst *di; |
94d43b37 | 237 | char *proto_id; |
7ee0c40b BV |
238 | /* Only used for OUTPUT_META. */ |
239 | const GVariantType *meta_type; | |
240 | char *meta_name; | |
241 | char *meta_descr; | |
e5080882 BV |
242 | }; |
243 | ||
94d43b37 | 244 | struct srd_proto_data { |
15969949 BV |
245 | uint64_t start_sample; |
246 | uint64_t end_sample; | |
247 | struct srd_pd_output *pdo; | |
983cb0f5 | 248 | void *data; |
15969949 | 249 | }; |
0b922460 BV |
250 | struct srd_proto_data_annotation { |
251 | int ann_format; | |
252 | char **ann_text; | |
253 | }; | |
d75d8a7c BV |
254 | struct srd_proto_data_binary { |
255 | int bin_class; | |
256 | uint64_t size; | |
257 | const unsigned char *data; | |
258 | }; | |
15969949 | 259 | |
2372b199 UH |
260 | typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata, |
261 | void *cb_data); | |
ae53d0a5 | 262 | |
983cb0f5 BV |
263 | struct srd_pd_callback { |
264 | int output_type; | |
2372b199 | 265 | srd_pd_output_callback cb; |
41a5d962 | 266 | void *cb_data; |
983cb0f5 | 267 | }; |
bc5f5a43 | 268 | |
909fbf41 | 269 | /* srd.c */ |
abeeed8b | 270 | SRD_API int srd_init(const char *path); |
55c3c5f4 | 271 | SRD_API int srd_exit(void); |
909fbf41 BV |
272 | |
273 | /* session.c */ | |
32cfb920 BV |
274 | SRD_API int srd_session_new(struct srd_session **sess); |
275 | SRD_API int srd_session_start(struct srd_session *sess); | |
ed416497 | 276 | SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, |
32cfb920 BV |
277 | GVariant *data); |
278 | SRD_API int srd_session_send(struct srd_session *sess, | |
ed416497 BV |
279 | uint64_t start_samplenum, uint64_t end_samplenum, |
280 | const uint8_t *inbuf, uint64_t inbuflen); | |
32cfb920 BV |
281 | SRD_API int srd_session_destroy(struct srd_session *sess); |
282 | SRD_API int srd_pd_output_callback_add(struct srd_session *sess, | |
2372b199 | 283 | int output_type, srd_pd_output_callback cb, void *cb_data); |
b2c19614 | 284 | |
909fbf41 | 285 | /* decoder.c */ |
38ff5046 | 286 | SRD_API const GSList *srd_decoder_list(void); |
9d122fd5 BV |
287 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id); |
288 | SRD_API int srd_decoder_load(const char *name); | |
909fbf41 | 289 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); |
9d122fd5 | 290 | SRD_API int srd_decoder_unload(struct srd_decoder *dec); |
8ad6e500 UH |
291 | SRD_API int srd_decoder_load_all(void); |
292 | SRD_API int srd_decoder_unload_all(void); | |
b2c19614 | 293 | |
909fbf41 BV |
294 | /* instance.c */ |
295 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, | |
296 | GHashTable *options); | |
6a15597a UH |
297 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
298 | GHashTable *channels, int unit_size); | |
909fbf41 BV |
299 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
300 | const char *id, GHashTable *options); | |
301 | SRD_API int srd_inst_stack(struct srd_session *sess, | |
302 | struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to); | |
303 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, | |
304 | const char *inst_id); | |
c9bfccc6 | 305 | |
909fbf41 | 306 | /* log.c */ |
2372b199 | 307 | typedef int (*srd_log_callback)(void *cb_data, int loglevel, |
0082d592 | 308 | const char *format, va_list args); |
55c3c5f4 UH |
309 | SRD_API int srd_log_loglevel_set(int loglevel); |
310 | SRD_API int srd_log_loglevel_get(void); | |
2372b199 | 311 | SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data); |
0082d592 | 312 | SRD_API int srd_log_callback_set_default(void); |
55c3c5f4 UH |
313 | SRD_API int srd_log_logdomain_set(const char *logdomain); |
314 | SRD_API char *srd_log_logdomain_get(void); | |
1c6fa20f | 315 | |
909fbf41 BV |
316 | /* error.c */ |
317 | SRD_API const char *srd_strerror(int error_code); | |
318 | SRD_API const char *srd_strerror_name(int error_code); | |
0c081c63 | 319 | |
909fbf41 | 320 | /* version.c */ |
0c081c63 UH |
321 | SRD_API int srd_package_version_major_get(void); |
322 | SRD_API int srd_package_version_minor_get(void); | |
323 | SRD_API int srd_package_version_micro_get(void); | |
324 | SRD_API const char *srd_package_version_string_get(void); | |
0c081c63 UH |
325 | SRD_API int srd_lib_version_current_get(void); |
326 | SRD_API int srd_lib_version_revision_get(void); | |
327 | SRD_API int srd_lib_version_age_get(void); | |
328 | SRD_API const char *srd_lib_version_string_get(void); | |
329 | ||
2b628af1 BV |
330 | #include "version.h" |
331 | ||
253f9603 UH |
332 | #ifdef __cplusplus |
333 | } | |
334 | #endif | |
335 | ||
1c6fa20f | 336 | #endif |