3beff35ffe4d804094bfee6b69657b077435f338
[libsigrokdecode.git] / libsigrokdecode.h.in
1 /*
2  * This file is part of the libsigrokdecode project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #ifndef LIBSIGROKDECODE_SIGROKDECODE_H
23 #define LIBSIGROKDECODE_SIGROKDECODE_H
24
25 #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
26 #include <stdint.h>
27 #include <glib.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 struct srd_session;
34
35 /**
36  * @file
37  *
38  * The public libsigrokdecode header file to be used by frontends.
39  *
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.
43  *
44  * The correct way to get/use the libsigrokdecode API functions is:
45  *
46  * @code{.c}
47  *   #include <libsigrokdecode/libsigrokdecode.h>
48  * @endcode
49  */
50
51 /*
52  * Package version macros (can be used for conditional compilation).
53  */
54
55 /** The libsigrokdecode package 'major' version number. */
56 #define SRD_PACKAGE_VERSION_MAJOR @SRD_PACKAGE_VERSION_MAJOR@
57
58 /** The libsigrokdecode package 'minor' version number. */
59 #define SRD_PACKAGE_VERSION_MINOR @SRD_PACKAGE_VERSION_MINOR@
60
61 /** The libsigrokdecode package 'micro' version number. */
62 #define SRD_PACKAGE_VERSION_MICRO @SRD_PACKAGE_VERSION_MICRO@
63
64 /** The libsigrokdecode package version ("major.minor.micro") as string. */
65 #define SRD_PACKAGE_VERSION_STRING "@SRD_PACKAGE_VERSION@"
66
67 /*
68  * Library/libtool version macros (can be used for conditional compilation).
69  */
70
71 /** The libsigrokdecode libtool 'current' version number. */
72 #define SRD_LIB_VERSION_CURRENT @SRD_LIB_VERSION_CURRENT@
73
74 /** The libsigrokdecode libtool 'revision' version number. */
75 #define SRD_LIB_VERSION_REVISION @SRD_LIB_VERSION_REVISION@
76
77 /** The libsigrokdecode libtool 'age' version number. */
78 #define SRD_LIB_VERSION_AGE @SRD_LIB_VERSION_AGE@
79
80 /** The libsigrokdecode libtool version ("current:revision:age") as string. */
81 #define SRD_LIB_VERSION_STRING "@SRD_LIB_VERSION@"
82
83 /*
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.
87  *
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
92  * same return code.
93  *
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.
97  */
98
99 /** Status/error codes returned by libsigrokdecode functions. */
100 enum {
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 */
108
109         /*
110          * Note: When adding entries here, don't forget to also update the
111          * srd_strerror() and srd_strerror_name() functions in error.c.
112          */
113 };
114
115 /* libsigrokdecode loglevels. */
116 enum {
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. */
123 };
124
125 /*
126  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
127  *
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.
132  *
133  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
134  *
135  * This feature is not available on MinGW/Windows, as it is a feature of
136  * ELF files and MinGW/Windows uses PE files.
137  *
138  * Details: http://gcc.gnu.org/wiki/Visibility
139  */
140
141 /* Marks public libsigrokdecode API symbols. */
142 #ifndef _WIN32
143 #define SRD_API __attribute__((visibility("default")))
144 #else
145 #define SRD_API
146 #endif
147
148 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
149 #ifndef _WIN32
150 #define SRD_PRIV __attribute__((visibility("hidden")))
151 #else
152 #define SRD_PRIV
153 #endif
154
155 /*
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
160  */
161 enum {
162         SRD_OUTPUT_ANN,
163         SRD_OUTPUT_PYTHON,
164         SRD_OUTPUT_BINARY,
165 };
166
167 #define SRD_MAX_NUM_PROBES 64
168
169 enum {
170         SRD_CONF_SAMPLERATE = 10000,
171 };
172
173 struct srd_decoder {
174         /** The decoder ID. Must be non-NULL and unique for all decoders. */
175         char *id;
176
177         /** The (short) decoder name. Must be non-NULL. */
178         char *name;
179
180         /** The (long) decoder name. Must be non-NULL. */
181         char *longname;
182
183         /** A (short, one-line) description of the decoder. Must be non-NULL. */
184         char *desc;
185
186         /**
187          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
188          * Other values are currently not allowed. Must be non-NULL.
189          */
190         char *license;
191
192         /** List of probes required by this decoder. */
193         GSList *probes;
194
195         /** List of optional probes for this decoder. */
196         GSList *opt_probes;
197
198         /**
199          * List of NULL-terminated char[], containing descriptions of the
200          * supported annotation output.
201          */
202         GSList *annotations;
203
204         /** List of decoder options.  */
205         GSList *options;
206
207         /** Python module. */
208         PyObject *py_mod;
209
210         /** sigrokdecode.Decoder class. */
211         PyObject *py_dec;
212 };
213
214 /**
215  * Structure which contains information about one protocol decoder probe.
216  * For example, I2C has two probes, SDA and SCL.
217  */
218 struct srd_probe {
219         /** The ID of the probe. Must be non-NULL. */
220         char *id;
221         /** The name of the probe. Must not be NULL. */
222         char *name;
223         /** The description of the probe. Must not be NULL. */
224         char *desc;
225         /** The index of the probe, i.e. its order in the list of probes. */
226         int order;
227 };
228
229 struct srd_decoder_option {
230         char *id;
231         char *desc;
232         GVariant *def;
233 };
234
235 struct srd_decoder_inst {
236         struct srd_decoder *decoder;
237         struct srd_session *sess;
238         PyObject *py_inst;
239         char *inst_id;
240         GSList *pd_output;
241         int dec_num_probes;
242         int *dec_probemap;
243         int data_unitsize;
244         GSList *next_di;
245 };
246
247 struct srd_pd_output {
248         int pdo_id;
249         int output_type;
250         struct srd_decoder_inst *di;
251         char *proto_id;
252 };
253
254 struct srd_proto_data {
255         uint64_t start_sample;
256         uint64_t end_sample;
257         struct srd_pd_output *pdo;
258         void *data;
259 };
260 struct srd_proto_data_annotation {
261         int ann_format;
262         char **ann_text;
263 };
264
265 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
266                                          void *cb_data);
267
268 struct srd_pd_callback {
269         int output_type;
270         srd_pd_output_callback_t cb;
271         void *cb_data;
272 };
273
274 /* Custom Python types: */
275
276 typedef struct {
277         PyObject_HEAD
278 } srd_Decoder;
279
280 typedef struct {
281         PyObject_HEAD
282         struct srd_decoder_inst *di;
283         uint64_t start_samplenum;
284         unsigned int itercnt;
285         uint8_t *inbuf;
286         uint64_t inbuflen;
287         PyObject *sample;
288 } srd_logic;
289
290 /*--- controller.c ----------------------------------------------------------*/
291
292 SRD_API int srd_init(const char *path);
293 SRD_API int srd_exit(void);
294 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
295                 GHashTable *options);
296 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
297                 GHashTable *probes);
298 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
299                 const char *id, GHashTable *options);
300 SRD_API int srd_inst_stack(struct srd_session *sess,
301                 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
302 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
303                 const char *inst_id);
304 SRD_API int srd_session_new(struct srd_session **sess);
305 SRD_API int srd_session_start(struct srd_session *sess);
306 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
307                 GVariant *data);
308 SRD_API int srd_session_send(struct srd_session *sess,
309                 uint64_t start_samplenum, uint64_t end_samplenum,
310                 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);
314
315 /*--- decoder.c -------------------------------------------------------------*/
316
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);
324
325 /*--- log.c -----------------------------------------------------------------*/
326
327 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
328                                   const char *format, va_list args);
329
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);
336
337 /*--- version.c -------------------------------------------------------------*/
338
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);
343
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);
348
349 /*--- error.c ---------------------------------------------------------------*/
350
351 SRD_API const char *srd_strerror(int error_code);
352 SRD_API const char *srd_strerror_name(int error_code);
353
354 #ifdef __cplusplus
355 }
356 #endif
357
358 #endif