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