]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrokdecode project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
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, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
21 | #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H | |
22 | #define LIBSIGROKDECODE_LIBSIGROKDECODE_H | |
23 | ||
24 | #include <stdint.h> | |
25 | #include <glib.h> | |
26 | ||
27 | #ifdef __cplusplus | |
28 | extern "C" { | |
29 | #endif | |
30 | ||
31 | struct srd_session; | |
32 | ||
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} | |
45 | * #include <libsigrokdecode/libsigrokdecode.h> | |
46 | * @endcode | |
47 | */ | |
48 | ||
49 | /* | |
50 | * All possible return codes of libsigrokdecode functions must be listed here. | |
51 | * Functions should never return hardcoded numbers as status, but rather | |
52 | * use these enum values. All error codes are negative numbers. | |
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 | |
61 | * or reused for different errors later. You can only add new entries and | |
62 | * return codes, but never remove or redefine existing ones. | |
63 | */ | |
64 | ||
65 | /** Status/error codes returned by libsigrokdecode functions. */ | |
66 | enum srd_error_code { | |
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 | SRD_ERR_TERM_REQ = -7, /**< Termination requested */ | |
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 | }; | |
81 | ||
82 | /* libsigrokdecode loglevels. */ | |
83 | enum srd_loglevel { | |
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 | }; | |
91 | ||
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 | |
96 | * need SRD_PRIV. However, functions which are not static (because they need | |
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 | * | |
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 | * | |
105 | * Details: http://gcc.gnu.org/wiki/Visibility | |
106 | */ | |
107 | ||
108 | /* Marks public libsigrokdecode API symbols. */ | |
109 | #ifndef _WIN32 | |
110 | #define SRD_API __attribute__((visibility("default"))) | |
111 | #else | |
112 | #define SRD_API | |
113 | #endif | |
114 | ||
115 | /* Marks private, non-public libsigrokdecode symbols (not part of the API). */ | |
116 | #ifndef _WIN32 | |
117 | #define SRD_PRIV __attribute__((visibility("hidden"))) | |
118 | #else | |
119 | #define SRD_PRIV | |
120 | #endif | |
121 | ||
122 | /* | |
123 | * When adding an output type, don't forget to... | |
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() | |
127 | */ | |
128 | enum srd_output_type { | |
129 | SRD_OUTPUT_ANN, | |
130 | SRD_OUTPUT_PYTHON, | |
131 | SRD_OUTPUT_BINARY, | |
132 | SRD_OUTPUT_LOGIC, | |
133 | SRD_OUTPUT_META, | |
134 | }; | |
135 | ||
136 | enum srd_configkey { | |
137 | SRD_CONF_SAMPLERATE = 10000, | |
138 | }; | |
139 | ||
140 | struct srd_decoder { | |
141 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ | |
142 | char *id; | |
143 | ||
144 | /** The (short) decoder name. Must be non-NULL. */ | |
145 | char *name; | |
146 | ||
147 | /** The (long) decoder name. Must be non-NULL. */ | |
148 | char *longname; | |
149 | ||
150 | /** A (short, one-line) description of the decoder. Must be non-NULL. */ | |
151 | char *desc; | |
152 | ||
153 | /** | |
154 | * The license of the decoder. Valid values: "gplv2+", "gplv3+". | |
155 | * Other values are currently not allowed. Must be non-NULL. | |
156 | */ | |
157 | char *license; | |
158 | ||
159 | /** List of possible decoder input IDs. */ | |
160 | GSList *inputs; | |
161 | ||
162 | /** List of possible decoder output IDs. */ | |
163 | GSList *outputs; | |
164 | ||
165 | /** List of tags associated with this decoder. */ | |
166 | GSList *tags; | |
167 | ||
168 | /** List of channels required by this decoder. */ | |
169 | GSList *channels; | |
170 | ||
171 | /** List of optional channels for this decoder. */ | |
172 | GSList *opt_channels; | |
173 | ||
174 | /** | |
175 | * List of annotation classes. Each list item is a GSList itself, with | |
176 | * two NUL-terminated strings: name and description. | |
177 | */ | |
178 | GSList *annotations; | |
179 | ||
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 | ||
186 | /** | |
187 | * List of binary classes. Each list item is a GSList itself, with | |
188 | * two NUL-terminated strings: name and description. | |
189 | */ | |
190 | GSList *binary; | |
191 | ||
192 | /** | |
193 | * List of logic output channels (item: id, description, samplerate). | |
194 | */ | |
195 | GSList *logic_output_channels; | |
196 | ||
197 | /** List of decoder options. */ | |
198 | GSList *options; | |
199 | ||
200 | /** Python module. */ | |
201 | void *py_mod; | |
202 | ||
203 | /** sigrokdecode.Decoder class. */ | |
204 | void *py_dec; | |
205 | }; | |
206 | ||
207 | enum srd_initial_pin { | |
208 | SRD_INITIAL_PIN_LOW, | |
209 | SRD_INITIAL_PIN_HIGH, | |
210 | SRD_INITIAL_PIN_SAME_AS_SAMPLE0, | |
211 | }; | |
212 | ||
213 | /** | |
214 | * Structure which contains information about one protocol decoder channel. | |
215 | * For example, I2C has two channels, SDA and SCL. | |
216 | */ | |
217 | struct srd_channel { | |
218 | /** The ID of the channel. Must be non-NULL. */ | |
219 | char *id; | |
220 | /** The name of the channel. Must not be NULL. */ | |
221 | char *name; | |
222 | /** The description of the channel. Must not be NULL. */ | |
223 | char *desc; | |
224 | /** The index of the channel, i.e. its order in the list of channels. */ | |
225 | int order; | |
226 | }; | |
227 | ||
228 | struct srd_decoder_option { | |
229 | char *id; | |
230 | char *desc; | |
231 | GVariant *def; | |
232 | GSList *values; | |
233 | }; | |
234 | ||
235 | struct srd_decoder_annotation_row { | |
236 | char *id; | |
237 | char *desc; | |
238 | GSList *ann_classes; | |
239 | }; | |
240 | ||
241 | struct srd_decoder_logic_output_channel { | |
242 | char *id; | |
243 | char *desc; | |
244 | uint64_t samplerate; | |
245 | }; | |
246 | ||
247 | struct srd_decoder_inst { | |
248 | struct srd_decoder *decoder; | |
249 | struct srd_session *sess; | |
250 | void *py_inst; | |
251 | char *inst_id; | |
252 | GSList *pd_output; | |
253 | int dec_num_channels; | |
254 | int *dec_channelmap; | |
255 | int data_unitsize; | |
256 | uint8_t *channel_samples; | |
257 | GSList *next_di; | |
258 | ||
259 | /** List of conditions a PD wants to wait for. */ | |
260 | GSList *condition_list; | |
261 | ||
262 | /** Array of booleans denoting which conditions matched. */ | |
263 | GArray *match_array; | |
264 | ||
265 | /** Absolute start sample number. */ | |
266 | uint64_t abs_start_samplenum; | |
267 | ||
268 | /** Absolute end sample number. */ | |
269 | uint64_t abs_end_samplenum; | |
270 | ||
271 | /** Pointer to the buffer/chunk of input samples. */ | |
272 | const uint8_t *inbuf; | |
273 | ||
274 | /** Length (in bytes) of the input sample buffer. */ | |
275 | uint64_t inbuflen; | |
276 | ||
277 | /** Absolute current samplenumber. */ | |
278 | uint64_t abs_cur_samplenum; | |
279 | ||
280 | /** Array of "old" (previous sample) pin values. */ | |
281 | GArray *old_pins_array; | |
282 | ||
283 | /** Handle for this PD stack's worker thread. */ | |
284 | GThread *thread_handle; | |
285 | ||
286 | /** Indicates whether new samples are available for processing. */ | |
287 | gboolean got_new_samples; | |
288 | ||
289 | /** Indicates whether the worker thread has handled all samples. */ | |
290 | gboolean handled_all_samples; | |
291 | ||
292 | /** Requests termination of wait() and decode(). */ | |
293 | gboolean want_wait_terminate; | |
294 | ||
295 | /** Indicates the current state of the decoder stack. */ | |
296 | int decoder_state; | |
297 | ||
298 | GCond got_new_samples_cond; | |
299 | GCond handled_all_samples_cond; | |
300 | GMutex data_mutex; | |
301 | }; | |
302 | ||
303 | struct srd_pd_output { | |
304 | int pdo_id; | |
305 | int output_type; | |
306 | struct srd_decoder_inst *di; | |
307 | char *proto_id; | |
308 | /* Only used for OUTPUT_META. */ | |
309 | const GVariantType *meta_type; | |
310 | char *meta_name; | |
311 | char *meta_descr; | |
312 | }; | |
313 | ||
314 | struct srd_proto_data { | |
315 | uint64_t start_sample; | |
316 | uint64_t end_sample; | |
317 | struct srd_pd_output *pdo; | |
318 | void *data; | |
319 | }; | |
320 | struct srd_proto_data_annotation { | |
321 | int ann_class; /* Index into "struct srd_decoder"->annotations. */ | |
322 | char **ann_text; | |
323 | }; | |
324 | struct srd_proto_data_binary { | |
325 | int bin_class; /* Index into "struct srd_decoder"->binary. */ | |
326 | uint64_t size; | |
327 | const unsigned char *data; | |
328 | }; | |
329 | struct srd_proto_data_logic { | |
330 | int logic_class; | |
331 | uint64_t size; | |
332 | const unsigned char *data; | |
333 | }; | |
334 | ||
335 | typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata, | |
336 | void *cb_data); | |
337 | ||
338 | struct srd_pd_callback { | |
339 | int output_type; | |
340 | srd_pd_output_callback cb; | |
341 | void *cb_data; | |
342 | }; | |
343 | ||
344 | /* srd.c */ | |
345 | SRD_API int srd_init(const char *path); | |
346 | SRD_API int srd_exit(void); | |
347 | SRD_API GSList *srd_searchpaths_get(void); | |
348 | ||
349 | /* session.c */ | |
350 | SRD_API int srd_session_new(struct srd_session **sess); | |
351 | SRD_API int srd_session_start(struct srd_session *sess); | |
352 | SRD_API int srd_session_metadata_set(struct srd_session *sess, int key, | |
353 | GVariant *data); | |
354 | SRD_API int srd_session_send(struct srd_session *sess, | |
355 | uint64_t abs_start_samplenum, uint64_t abs_end_samplenum, | |
356 | const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize); | |
357 | SRD_API int srd_session_terminate_reset(struct srd_session *sess); | |
358 | SRD_API int srd_session_destroy(struct srd_session *sess); | |
359 | SRD_API int srd_pd_output_callback_add(struct srd_session *sess, | |
360 | int output_type, srd_pd_output_callback cb, void *cb_data); | |
361 | ||
362 | /* decoder.c */ | |
363 | SRD_API const GSList *srd_decoder_list(void); | |
364 | SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id); | |
365 | SRD_API int srd_decoder_load(const char *name); | |
366 | SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec); | |
367 | SRD_API int srd_decoder_unload(struct srd_decoder *dec); | |
368 | SRD_API int srd_decoder_load_all(void); | |
369 | SRD_API int srd_decoder_unload_all(void); | |
370 | ||
371 | /* instance.c */ | |
372 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, | |
373 | GHashTable *options); | |
374 | SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di, | |
375 | GHashTable *channels); | |
376 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, | |
377 | const char *id, GHashTable *options); | |
378 | SRD_API int srd_inst_stack(struct srd_session *sess, | |
379 | struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to); | |
380 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, | |
381 | const char *inst_id); | |
382 | SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di, | |
383 | GArray *initial_pins); | |
384 | ||
385 | /* log.c */ | |
386 | typedef int (*srd_log_callback)(void *cb_data, int loglevel, | |
387 | const char *format, va_list args); | |
388 | SRD_API int srd_log_loglevel_set(int loglevel); | |
389 | SRD_API int srd_log_loglevel_get(void); | |
390 | SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data); | |
391 | SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data); | |
392 | SRD_API int srd_log_callback_set_default(void); | |
393 | ||
394 | /* error.c */ | |
395 | SRD_API const char *srd_strerror(int error_code); | |
396 | SRD_API const char *srd_strerror_name(int error_code); | |
397 | ||
398 | /* version.c */ | |
399 | SRD_API int srd_package_version_major_get(void); | |
400 | SRD_API int srd_package_version_minor_get(void); | |
401 | SRD_API int srd_package_version_micro_get(void); | |
402 | SRD_API const char *srd_package_version_string_get(void); | |
403 | SRD_API int srd_lib_version_current_get(void); | |
404 | SRD_API int srd_lib_version_revision_get(void); | |
405 | SRD_API int srd_lib_version_age_get(void); | |
406 | SRD_API const char *srd_lib_version_string_get(void); | |
407 | SRD_API GSList *srd_buildinfo_libs_get(void); | |
408 | SRD_API char *srd_buildinfo_host_get(void); | |
409 | ||
410 | #include "version.h" | |
411 | ||
412 | #ifdef __cplusplus | |
413 | } | |
414 | #endif | |
415 | ||
416 | #endif |