]>
Commit | Line | Data |
---|---|---|
1c6fa20f UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
bc5f5a43 | 5 | * Copyright (C) 2012 Bert Vermeulen <bert@biot.com> |
1c6fa20f UH |
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 | ||
3b5839d5 UH |
22 | #ifndef LIBSIGROKDECODE_SIGROKDECODE_H |
23 | #define LIBSIGROKDECODE_SIGROKDECODE_H | |
1c6fa20f UH |
24 | |
25 | #include <Python.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
26 | #include <stdint.h> | |
5c55017c | 27 | #include <glib.h> |
1c6fa20f | 28 | |
253f9603 UH |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
a4898be7 UH |
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 | */ | |
bc5f5a43 BV |
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 */ | |
47bd8dde UH |
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 */ | |
7c24d086 | 57 | |
43c0a640 | 58 | /* libsigrokdecode loglevels. */ |
bc5f5a43 BV |
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. */ | |
43c0a640 | 65 | |
55c3c5f4 UH |
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 | ||
c9bfccc6 UH |
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 | */ | |
e5080882 | 91 | enum { |
94d43b37 UH |
92 | SRD_OUTPUT_ANN, |
93 | SRD_OUTPUT_PROTO, | |
15969949 | 94 | SRD_OUTPUT_BINARY, |
e5080882 BV |
95 | }; |
96 | ||
bc5f5a43 BV |
97 | #define SRD_MAX_NUM_PROBES 64 |
98 | ||
31b82285 | 99 | /* TODO: Documentation. */ |
d752b12b | 100 | struct srd_decoder { |
775dda7a | 101 | /** The decoder ID. Must be non-NULL and unique for all decoders. */ |
31b82285 | 102 | char *id; |
775dda7a UH |
103 | |
104 | /** The (short) decoder name. */ | |
31b82285 | 105 | char *name; |
775dda7a UH |
106 | |
107 | /** The (long) decoder name. May be NULL. */ | |
75a282e5 | 108 | char *longname; |
775dda7a UH |
109 | |
110 | /** A (short, one-line) description of the decoder. */ | |
5c55017c | 111 | char *desc; |
775dda7a | 112 | |
775dda7a | 113 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ |
75a282e5 UH |
114 | char *license; |
115 | ||
775dda7a | 116 | /** TODO */ |
5c55017c | 117 | GSList *inputformats; |
775dda7a UH |
118 | |
119 | /** TODO */ | |
5c55017c UH |
120 | GSList *outputformats; |
121 | ||
f38ec285 BV |
122 | /** Probes */ |
123 | GSList *probes; | |
124 | ||
125 | /** Optional probes */ | |
dcdf4883 | 126 | GSList *opt_probes; |
f38ec285 | 127 | |
c9bfccc6 UH |
128 | /* |
129 | * List of NULL-terminated char[], containing descriptions of the | |
15969949 BV |
130 | * supported annotation output. |
131 | */ | |
e97b6ef5 | 132 | GSList *annotations; |
15969949 | 133 | |
451680f1 | 134 | /** Python module */ |
b2c19614 BV |
135 | PyObject *py_mod; |
136 | ||
451680f1 BV |
137 | /** sigrokdecode.Decoder class */ |
138 | PyObject *py_dec; | |
74911b4c GM |
139 | }; |
140 | ||
f38ec285 BV |
141 | struct srd_probe { |
142 | char *id; | |
143 | char *name; | |
144 | char *desc; | |
145 | int order; | |
146 | }; | |
147 | ||
74911b4c | 148 | struct srd_decoder_instance { |
b2c19614 | 149 | struct srd_decoder *decoder; |
052f32ee | 150 | PyObject *py_instance; |
7ce7775c | 151 | char *instance_id; |
b2c19614 | 152 | GSList *pd_output; |
f38ec285 BV |
153 | int dec_num_probes; |
154 | int *dec_probemap; | |
155 | int data_num_probes; | |
156 | int data_unitsize; | |
157 | uint64_t data_samplerate; | |
7ce7775c | 158 | GSList *next_di; |
31b82285 | 159 | }; |
160 | ||
e5080882 BV |
161 | struct srd_pd_output { |
162 | int pdo_id; | |
163 | int output_type; | |
b3b2cae8 | 164 | struct srd_decoder_instance *di; |
94d43b37 | 165 | char *proto_id; |
e5080882 BV |
166 | }; |
167 | ||
94d43b37 | 168 | struct srd_proto_data { |
15969949 BV |
169 | uint64_t start_sample; |
170 | uint64_t end_sample; | |
171 | struct srd_pd_output *pdo; | |
94d43b37 | 172 | int ann_format; |
983cb0f5 | 173 | void *data; |
15969949 BV |
174 | }; |
175 | ||
983cb0f5 BV |
176 | struct srd_pd_callback { |
177 | int output_type; | |
94d43b37 | 178 | void (*callback)(struct srd_proto_data *); |
983cb0f5 | 179 | }; |
bc5f5a43 | 180 | |
f8e45857 BV |
181 | /* custom python types */ |
182 | typedef struct { | |
183 | PyObject_HEAD | |
184 | } srd_Decoder; | |
43c0a640 | 185 | |
f8e45857 BV |
186 | typedef struct { |
187 | PyObject_HEAD | |
188 | struct srd_decoder_instance *di; | |
86528298 | 189 | uint64_t start_samplenum; |
f8e45857 BV |
190 | unsigned int itercnt; |
191 | uint8_t *inbuf; | |
192 | uint64_t inbuflen; | |
193 | PyObject *sample; | |
194 | } srd_logic; | |
195 | ||
f8e45857 | 196 | /*--- controller.c ----------------------------------------------------------*/ |
c9bfccc6 | 197 | |
55c3c5f4 UH |
198 | SRD_API int srd_init(void); |
199 | SRD_API int srd_exit(void); | |
200 | SRD_API int set_modulepath(void); | |
201 | SRD_API int srd_instance_set_options(struct srd_decoder_instance *di, | |
202 | GHashTable *options); | |
203 | SRD_API int srd_instance_set_probes(struct srd_decoder_instance *di, | |
204 | GHashTable *probes); | |
205 | SRD_API struct srd_decoder_instance *srd_instance_new(const char *id, | |
206 | GHashTable *options); | |
207 | SRD_API int srd_instance_stack(struct srd_decoder_instance *di_from, | |
208 | struct srd_decoder_instance *di_to); | |
209 | SRD_API struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id); | |
210 | SRD_API struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack, | |
211 | PyObject *obj); | |
212 | SRD_API int srd_instance_start(struct srd_decoder_instance *di, PyObject *args); | |
213 | SRD_API int srd_instance_decode(uint64_t start_samplenum, | |
214 | struct srd_decoder_instance *dec, | |
215 | uint8_t *inbuf, uint64_t inbuflen); | |
216 | SRD_API void srd_instance_free(struct srd_decoder_instance *di); | |
217 | SRD_API void srd_instance_free_all(GSList *stack); | |
218 | SRD_API int srd_session_start(int num_probes, int unitsize, | |
219 | uint64_t samplerate); | |
220 | SRD_API int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, | |
221 | uint64_t inbuflen); | |
222 | SRD_PRIV int pd_add(struct srd_decoder_instance *di, int output_type, | |
223 | char *output_id); | |
224 | SRD_API struct srd_decoder_instance *get_di_by_decobject(void *decobject); | |
bb590e07 | 225 | typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata); |
55c3c5f4 UH |
226 | SRD_API int srd_register_callback(int output_type, srd_pd_output_callback_t cb); |
227 | SRD_API void *srd_find_callback(int output_type); | |
b2c19614 | 228 | |
43c0a640 | 229 | /*--- decoder.c -------------------------------------------------------------*/ |
c9bfccc6 | 230 | |
55c3c5f4 UH |
231 | SRD_API GSList *srd_list_decoders(void); |
232 | SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
233 | SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec); | |
234 | SRD_API int srd_unload_decoder(struct srd_decoder *dec); | |
235 | SRD_API int srd_load_all_decoders(void); | |
236 | SRD_API int srd_unload_all_decoders(void); | |
237 | SRD_API char *srd_decoder_doc(struct srd_decoder *dec); | |
b2c19614 | 238 | |
ec871a27 | 239 | /*--- exception.c -----------------------------------------------------------*/ |
c9bfccc6 | 240 | |
55c3c5f4 | 241 | SRD_PRIV void catch_exception(const char *format, ...); |
ec871a27 | 242 | |
43c0a640 | 243 | /*--- util.c ----------------------------------------------------------------*/ |
c9bfccc6 | 244 | |
55c3c5f4 UH |
245 | SRD_PRIV int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr); |
246 | SRD_PRIV int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr); | |
247 | SRD_PRIV int py_str_as_str(PyObject *py_str, char **outstr); | |
248 | SRD_PRIV int py_strlist_to_char(PyObject *py_strlist, char ***outstr); | |
b2c19614 | 249 | |
43c0a640 | 250 | /*--- log.c -----------------------------------------------------------------*/ |
c9bfccc6 | 251 | |
66e4c27c UH |
252 | typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format, |
253 | va_list args); | |
c9bfccc6 | 254 | |
55c3c5f4 UH |
255 | SRD_API int srd_log_loglevel_set(int loglevel); |
256 | SRD_API int srd_log_loglevel_get(void); | |
257 | SRD_API int srd_log_handler_set(srd_log_handler_t handler, void *data); | |
258 | SRD_API int srd_log_handler_set_default(void); | |
259 | SRD_API int srd_log_logdomain_set(const char *logdomain); | |
260 | SRD_API char *srd_log_logdomain_get(void); | |
1c6fa20f | 261 | |
253f9603 UH |
262 | #ifdef __cplusplus |
263 | } | |
264 | #endif | |
265 | ||
1c6fa20f | 266 | #endif |