]>
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 | ||
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 | ||
03a66522 UH |
49 | /* |
50 | * Package version macros (can be used for conditional compilation). | |
51 | */ | |
52 | ||
53 | /** The libsigrokdecode package 'major' version number. */ | |
14b42dad | 54 | #define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@ |
03a66522 UH |
55 | |
56 | /** The libsigrokdecode package 'minor' version number. */ | |
14b42dad | 57 | #define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@ |
03a66522 UH |
58 | |
59 | /** The libsigrokdecode package 'micro' version number. */ | |
14b42dad | 60 | #define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@ |
03a66522 UH |
61 | |
62 | /** The libsigrokdecode package version ("major.minor.micro") as string. */ | |
14b42dad | 63 | #define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@" |
03a66522 UH |
64 | |
65 | /* | |
66 | * Library/libtool version macros (can be used for conditional compilation). | |
67 | */ | |
68 | ||
69 | /** The libsigrokdecode libtool 'current' version number. */ | |
14b42dad | 70 | #define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@ |
03a66522 UH |
71 | |
72 | /** The libsigrokdecode libtool 'revision' version number. */ | |
14b42dad | 73 | #define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@ |
03a66522 UH |
74 | |
75 | /** The libsigrokdecode libtool 'age' version number. */ | |
14b42dad | 76 | #define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@ |
03a66522 UH |
77 | |
78 | /** The libsigrokdecode libtool version ("current:revision:age") as string. */ | |
14b42dad | 79 | #define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@" |
03a66522 | 80 | |
a4898be7 | 81 | /* |
a4898be7 UH |
82 | * All possible return codes of libsigrokdecode functions must be listed here. |
83 | * Functions should never return hardcoded numbers as status, but rather | |
47dfa77d | 84 | * use these enum values. All error codes are negative numbers. |
a4898be7 UH |
85 | * |
86 | * The error codes are globally unique in libsigrokdecode, i.e. if one of the | |
87 | * libsigrokdecode functions returns a "malloc error" it must be exactly the | |
88 | * same return value as used by all other functions to indicate "malloc error". | |
89 | * There must be no functions which indicate two different errors via the | |
90 | * same return code. | |
91 | * | |
92 | * Also, for compatibility reasons, no defined return codes are ever removed | |
47dfa77d | 93 | * or reused for different errors later. You can only add new entries and |
a4898be7 UH |
94 | * return codes, but never remove or redefine existing ones. |
95 | */ | |
47dfa77d UH |
96 | |
97 | /** Status/error codes returned by libsigrokdecode functions. */ | |
98 | enum { | |
99 | SRD_OK = 0, /**< No error */ | |
100 | SRD_ERR = -1, /**< Generic/unspecified error */ | |
101 | SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */ | |
102 | SRD_ERR_ARG = -3, /**< Function argument error */ | |
103 | SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */ | |
104 | SRD_ERR_PYTHON = -5, /**< Python C API error */ | |
105 | SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */ | |
106 | ||
107 | /* | |
108 | * Note: When adding entries here, don't forget to also update the | |
109 | * srd_strerror() and srd_strerror_name() functions in error.c. | |
110 | */ | |
111 | }; | |
7c24d086 | 112 | |
43c0a640 | 113 | /* libsigrokdecode loglevels. */ |
47dfa77d UH |
114 | enum { |
115 | SRD_LOG_NONE = 0, /**< Output no messages at all. */ | |
116 | SRD_LOG_ERR = 1, /**< Output error messages. */ | |
117 | SRD_LOG_WARN = 2, /**< Output warnings. */ | |
118 | SRD_LOG_INFO = 3, /**< Output informational messages. */ | |
119 | SRD_LOG_DBG = 4, /**< Output debug messages. */ | |
120 | SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */ | |
121 | }; | |
43c0a640 | 122 | |
55c3c5f4 UH |
123 | /* |
124 | * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols. | |
125 | * | |
126 | * Variables and functions marked 'static' are private already and don't | |
d523eae6 | 127 | * need SRD_PRIV. However, functions which are not static (because they need |
55c3c5f4 UH |
128 | * to be used in other libsigrokdecode-internal files) but are also not |
129 | * meant to be part of the public libsigrokdecode API, must use SRD_PRIV. | |
130 | * | |
131 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
132 | * | |
a4cb05f7 UH |
133 | * This feature is not available on MinGW/Windows, as it is a feature of |
134 | * ELF files and MinGW/Windows uses PE files. | |
135 | * | |
55c3c5f4 UH |
136 | * Details: http://gcc.gnu.org/wiki/Visibility |
137 | */ | |
138 | ||
139 | /* Marks public libsigrokdecode API symbols. */ | |
a4cb05f7 | 140 | #ifndef _WIN32 |
55c3c5f4 | 141 | #define SRD_API __attribute__((visibility("default"))) |
a4cb05f7 UH |
142 | #else |
143 | #define SRD_API | |
144 | #endif | |
55c3c5f4 UH |
145 | |
146 | /* Marks private, non-public libsigrokdecode symbols (not part of the API). */ | |
a4cb05f7 | 147 | #ifndef _WIN32 |
55c3c5f4 | 148 | #define SRD_PRIV __attribute__((visibility("hidden"))) |
a4cb05f7 UH |
149 | #else |
150 | #define SRD_PRIV | |
151 | #endif | |
55c3c5f4 | 152 | |
c9bfccc6 UH |
153 | /* |
154 | * When adding an output type, don't forget to... | |
155 | * - expose it to PDs in controller.c:PyInit_sigrokdecode() | |
156 | * - add a check in module_sigrokdecode.c:Decoder_put() | |
157 | * - add a debug string in type_decoder.c:OUTPUT_TYPES | |
158 | */ | |
e5080882 | 159 | enum { |
94d43b37 UH |
160 | SRD_OUTPUT_ANN, |
161 | SRD_OUTPUT_PROTO, | |
15969949 | 162 | SRD_OUTPUT_BINARY, |
e5080882 BV |
163 | }; |
164 | ||
a61ece20 | 165 | #define SRD_MAX_NUM_PROBES 64 |
bc5f5a43 | 166 | |
d752b12b | 167 | struct srd_decoder { |
775dda7a | 168 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 169 | char *id; |
775dda7a | 170 | |
361fdcaa | 171 | /** The (short) decoder name. Must be non-NULL. */ |
31b82285 | 172 | char *name; |
775dda7a | 173 | |
122e9a90 | 174 | /** The (long) decoder name. Must be non-NULL. */ |
75a282e5 | 175 | char *longname; |
775dda7a | 176 | |
361fdcaa | 177 | /** A (short, one-line) description of the decoder. Must be non-NULL. */ |
5c55017c | 178 | char *desc; |
775dda7a | 179 | |
361fdcaa UH |
180 | /** |
181 | * The license of the decoder. Valid values: "gplv2+", "gplv3+". | |
182 | * Other values are currently not allowed. Must be non-NULL. | |
183 | */ | |
75a282e5 UH |
184 | char *license; |
185 | ||
361fdcaa | 186 | /** List of probes required by this decoder. */ |
f38ec285 BV |
187 | GSList *probes; |
188 | ||
361fdcaa | 189 | /** List of optional probes for this decoder. */ |
dcdf4883 | 190 | GSList *opt_probes; |
f38ec285 | 191 | |
361fdcaa | 192 | /** |
c9bfccc6 | 193 | * List of NULL-terminated char[], containing descriptions of the |
15969949 BV |
194 | * supported annotation output. |
195 | */ | |
e97b6ef5 | 196 | GSList *annotations; |
15969949 | 197 | |
2f395bff BV |
198 | /** List of decoder options. */ |
199 | GSList *options; | |
200 | ||
361fdcaa | 201 | /** Python module. */ |
b2c19614 BV |
202 | PyObject *py_mod; |
203 | ||
361fdcaa | 204 | /** sigrokdecode.Decoder class. */ |
451680f1 | 205 | PyObject *py_dec; |
74911b4c GM |
206 | }; |
207 | ||
361fdcaa UH |
208 | /** |
209 | * Structure which contains information about one protocol decoder probe. | |
210 | * For example, I2C has two probes, SDA and SCL. | |
211 | */ | |
f38ec285 | 212 | struct srd_probe { |
361fdcaa | 213 | /** The ID of the probe. Must be non-NULL. */ |
f38ec285 | 214 | char *id; |
361fdcaa | 215 | /** The name of the probe. Must not be NULL. */ |
f38ec285 | 216 | char *name; |
361fdcaa | 217 | /** The description of the probe. Must not be NULL. */ |
f38ec285 | 218 | char *desc; |
361fdcaa | 219 | /** The index of the probe, i.e. its order in the list of probes. */ |
f38ec285 BV |
220 | int order; |
221 | }; | |
222 | ||
2f395bff BV |
223 | struct srd_decoder_option { |
224 | char *id; | |
225 | char *desc; | |
226 | GVariant *def; | |
227 | }; | |
228 | ||
a8b72b05 | 229 | struct srd_decoder_inst { |
b2c19614 | 230 | struct srd_decoder *decoder; |
a8b72b05 BV |
231 | PyObject *py_inst; |
232 | char *inst_id; | |
b2c19614 | 233 | GSList *pd_output; |
f38ec285 BV |
234 | int dec_num_probes; |
235 | int *dec_probemap; | |
236 | int data_num_probes; | |
237 | int data_unitsize; | |
238 | uint64_t data_samplerate; | |
7ce7775c | 239 | GSList *next_di; |
31b82285 | 240 | }; |
241 | ||
e5080882 BV |
242 | struct srd_pd_output { |
243 | int pdo_id; | |
244 | int output_type; | |
a8b72b05 | 245 | struct srd_decoder_inst *di; |
94d43b37 | 246 | char *proto_id; |
e5080882 BV |
247 | }; |
248 | ||
94d43b37 | 249 | struct srd_proto_data { |
15969949 BV |
250 | uint64_t start_sample; |
251 | uint64_t end_sample; | |
252 | struct srd_pd_output *pdo; | |
94d43b37 | 253 | int ann_format; |
983cb0f5 | 254 | void *data; |
15969949 BV |
255 | }; |
256 | ||
ae53d0a5 | 257 | typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata, |
41a5d962 | 258 | void *cb_data); |
ae53d0a5 | 259 | |
983cb0f5 BV |
260 | struct srd_pd_callback { |
261 | int output_type; | |
4c1d0670 | 262 | srd_pd_output_callback_t cb; |
41a5d962 | 263 | void *cb_data; |
983cb0f5 | 264 | }; |
bc5f5a43 | 265 | |
361fdcaa UH |
266 | /* Custom Python types: */ |
267 | ||
f8e45857 BV |
268 | typedef struct { |
269 | PyObject_HEAD | |
270 | } srd_Decoder; | |
43c0a640 | 271 | |
f8e45857 BV |
272 | typedef struct { |
273 | PyObject_HEAD | |
a8b72b05 | 274 | struct srd_decoder_inst *di; |
86528298 | 275 | uint64_t start_samplenum; |
f8e45857 BV |
276 | unsigned int itercnt; |
277 | uint8_t *inbuf; | |
278 | uint64_t inbuflen; | |
279 | PyObject *sample; | |
280 | } srd_logic; | |
281 | ||
f8e45857 | 282 | /*--- controller.c ----------------------------------------------------------*/ |
c9bfccc6 | 283 | |
abeeed8b | 284 | SRD_API int srd_init(const char *path); |
55c3c5f4 | 285 | SRD_API int srd_exit(void); |
b33b8aa5 | 286 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
0ff2d191 | 287 | GHashTable *options); |
b33b8aa5 | 288 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, |
0ff2d191 | 289 | GHashTable *probes); |
a8b72b05 | 290 | SRD_API struct srd_decoder_inst *srd_inst_new(const char *id, |
0ff2d191 | 291 | GHashTable *options); |
a8b72b05 | 292 | SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, |
0ff2d191 | 293 | struct srd_decoder_inst *di_to); |
abeeed8b | 294 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id); |
0ff2d191 | 295 | SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate); |
29dad0ac | 296 | SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, |
0ff2d191 | 297 | uint64_t inbuflen); |
b33b8aa5 | 298 | SRD_API int srd_pd_output_callback_add(int output_type, |
0ff2d191 | 299 | srd_pd_output_callback_t cb, void *cb_data); |
b2c19614 | 300 | |
43c0a640 | 301 | /*--- decoder.c -------------------------------------------------------------*/ |
c9bfccc6 | 302 | |
38ff5046 | 303 | SRD_API const GSList *srd_decoder_list(void); |
9d122fd5 BV |
304 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id); |
305 | SRD_API int srd_decoder_load(const char *name); | |
306 | SRD_API int srd_decoder_unload(struct srd_decoder *dec); | |
8ad6e500 UH |
307 | SRD_API int srd_decoder_load_all(void); |
308 | SRD_API int srd_decoder_unload_all(void); | |
b33b8aa5 | 309 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); |
b2c19614 | 310 | |
43c0a640 | 311 | /*--- log.c -----------------------------------------------------------------*/ |
c9bfccc6 | 312 | |
0082d592 UH |
313 | typedef int (*srd_log_callback_t)(void *cb_data, int loglevel, |
314 | const char *format, va_list args); | |
c9bfccc6 | 315 | |
55c3c5f4 UH |
316 | SRD_API int srd_log_loglevel_set(int loglevel); |
317 | SRD_API int srd_log_loglevel_get(void); | |
0082d592 UH |
318 | SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data); |
319 | SRD_API int srd_log_callback_set_default(void); | |
55c3c5f4 UH |
320 | SRD_API int srd_log_logdomain_set(const char *logdomain); |
321 | SRD_API char *srd_log_logdomain_get(void); | |
1c6fa20f | 322 | |
0c081c63 UH |
323 | /*--- version.c -------------------------------------------------------------*/ |
324 | ||
325 | SRD_API int srd_package_version_major_get(void); | |
326 | SRD_API int srd_package_version_minor_get(void); | |
327 | SRD_API int srd_package_version_micro_get(void); | |
328 | SRD_API const char *srd_package_version_string_get(void); | |
329 | ||
330 | SRD_API int srd_lib_version_current_get(void); | |
331 | SRD_API int srd_lib_version_revision_get(void); | |
332 | SRD_API int srd_lib_version_age_get(void); | |
333 | SRD_API const char *srd_lib_version_string_get(void); | |
334 | ||
cdf156ba UH |
335 | /*--- error.c ---------------------------------------------------------------*/ |
336 | ||
337 | SRD_API const char *srd_strerror(int error_code); | |
338 | SRD_API const char *srd_strerror_name(int error_code); | |
339 | ||
253f9603 UH |
340 | #ifdef __cplusplus |
341 | } | |
342 | #endif | |
343 | ||
1c6fa20f | 344 | #endif |