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