session: add "terminate and reset" support for protocol stacks
[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, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef LIBSIGROKDECODE_LIBSIGROKDECODE_H
22 #define LIBSIGROKDECODE_LIBSIGROKDECODE_H
23
24 #include <stdint.h>
25 #include <glib.h>
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct srd_session;
32
33 /**
34  * @file
35  *
36  * The public libsigrokdecode header file to be used by frontends.
37  *
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.
41  *
42  * The correct way to get/use the libsigrokdecode API functions is:
43  *
44  * @code{.c}
45  *   #include <libsigrokdecode/libsigrokdecode.h>
46  * @endcode
47  */
48
49 /*
50  * All possible return codes of libsigrokdecode functions must be listed here.
51  * Functions should never return hardcoded numbers as status, but rather
52  * use these enum values. All error codes are negative numbers.
53  *
54  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
55  * libsigrokdecode functions returns a "malloc error" it must be exactly the
56  * same return value as used by all other functions to indicate "malloc error".
57  * There must be no functions which indicate two different errors via the
58  * same return code.
59  *
60  * Also, for compatibility reasons, no defined return codes are ever removed
61  * or reused for different errors later. You can only add new entries and
62  * return codes, but never remove or redefine existing ones.
63  */
64
65 /** Status/error codes returned by libsigrokdecode functions. */
66 enum srd_error_code {
67         SRD_OK               =  0, /**< No error */
68         SRD_ERR              = -1, /**< Generic/unspecified error */
69         SRD_ERR_MALLOC       = -2, /**< Malloc/calloc/realloc error */
70         SRD_ERR_ARG          = -3, /**< Function argument error */
71         SRD_ERR_BUG          = -4, /**< Errors hinting at internal bugs */
72         SRD_ERR_PYTHON       = -5, /**< Python C API error */
73         SRD_ERR_DECODERS_DIR = -6, /**< Protocol decoder path invalid */
74
75         /*
76          * Note: When adding entries here, don't forget to also update the
77          * srd_strerror() and srd_strerror_name() functions in error.c.
78          */
79 };
80
81 /* libsigrokdecode loglevels. */
82 enum srd_loglevel {
83         SRD_LOG_NONE = 0, /**< Output no messages at all. */
84         SRD_LOG_ERR  = 1, /**< Output error messages. */
85         SRD_LOG_WARN = 2, /**< Output warnings. */
86         SRD_LOG_INFO = 3, /**< Output informational messages. */
87         SRD_LOG_DBG  = 4, /**< Output debug messages. */
88         SRD_LOG_SPEW = 5, /**< Output very noisy debug messages. */
89 };
90
91 /*
92  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
93  *
94  * Variables and functions marked 'static' are private already and don't
95  * need SRD_PRIV. However, functions which are not static (because they need
96  * to be used in other libsigrokdecode-internal files) but are also not
97  * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
98  *
99  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
100  *
101  * This feature is not available on MinGW/Windows, as it is a feature of
102  * ELF files and MinGW/Windows uses PE files.
103  *
104  * Details: http://gcc.gnu.org/wiki/Visibility
105  */
106
107 /* Marks public libsigrokdecode API symbols. */
108 #ifndef _WIN32
109 #define SRD_API __attribute__((visibility("default")))
110 #else
111 #define SRD_API
112 #endif
113
114 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
115 #ifndef _WIN32
116 #define SRD_PRIV __attribute__((visibility("hidden")))
117 #else
118 #define SRD_PRIV
119 #endif
120
121 /*
122  * When adding an output type, don't forget to...
123  *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
124  *   - add a check in module_sigrokdecode.c:Decoder_put()
125  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
126  */
127 enum srd_output_type {
128         SRD_OUTPUT_ANN,
129         SRD_OUTPUT_PYTHON,
130         SRD_OUTPUT_BINARY,
131         SRD_OUTPUT_META,
132 };
133
134 enum srd_configkey {
135         SRD_CONF_SAMPLERATE = 10000,
136 };
137
138 struct srd_decoder {
139         /** The decoder ID. Must be non-NULL and unique for all decoders. */
140         char *id;
141
142         /** The (short) decoder name. Must be non-NULL. */
143         char *name;
144
145         /** The (long) decoder name. Must be non-NULL. */
146         char *longname;
147
148         /** A (short, one-line) description of the decoder. Must be non-NULL. */
149         char *desc;
150
151         /**
152          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
153          * Other values are currently not allowed. Must be non-NULL.
154          */
155         char *license;
156
157         /** List of possible decoder input IDs. */
158         GSList *inputs;
159
160         /** List of possible decoder output IDs. */
161         GSList *outputs;
162
163         /** List of channels required by this decoder. */
164         GSList *channels;
165
166         /** List of optional channels for this decoder. */
167         GSList *opt_channels;
168
169         /**
170          * List of NULL-terminated char[], containing descriptions of the
171          * supported annotation output.
172          */
173         GSList *annotations;
174
175         /**
176          * List of annotation rows (row items: id, description, and a list
177          * of annotation classes belonging to this row).
178          */
179         GSList *annotation_rows;
180
181         /**
182          * List of NULL-terminated char[], containing descriptions of the
183          * supported binary output.
184          */
185         GSList *binary;
186
187         /** List of decoder options. */
188         GSList *options;
189
190         /** Python module. */
191         void *py_mod;
192
193         /** sigrokdecode.Decoder class. */
194         void *py_dec;
195 };
196
197 enum srd_initial_pin {
198         SRD_INITIAL_PIN_LOW,
199         SRD_INITIAL_PIN_HIGH,
200         SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
201 };
202
203 /**
204  * Structure which contains information about one protocol decoder channel.
205  * For example, I2C has two channels, SDA and SCL.
206  */
207 struct srd_channel {
208         /** The ID of the channel. Must be non-NULL. */
209         char *id;
210         /** The name of the channel. Must not be NULL. */
211         char *name;
212         /** The description of the channel. Must not be NULL. */
213         char *desc;
214         /** The index of the channel, i.e. its order in the list of channels. */
215         int order;
216 };
217
218 struct srd_decoder_option {
219         char *id;
220         char *desc;
221         GVariant *def;
222         GSList *values;
223 };
224
225 struct srd_decoder_annotation_row {
226         char *id;
227         char *desc;
228         GSList *ann_classes;
229 };
230
231 struct srd_decoder_inst {
232         struct srd_decoder *decoder;
233         struct srd_session *sess;
234         void *py_inst;
235         char *inst_id;
236         GSList *pd_output;
237         int dec_num_channels;
238         int *dec_channelmap;
239         int data_unitsize;
240         uint8_t *channel_samples;
241         GSList *next_di;
242
243         /** List of conditions a PD wants to wait for. */
244         GSList *condition_list;
245
246         /** Array of booleans denoting which conditions matched. */
247         GArray *match_array;
248
249         /** Absolute start sample number. */
250         uint64_t abs_start_samplenum;
251
252         /** Absolute end sample number. */
253         uint64_t abs_end_samplenum;
254
255         /** Pointer to the buffer/chunk of input samples. */
256         const uint8_t *inbuf;
257
258         /** Length (in bytes) of the input sample buffer. */
259         uint64_t inbuflen;
260
261         /** Absolute current samplenumber. */
262         uint64_t abs_cur_samplenum;
263
264         /** Array of "old" (previous sample) pin values. */
265         GArray *old_pins_array;
266
267         /** Handle for this PD stack's worker thread. */
268         GThread *thread_handle;
269
270         /** Indicates whether new samples are available for processing. */
271         gboolean got_new_samples;
272
273         /** Indicates whether the worker thread has handled all samples. */
274         gboolean handled_all_samples;
275
276         /** Requests termination of wait() and decode(). */
277         gboolean want_wait_terminate;
278
279         GCond got_new_samples_cond;
280         GCond handled_all_samples_cond;
281         GMutex data_mutex;
282 };
283
284 struct srd_pd_output {
285         int pdo_id;
286         int output_type;
287         struct srd_decoder_inst *di;
288         char *proto_id;
289         /* Only used for OUTPUT_META. */
290         const GVariantType *meta_type;
291         char *meta_name;
292         char *meta_descr;
293 };
294
295 struct srd_proto_data {
296         uint64_t start_sample;
297         uint64_t end_sample;
298         struct srd_pd_output *pdo;
299         void *data;
300 };
301 struct srd_proto_data_annotation {
302         int ann_class;
303         char **ann_text;
304 };
305 struct srd_proto_data_binary {
306         int bin_class;
307         uint64_t size;
308         const unsigned char *data;
309 };
310
311 typedef void (*srd_pd_output_callback)(struct srd_proto_data *pdata,
312                                         void *cb_data);
313
314 struct srd_pd_callback {
315         int output_type;
316         srd_pd_output_callback cb;
317         void *cb_data;
318 };
319
320 /* srd.c */
321 SRD_API int srd_init(const char *path);
322 SRD_API int srd_exit(void);
323 SRD_API GSList *srd_searchpaths_get(void);
324
325 /* session.c */
326 SRD_API int srd_session_new(struct srd_session **sess);
327 SRD_API int srd_session_start(struct srd_session *sess);
328 SRD_API int srd_session_metadata_set(struct srd_session *sess, int key,
329                 GVariant *data);
330 SRD_API int srd_session_send(struct srd_session *sess,
331                 uint64_t abs_start_samplenum, uint64_t abs_end_samplenum,
332                 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize);
333 SRD_API int srd_session_terminate_reset(struct srd_session *sess);
334 SRD_API int srd_session_destroy(struct srd_session *sess);
335 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
336                 int output_type, srd_pd_output_callback cb, void *cb_data);
337
338 /* decoder.c */
339 SRD_API const GSList *srd_decoder_list(void);
340 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
341 SRD_API int srd_decoder_load(const char *name);
342 SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec);
343 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
344 SRD_API int srd_decoder_load_all(void);
345 SRD_API int srd_decoder_unload_all(void);
346
347 /* instance.c */
348 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
349                 GHashTable *options);
350 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
351                 GHashTable *channels);
352 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
353                 const char *id, GHashTable *options);
354 SRD_API int srd_inst_stack(struct srd_session *sess,
355                 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to);
356 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
357                 const char *inst_id);
358 SRD_API int srd_inst_initial_pins_set_all(struct srd_decoder_inst *di,
359                 GArray *initial_pins);
360
361 /* log.c */
362 typedef int (*srd_log_callback)(void *cb_data, int loglevel,
363                                   const char *format, va_list args);
364 SRD_API int srd_log_loglevel_set(int loglevel);
365 SRD_API int srd_log_loglevel_get(void);
366 SRD_API int srd_log_callback_set(srd_log_callback cb, void *cb_data);
367 SRD_API int srd_log_callback_set_default(void);
368
369 /* error.c */
370 SRD_API const char *srd_strerror(int error_code);
371 SRD_API const char *srd_strerror_name(int error_code);
372
373 /* version.c */
374 SRD_API int srd_package_version_major_get(void);
375 SRD_API int srd_package_version_minor_get(void);
376 SRD_API int srd_package_version_micro_get(void);
377 SRD_API const char *srd_package_version_string_get(void);
378 SRD_API int srd_lib_version_current_get(void);
379 SRD_API int srd_lib_version_revision_get(void);
380 SRD_API int srd_lib_version_age_get(void);
381 SRD_API const char *srd_lib_version_string_get(void);
382 SRD_API GSList *srd_buildinfo_libs_get(void);
383 SRD_API char *srd_buildinfo_host_get(void);
384
385 #include "version.h"
386
387 #ifdef __cplusplus
388 }
389 #endif
390
391 #endif