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_SIGROKDECODE_H
23 #define LIBSIGROKDECODE_SIGROKDECODE_H
25 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
38 * The public libsigrokdecode header file to be used by frontends.
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.
44 * The correct way to get/use the libsigrokdecode API functions is:
47 * #include <libsigrokdecode/libsigrokdecode.h>
52 * Package version macros (can be used for conditional compilation).
55 /** The libsigrokdecode package 'major' version number. */
56 #define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
58 /** The libsigrokdecode package 'minor' version number. */
59 #define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
61 /** The libsigrokdecode package 'micro' version number. */
62 #define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
64 /** The libsigrokdecode package version ("major.minor.micro") as string. */
65 #define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
68 * Library/libtool version macros (can be used for conditional compilation).
71 /** The libsigrokdecode libtool 'current' version number. */
72 #define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
74 /** The libsigrokdecode libtool 'revision' version number. */
75 #define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
77 /** The libsigrokdecode libtool 'age' version number. */
78 #define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
80 /** The libsigrokdecode libtool version ("current:revision:age") as string. */
81 #define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
84 * All possible return codes of libsigrokdecode functions must be listed here.
85 * Functions should never return hardcoded numbers as status, but rather
86 * use these enum values. All error codes are negative numbers.
88 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
89 * libsigrokdecode functions returns a "malloc error" it must be exactly the
90 * same return value as used by all other functions to indicate "malloc error".
91 * There must be no functions which indicate two different errors via the
94 * Also, for compatibility reasons, no defined return codes are ever removed
95 * or reused for different errors later. You can only add new entries and
96 * return codes, but never remove or redefine existing ones.
99 /** Status/error codes returned by libsigrokdecode functions. */
101 SRD_OK = 0, /**< No error */
102 SRD_ERR = -1, /**< Generic/unspecified error */
103 SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */
104 SRD_ERR_ARG = -3, /**< Function argument error */
105 SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */
106 SRD_ERR_PYTHON = -5, /**< Python C API error */
107 SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
110 * Note: When adding entries here, don't forget to also update the
111 * srd_strerror() and srd_strerror_name() functions in error.c.
115 /* libsigrokdecode loglevels. */
117 SRD_LOG_NONE = 0, /**< Output no messages at all. */
118 SRD_LOG_ERR = 1, /**< Output error messages. */
119 SRD_LOG_WARN = 2, /**< Output warnings. */
120 SRD_LOG_INFO = 3, /**< Output informational messages. */
121 SRD_LOG_DBG = 4, /**< Output debug messages. */
122 SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
126 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
128 * Variables and functions marked 'static' are private already and don't
129 * need SRD_PRIV. However, functions which are not static (because they need
130 * to be used in other libsigrokdecode-internal files) but are also not
131 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
133 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
135 * This feature is not available on MinGW/Windows, as it is a feature of
136 * ELF files and MinGW/Windows uses PE files.
138 * Details: http://gcc.gnu.org/wiki/Visibility
141 /* Marks public libsigrokdecode API symbols. */
143 #define SRD_API __attribute__((visibility("default")))
148 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
150 #define SRD_PRIV __attribute__((visibility("hidden")))
156 * When adding an output type, don't forget to...
157 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
158 * - add a check in module_sigrokdecode.c:Decoder_put()
159 * - add a debug string in type_decoder.c:OUTPUT_TYPES
167 #define SRD_MAX_NUM_PROBES 64
170 SRD_CONF_NUM_PROBES = 10000,
176 /** The decoder ID. Must be non-NULL and unique for all decoders. */
179 /** The (short) decoder name. Must be non-NULL. */
182 /** The (long) decoder name. Must be non-NULL. */
185 /** A (short, one-line) description of the decoder. Must be non-NULL. */
189 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
190 * Other values are currently not allowed. Must be non-NULL.
194 /** List of probes required by this decoder. */
197 /** List of optional probes for this decoder. */
201 * List of NULL-terminated char[], containing descriptions of the
202 * supported annotation output.
206 /** List of decoder options. */
209 /** Python module. */
212 /** sigrokdecode.Decoder class. */
217 * Structure which contains information about one protocol decoder probe.
218 * For example, I2C has two probes, SDA and SCL.
221 /** The ID of the probe. Must be non-NULL. */
223 /** The name of the probe. Must not be NULL. */
225 /** The description of the probe. Must not be NULL. */
227 /** The index of the probe, i.e. its order in the list of probes. */
231 struct srd_decoder_option {
237 struct srd_decoder_inst {
238 struct srd_decoder *decoder;
239 struct srd_session *sess;
247 uint64_t data_samplerate;
251 struct srd_pd_output {
254 struct srd_decoder_inst *di;
258 struct srd_proto_data {
259 uint64_t start_sample;
261 struct srd_pd_output *pdo;
266 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
269 struct srd_pd_callback {
271 srd_pd_output_callback_t cb;
275 /* Custom Python types: */
283 struct srd_decoder_inst *di;
284 uint64_t start_samplenum;
285 unsigned int itercnt;
291 /*--- controller.c ----------------------------------------------------------*/
293 SRD_API int srd_init(const char *path);
294 SRD_API int srd_exit(void);
295 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
296 GHashTable *options);
297 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
299 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
300 const char *id, GHashTable *options);
301 SRD_API int srd_inst_stack(struct srd_session *sess,
302 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
303 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
304 const char *inst_id);
305 SRD_API int srd_session_new(struct srd_session **sess);
306 SRD_API int srd_session_start(struct srd_session *sess);
307 SRD_API int srd_session_config_set(struct srd_session *sess, int key,
309 SRD_API int srd_session_send(struct srd_session *sess,
310 uint64_t start_samplenum, const uint8_t *inbuf, uint64_t inbuflen);
311 SRD_API int srd_session_destroy(struct srd_session *sess);
312 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
313 int output_type, srd_pd_output_callback_t cb, void *cb_data);
315 /*--- decoder.c -------------------------------------------------------------*/
317 SRD_API const GSList *srd_decoder_list(void);
318 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
319 SRD_API int srd_decoder_load(const char *name);
320 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
321 SRD_API int srd_decoder_load_all(void);
322 SRD_API int srd_decoder_unload_all(void);
323 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
325 /*--- log.c -----------------------------------------------------------------*/
327 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
328 const char *format, va_list args);
330 SRD_API int srd_log_loglevel_set(int loglevel);
331 SRD_API int srd_log_loglevel_get(void);
332 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
333 SRD_API int srd_log_callback_set_default(void);
334 SRD_API int srd_log_logdomain_set(const char *logdomain);
335 SRD_API char *srd_log_logdomain_get(void);
337 /*--- version.c -------------------------------------------------------------*/
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);
344 SRD_API int srd_lib_version_current_get(void);
345 SRD_API int srd_lib_version_revision_get(void);
346 SRD_API int srd_lib_version_age_get(void);
347 SRD_API const char *srd_lib_version_string_get(void);
349 /*--- error.c ---------------------------------------------------------------*/
351 SRD_API const char *srd_strerror(int error_code);
352 SRD_API const char *srd_strerror_name(int error_code);