2 * This file is part of the sigrok 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. */
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 <sigrokdecode.h>
50 * Package version macros (can be used for conditional compilation).
53 /** The libsigrokdecode package 'major' version number. */
54 #define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
56 /** The libsigrokdecode package 'minor' version number. */
57 #define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
59 /** The libsigrokdecode package 'micro' version number. */
60 #define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
62 /** The libsigrokdecode package version ("major.minor.micro") as string. */
63 #define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
66 * Library/libtool version macros (can be used for conditional compilation).
69 /** The libsigrokdecode libtool 'current' version number. */
70 #define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
72 /** The libsigrokdecode libtool 'revision' version number. */
73 #define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
75 /** The libsigrokdecode libtool 'age' version number. */
76 #define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
78 /** The libsigrokdecode libtool version ("current:revision:age") as string. */
79 #define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
82 * Status/error codes returned by libsigrokdecode functions.
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 #defines instead. 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 #defines later. You can only add new #defines and
96 * return codes, but never remove or redefine existing ones.
98 #define SRD_OK 0 /**< No error */
99 #define SRD_ERR -1 /**< Generic/unspecified error */
100 #define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */
101 #define SRD_ERR_ARG -3 /**< Function argument error */
102 #define SRD_ERR_BUG -4 /**< Errors hinting at internal bugs */
103 #define SRD_ERR_PYTHON -5 /**< Python C API error */
104 #define SRD_ERR_DECODERS_DIR -6 /**< Protocol decoder path invalid */
106 /* libsigrokdecode loglevels. */
107 #define SRD_LOG_NONE 0 /**< Output no messages at all. */
108 #define SRD_LOG_ERR 1 /**< Output error messages. */
109 #define SRD_LOG_WARN 2 /**< Output warnings. */
110 #define SRD_LOG_INFO 3 /**< Output informational messages. */
111 #define SRD_LOG_DBG 4 /**< Output debug messages. */
112 #define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */
115 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
117 * Variables and functions marked 'static' are private already and don't
118 * need SRD_PRIV. However, functions which are not static (because they need
119 * to be used in other libsigrokdecode-internal files) but are also not
120 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
122 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
124 * This feature is not available on MinGW/Windows, as it is a feature of
125 * ELF files and MinGW/Windows uses PE files.
127 * Details: http://gcc.gnu.org/wiki/Visibility
130 /* Marks public libsigrokdecode API symbols. */
132 #define SRD_API __attribute__((visibility("default")))
137 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
139 #define SRD_PRIV __attribute__((visibility("hidden")))
145 * When adding an output type, don't forget to...
146 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
147 * - add a check in module_sigrokdecode.c:Decoder_put()
148 * - add a debug string in type_decoder.c:OUTPUT_TYPES
156 #define SRD_MAX_NUM_PROBES 64
158 /* TODO: Documentation. */
160 /** The decoder ID. Must be non-NULL and unique for all decoders. */
163 /** The (short) decoder name. Must be non-NULL. */
166 /** The (long) decoder name. Must be non-NULL. */
169 /** A (short, one-line) description of the decoder. Must be non-NULL. */
173 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
174 * Other values are currently not allowed. Must be non-NULL.
178 /** List of probes required by this decoder. */
181 /** List of optional probes for this decoder. */
185 * List of NULL-terminated char[], containing descriptions of the
186 * supported annotation output.
190 /** Python module. */
193 /** sigrokdecode.Decoder class. */
198 * Structure which contains information about one protocol decoder probe.
199 * For example, I2C has two probes, SDA and SCL.
202 /** The ID of the probe. Must be non-NULL. */
204 /** The name of the probe. Must not be NULL. */
206 /** The description of the probe. Must not be NULL. */
208 /** The index of the probe, i.e. its order in the list of probes. */
212 struct srd_decoder_inst {
213 struct srd_decoder *decoder;
221 uint64_t data_samplerate;
225 struct srd_pd_output {
228 struct srd_decoder_inst *di;
232 struct srd_proto_data {
233 uint64_t start_sample;
235 struct srd_pd_output *pdo;
240 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
243 struct srd_pd_callback {
245 srd_pd_output_callback_t cb;
249 /* Custom Python types: */
257 struct srd_decoder_inst *di;
258 uint64_t start_samplenum;
259 unsigned int itercnt;
265 /*--- controller.c ----------------------------------------------------------*/
267 SRD_API int srd_init(const char *path);
268 SRD_API int srd_exit(void);
269 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
270 GHashTable *options);
271 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
273 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
274 GHashTable *options);
275 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
276 struct srd_decoder_inst *di_to);
277 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
278 SRD_API int srd_session_start(int num_probes, int unitsize,
279 uint64_t samplerate);
280 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
282 SRD_API int srd_pd_output_callback_add(int output_type,
283 srd_pd_output_callback_t cb, void *cb_data);
285 /*--- decoder.c -------------------------------------------------------------*/
287 SRD_API const GSList *srd_decoder_list(void);
288 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
289 SRD_API int srd_decoder_load(const char *name);
290 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
291 SRD_API int srd_decoder_load_all(void);
292 SRD_API int srd_decoder_unload_all(void);
293 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
295 /*--- log.c -----------------------------------------------------------------*/
297 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
298 const char *format, va_list args);
300 SRD_API int srd_log_loglevel_set(int loglevel);
301 SRD_API int srd_log_loglevel_get(void);
302 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
303 SRD_API int srd_log_callback_set_default(void);
304 SRD_API int srd_log_logdomain_set(const char *logdomain);
305 SRD_API char *srd_log_logdomain_get(void);
307 /*--- version.c -------------------------------------------------------------*/
309 SRD_API int srd_package_version_major_get(void);
310 SRD_API int srd_package_version_minor_get(void);
311 SRD_API int srd_package_version_micro_get(void);
312 SRD_API const char *srd_package_version_string_get(void);
314 SRD_API int srd_lib_version_current_get(void);
315 SRD_API int srd_lib_version_revision_get(void);
316 SRD_API int srd_lib_version_age_get(void);
317 SRD_API const char *srd_lib_version_string_get(void);