71d0ae478b69e2e2da8a0657e7a3d747fd86885c
[libsigrokdecode.git] / sigrokdecode.h
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 SIGROKDECODE_SIGROKDECODE_H
23 #define SIGROKDECODE_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 enum {
67         SRD_OUTPUT_ANN,
68         SRD_OUTPUT_PROTO,
69         SRD_OUTPUT_BINARY,
70         /* When adding an output type, don't forget to expose it to PDs in:
71          *     controller.c:PyInit_sigrokdecode()
72          * and add a check in:
73          *     module_sigrokdecode.c:Decoder_put()
74          */
75 };
76
77 #define SRD_MAX_NUM_PROBES   64
78
79 /* TODO: Documentation. */
80 struct srd_decoder {
81         /** The decoder ID. Must be non-NULL and unique for all decoders. */
82         char *id;
83
84         /** The (short) decoder name. */
85         char *name;
86
87         /** The (long) decoder name. May be NULL. */
88         char *longname;
89
90         /** A (short, one-line) description of the decoder. */
91         char *desc;
92
93         /** A (long, multi-line) description of the decoder. May be NULL. */
94         char *longdesc;
95
96         /** The author of the decoder. May be NULL. */
97         char *author;
98
99         /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */
100         char *license;
101
102         /** TODO */
103         char *func;
104
105         /** TODO */
106         GSList *inputformats;
107
108         /** TODO */
109         GSList *outputformats;
110
111         /* List of NULL-terminated char[], containing descriptions of the
112          * supported annotation output.
113          */
114         GSList *annotations;
115
116         /** TODO */
117         PyObject *py_mod;
118
119         /** Python object that performs the decoding */
120         PyObject *py_decobj;
121 };
122
123 struct srd_decoder_instance {
124         struct srd_decoder *decoder;
125         PyObject *py_instance;
126         char *instance_id;
127         GSList *pd_output;
128         int num_probes;
129         int unitsize;
130         uint64_t samplerate;
131         GSList *next_di;
132 };
133
134 struct srd_pd_output {
135         int pdo_id;
136         int output_type;
137         struct srd_decoder *decoder;
138         char *proto_id;
139 };
140
141 struct srd_proto_data {
142         uint64_t start_sample;
143         uint64_t end_sample;
144         struct srd_pd_output *pdo;
145         int ann_format;
146         void *data;
147 };
148
149 struct srd_pd_callback {
150         int output_type;
151         void (*callback)(struct srd_proto_data *);
152 };
153
154
155 /* custom python types */
156 typedef struct {
157         PyObject_HEAD
158 } srd_Decoder;
159
160 typedef struct {
161         PyObject_HEAD
162         struct srd_decoder_instance *di;
163         unsigned int itercnt;
164         uint8_t *inbuf;
165         uint64_t inbuflen;
166         PyObject *sample;
167 } srd_logic;
168
169
170 /*--- controller.c ----------------------------------------------------------*/
171 int srd_init(void);
172 int srd_exit(void);
173 int set_modulepath(void);
174 struct srd_decoder_instance *srd_instance_new(const char *id,
175                 const char *instance_id);
176 int srd_instance_stack(struct srd_decoder_instance *di_from,
177                 struct srd_decoder_instance *di_to);
178 int srd_instance_set_probe(struct srd_decoder_instance *di,
179                                 const char *probename, int num);
180 struct srd_decoder_instance *srd_instance_find(char *instance_id);
181 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args);
182 int srd_instance_decode(uint64_t timeoffset, uint64_t duration,
183                 struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen);
184 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate);
185 int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
186                 uint64_t inbuflen);
187 int pd_add(struct srd_decoder_instance *di, int output_type,
188                 char *output_id);
189 struct srd_decoder_instance *get_di_by_decobject(void *decobject);
190 int srd_register_callback(int output_type, void *cb);
191 void *srd_find_callback(int output_type);
192
193 /*--- decoder.c -------------------------------------------------------------*/
194
195 GSList *srd_list_decoders(void);
196 struct srd_decoder *srd_get_decoder_by_id(const char *id);
197 int srd_load_decoder(const char *name, struct srd_decoder **dec);
198 int srd_unload_decoder(struct srd_decoder *dec);
199 int srd_load_all_decoders(void);
200 int srd_unload_all_decoders(void);
201
202 /*--- util.c ----------------------------------------------------------------*/
203 int h_str(PyObject *py_res, const char *key, char **outstr);
204 int py_strlist_to_char(PyObject *py_strlist, char ***outstr);
205
206 /*--- log.c -----------------------------------------------------------------*/
207
208 int srd_set_loglevel(int loglevel);
209 int srd_get_loglevel(void);
210
211 #ifdef __cplusplus
212 }
213 #endif
214
215 #endif