Add support for annotation rows.
[libsigrokdecode.git] / libsigrokdecode.h
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  * 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.
55  *
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
60  * same return code.
61  *
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.
65  */
66
67 /** Status/error codes returned by libsigrokdecode functions. */
68 enum {
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 */
76
77         /*
78          * Note: When adding entries here, don't forget to also update the
79          * srd_strerror() and srd_strerror_name() functions in error.c.
80          */
81 };
82
83 /* libsigrokdecode loglevels. */
84 enum {
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. */
91 };
92
93 /*
94  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
95  *
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.
100  *
101  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
102  *
103  * This feature is not available on MinGW/Windows, as it is a feature of
104  * ELF files and MinGW/Windows uses PE files.
105  *
106  * Details: http://gcc.gnu.org/wiki/Visibility
107  */
108
109 /* Marks public libsigrokdecode API symbols. */
110 #ifndef _WIN32
111 #define SRD_API __attribute__((visibility("default")))
112 #else
113 #define SRD_API
114 #endif
115
116 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
117 #ifndef _WIN32
118 #define SRD_PRIV __attribute__((visibility("hidden")))
119 #else
120 #define SRD_PRIV
121 #endif
122
123 /*
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
128  */
129 enum {
130         SRD_OUTPUT_ANN,
131         SRD_OUTPUT_PYTHON,
132         SRD_OUTPUT_BINARY,
133         SRD_OUTPUT_META,
134 };
135
136 enum {
137         SRD_CONF_SAMPLERATE = 10000,
138 };
139
140 struct srd_decoder {
141         /** The decoder ID. Must be non-NULL and unique for all decoders. */
142         char *id;
143
144         /** The (short) decoder name. Must be non-NULL. */
145         char *name;
146
147         /** The (long) decoder name. Must be non-NULL. */
148         char *longname;
149
150         /** A (short, one-line) description of the decoder. Must be non-NULL. */
151         char *desc;
152
153         /**
154          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
155          * Other values are currently not allowed. Must be non-NULL.
156          */
157         char *license;
158
159         /** List of probes required by this decoder. */
160         GSList *probes;
161
162         /** List of optional probes for this decoder. */
163         GSList *opt_probes;
164
165         /**
166          * List of NULL-terminated char[], containing descriptions of the
167          * supported annotation output.
168          */
169         GSList *annotations;
170
171         /**
172          * List of annotation rows (row items: id, description, and a list
173          * of annotation classes belonging to this row).
174          */
175         GSList *annotation_rows;
176
177         /**
178          * List of NULL-terminated char[], containing descriptions of the
179          * supported binary output.
180          */
181         GSList *binary;
182
183         /** List of decoder options.  */
184         GSList *options;
185
186         /** Python module. */
187         PyObject *py_mod;
188
189         /** sigrokdecode.Decoder class. */
190         PyObject *py_dec;
191 };
192
193 /**
194  * Structure which contains information about one protocol decoder probe.
195  * For example, I2C has two probes, SDA and SCL.
196  */
197 struct srd_probe {
198         /** The ID of the probe. Must be non-NULL. */
199         char *id;
200         /** The name of the probe. Must not be NULL. */
201         char *name;
202         /** The description of the probe. Must not be NULL. */
203         char *desc;
204         /** The index of the probe, i.e. its order in the list of probes. */
205         int order;
206 };
207
208 struct srd_decoder_option {
209         char *id;
210         char *desc;
211         GVariant *def;
212 };
213
214 struct srd_decoder_annotation_row {
215         char *id;
216         char *desc;
217         GSList *ann_classes;
218 };
219
220 struct srd_decoder_inst {
221         struct srd_decoder *decoder;
222         struct srd_session *sess;
223         PyObject *py_inst;
224         char *inst_id;
225         GSList *pd_output;
226         int dec_num_probes;
227         int *dec_probemap;
228         int data_unitsize;
229         uint8_t *probe_samples;
230         GSList *next_di;
231 };
232
233 struct srd_pd_output {
234         int pdo_id;
235         int output_type;
236         struct srd_decoder_inst *di;
237         char *proto_id;
238         /* Only used for OUTPUT_META. */
239         const GVariantType *meta_type;
240         char *meta_name;
241         char *meta_descr;
242 };
243
244 struct srd_proto_data {
245         uint64_t start_sample;
246         uint64_t end_sample;
247         struct srd_pd_output *pdo;
248         void *data;
249 };
250 struct srd_proto_data_annotation {
251         int ann_format;
252         char **ann_text;
253 };
254 struct srd_proto_data_binary {
255         int bin_class;
256         uint64_t size;
257         const unsigned char *data;
258 };
259
260 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
261                                          void *cb_data);
262
263 struct srd_pd_callback {
264         int output_type;
265         srd_pd_output_callback_t cb;
266         void *cb_data;
267 };
268
269 /* Custom Python types: */
270
271 typedef struct {
272         PyObject_HEAD
273 } srd_Decoder;
274
275 typedef struct {
276         PyObject_HEAD
277         struct srd_decoder_inst *di;
278         uint64_t start_samplenum;
279         unsigned int itercnt;
280         uint8_t *inbuf;
281         uint64_t inbuflen;
282         PyObject *sample;
283 } srd_logic;
284
285
286 /* srd.c */
287 SRD_API int srd_init(const char *path);
288 SRD_API int srd_exit(void);
289
290 /* session.c */
291 SRD_API int srd_session_new(struct srd_session **sess);
292 SRD_API int srd_session_start(struct srd_session *sess);
293 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
294                 GVariant *data);
295 SRD_API int srd_session_send(struct srd_session *sess,
296                 uint64_t start_samplenum, uint64_t end_samplenum,
297                 const uint8_t *inbuf, uint64_t inbuflen);
298 SRD_API int srd_session_destroy(struct srd_session *sess);
299 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
300                 int output_type, srd_pd_output_callback_t cb, void *cb_data);
301
302 /* decoder.c */
303 SRD_API const GSList *srd_decoder_list(void);
304 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
305 SRD_API int srd_decoder_load(const char *name);
306 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
307 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
308 SRD_API int srd_decoder_load_all(void);
309 SRD_API int srd_decoder_unload_all(void);
310
311 /* instance.c */
312 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
313                 GHashTable *options);
314 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
315                 GHashTable *probes);
316 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
317                 const char *id, GHashTable *options);
318 SRD_API int srd_inst_stack(struct srd_session *sess,
319                 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
320 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
321                 const char *inst_id);
322
323 /* log.c */
324 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
325                                   const char *format, va_list args);
326 SRD_API int srd_log_loglevel_set(int loglevel);
327 SRD_API int srd_log_loglevel_get(void);
328 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
329 SRD_API int srd_log_callback_set_default(void);
330 SRD_API int srd_log_logdomain_set(const char *logdomain);
331 SRD_API char *srd_log_logdomain_get(void);
332
333 /* error.c */
334 SRD_API const char *srd_strerror(int error_code);
335 SRD_API const char *srd_strerror_name(int error_code);
336
337 /* version.c */
338 SRD_API int srd_package_version_major_get(void);
339 SRD_API int srd_package_version_minor_get(void);
340 SRD_API int srd_package_version_micro_get(void);
341 SRD_API const char *srd_package_version_string_get(void);
342 SRD_API int srd_lib_version_current_get(void);
343 SRD_API int srd_lib_version_revision_get(void);
344 SRD_API int srd_lib_version_age_get(void);
345 SRD_API const char *srd_lib_version_string_get(void);
346
347 #include "version.h"
348
349 #ifdef __cplusplus
350 }
351 #endif
352
353 #endif