]>
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 */ | |
3f3c4614 | 74 | SRD_ERR_TERM_REQ = -7, /**< Termination requested */ |
47dfa77d UH |
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... | |
ddcde186 UH |
124 | * - expose it to PDs in module_sigrokdecode.c:PyInit_sigrokdecode() |
125 | * - add a check in type_decoder.c:Decoder_put() | |
126 | * - add a debug string in type_decoder.c:output_type_name() | |
c9bfccc6 | 127 | */ |
af9527d1 | 128 | enum srd_output_type { |
94d43b37 | 129 | SRD_OUTPUT_ANN, |
f2a5df42 | 130 | SRD_OUTPUT_PYTHON, |
15969949 | 131 | SRD_OUTPUT_BINARY, |
ddcde186 | 132 | SRD_OUTPUT_LOGIC, |
7ee0c40b | 133 | SRD_OUTPUT_META, |
e5080882 BV |
134 | }; |
135 | ||
af9527d1 | 136 | enum srd_configkey { |
ed416497 | 137 | SRD_CONF_SAMPLERATE = 10000, |
32cfb920 BV |
138 | }; |
139 | ||
d752b12b | 140 | struct srd_decoder { |
775dda7a | 141 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 142 | char *id; |
775dda7a | 143 | |
361fdcaa | 144 | /** The (short) decoder name. Must be non-NULL. */ |
31b82285 | 145 | char *name; |
775dda7a | 146 | |
122e9a90 | 147 | /** The (long) decoder name. Must be non-NULL. */ |
75a282e5 | 148 | char *longname; |
775dda7a | 149 | |
361fdcaa | 150 | /** A (short, one-line) description of the decoder. Must be non-NULL. */ |
5c55017c | 151 | char *desc; |
775dda7a | 152 | |
361fdcaa UH |
153 | /** |
154 | * The license of the decoder. Valid values: "gplv2+", "gplv3+". | |
155 | * Other values are currently not allowed. Must be non-NULL. | |
156 | */ | |
75a282e5 UH |
157 | char *license; |
158 | ||
d480174d UH |
159 | /** List of possible decoder input IDs. */ |
160 | GSList *inputs; | |
161 | ||
162 | /** List of possible decoder output IDs. */ | |
163 | GSList *outputs; | |
164 | ||
4c180223 SA |
165 | /** List of tags associated with this decoder. */ |
166 | GSList *tags; | |
167 | ||
6a15597a UH |
168 | /** List of channels required by this decoder. */ |
169 | GSList *channels; | |
f38ec285 | 170 | |
6a15597a UH |
171 | /** List of optional channels for this decoder. */ |
172 | GSList *opt_channels; | |
f38ec285 | 173 | |
361fdcaa | 174 | /** |
49f2cdc7 UH |
175 | * List of annotation classes. Each list item is a GSList itself, with |
176 | * two NUL-terminated strings: name and description. | |
15969949 | 177 | */ |
e97b6ef5 | 178 | GSList *annotations; |
15969949 | 179 | |
1ce46817 UH |
180 | /** |
181 | * List of annotation rows (row items: id, description, and a list | |
182 | * of annotation classes belonging to this row). | |
183 | */ | |
184 | GSList *annotation_rows; | |
185 | ||
d75d8a7c | 186 | /** |
49f2cdc7 UH |
187 | * List of binary classes. Each list item is a GSList itself, with |
188 | * two NUL-terminated strings: name and description. | |
d75d8a7c BV |
189 | */ |
190 | GSList *binary; | |
191 | ||
ddcde186 | 192 | /** |
460e6cfa | 193 | * List of logic output channels (item: id, description). |
ddcde186 UH |
194 | */ |
195 | GSList *logic_output_channels; | |
196 | ||
d841d5b2 | 197 | /** List of decoder options. */ |
2f395bff BV |
198 | GSList *options; |
199 | ||
361fdcaa | 200 | /** Python module. */ |
f6c7eade | 201 | void *py_mod; |
b2c19614 | 202 | |
361fdcaa | 203 | /** sigrokdecode.Decoder class. */ |
f6c7eade | 204 | void *py_dec; |
74911b4c GM |
205 | }; |
206 | ||
97b874bd UH |
207 | enum srd_initial_pin { |
208 | SRD_INITIAL_PIN_LOW, | |
209 | SRD_INITIAL_PIN_HIGH, | |
210 | SRD_INITIAL_PIN_SAME_AS_SAMPLE0, | |
211 | }; | |
212 | ||
361fdcaa | 213 | /** |
6a15597a UH |
214 | * Structure which contains information about one protocol decoder channel. |
215 | * For example, I2C has two channels, SDA and SCL. | |
361fdcaa | 216 | */ |
6a15597a UH |
217 | struct srd_channel { |
218 | /** The ID of the channel. Must be non-NULL. */ | |
f38ec285 | 219 | char *id; |
6a15597a | 220 | /** The name of the channel. Must not be NULL. */ |
f38ec285 | 221 | char *name; |
6a15597a | 222 | /** The description of the channel. Must not be NULL. */ |
f38ec285 | 223 | char *desc; |
6a15597a | 224 | /** The index of the channel, i.e. its order in the list of channels. */ |
f38ec285 BV |
225 | int order; |
226 | }; | |
227 | ||
2f395bff BV |
228 | struct srd_decoder_option { |
229 | char *id; | |
230 | char *desc; | |
231 | GVariant *def; | |
d841d5b2 | 232 | GSList *values; |
2f395bff BV |
233 | }; |
234 | ||
1ce46817 UH |
235 | struct srd_decoder_annotation_row { |
236 | char *id; | |
237 | char *desc; | |
238 | GSList *ann_classes; | |
239 | }; | |
240 | ||
ddcde186 UH |
241 | struct srd_decoder_logic_output_channel { |
242 | char *id; | |
243 | char *desc; | |
ddcde186 UH |
244 | }; |
245 | ||
a8b72b05 | 246 | struct srd_decoder_inst { |
b2c19614 | 247 | struct srd_decoder *decoder; |
32cfb920 | 248 | struct srd_session *sess; |
f6c7eade | 249 | void *py_inst; |
a8b72b05 | 250 | char *inst_id; |
b2c19614 | 251 | GSList *pd_output; |
6a15597a UH |
252 | int dec_num_channels; |
253 | int *dec_channelmap; | |
f38ec285 | 254 | int data_unitsize; |
6a15597a | 255 | uint8_t *channel_samples; |
7ce7775c | 256 | GSList *next_di; |
21dfd91d UH |
257 | |
258 | /** List of conditions a PD wants to wait for. */ | |
259 | GSList *condition_list; | |
260 | ||
261 | /** Array of booleans denoting which conditions matched. */ | |
262 | GArray *match_array; | |
263 | ||
264 | /** Absolute start sample number. */ | |
4564e8e5 | 265 | uint64_t abs_start_samplenum; |
21dfd91d UH |
266 | |
267 | /** Absolute end sample number. */ | |
4564e8e5 | 268 | uint64_t abs_end_samplenum; |
21dfd91d UH |
269 | |
270 | /** Pointer to the buffer/chunk of input samples. */ | |
271 | const uint8_t *inbuf; | |
272 | ||
273 | /** Length (in bytes) of the input sample buffer. */ | |
274 | uint64_t inbuflen; | |
275 | ||
276 | /** Absolute current samplenumber. */ | |
4564e8e5 | 277 | uint64_t abs_cur_samplenum; |
21dfd91d UH |
278 | |
279 | /** Array of "old" (previous sample) pin values. */ | |
280 | GArray *old_pins_array; | |
281 | ||
282 | /** Handle for this PD stack's worker thread. */ | |
283 | GThread *thread_handle; | |
284 | ||
285 | /** Indicates whether new samples are available for processing. */ | |
286 | gboolean got_new_samples; | |
287 | ||
288 | /** Indicates whether the worker thread has handled all samples. */ | |
289 | gboolean handled_all_samples; | |
290 | ||
04383ea8 GS |
291 | /** Requests termination of wait() and decode(). */ |
292 | gboolean want_wait_terminate; | |
293 | ||
d4d8ac2a SA |
294 | /** Indicates the current state of the decoder stack. */ |
295 | int decoder_state; | |
296 | ||
21dfd91d UH |
297 | GCond got_new_samples_cond; |
298 | GCond handled_all_samples_cond; | |
299 | GMutex data_mutex; | |
31b82285 | 300 | }; |
301 | ||
e5080882 BV |
302 | struct srd_pd_output { |
303 | int pdo_id; | |
304 | int output_type; | |
a8b72b05 | 305 | struct srd_decoder_inst *di; |
94d43b37 | 306 | char *proto_id; |
7ee0c40b BV |
307 | /* Only used for OUTPUT_META. */ |
308 | const GVariantType *meta_type; | |
309 | char *meta_name; | |
310 | char *meta_descr; | |
e5080882 BV |
311 | }; |
312 | ||
94d43b37 | 313 | struct srd_proto_data { |
15969949 BV |
314 | uint64_t start_sample; |
315 | uint64_t end_sample; | |
316 | struct srd_pd_output *pdo; | |
983cb0f5 | 317 | void *data; |
15969949 | 318 | }; |
0b922460 | 319 | struct srd_proto_data_annotation { |
49f2cdc7 | 320 | int ann_class; /* Index into "struct srd_decoder"->annotations. */ |
0b922460 BV |
321 | char **ann_text; |
322 | }; | |
d75d8a7c | 323 | struct srd_proto_data_binary { |
49f2cdc7 | 324 | int bin_class; /* Index into "struct srd_decoder"->binary. */ |
d75d8a7c | 325 | uint64_t size; |
2ee740fd | 326 | const uint8_t *data; |
ddcde186 UH |
327 | }; |
328 | struct srd_proto_data_logic { | |
b8c8dc8a SA |
329 | int logic_group; |
330 | uint64_t repeat_count; /* Number of times the value in data was repeated. */ | |
2ee740fd | 331 | const uint8_t *data; /* Bitfield containing the states of the logic outputs */ |
d75d8a7c | 332 | }; |
15969949 | 333 | |
2372b199 UH |
334 | typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata, |
335 | void *cb_data); | |
ae53d0a5 | 336 | |
983cb0f5 BV |
337 | struct srd_pd_callback { |
338 | int output_type; | |
2372b199 | 339 | srd_pd_output_callback cb; |
41a5d962 | 340 | void *cb_data; |
983cb0f5 | 341 | }; |
bc5f5a43 | 342 | |
909fbf41 | 343 | /* srd.c */ |
abeeed8b | 344 | SRD_API int srd_init(const char *path); |
55c3c5f4 | 345 | SRD_API int srd_exit(void); |
1a41642e | 346 | SRD_API GSList *srd_searchpaths_get(void); |
909fbf41 BV |
347 | |
348 | /* session.c */ | |
32cfb920 BV |
349 | SRD_API int srd_session_new(struct srd_session **sess); |
350 | SRD_API int srd_session_start(struct srd_session *sess); | |
ed416497 | 351 | SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, |
32cfb920 BV |
352 | GVariant *data); |
353 | SRD_API int srd_session_send(struct srd_session *sess, | |
4564e8e5 | 354 | uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, |
cda2d36c | 355 | const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize); |
9553e962 | 356 | SRD_API int srd_session_terminate_reset(struct srd_session *sess); |
32cfb920 BV |
357 | SRD_API int srd_session_destroy(struct srd_session *sess); |
358 | SRD_API int srd_pd_output_callback_add(struct srd_session *sess, | |
2372b199 | 359 | int output_type, srd_pd_output_callback cb, void *cb_data); |
b2c19614 | 360 | |
909fbf41 | 361 | /* decoder.c */ |
38ff5046 | 362 | SRD_API const GSList *srd_decoder_list(void); |
9d122fd5 BV |
363 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id); |
364 | SRD_API int srd_decoder_load(const char *name); | |
909fbf41 | 365 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); |
9d122fd5 | 366 | SRD_API int srd_decoder_unload(struct srd_decoder *dec); |
8ad6e500 UH |
367 | SRD_API int srd_decoder_load_all(void); |
368 | SRD_API int srd_decoder_unload_all(void); | |
b2c19614 | 369 | |
909fbf41 BV |
370 | /* instance.c */ |
371 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, | |
372 | GHashTable *options); | |
6a15597a | 373 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, |
cda2d36c | 374 | GHashTable *channels); |
909fbf41 BV |
375 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, |
376 | const char *id, GHashTable *options); | |
377 | SRD_API int srd_inst_stack(struct srd_session *sess, | |
378 | struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to); | |
379 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, | |
380 | const char *inst_id); | |
97b874bd UH |
381 | SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, |
382 | GArray *initial_pins); | |
c9bfccc6 | 383 | |
909fbf41 | 384 | /* log.c */ |
2372b199 | 385 | typedef int (*srd_log_callback)(void *cb_data, int loglevel, |
0082d592 | 386 | const char *format, va_list args); |
55c3c5f4 UH |
387 | SRD_API int srd_log_loglevel_set(int loglevel); |
388 | SRD_API int srd_log_loglevel_get(void); | |
c7b211b1 | 389 | SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data); |
2372b199 | 390 | SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data); |
0082d592 | 391 | SRD_API int srd_log_callback_set_default(void); |
1c6fa20f | 392 | |
909fbf41 BV |
393 | /* error.c */ |
394 | SRD_API const char *srd_strerror(int error_code); | |
395 | SRD_API const char *srd_strerror_name(int error_code); | |
0c081c63 | 396 | |
909fbf41 | 397 | /* version.c */ |
0c081c63 UH |
398 | SRD_API int srd_package_version_major_get(void); |
399 | SRD_API int srd_package_version_minor_get(void); | |
400 | SRD_API int srd_package_version_micro_get(void); | |
401 | SRD_API const char *srd_package_version_string_get(void); | |
0c081c63 UH |
402 | SRD_API int srd_lib_version_current_get(void); |
403 | SRD_API int srd_lib_version_revision_get(void); | |
404 | SRD_API int srd_lib_version_age_get(void); | |
405 | SRD_API const char *srd_lib_version_string_get(void); | |
cdb49509 UH |
406 | SRD_API GSList *srd_buildinfo_libs_get(void); |
407 | SRD_API char *srd_buildinfo_host_get(void); | |
0c081c63 | 408 | |
2b628af1 BV |
409 | #include "version.h" |
410 | ||
253f9603 UH |
411 | #ifdef __cplusplus |
412 | } | |
413 | #endif | |
414 | ||
1c6fa20f | 415 | #endif |