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, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
23 #define LIBSIGROKDECODE_LIBSIGROKDECODE_H
37 * The public libsigrokdecode header file to be used by frontends.
39 * This is the only file that libsigrokdecode users (frontends) are supposed
40 * to use and include. There are other header files which get installed with
41 * libsigrokdecode, but those are not meant to be used directly by frontends.
43 * The correct way to get/use the libsigrokdecode API functions is:
46 * #include <libsigrokdecode/libsigrokdecode.h>
51 * All possible return codes of libsigrokdecode functions must be listed here.
52 * Functions should never return hardcoded numbers as status, but rather
53 * use these enum values. All error codes are negative numbers.
55 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
56 * libsigrokdecode functions returns a "malloc error" it must be exactly the
57 * same return value as used by all other functions to indicate "malloc error".
58 * There must be no functions which indicate two different errors via the
61 * Also, for compatibility reasons, no defined return codes are ever removed
62 * or reused for different errors later. You can only add new entries and
63 * return codes, but never remove or redefine existing ones.
66 /** Status/error codes returned by libsigrokdecode functions. */
68 SRD_OK = 0, /**< No error */
69 SRD_ERR = -1, /**< Generic/unspecified error */
70 SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */
71 SRD_ERR_ARG = -3, /**< Function argument error */
72 SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */
73 SRD_ERR_PYTHON = -5, /**< Python C API error */
74 SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
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 controller.c:PyInit_sigrokdecode()
125 * - add a check in module_sigrokdecode.c:Decoder_put()
126 * - add a debug string in type_decoder.c:OUTPUT_TYPES
128 enum srd_output_type {
136 SRD_CONF_SAMPLERATE = 10000,
140 /** The decoder ID. Must be non-NULL and unique for all decoders. */
143 /** The (short) decoder name. Must be non-NULL. */
146 /** The (long) decoder name. Must be non-NULL. */
149 /** A (short, one-line) description of the decoder. Must be non-NULL. */
153 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
154 * Other values are currently not allowed. Must be non-NULL.
158 /** List of channels required by this decoder. */
161 /** List of optional channels for this decoder. */
162 GSList *opt_channels;
165 * List of NULL-terminated char[], containing descriptions of the
166 * supported annotation output.
171 * List of annotation rows (row items: id, description, and a list
172 * of annotation classes belonging to this row).
174 GSList *annotation_rows;
177 * List of NULL-terminated char[], containing descriptions of the
178 * supported binary output.
182 /** List of decoder options. */
185 /** Python module. */
188 /** sigrokdecode.Decoder class. */
193 * Structure which contains information about one protocol decoder channel.
194 * For example, I2C has two channels, SDA and SCL.
197 /** The ID of the channel. Must be non-NULL. */
199 /** The name of the channel. Must not be NULL. */
201 /** The description of the channel. Must not be NULL. */
203 /** The index of the channel, i.e. its order in the list of channels. */
207 struct srd_decoder_option {
214 struct srd_decoder_annotation_row {
220 struct srd_decoder_inst {
221 struct srd_decoder *decoder;
222 struct srd_session *sess;
226 int dec_num_channels;
229 uint8_t *channel_samples;
232 /** List of conditions a PD wants to wait for. */
233 GSList *condition_list;
235 /** Array of booleans denoting which conditions matched. */
238 /** Absolute start sample number. */
239 uint64_t start_samplenum;
241 /** Absolute end sample number. */
242 uint64_t end_samplenum;
244 /** Pointer to the buffer/chunk of input samples. */
245 const uint8_t *inbuf;
247 /** Length (in bytes) of the input sample buffer. */
250 /** Absolute current samplenumber. */
251 uint64_t cur_samplenum;
253 /** Array of "old" (previous sample) pin values. */
254 GArray *old_pins_array;
256 /** Handle for this PD stack's worker thread. */
257 GThread *thread_handle;
259 /** Indicates whether new samples are available for processing. */
260 gboolean got_new_samples;
262 /** Indicates whether the worker thread has handled all samples. */
263 gboolean handled_all_samples;
265 GCond got_new_samples_cond;
266 GCond handled_all_samples_cond;
270 struct srd_pd_output {
273 struct srd_decoder_inst *di;
275 /* Only used for OUTPUT_META. */
276 const GVariantType *meta_type;
281 struct srd_proto_data {
282 uint64_t start_sample;
284 struct srd_pd_output *pdo;
287 struct srd_proto_data_annotation {
291 struct srd_proto_data_binary {
294 const unsigned char *data;
297 typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
300 struct srd_pd_callback {
302 srd_pd_output_callback cb;
307 SRD_API int srd_init(const char *path);
308 SRD_API int srd_exit(void);
311 SRD_API int srd_session_new(struct srd_session **sess);
312 SRD_API int srd_session_start(struct srd_session *sess);
313 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
315 SRD_API int srd_session_send(struct srd_session *sess,
316 uint64_t start_samplenum, uint64_t end_samplenum,
317 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
318 SRD_API int srd_session_destroy(struct srd_session *sess);
319 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
320 int output_type, srd_pd_output_callback cb, void *cb_data);
323 SRD_API const GSList *srd_decoder_list(void);
324 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
325 SRD_API int srd_decoder_load(const char *name);
326 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
327 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
328 SRD_API int srd_decoder_load_all(void);
329 SRD_API int srd_decoder_unload_all(void);
332 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
333 GHashTable *options);
334 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
335 GHashTable *channels);
336 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
337 const char *id, GHashTable *options);
338 SRD_API int srd_inst_stack(struct srd_session *sess,
339 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
340 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
341 const char *inst_id);
344 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
345 const char *format, va_list args);
346 SRD_API int srd_log_loglevel_set(int loglevel);
347 SRD_API int srd_log_loglevel_get(void);
348 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
349 SRD_API int srd_log_callback_set_default(void);
352 SRD_API const char *srd_strerror(int error_code);
353 SRD_API const char *srd_strerror_name(int error_code);
356 SRD_API int srd_package_version_major_get(void);
357 SRD_API int srd_package_version_minor_get(void);
358 SRD_API int srd_package_version_micro_get(void);
359 SRD_API const char *srd_package_version_string_get(void);
360 SRD_API int srd_lib_version_current_get(void);
361 SRD_API int srd_lib_version_revision_get(void);
362 SRD_API int srd_lib_version_age_get(void);
363 SRD_API const char *srd_lib_version_string_get(void);