ded00bf638b918b2a3a3ebb9446fede7186e26ad
[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  * Status/error codes returned by libsigrokdecode functions.
35  *
36  * All possible return codes of libsigrokdecode functions must be listed here.
37  * Functions should never return hardcoded numbers as status, but rather
38  * use these #defines instead. All error codes are negative numbers.
39  *
40  * The error codes are globally unique in libsigrokdecode, i.e. if one of the
41  * libsigrokdecode functions returns a "malloc error" it must be exactly the
42  * same return value as used by all other functions to indicate "malloc error".
43  * There must be no functions which indicate two different errors via the
44  * same return code.
45  *
46  * Also, for compatibility reasons, no defined return codes are ever removed
47  * or reused for different #defines later. You can only add new #defines and
48  * return codes, but never remove or redefine existing ones.
49  */
50 #define SRD_OK                 0 /**< No error */
51 #define SRD_ERR               -1 /**< Generic/unspecified error */
52 #define SRD_ERR_MALLOC        -2 /**< Malloc/calloc/realloc error */
53 #define SRD_ERR_ARG           -3 /**< Function argument error */
54 #define SRD_ERR_BUG           -4 /**< Errors hinting at internal bugs */
55 #define SRD_ERR_PYTHON        -5 /**< Python C API error */
56 #define SRD_ERR_DECODERS_DIR  -6 /**< Protocol decoder path invalid */
57
58 /* libsigrokdecode loglevels. */
59 #define SRD_LOG_NONE   0 /**< Output no messages at all. */
60 #define SRD_LOG_ERR    1 /**< Output error messages. */
61 #define SRD_LOG_WARN   2 /**< Output warnings. */
62 #define SRD_LOG_INFO   3 /**< Output informational messages. */
63 #define SRD_LOG_DBG    4 /**< Output debug messages. */
64 #define SRD_LOG_SPEW   5 /**< Output very noisy debug messages. */
65
66 /*
67  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
68  *
69  * Variables and functions marked 'static' are private already and don't
70  * need SR_PRIV. However, functions which are not static (because they need
71  * to be used in other libsigrokdecode-internal files) but are also not
72  * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
73  *
74  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
75  *
76  * Details: http://gcc.gnu.org/wiki/Visibility
77  */
78
79 /* Marks public libsigrokdecode API symbols. */
80 #define SRD_API __attribute__((visibility("default")))
81
82 /* Marks private, non-public libsigrokdecode symbols (not part of the API). */
83 #define SRD_PRIV __attribute__((visibility("hidden")))
84
85 /*
86  * When adding an output type, don't forget to...
87  *   - expose it to PDs in controller.c:PyInit_sigrokdecode()
88  *   - add a check in module_sigrokdecode.c:Decoder_put()
89  *   - add a debug string in type_decoder.c:OUTPUT_TYPES
90  */
91 enum {
92         SRD_OUTPUT_ANN,
93         SRD_OUTPUT_PROTO,
94         SRD_OUTPUT_BINARY,
95 };
96
97 #define SRD_MAX_NUM_PROBES 64
98
99 /* TODO: Documentation. */
100 struct srd_decoder {
101         /** The decoder ID. Must be non-NULL and unique for all decoders. */
102         char *id;
103
104         /** The (short) decoder name. Must be non-NULL. */
105         char *name;
106
107         /** The (long) decoder name. May be NULL. */
108         char *longname;
109
110         /** A (short, one-line) description of the decoder. Must be non-NULL. */
111         char *desc;
112
113         /**
114          * The license of the decoder. Valid values: "gplv2+", "gplv3+".
115          * Other values are currently not allowed. Must be non-NULL.
116          */
117         char *license;
118
119         /** List of probes required by this decoder. */
120         GSList *probes;
121
122         /** List of optional probes for this decoder. */
123         GSList *opt_probes;
124
125         /**
126          * List of NULL-terminated char[], containing descriptions of the
127          * supported annotation output.
128          */
129         GSList *annotations;
130
131         /** Python module. */
132         PyObject *py_mod;
133
134         /** sigrokdecode.Decoder class. */
135         PyObject *py_dec;
136 };
137
138 /**
139  * Structure which contains information about one protocol decoder probe.
140  * For example, I2C has two probes, SDA and SCL.
141  */
142 struct srd_probe {
143         /** The ID of the probe. Must be non-NULL. */
144         char *id;
145         /** The name of the probe. Must not be NULL. */
146         char *name;
147         /** The description of the probe. Must not be NULL. */
148         char *desc;
149         /** The index of the probe, i.e. its order in the list of probes. */
150         int order;
151 };
152
153 struct srd_decoder_inst {
154         struct srd_decoder *decoder;
155         PyObject *py_inst;
156         char *inst_id;
157         GSList *pd_output;
158         int dec_num_probes;
159         int *dec_probemap;
160         int data_num_probes;
161         int data_unitsize;
162         uint64_t data_samplerate;
163         GSList *next_di;
164 };
165
166 struct srd_pd_output {
167         int pdo_id;
168         int output_type;
169         struct srd_decoder_inst *di;
170         char *proto_id;
171 };
172
173 struct srd_proto_data {
174         uint64_t start_sample;
175         uint64_t end_sample;
176         struct srd_pd_output *pdo;
177         int ann_format;
178         void *data;
179 };
180
181 typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata,
182                                          void *cb_data);
183
184 struct srd_pd_callback {
185         int output_type;
186         srd_pd_output_callback_t cb;
187         void *cb_data;
188 };
189
190 /* Custom Python types: */
191
192 typedef struct {
193         PyObject_HEAD
194 } srd_Decoder;
195
196 typedef struct {
197         PyObject_HEAD
198         struct srd_decoder_inst *di;
199         uint64_t start_samplenum;
200         unsigned int itercnt;
201         uint8_t *inbuf;
202         uint64_t inbuflen;
203         PyObject *sample;
204 } srd_logic;
205
206 /*--- controller.c ----------------------------------------------------------*/
207
208 SRD_API int srd_init(const char *path);
209 SRD_API int srd_exit(void);
210 SRD_API int srd_inst_options_set(struct srd_decoder_inst *di,
211                                  GHashTable *options);
212 SRD_API int srd_inst_probes_set(struct srd_decoder_inst *di,
213                                 GHashTable *probes);
214 SRD_API struct srd_decoder_inst *srd_inst_new(const char *id,
215                                               GHashTable *options);
216 SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from,
217                            struct srd_decoder_inst *di_to);
218 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id);
219 SRD_API int srd_session_start(int num_probes, int unitsize,
220                               uint64_t samplerate);
221 SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf,
222                              uint64_t inbuflen);
223 SRD_API int srd_register_callback(int output_type,
224                                   srd_pd_output_callback_t cb, void *cb_data);
225
226 /*--- decoder.c -------------------------------------------------------------*/
227
228 SRD_API GSList *srd_decoder_list(void);
229 SRD_API struct srd_decoder *srd_decoder_get_by_id(const char *id);
230 SRD_API int srd_decoder_load(const char *name);
231 SRD_API int srd_decoder_unload(struct srd_decoder *dec);
232 SRD_API int srd_decoder_load_all(void);
233 SRD_API int srd_decoder_unload_all(void);
234 SRD_API char *srd_decoder_doc(const struct srd_decoder *dec);
235
236 /*--- log.c -----------------------------------------------------------------*/
237
238 typedef int (*srd_log_callback_t)(void *cb_data, int loglevel,
239                                   const char *format, va_list args);
240
241 SRD_API int srd_log_loglevel_set(int loglevel);
242 SRD_API int srd_log_loglevel_get(void);
243 SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data);
244 SRD_API int srd_log_callback_set_default(void);
245 SRD_API int srd_log_logdomain_set(const char *logdomain);
246 SRD_API char *srd_log_logdomain_get(void);
247
248 #ifdef __cplusplus
249 }
250 #endif
251
252 #endif