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 * All possible return codes of libsigrokdecode functions must be listed here.
53 * Functions should never return hardcoded numbers as status, but rather
54 * use these enum values. All error codes are negative numbers.
56 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
57 * libsigrokdecode functions returns a "malloc error" it must be exactly the
58 * same return value as used by all other functions to indicate "malloc error".
59 * There must be no functions which indicate two different errors via the
62 * Also, for compatibility reasons, no defined return codes are ever removed
63 * or reused for different errors later. You can only add new entries and
64 * return codes, but never remove or redefine existing ones.
67 /** Status/error codes returned by libsigrokdecode functions. */
69 SRD_OK = 0, /**< No error */
70 SRD_ERR = -1, /**< Generic/unspecified error */
71 SRD_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error */
72 SRD_ERR_ARG = -3, /**< Function argument error */
73 SRD_ERR_BUG = -4, /**< Errors hinting at internal bugs */
74 SRD_ERR_PYTHON = -5, /**< Python C API error */
75 SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
78 * Note: When adding entries here, don't forget to also update the
79 * srd_strerror() and srd_strerror_name() functions in error.c.
83 /* libsigrokdecode loglevels. */
85 SRD_LOG_NONE = 0, /**< Output no messages at all. */
86 SRD_LOG_ERR = 1, /**< Output error messages. */
87 SRD_LOG_WARN = 2, /**< Output warnings. */
88 SRD_LOG_INFO = 3, /**< Output informational messages. */
89 SRD_LOG_DBG = 4, /**< Output debug messages. */
90 SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
94 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
96 * Variables and functions marked 'static' are private already and don't
97 * need SRD_PRIV. However, functions which are not static (because they need
98 * to be used in other libsigrokdecode-internal files) but are also not
99 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
101 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
103 * This feature is not available on MinGW/Windows, as it is a feature of
104 * ELF files and MinGW/Windows uses PE files.
106 * Details: http://gcc.gnu.org/wiki/Visibility
109 /* Marks public libsigrokdecode API symbols. */
111 #define SRD_API __attribute__((visibility("default")))
116 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
118 #define SRD_PRIV __attribute__((visibility("hidden")))
124 * When adding an output type, don't forget to...
125 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
126 * - add a check in module_sigrokdecode.c:Decoder_put()
127 * - add a debug string in type_decoder.c:OUTPUT_TYPES
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 probes required by this decoder. */
162 /** List of optional probes for this decoder. */
166 * List of NULL-terminated char[], containing descriptions of the
167 * supported annotation output.
172 * List of NULL-terminated char[], containing descriptions of the
173 * supported binary output.
177 /** List of decoder options. */
180 /** Python module. */
183 /** sigrokdecode.Decoder class. */
188 * Structure which contains information about one protocol decoder probe.
189 * For example, I2C has two probes, SDA and SCL.
192 /** The ID of the probe. Must be non-NULL. */
194 /** The name of the probe. Must not be NULL. */
196 /** The description of the probe. Must not be NULL. */
198 /** The index of the probe, i.e. its order in the list of probes. */
202 struct srd_decoder_option {
208 struct srd_decoder_inst {
209 struct srd_decoder *decoder;
210 struct srd_session *sess;
217 uint8_t *probe_samples;
221 struct srd_pd_output {
224 struct srd_decoder_inst *di;
226 /* Only used for OUTPUT_META. */
227 const GVariantType *meta_type;
232 struct srd_proto_data {
233 uint64_t start_sample;
235 struct srd_pd_output *pdo;
238 struct srd_proto_data_annotation {
242 struct srd_proto_data_binary {
245 const unsigned char *data;
248 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
251 struct srd_pd_callback {
253 srd_pd_output_callback_t cb;
257 /* Custom Python types: */
265 struct srd_decoder_inst *di;
266 uint64_t start_samplenum;
267 unsigned int itercnt;
275 SRD_API int srd_init(const char *path);
276 SRD_API int srd_exit(void);
279 SRD_API int srd_session_new(struct srd_session **sess);
280 SRD_API int srd_session_start(struct srd_session *sess);
281 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
283 SRD_API int srd_session_send(struct srd_session *sess,
284 uint64_t start_samplenum, uint64_t end_samplenum,
285 const uint8_t *inbuf, uint64_t inbuflen);
286 SRD_API int srd_session_destroy(struct srd_session *sess);
287 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
288 int output_type, srd_pd_output_callback_t cb, void *cb_data);
291 SRD_API const GSList *srd_decoder_list(void);
292 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
293 SRD_API int srd_decoder_load(const char *name);
294 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
295 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
296 SRD_API int srd_decoder_load_all(void);
297 SRD_API int srd_decoder_unload_all(void);
300 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
301 GHashTable *options);
302 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
304 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
305 const char *id, GHashTable *options);
306 SRD_API int srd_inst_stack(struct srd_session *sess,
307 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
308 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
309 const char *inst_id);
312 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
313 const char *format, va_list args);
314 SRD_API int srd_log_loglevel_set(int loglevel);
315 SRD_API int srd_log_loglevel_get(void);
316 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
317 SRD_API int srd_log_callback_set_default(void);
318 SRD_API int srd_log_logdomain_set(const char *logdomain);
319 SRD_API char *srd_log_logdomain_get(void);
322 SRD_API const char *srd_strerror(int error_code);
323 SRD_API const char *srd_strerror_name(int error_code);
326 SRD_API int srd_package_version_major_get(void);
327 SRD_API int srd_package_version_minor_get(void);
328 SRD_API int srd_package_version_micro_get(void);
329 SRD_API const char *srd_package_version_string_get(void);
330 SRD_API int srd_lib_version_current_get(void);
331 SRD_API int srd_lib_version_revision_get(void);
332 SRD_API int srd_lib_version_age_get(void);
333 SRD_API const char *srd_lib_version_string_get(void);