2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
22 #define LIBSIGROKDECODE_LIBSIGROKDECODE_H
36 * The public libsigrokdecode header file to be used by frontends.
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.
42 * The correct way to get/use the libsigrokdecode API functions is:
45 * #include <libsigrokdecode/libsigrokdecode.h>
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.
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
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.
65 /** Status/error codes returned by libsigrokdecode functions. */
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 */
77 * Note: When adding entries here, don't forget to also update the
78 * srd_strerror() and srd_strerror_name() functions in error.c.
82 /* libsigrokdecode loglevels. */
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. */
93 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
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.
100 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
102 * This feature is not available on MinGW/Windows, as it is a feature of
103 * ELF files and MinGW/Windows uses PE files.
105 * Details: http://gcc.gnu.org/wiki/Visibility
108 /* Marks public libsigrokdecode API symbols. */
110 #define SRD_API __attribute__((visibility("default")))
115 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
117 #define SRD_PRIV __attribute__((visibility("hidden")))
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()
128 enum srd_output_type {
137 SRD_CONF_SAMPLERATE = 10000,
141 /** The decoder ID. Must be non-NULL and unique for all decoders. */
144 /** The (short) decoder name. Must be non-NULL. */
147 /** The (long) decoder name. Must be non-NULL. */
150 /** A (short, one-line) description of the decoder. Must be non-NULL. */
154 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
155 * Other values are currently not allowed. Must be non-NULL.
159 /** List of possible decoder input IDs. */
162 /** List of possible decoder output IDs. */
165 /** List of tags associated with this decoder. */
168 /** List of channels required by this decoder. */
171 /** List of optional channels for this decoder. */
172 GSList *opt_channels;
175 * List of annotation classes. Each list item is a GSList itself, with
176 * two NUL-terminated strings: name and description.
181 * List of annotation rows (row items: id, description, and a list
182 * of annotation classes belonging to this row).
184 GSList *annotation_rows;
187 * List of binary classes. Each list item is a GSList itself, with
188 * two NUL-terminated strings: name and description.
193 * List of logic output channels (item: id, description).
195 GSList *logic_output_channels;
197 /** List of decoder options. */
200 /** Python module. */
203 /** sigrokdecode.Decoder class. */
207 enum srd_initial_pin {
209 SRD_INITIAL_PIN_HIGH,
210 SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
214 * Structure which contains information about one protocol decoder channel.
215 * For example, I2C has two channels, SDA and SCL.
218 /** The ID of the channel. Must be non-NULL. */
220 /** The name of the channel. Must not be NULL. */
222 /** The description of the channel. Must not be NULL. */
224 /** The index of the channel, i.e. its order in the list of channels. */
228 struct srd_decoder_option {
235 struct srd_decoder_annotation_row {
241 struct srd_decoder_logic_output_channel {
246 struct srd_decoder_inst {
247 struct srd_decoder *decoder;
248 struct srd_session *sess;
252 int dec_num_channels;
255 uint8_t *channel_samples;
258 /** List of conditions a PD wants to wait for. */
259 GSList *condition_list;
261 /** Array of booleans denoting which conditions matched. */
264 /** Absolute start sample number. */
265 uint64_t abs_start_samplenum;
267 /** Absolute end sample number. */
268 uint64_t abs_end_samplenum;
270 /** Pointer to the buffer/chunk of input samples. */
271 const uint8_t *inbuf;
273 /** Length (in bytes) of the input sample buffer. */
276 /** Absolute current samplenumber. */
277 uint64_t abs_cur_samplenum;
279 /** Array of "old" (previous sample) pin values. */
280 GArray *old_pins_array;
282 /** Handle for this PD stack's worker thread. */
283 GThread *thread_handle;
285 /** Indicates whether new samples are available for processing. */
286 gboolean got_new_samples;
288 /** Indicates whether the worker thread has handled all samples. */
289 gboolean handled_all_samples;
291 /** Requests termination of wait() and decode(). */
292 gboolean want_wait_terminate;
294 /** Requests that .wait() terminates a Python iteration. */
295 gboolean communicate_eof;
297 /** Indicates the current state of the decoder stack. */
300 GCond got_new_samples_cond;
301 GCond handled_all_samples_cond;
305 struct srd_pd_output {
308 struct srd_decoder_inst *di;
310 /* Only used for OUTPUT_META. */
311 const GVariantType *meta_type;
316 struct srd_proto_data {
317 uint64_t start_sample;
319 struct srd_pd_output *pdo;
322 struct srd_proto_data_annotation {
323 int ann_class; /* Index into "struct srd_decoder"->annotations. */
326 struct srd_proto_data_binary {
327 int bin_class; /* Index into "struct srd_decoder"->binary. */
331 struct srd_proto_data_logic {
333 uint64_t repeat_count; /* Number of times the value in data was repeated. */
334 const uint8_t *data; /* Bitfield containing the states of the logic outputs */
337 typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
340 struct srd_pd_callback {
342 srd_pd_output_callback cb;
347 SRD_API int srd_init(const char *path);
348 SRD_API int srd_exit(void);
349 SRD_API GSList *srd_searchpaths_get(void);
352 SRD_API int srd_session_new(struct srd_session **sess);
353 SRD_API int srd_session_start(struct srd_session *sess);
354 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
356 SRD_API int srd_session_send(struct srd_session *sess,
357 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
358 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
359 SRD_API int srd_session_send_eof(struct srd_session *sess);
360 SRD_API int srd_session_terminate_reset(struct srd_session *sess);
361 SRD_API int srd_session_destroy(struct srd_session *sess);
362 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
363 int output_type, srd_pd_output_callback cb, void *cb_data);
366 SRD_API const GSList *srd_decoder_list(void);
367 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
368 SRD_API int srd_decoder_load(const char *name);
369 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
370 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
371 SRD_API int srd_decoder_load_all(void);
372 SRD_API int srd_decoder_unload_all(void);
375 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
376 GHashTable *options);
377 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
378 GHashTable *channels);
379 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
380 const char *id, GHashTable *options);
381 SRD_API int srd_inst_stack(struct srd_session *sess,
382 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
383 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
384 const char *inst_id);
385 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di,
386 GArray *initial_pins);
389 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
390 const char *format, va_list args);
391 SRD_API int srd_log_loglevel_set(int loglevel);
392 SRD_API int srd_log_loglevel_get(void);
393 SRD_API int srd_log_callback_get(srd_log_callback *cb, void **cb_data);
394 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
395 SRD_API int srd_log_callback_set_default(void);
398 SRD_API const char *srd_strerror(int error_code);
399 SRD_API const char *srd_strerror_name(int error_code);
402 SRD_API int srd_package_version_major_get(void);
403 SRD_API int srd_package_version_minor_get(void);
404 SRD_API int srd_package_version_micro_get(void);
405 SRD_API const char *srd_package_version_string_get(void);
406 SRD_API int srd_lib_version_current_get(void);
407 SRD_API int srd_lib_version_revision_get(void);
408 SRD_API int srd_lib_version_age_get(void);
409 SRD_API const char *srd_lib_version_string_get(void);
410 SRD_API GSList *srd_buildinfo_libs_get(void);
411 SRD_API char *srd_buildinfo_host_get(void);