srd: PDs: Kill obsolete 'longdesc' entries.
[libsigrokdecode.git] / sigrokdecode.h.in
1 /*
2  * This file is part of the sigrok 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 /*
34  * Package version macros (can be used for conditional compilation).
35  */
36
37 /** The libsigrokdecode package 'major' version number. */
38 #define LIBSIGROKDECODE_MAJOR_VERSION @LIBSIGROKDECODE_MAJOR_VERSION@
39
40 /** The libsigrokdecode package 'minor' version number. */
41 #define LIBSIGROKDECODE_MINOR_VERSION @LIBSIGROKDECODE_MINOR_VERSION@
42
43 /** The libsigrokdecode package 'micro' version number. */
44 #define LIBSIGROKDECODE_MICRO_VERSION @LIBSIGROKDECODE_MICRO_VERSION@
45
46 /** The libsigrokdecode package version ("major.minor.micro") as string. */
47 #define LIBSIGROKDECODE_VERSION_STRING "@LIBSIGROKDECODE_VERSION@"
48
49 /*
50  * Library/libtool version macros (can be used for conditional compilation).
51  */
52
53 /** The libsigrokdecode libtool 'current' version number. */
54 #define LIBSIGROKDECODE_LT_CURRENT @LIBSIGROKDECODE_LT_CURRENT@
55
56 /** The libsigrokdecode libtool 'revision' version number. */
57 #define LIBSIGROKDECODE_LT_REVISION @LIBSIGROKDECODE_LT_REVISION@
58
59 /** The libsigrokdecode libtool 'age' version number. */
60 #define LIBSIGROKDECODE_LT_AGE @LIBSIGROKDECODE_LT_AGE@
61
62 /** The libsigrokdecode libtool version ("current:revision:age") as string. */
63 #define LIBSIGROKDECODE_LT_VERSION_STRING "@LIBSIGROKDECODE_LT_VERSION@"
64
65 /*
66  * Status/error codes returned by libsigrokdecode functions.
67  *
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.
71  *
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
76  * same return code.
77  *
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.
81  */
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 */
89
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. */
97
98 /*
99  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
100  *
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.
105  *
106  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
107  *
108  * Details: http://gcc.gnu.org/wiki/Visibility
109  */
110
111 /* Marks public libsigrokdecode API symbols. */
112 #define SRD_API __attribute__((visibility("default")))
113
114 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
115 #define SRD_PRIV __attribute__((visibility("hidden")))
116
117 /*
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
122  */
123 enum {
124         SRD_OUTPUT_ANN,
125         SRD_OUTPUT_PROTO,
126         SRD_OUTPUT_BINARY,
127 };
128
129 #define SRD_MAX_NUM_PROBES 64
130
131 /* TODO: Documentation. */
132 struct srd_decoder {
133         /** The decoder ID. Must be non-NULL and unique for all decoders. */
134         char *id;
135
136         /** The (short) decoder name. Must be non-NULL. */
137         char *name;
138
139         /** The (long) decoder name. Must be non-NULL. */
140         char *longname;
141
142         /** A (short, one-line) description of the decoder. Must be non-NULL. */
143         char *desc;
144
145         /**
146          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
147          * Other values are currently not allowed. Must be non-NULL.
148          */
149         char *license;
150
151         /** List of probes required by this decoder. */
152         GSList *probes;
153
154         /** List of optional probes for this decoder. */
155         GSList *opt_probes;
156
157         /**
158          * List of NULL-terminated char[], containing descriptions of the
159          * supported annotation output.
160          */
161         GSList *annotations;
162
163         /** Python module. */
164         PyObject *py_mod;
165
166         /** sigrokdecode.Decoder class. */
167         PyObject *py_dec;
168 };
169
170 /**
171  * Structure which contains information about one protocol decoder probe.
172  * For example, I2C has two probes, SDA and SCL.
173  */
174 struct srd_probe {
175         /** The ID of the probe. Must be non-NULL. */
176         char *id;
177         /** The name of the probe. Must not be NULL. */
178         char *name;
179         /** The description of the probe. Must not be NULL. */
180         char *desc;
181         /** The index of the probe, i.e. its order in the list of probes. */
182         int order;
183 };
184
185 struct srd_decoder_inst {
186         struct srd_decoder *decoder;
187         PyObject *py_inst;
188         char *inst_id;
189         GSList *pd_output;
190         int dec_num_probes;
191         int *dec_probemap;
192         int data_num_probes;
193         int data_unitsize;
194         uint64_t data_samplerate;
195         GSList *next_di;
196 };
197
198 struct srd_pd_output {
199         int pdo_id;
200         int output_type;
201         struct srd_decoder_inst *di;
202         char *proto_id;
203 };
204
205 struct srd_proto_data {
206         uint64_t start_sample;
207         uint64_t end_sample;
208         struct srd_pd_output *pdo;
209         int ann_format;
210         void *data;
211 };
212
213 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
214                                          void *cb_data);
215
216 struct srd_pd_callback {
217         int output_type;
218         srd_pd_output_callback_t cb;
219         void *cb_data;
220 };
221
222 /* Custom Python types: */
223
224 typedef struct {
225         PyObject_HEAD
226 } srd_Decoder;
227
228 typedef struct {
229         PyObject_HEAD
230         struct srd_decoder_inst *di;
231         uint64_t start_samplenum;
232         unsigned int itercnt;
233         uint8_t *inbuf;
234         uint64_t inbuflen;
235         PyObject *sample;
236 } srd_logic;
237
238 /*--- controller.c ----------------------------------------------------------*/
239
240 SRD_API int srd_init(const char *path);
241 SRD_API int srd_exit(void);
242 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
243                                  GHashTable *options);
244 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
245                                 GHashTable *probes);
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,
254                              uint64_t inbuflen);
255 SRD_API int srd_register_callback(int output_type,
256                                   srd_pd_output_callback_t cb, void *cb_data);
257
258 /*--- decoder.c -------------------------------------------------------------*/
259
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(const struct srd_decoder *dec);
267
268 /*--- log.c -----------------------------------------------------------------*/
269
270 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
271                                   const char *format, va_list args);
272
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);
279
280 #ifdef __cplusplus
281 }
282 #endif
283
284 #endif