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. */
34 * Package version macros (can be used for conditional compilation).
37 /** The libsigrokdecode package 'major' version number. */
38 #define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
40 /** The libsigrokdecode package 'minor' version number. */
41 #define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
43 /** The libsigrokdecode package 'micro' version number. */
44 #define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
46 /** The libsigrokdecode package version ("major.minor.micro") as string. */
47 #define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
50 * Library/libtool version macros (can be used for conditional compilation).
53 /** The libsigrokdecode libtool 'current' version number. */
54 #define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
56 /** The libsigrokdecode libtool 'revision' version number. */
57 #define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
59 /** The libsigrokdecode libtool 'age' version number. */
60 #define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
62 /** The libsigrokdecode libtool version ("current:revision:age") as string. */
63 #define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
66 * Status/error codes returned by libsigrokdecode functions.
68 * All possible return codes of libsigrokdecode functions must be listed here.
69 * Functions should never return hardcoded numbers as status, but rather
70 * use these #defines instead. All error codes are negative numbers.
72 * The error codes are globally unique in libsigrokdecode, i.e. if one of the
73 * libsigrokdecode functions returns a "malloc error" it must be exactly the
74 * same return value as used by all other functions to indicate "malloc error".
75 * There must be no functions which indicate two different errors via the
78 * Also, for compatibility reasons, no defined return codes are ever removed
79 * or reused for different #defines later. You can only add new #defines and
80 * return codes, but never remove or redefine existing ones.
82 #define SRD_OK 0 /**< No error */
83 #define SRD_ERR -1 /**< Generic/unspecified error */
84 #define SRD_ERR_MALLOC -2 /**< Malloc/calloc/realloc error */
85 #define SRD_ERR_ARG -3 /**< Function argument error */
86 #define SRD_ERR_BUG -4 /**< Errors hinting at internal bugs */
87 #define SRD_ERR_PYTHON -5 /**< Python C API error */
88 #define SRD_ERR_DECODERS_DIR -6 /**< Protocol decoder path invalid */
90 /* libsigrokdecode loglevels. */
91 #define SRD_LOG_NONE 0 /**< Output no messages at all. */
92 #define SRD_LOG_ERR 1 /**< Output error messages. */
93 #define SRD_LOG_WARN 2 /**< Output warnings. */
94 #define SRD_LOG_INFO 3 /**< Output informational messages. */
95 #define SRD_LOG_DBG 4 /**< Output debug messages. */
96 #define SRD_LOG_SPEW 5 /**< Output very noisy debug messages. */
99 * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
101 * Variables and functions marked 'static' are private already and don't
102 * need SR_PRIV. However, functions which are not static (because they need
103 * to be used in other libsigrokdecode-internal files) but are also not
104 * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
106 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
108 * Details: http://gcc.gnu.org/wiki/Visibility
111 /* Marks public libsigrokdecode API symbols. */
112 #define SRD_API __attribute__((visibility("default")))
114 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
115 #define SRD_PRIV __attribute__((visibility("hidden")))
118 * When adding an output type, don't forget to...
119 * - expose it to PDs in controller.c:PyInit_sigrokdecode()
120 * - add a check in module_sigrokdecode.c:Decoder_put()
121 * - add a debug string in type_decoder.c:OUTPUT_TYPES
129 #define SRD_MAX_NUM_PROBES 64
131 /* TODO: Documentation. */
133 /** The decoder ID. Must be non-NULL and unique for all decoders. */
136 /** The (short) decoder name. Must be non-NULL. */
139 /** The (long) decoder name. Must be non-NULL. */
142 /** A (short, one-line) description of the decoder. Must be non-NULL. */
146 * The license of the decoder. Valid values: "gplv2+", "gplv3+".
147 * Other values are currently not allowed. Must be non-NULL.
151 /** List of probes required by this decoder. */
154 /** List of optional probes for this decoder. */
158 * List of NULL-terminated char[], containing descriptions of the
159 * supported annotation output.
163 /** Python module. */
166 /** sigrokdecode.Decoder class. */
171 * Structure which contains information about one protocol decoder probe.
172 * For example, I2C has two probes, SDA and SCL.
175 /** The ID of the probe. Must be non-NULL. */
177 /** The name of the probe. Must not be NULL. */
179 /** The description of the probe. Must not be NULL. */
181 /** The index of the probe, i.e. its order in the list of probes. */
185 struct srd_decoder_inst {
186 struct srd_decoder *decoder;
194 uint64_t data_samplerate;
198 struct srd_pd_output {
201 struct srd_decoder_inst *di;
205 struct srd_proto_data {
206 uint64_t start_sample;
208 struct srd_pd_output *pdo;
213 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
216 struct srd_pd_callback {
218 srd_pd_output_callback_t cb;
222 /* Custom Python types: */
230 struct srd_decoder_inst *di;
231 uint64_t start_samplenum;
232 unsigned int itercnt;
238 /*--- controller.c ----------------------------------------------------------*/
240 SRD_API int srd_init(const char *path);
241 SRD_API int srd_exit(void);
242 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
243 GHashTable *options);
244 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
246 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
247 GHashTable *options);
248 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
249 struct srd_decoder_inst *di_to);
250 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
251 SRD_API int srd_session_start(int num_probes, int unitsize,
252 uint64_t samplerate);
253 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
255 SRD_API int srd_pd_output_callback_add(int output_type,
256 srd_pd_output_callback_t cb, void *cb_data);
258 /*--- decoder.c -------------------------------------------------------------*/
260 SRD_API GSList *srd_decoder_list(void);
261 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
262 SRD_API int srd_decoder_load(const char *name);
263 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
264 SRD_API int srd_decoder_load_all(void);
265 SRD_API int srd_decoder_unload_all(void);
266 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
268 /*--- log.c -----------------------------------------------------------------*/
270 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
271 const char *format, va_list args);
273 SRD_API int srd_log_loglevel_set(int loglevel);
274 SRD_API int srd_log_loglevel_get(void);
275 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
276 SRD_API int srd_log_callback_set_default(void);
277 SRD_API int srd_log_logdomain_set(const char *logdomain);
278 SRD_API char *srd_log_logdomain_get(void);