]>
Commit | Line | Data |
---|---|---|
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... | |
71 | * - expose it to PDs in controller.c:PyInit_sigrokdecode() | |
72 | * - add a check in module_sigrokdecode.c:Decoder_put() | |
73 | * - add a debug string in type_decoder.c:OUTPUT_TYPES | |
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 | /** The license of the decoder. Valid values: "gplv2+", "gplv3+". */ | |
94 | char *license; | |
95 | ||
96 | /** TODO */ | |
97 | GSList *inputformats; | |
98 | ||
99 | /** TODO */ | |
100 | GSList *outputformats; | |
101 | ||
102 | /** Probes */ | |
103 | GSList *probes; | |
104 | ||
105 | /** Optional probes */ | |
106 | GSList *opt_probes; | |
107 | ||
108 | /* List of NULL-terminated char[], containing descriptions of the | |
109 | * supported annotation output. | |
110 | */ | |
111 | GSList *annotations; | |
112 | ||
113 | /** Python module */ | |
114 | PyObject *py_mod; | |
115 | ||
116 | /** sigrokdecode.Decoder class */ | |
117 | PyObject *py_dec; | |
118 | }; | |
119 | ||
120 | struct srd_probe { | |
121 | char *id; | |
122 | char *name; | |
123 | char *desc; | |
124 | int order; | |
125 | }; | |
126 | ||
127 | struct srd_decoder_instance { | |
128 | struct srd_decoder *decoder; | |
129 | PyObject *py_instance; | |
130 | char *instance_id; | |
131 | GSList *pd_output; | |
132 | int dec_num_probes; | |
133 | int *dec_probemap; | |
134 | int data_num_probes; | |
135 | int data_unitsize; | |
136 | uint64_t data_samplerate; | |
137 | GSList *next_di; | |
138 | }; | |
139 | ||
140 | struct srd_pd_output { | |
141 | int pdo_id; | |
142 | int output_type; | |
143 | struct srd_decoder_instance *di; | |
144 | char *proto_id; | |
145 | }; | |
146 | ||
147 | struct srd_proto_data { | |
148 | uint64_t start_sample; | |
149 | uint64_t end_sample; | |
150 | struct srd_pd_output *pdo; | |
151 | int ann_format; | |
152 | void *data; | |
153 | }; | |
154 | ||
155 | struct srd_pd_callback { | |
156 | int output_type; | |
157 | void (*callback)(struct srd_proto_data *); | |
158 | }; | |
159 | ||
160 | ||
161 | /* custom python types */ | |
162 | typedef struct { | |
163 | PyObject_HEAD | |
164 | } srd_Decoder; | |
165 | ||
166 | typedef struct { | |
167 | PyObject_HEAD | |
168 | struct srd_decoder_instance *di; | |
169 | uint64_t start_samplenum; | |
170 | unsigned int itercnt; | |
171 | uint8_t *inbuf; | |
172 | uint64_t inbuflen; | |
173 | PyObject *sample; | |
174 | } srd_logic; | |
175 | ||
176 | ||
177 | /*--- controller.c ----------------------------------------------------------*/ | |
178 | int srd_init(void); | |
179 | int srd_exit(void); | |
180 | int set_modulepath(void); | |
181 | int srd_instance_set_options(struct srd_decoder_instance *di, | |
182 | GHashTable *options); | |
183 | int srd_instance_set_probes(struct srd_decoder_instance *di, | |
184 | GHashTable *probes); | |
185 | struct srd_decoder_instance *srd_instance_new(const char *id, | |
186 | GHashTable *options); | |
187 | int srd_instance_stack(struct srd_decoder_instance *di_from, | |
188 | struct srd_decoder_instance *di_to); | |
189 | struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id); | |
190 | struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack, | |
191 | PyObject *obj); | |
192 | int srd_instance_start(struct srd_decoder_instance *di, PyObject *args); | |
193 | int srd_instance_decode(uint64_t start_samplenum, | |
194 | struct srd_decoder_instance *dec, uint8_t *inbuf, uint64_t inbuflen); | |
195 | void srd_instance_free(struct srd_decoder_instance *di); | |
196 | void srd_instance_free_all(GSList *stack); | |
197 | int srd_session_start(int num_probes, int unitsize, uint64_t samplerate); | |
198 | int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen); | |
199 | int pd_add(struct srd_decoder_instance *di, int output_type, char *output_id); | |
200 | struct srd_decoder_instance *get_di_by_decobject(void *decobject); | |
201 | typedef void (*srd_pd_output_callback_t)(struct srd_proto_data *pdata); | |
202 | int srd_register_callback(int output_type, srd_pd_output_callback_t cb); | |
203 | void *srd_find_callback(int output_type); | |
204 | ||
205 | /*--- decoder.c -------------------------------------------------------------*/ | |
206 | GSList *srd_list_decoders(void); | |
207 | struct srd_decoder *srd_get_decoder_by_id(const char *id); | |
208 | int srd_load_decoder(const char *name, struct srd_decoder **dec); | |
209 | int srd_unload_decoder(struct srd_decoder *dec); | |
210 | int srd_load_all_decoders(void); | |
211 | int srd_unload_all_decoders(void); | |
212 | char *srd_decoder_doc(struct srd_decoder *dec); | |
213 | ||
214 | /*--- exception.c -----------------------------------------------------------*/ | |
215 | void catch_exception(const char *format, ...); | |
216 | ||
217 | /*--- util.c ----------------------------------------------------------------*/ | |
218 | int py_attr_as_str(PyObject *py_obj, const char *attr, char **outstr); | |
219 | int py_dictitem_as_str(PyObject *py_obj, const char *key, char **outstr); | |
220 | int py_str_as_str(PyObject *py_str, char **outstr); | |
221 | int py_strlist_to_char(PyObject *py_strlist, char ***outstr); | |
222 | ||
223 | /*--- log.c -----------------------------------------------------------------*/ | |
224 | typedef int (*srd_log_handler_t)(void *data, int loglevel, const char *format, | |
225 | va_list args); | |
226 | int srd_set_loglevel(int loglevel); | |
227 | int srd_get_loglevel(void); | |
228 | int srd_log_set_handler(srd_log_handler_t handler, void *data); | |
229 | int srd_log_set_default_handler(void); | |
230 | int srd_log_set_logdomain(const char *logdomain); | |
231 | char *srd_log_get_logdomain(void); | |
232 | ||
233 | #ifdef __cplusplus | |
234 | } | |
235 | #endif | |
236 | ||
237 | #endif |