]>
Commit | Line | Data |
---|---|---|
b2c19614 BV |
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> |
b2c19614 BV |
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 3 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, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
73191416 | 21 | #include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ |
7ce7775c BV |
22 | #include "sigrokdecode-internal.h" |
23 | #include "config.h" | |
b2c19614 | 24 | #include <glib.h> |
1aef2f93 | 25 | #include <inttypes.h> |
0bdadba2 | 26 | #include <stdlib.h> |
b2c19614 | 27 | |
d906d3f9 | 28 | /* List of decoder instances. */ |
7ce7775c | 29 | static GSList *di_list = NULL; |
d906d3f9 | 30 | |
361fdcaa | 31 | /* List of frontend callbacks to receive decoder output. */ |
983cb0f5 BV |
32 | static GSList *callbacks = NULL; |
33 | ||
c9bfccc6 | 34 | /* decoder.c */ |
55c3c5f4 | 35 | extern SRD_PRIV GSList *pd_list; |
b2c19614 | 36 | |
c9bfccc6 | 37 | /* module_sigrokdecode.c */ |
53a07a6d UH |
38 | /* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */ |
39 | extern PyMODINIT_FUNC PyInit_sigrokdecode(void); | |
b2c19614 | 40 | |
c9bfccc6 | 41 | /* type_logic.c */ |
55c3c5f4 | 42 | extern SRD_PRIV PyTypeObject srd_logic_type; |
b2c19614 BV |
43 | |
44 | /** | |
45 | * Initialize libsigrokdecode. | |
46 | * | |
47 | * This initializes the Python interpreter, and creates and initializes | |
361fdcaa | 48 | * a "sigrokdecode" Python module. |
b2c19614 BV |
49 | * |
50 | * Then, it searches for sigrok protocol decoder files (*.py) in the | |
51 | * "decoders" subdirectory of the the sigrok installation directory. | |
52 | * All decoders that are found are loaded into memory and added to an | |
9d122fd5 | 53 | * internal list of decoders, which can be queried via srd_decoders_list(). |
b2c19614 BV |
54 | * |
55 | * The caller is responsible for calling the clean-up function srd_exit(), | |
56 | * which will properly shut down libsigrokdecode and free its allocated memory. | |
57 | * | |
7ce7775c | 58 | * Multiple calls to srd_init(), without calling srd_exit() in between, |
b2c19614 BV |
59 | * are not allowed. |
60 | * | |
65e1c7d0 | 61 | * @param path Path to an extra directory containing protocol decoders |
361fdcaa | 62 | * which will be added to the Python sys.path, or NULL. |
65e1c7d0 | 63 | * |
b2c19614 BV |
64 | * @return SRD_OK upon success, a (negative) error code otherwise. |
65 | * Upon Python errors, return SRD_ERR_PYTHON. If the sigrok decoders | |
66 | * directory cannot be accessed, return SRD_ERR_DECODERS_DIR. | |
67 | * If not enough memory could be allocated, return SRD_ERR_MALLOC. | |
68 | */ | |
abeeed8b | 69 | SRD_API int srd_init(const char *path) |
b2c19614 BV |
70 | { |
71 | int ret; | |
65e1c7d0 | 72 | char *env_path; |
b2c19614 | 73 | |
7a1712c4 | 74 | srd_dbg("Initializing libsigrokdecode."); |
d906d3f9 BV |
75 | |
76 | /* Add our own module to the list of built-in modules. */ | |
bc5f5a43 | 77 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); |
5f802ec6 | 78 | |
511e2123 | 79 | /* Initialize the Python interpreter. */ |
b2c19614 BV |
80 | Py_Initialize(); |
81 | ||
65e1c7d0 | 82 | /* Installed decoders. */ |
aafeeaea | 83 | if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { |
b2c19614 BV |
84 | Py_Finalize(); |
85 | return ret; | |
86 | } | |
87 | ||
65e1c7d0 BV |
88 | /* Path specified by the user. */ |
89 | if (path) { | |
aafeeaea | 90 | if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { |
65e1c7d0 BV |
91 | Py_Finalize(); |
92 | return ret; | |
93 | } | |
94 | } | |
95 | ||
96 | /* Environment variable overrides everything, for debugging. */ | |
97 | if ((env_path = getenv("SIGROKDECODE_DIR"))) { | |
aafeeaea | 98 | if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { |
65e1c7d0 BV |
99 | Py_Finalize(); |
100 | return ret; | |
101 | } | |
102 | } | |
103 | ||
b2c19614 BV |
104 | return SRD_OK; |
105 | } | |
106 | ||
b2c19614 BV |
107 | /** |
108 | * Shutdown libsigrokdecode. | |
109 | * | |
110 | * This frees all the memory allocated for protocol decoders and shuts down | |
111 | * the Python interpreter. | |
112 | * | |
113 | * This function should only be called if there was a (successful!) invocation | |
114 | * of srd_init() before. Calling this function multiple times in a row, without | |
7ce7775c | 115 | * any successful srd_init() calls in between, is not allowed. |
b2c19614 BV |
116 | * |
117 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
118 | */ | |
55c3c5f4 | 119 | SRD_API int srd_exit(void) |
b2c19614 | 120 | { |
7a1712c4 | 121 | srd_dbg("Exiting libsigrokdecode."); |
d906d3f9 | 122 | |
8ad6e500 | 123 | srd_decoder_unload_all(); |
e5080882 | 124 | g_slist_free(pd_list); |
96c52595 | 125 | pd_list = NULL; |
b2c19614 BV |
126 | |
127 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
128 | Py_Finalize(); | |
129 | ||
130 | return SRD_OK; | |
131 | } | |
132 | ||
b2c19614 | 133 | /** |
9d9fcb37 UH |
134 | * Add an additional search directory for the protocol decoders. |
135 | * | |
136 | * The specified directory is prepended (not appended!) to Python's sys.path, | |
137 | * in order to search for sigrok protocol decoders in the specified | |
138 | * directories first, and in the generic Python module directories (and in | |
139 | * the current working directory) last. This avoids conflicts if there are | |
140 | * Python modules which have the same name as a sigrok protocol decoder in | |
141 | * sys.path or in the current working directory. | |
b2c19614 | 142 | * |
361fdcaa UH |
143 | * @param path Path to the directory containing protocol decoders which shall |
144 | * be added to the Python sys.path, or NULL. | |
9d9fcb37 | 145 | * |
65e1c7d0 | 146 | * @return SRD_OK upon success, a (negative) error code otherwise. |
b2c19614 | 147 | */ |
aafeeaea | 148 | SRD_PRIV int srd_decoder_searchpath_add(const char *path) |
b2c19614 | 149 | { |
65e1c7d0 BV |
150 | PyObject *py_cur_path, *py_item; |
151 | GString *new_path; | |
152 | int wc_len, i; | |
153 | wchar_t *wc_new_path; | |
154 | char *item; | |
155 | ||
8ad6e500 | 156 | srd_dbg("Adding '%s' to module path.", path); |
65e1c7d0 BV |
157 | |
158 | new_path = g_string_sized_new(256); | |
159 | g_string_assign(new_path, g_strdup(path)); | |
160 | py_cur_path = PySys_GetObject("path"); | |
161 | for (i = 0; i < PyList_Size(py_cur_path); i++) { | |
162 | g_string_append(new_path, g_strdup(G_SEARCHPATH_SEPARATOR_S)); | |
163 | py_item = PyList_GetItem(py_cur_path, i); | |
164 | if (!PyUnicode_Check(py_item)) | |
165 | /* Shouldn't happen. */ | |
166 | continue; | |
167 | if (py_str_as_str(py_item, &item) != SRD_OK) | |
168 | continue; | |
169 | g_string_append(new_path, item); | |
170 | } | |
639c5689 | 171 | |
65e1c7d0 BV |
172 | /* Convert to wide chars. */ |
173 | wc_len = sizeof(wchar_t) * (new_path->len + 1); | |
174 | if (!(wc_new_path = g_try_malloc(wc_len))) { | |
175 | srd_dbg("malloc failed"); | |
176 | return SRD_ERR_MALLOC; | |
177 | } | |
178 | mbstowcs(wc_new_path, new_path->str, wc_len); | |
179 | PySys_SetPath(wc_new_path); | |
180 | g_string_free(new_path, TRUE); | |
181 | g_free(wc_new_path); | |
182 | ||
183 | //#ifdef _WIN32 | |
184 | // gchar **splitted; | |
185 | // | |
186 | // /* | |
187 | // * On Windows/MinGW, Python's sys.path needs entries of the form | |
188 | // * 'C:\\foo\\bar' instead of '/foo/bar'. | |
189 | // */ | |
190 | // | |
191 | // splitted = g_strsplit(DECODERS_DIR, "/", 0); | |
192 | // path = g_build_pathv("\\\\", splitted); | |
193 | // g_strfreev(splitted); | |
194 | //#else | |
195 | // path = g_strdup(DECODERS_DIR); | |
196 | //#endif | |
b2c19614 | 197 | |
65e1c7d0 | 198 | return SRD_OK; |
b2c19614 BV |
199 | } |
200 | ||
7ce7775c | 201 | /** |
b33b8aa5 | 202 | * Set one or more options in a decoder instance. |
0bdadba2 | 203 | * |
361fdcaa UH |
204 | * Handled options are removed from the hash. |
205 | * | |
0bdadba2 BV |
206 | * @param di Decoder instance. |
207 | * @param options A GHashTable of options to set. | |
7ce7775c | 208 | * |
0bdadba2 BV |
209 | * @return SRD_OK upon success, a (negative) error code otherwise. |
210 | */ | |
b33b8aa5 UH |
211 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, |
212 | GHashTable *options) | |
0bdadba2 BV |
213 | { |
214 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
215 | PyObject *py_optlist, *py_classval; | |
216 | Py_UNICODE *py_ustr; | |
217 | unsigned long long int val_ull; | |
218 | int num_optkeys, ret, size, i; | |
219 | char *key, *value; | |
220 | ||
c9bfccc6 | 221 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { |
0bdadba2 | 222 | /* Decoder has no options. */ |
e431d9cc BV |
223 | if (g_hash_table_size(options) == 0) { |
224 | /* No options provided. */ | |
225 | return SRD_OK; | |
226 | } else { | |
227 | srd_err("Protocol decoder has no options."); | |
228 | return SRD_ERR_ARG; | |
229 | } | |
0bdadba2 | 230 | return SRD_OK; |
e431d9cc | 231 | } |
0bdadba2 BV |
232 | |
233 | ret = SRD_ERR_PYTHON; | |
234 | key = NULL; | |
235 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
236 | py_optlist = py_classval = NULL; | |
237 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
0bdadba2 BV |
238 | |
239 | /* All of these are synthesized objects, so they're good. */ | |
240 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
241 | num_optkeys = PyList_Size(py_dec_optkeys); | |
a8b72b05 | 242 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) |
0bdadba2 BV |
243 | goto err_out; |
244 | for (i = 0; i < num_optkeys; i++) { | |
245 | /* Get the default class value for this option. */ | |
246 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
247 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
248 | goto err_out; | |
249 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
250 | goto err_out; | |
130ef08a | 251 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { |
c9bfccc6 UH |
252 | srd_err("Options of type %s are not yet supported.", |
253 | Py_TYPE(py_classval)->tp_name); | |
130ef08a BV |
254 | goto err_out; |
255 | } | |
0bdadba2 BV |
256 | |
257 | if ((value = g_hash_table_lookup(options, key))) { | |
258 | /* An override for this option was provided. */ | |
259 | if (PyUnicode_Check(py_classval)) { | |
260 | if (!(py_optval = PyUnicode_FromString(value))) { | |
261 | /* Some UTF-8 encoding error. */ | |
262 | PyErr_Clear(); | |
263 | goto err_out; | |
264 | } | |
265 | } else if (PyLong_Check(py_classval)) { | |
266 | if (!(py_optval = PyLong_FromString(value, NULL, 0))) { | |
267 | /* ValueError Exception */ | |
268 | PyErr_Clear(); | |
c9bfccc6 UH |
269 | srd_err("Option %s has invalid value " |
270 | "%s: expected integer.", | |
271 | key, value); | |
0bdadba2 BV |
272 | goto err_out; |
273 | } | |
274 | } | |
275 | g_hash_table_remove(options, key); | |
276 | } else { | |
277 | /* Use the class default for this option. */ | |
278 | if (PyUnicode_Check(py_classval)) { | |
279 | /* Make a brand new copy of the string. */ | |
280 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
281 | size = PyUnicode_GET_SIZE(py_classval); | |
282 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
283 | } else if (PyLong_Check(py_classval)) { | |
284 | /* Make a brand new copy of the integer. */ | |
285 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
286 | if (val_ull == (unsigned long long)-1) { | |
287 | /* OverFlowError exception */ | |
288 | PyErr_Clear(); | |
c9bfccc6 UH |
289 | srd_err("Invalid integer value for %s: " |
290 | "expected integer.", key); | |
0bdadba2 BV |
291 | goto err_out; |
292 | } | |
293 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
294 | goto err_out; | |
295 | } | |
296 | } | |
297 | ||
361fdcaa UH |
298 | /* |
299 | * If we got here, py_optval holds a known good new reference | |
0bdadba2 BV |
300 | * to the instance option to set. |
301 | */ | |
302 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
303 | goto err_out; | |
304 | } | |
305 | ||
306 | ret = SRD_OK; | |
307 | ||
308 | err_out: | |
309 | Py_XDECREF(py_optlist); | |
310 | Py_XDECREF(py_di_options); | |
311 | Py_XDECREF(py_dec_optkeys); | |
312 | Py_XDECREF(py_dec_options); | |
6f858319 | 313 | g_free(key); |
2086c684 | 314 | if (PyErr_Occurred()) |
aafeeaea | 315 | srd_exception_catch("Stray exception in srd_inst_option_set()."); |
0bdadba2 BV |
316 | |
317 | return ret; | |
318 | } | |
319 | ||
b33b8aa5 | 320 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ |
abeeed8b | 321 | static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) |
f38ec285 | 322 | { |
f38ec285 BV |
323 | return strcmp(a->id, probe_id); |
324 | } | |
325 | ||
0bdadba2 | 326 | /** |
b33b8aa5 UH |
327 | * Set all probes in a decoder instance. |
328 | * | |
329 | * This function sets _all_ probes for the specified decoder instance, i.e., | |
330 | * it overwrites any probes that were already defined (if any). | |
0bdadba2 BV |
331 | * |
332 | * @param di Decoder instance. | |
29590b14 UH |
333 | * @param new_probes A GHashTable of probes to set. Key is probe name, value is |
334 | * the probe number. Samples passed to this instance will be | |
335 | * arranged in this order. | |
12243c22 | 336 | * |
0bdadba2 BV |
337 | * @return SRD_OK upon success, a (negative) error code otherwise. |
338 | */ | |
b33b8aa5 UH |
339 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, |
340 | GHashTable *new_probes) | |
0bdadba2 | 341 | { |
f38ec285 BV |
342 | GList *l; |
343 | GSList *sl; | |
344 | struct srd_probe *p; | |
345 | int *new_probemap, new_probenum; | |
be873260 | 346 | char *probe_id, *probenum_str; |
dd93276b | 347 | int i, num_required_probes; |
0bdadba2 | 348 | |
ce46beed | 349 | srd_dbg("set probes called for instance %s with list of %d probes", |
a8b72b05 | 350 | di->inst_id, g_hash_table_size(new_probes)); |
ce46beed | 351 | |
f38ec285 | 352 | if (g_hash_table_size(new_probes) == 0) |
0bdadba2 BV |
353 | /* No probes provided. */ |
354 | return SRD_OK; | |
355 | ||
c9bfccc6 | 356 | if (di->dec_num_probes == 0) { |
0bdadba2 | 357 | /* Decoder has no probes. */ |
f38ec285 | 358 | srd_err("Protocol decoder %s has no probes to define.", |
c9bfccc6 | 359 | di->decoder->name); |
f38ec285 BV |
360 | return SRD_ERR_ARG; |
361 | } | |
0bdadba2 | 362 | |
f38ec285 | 363 | new_probemap = NULL; |
0bdadba2 | 364 | |
f38ec285 | 365 | if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { |
a61ece20 | 366 | srd_err("Failed to g_malloc() new probe map."); |
f38ec285 | 367 | return SRD_ERR_MALLOC; |
0bdadba2 BV |
368 | } |
369 | ||
dd93276b UH |
370 | /* |
371 | * For now, map all indexes to probe -1 (can be overridden later). | |
372 | * This -1 is interpreted as an unspecified probe later. | |
373 | */ | |
374 | for (i = 0; i < di->dec_num_probes; i++) | |
375 | new_probemap[i] = -1; | |
376 | ||
f38ec285 BV |
377 | for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { |
378 | probe_id = l->data; | |
be873260 BV |
379 | probenum_str = g_hash_table_lookup(new_probes, probe_id); |
380 | if (!probenum_str) { | |
381 | /* Probe name was specified without a value. */ | |
c9bfccc6 UH |
382 | srd_err("No probe number was specified for %s.", |
383 | probe_id); | |
be873260 BV |
384 | g_free(new_probemap); |
385 | return SRD_ERR_ARG; | |
386 | } | |
387 | new_probenum = strtol(probenum_str, NULL, 10); | |
f38ec285 BV |
388 | if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, |
389 | (GCompareFunc)compare_probe_id))) { | |
390 | /* Fall back on optional probes. */ | |
dcdf4883 | 391 | if (!(sl = g_slist_find_custom(di->decoder->opt_probes, |
c9bfccc6 UH |
392 | probe_id, (GCompareFunc) compare_probe_id))) { |
393 | srd_err("Protocol decoder %s has no probe " | |
394 | "'%s'.", di->decoder->name, probe_id); | |
f38ec285 BV |
395 | g_free(new_probemap); |
396 | return SRD_ERR_ARG; | |
397 | } | |
398 | } | |
399 | p = sl->data; | |
400 | new_probemap[p->order] = new_probenum; | |
dd93276b UH |
401 | srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", |
402 | p->id, p->order, new_probenum); | |
403 | } | |
404 | ||
405 | srd_dbg("Final probe map:"); | |
406 | num_required_probes = g_slist_length(di->decoder->probes); | |
407 | for (i = 0; i < di->dec_num_probes; i++) { | |
408 | srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], | |
409 | (i < num_required_probes) ? "required" : "optional"); | |
f38ec285 | 410 | } |
dd93276b | 411 | |
f38ec285 BV |
412 | g_free(di->dec_probemap); |
413 | di->dec_probemap = new_probemap; | |
0bdadba2 | 414 | |
f38ec285 | 415 | return SRD_OK; |
0bdadba2 BV |
416 | } |
417 | ||
418 | /** | |
419 | * Create a new protocol decoder instance. | |
7ce7775c | 420 | * |
29590b14 | 421 | * @param decoder_id Decoder 'id' field. |
0bdadba2 | 422 | * @param options GHashtable of options which override the defaults set in |
c9bfccc6 | 423 | * the decoder class. |
12243c22 | 424 | * |
a8b72b05 | 425 | * @return Pointer to a newly allocated struct srd_decoder_inst, or |
c9bfccc6 | 426 | * NULL in case of failure. |
7ce7775c | 427 | */ |
a8b72b05 | 428 | SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id, |
361fdcaa | 429 | GHashTable *options) |
b2c19614 | 430 | { |
c9bfccc6 | 431 | int i; |
b2c19614 | 432 | struct srd_decoder *dec; |
a8b72b05 BV |
433 | struct srd_decoder_inst *di; |
434 | char *inst_id; | |
b2c19614 | 435 | |
7a1712c4 | 436 | srd_dbg("Creating new %s instance.", decoder_id); |
7ce7775c | 437 | |
9d122fd5 | 438 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { |
0bdadba2 | 439 | srd_err("Protocol decoder %s not found.", decoder_id); |
b2c19614 | 440 | return NULL; |
0bdadba2 | 441 | } |
b2c19614 | 442 | |
a8b72b05 | 443 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { |
a61ece20 | 444 | srd_err("Failed to g_malloc() instance."); |
7ce7775c BV |
445 | return NULL; |
446 | } | |
0bdadba2 | 447 | |
a8b72b05 | 448 | inst_id = g_hash_table_lookup(options, "id"); |
b2c19614 | 449 | di->decoder = dec; |
a8b72b05 | 450 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); |
0bdadba2 | 451 | g_hash_table_remove(options, "id"); |
b2c19614 | 452 | |
361fdcaa UH |
453 | /* |
454 | * Prepare a default probe map, where samples come in the | |
f38ec285 BV |
455 | * order in which the decoder class defined them. |
456 | */ | |
457 | di->dec_num_probes = g_slist_length(di->decoder->probes) + | |
c9bfccc6 | 458 | g_slist_length(di->decoder->opt_probes); |
19a90bab | 459 | if (di->dec_num_probes) { |
c9bfccc6 UH |
460 | if (!(di->dec_probemap = |
461 | g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
a61ece20 | 462 | srd_err("Failed to g_malloc() probe map."); |
19a90bab BV |
463 | g_free(di); |
464 | return NULL; | |
465 | } | |
466 | for (i = 0; i < di->dec_num_probes; i++) | |
467 | di->dec_probemap[i] = i; | |
f38ec285 | 468 | } |
f38ec285 | 469 | |
0bdadba2 | 470 | /* Create a new instance of this decoder class. */ |
a8b72b05 | 471 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { |
b2c19614 | 472 | if (PyErr_Occurred()) |
aafeeaea UH |
473 | srd_exception_catch("failed to create %s instance: ", |
474 | decoder_id); | |
f38ec285 | 475 | g_free(di->dec_probemap); |
0bdadba2 | 476 | g_free(di); |
7ce7775c | 477 | return NULL; |
b2c19614 | 478 | } |
7ce7775c | 479 | |
b33b8aa5 | 480 | if (srd_inst_option_set(di, options) != SRD_OK) { |
f38ec285 | 481 | g_free(di->dec_probemap); |
0bdadba2 BV |
482 | g_free(di); |
483 | return NULL; | |
484 | } | |
b2c19614 | 485 | |
f38ec285 BV |
486 | /* Instance takes input from a frontend by default. */ |
487 | di_list = g_slist_append(di_list, di); | |
488 | ||
b2c19614 BV |
489 | return di; |
490 | } | |
491 | ||
582c8473 BV |
492 | /** |
493 | * Stack a decoder instance on top of another. | |
494 | * | |
495 | * @param di_from The instance to move. | |
496 | * @param di_to The instance on top of which di_from will be stacked. | |
497 | * | |
498 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
499 | */ | |
a8b72b05 | 500 | SRD_API int srd_inst_stack(struct srd_decoder_inst *di_from, |
abeeed8b | 501 | struct srd_decoder_inst *di_to) |
7ce7775c | 502 | { |
7ce7775c | 503 | if (!di_from || !di_to) { |
d906d3f9 | 504 | srd_err("Invalid from/to instance pair."); |
7ce7775c BV |
505 | return SRD_ERR_ARG; |
506 | } | |
507 | ||
2072ae0c BV |
508 | if (g_slist_find(di_list, di_to)) { |
509 | /* Remove from the unstacked list. */ | |
510 | di_list = g_slist_remove(di_list, di_to); | |
7ce7775c BV |
511 | } |
512 | ||
7ce7775c BV |
513 | /* Stack on top of source di. */ |
514 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
515 | ||
516 | return SRD_OK; | |
517 | } | |
518 | ||
2072ae0c | 519 | /** |
361fdcaa UH |
520 | * Find a decoder instance by its instance ID. |
521 | * | |
522 | * Only the bottom level of instances are searched -- instances already stacked | |
523 | * on top of another one will not be found. | |
2072ae0c | 524 | * |
ed2306a6 | 525 | * @param inst_id The instance ID to be found. |
2072ae0c | 526 | * |
a8b72b05 | 527 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
2072ae0c | 528 | */ |
abeeed8b | 529 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(const char *inst_id) |
7ce7775c BV |
530 | { |
531 | GSList *l; | |
a8b72b05 | 532 | struct srd_decoder_inst *tmp, *di; |
b2c19614 | 533 | |
7ce7775c BV |
534 | di = NULL; |
535 | for (l = di_list; l; l = l->next) { | |
536 | tmp = l->data; | |
a8b72b05 | 537 | if (!strcmp(tmp->inst_id, inst_id)) { |
7ce7775c BV |
538 | di = tmp; |
539 | break; | |
540 | } | |
541 | } | |
542 | ||
543 | return di; | |
544 | } | |
545 | ||
2072ae0c | 546 | /** |
361fdcaa UH |
547 | * Find a decoder instance by its Python object. |
548 | * | |
549 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
550 | * This will recurse to find the instance anywhere in the stack tree. | |
2072ae0c | 551 | * |
361fdcaa UH |
552 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the |
553 | * stack to search. To start searching at the bottom level of | |
554 | * decoder instances, pass NULL. | |
511e2123 | 555 | * @param obj The Python class instantiation. |
2072ae0c | 556 | * |
a8b72b05 | 557 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. |
2072ae0c | 558 | */ |
abeeed8b UH |
559 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, |
560 | const PyObject *obj) | |
2072ae0c | 561 | { |
abeeed8b UH |
562 | // TODO? |
563 | const GSList *l; | |
a8b72b05 | 564 | struct srd_decoder_inst *tmp, *di; |
2072ae0c BV |
565 | |
566 | di = NULL; | |
567 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
568 | tmp = l->data; | |
a8b72b05 | 569 | if (tmp->py_inst == obj) |
2072ae0c BV |
570 | di = tmp; |
571 | else if (tmp->next_di) | |
a8b72b05 | 572 | di = srd_inst_find_by_obj(tmp->next_di, obj); |
2072ae0c BV |
573 | } |
574 | ||
575 | return di; | |
576 | } | |
577 | ||
ee4ed227 | 578 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) |
b2c19614 | 579 | { |
7ce7775c | 580 | PyObject *py_name, *py_res; |
2072ae0c | 581 | GSList *l; |
a8b72b05 | 582 | struct srd_decoder_inst *next_di; |
b2c19614 | 583 | |
7a1712c4 | 584 | srd_dbg("Calling start() method on protocol decoder instance %s.", |
a8b72b05 | 585 | di->inst_id); |
b2c19614 | 586 | |
7ce7775c | 587 | if (!(py_name = PyUnicode_FromString("start"))) { |
511e2123 | 588 | srd_err("Unable to build Python object for 'start'."); |
aafeeaea UH |
589 | srd_exception_catch("Protocol decoder instance %s: ", |
590 | di->inst_id); | |
7ce7775c BV |
591 | return SRD_ERR_PYTHON; |
592 | } | |
593 | ||
a8b72b05 | 594 | if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, |
c9bfccc6 | 595 | py_name, args, NULL))) { |
aafeeaea UH |
596 | srd_exception_catch("Protocol decoder instance %s: ", |
597 | di->inst_id); | |
7ce7775c | 598 | return SRD_ERR_PYTHON; |
b2c19614 BV |
599 | } |
600 | ||
f38ec285 BV |
601 | Py_DecRef(py_res); |
602 | Py_DecRef(py_name); | |
7ce7775c | 603 | |
361fdcaa UH |
604 | /* |
605 | * Start all the PDs stacked on top of this one. Pass along the | |
2072ae0c BV |
606 | * metadata all the way from the bottom PD, even though it's only |
607 | * applicable to logic data for now. | |
608 | */ | |
609 | for (l = di->next_di; l; l = l->next) { | |
610 | next_di = l->data; | |
a8b72b05 | 611 | srd_inst_start(next_di, args); |
2072ae0c BV |
612 | } |
613 | ||
b2c19614 BV |
614 | return SRD_OK; |
615 | } | |
616 | ||
b2c19614 BV |
617 | /** |
618 | * Run the specified decoder function. | |
619 | * | |
d906d3f9 | 620 | * @param start_samplenum The starting sample number for the buffer's sample |
7a1712c4 UH |
621 | * set, relative to the start of capture. |
622 | * @param di The decoder instance to call. Must not be NULL. | |
623 | * @param inbuf The buffer to decode. Must not be NULL. | |
624 | * @param inbuflen Length of the buffer. Must be > 0. | |
b2c19614 BV |
625 | * |
626 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
627 | */ | |
12243c22 | 628 | SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, |
abeeed8b UH |
629 | const struct srd_decoder_inst *di, |
630 | const uint8_t *inbuf, uint64_t inbuflen) | |
b2c19614 | 631 | { |
d906d3f9 | 632 | PyObject *py_res; |
bc5f5a43 | 633 | srd_logic *logic; |
86528298 | 634 | uint64_t end_samplenum; |
b2c19614 | 635 | |
7a1712c4 | 636 | srd_dbg("Calling decode() on instance %s with %d bytes starting " |
a8b72b05 | 637 | "at sample %d.", di->inst_id, inbuflen, start_samplenum); |
b2c19614 | 638 | |
d906d3f9 | 639 | /* Return an error upon unusable input. */ |
7a1712c4 UH |
640 | if (!di) { |
641 | srd_dbg("empty decoder instance"); | |
d906d3f9 BV |
642 | return SRD_ERR_ARG; |
643 | } | |
7a1712c4 UH |
644 | if (!inbuf) { |
645 | srd_dbg("NULL buffer pointer"); | |
d906d3f9 BV |
646 | return SRD_ERR_ARG; |
647 | } | |
648 | if (inbuflen == 0) { | |
7a1712c4 | 649 | srd_dbg("empty buffer"); |
d906d3f9 BV |
650 | return SRD_ERR_ARG; |
651 | } | |
b2c19614 | 652 | |
361fdcaa UH |
653 | /* |
654 | * Create new srd_logic object. Each iteration around the PD's loop | |
d906d3f9 BV |
655 | * will fill one sample into this object. |
656 | */ | |
bc5f5a43 BV |
657 | logic = PyObject_New(srd_logic, &srd_logic_type); |
658 | Py_INCREF(logic); | |
abeeed8b | 659 | logic->di = (struct srd_decoder_inst *)di; |
86528298 | 660 | logic->start_samplenum = start_samplenum; |
bc5f5a43 | 661 | logic->itercnt = 0; |
abeeed8b | 662 | logic->inbuf = (uint8_t *)inbuf; |
bc5f5a43 BV |
663 | logic->inbuflen = inbuflen; |
664 | logic->sample = PyList_New(2); | |
665 | Py_INCREF(logic->sample); | |
666 | ||
a8b72b05 | 667 | Py_IncRef(di->py_inst); |
f38ec285 | 668 | end_samplenum = start_samplenum + inbuflen / di->data_unitsize; |
a8b72b05 | 669 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", |
c9bfccc6 UH |
670 | "KKO", logic->start_samplenum, |
671 | end_samplenum, logic))) { | |
aafeeaea UH |
672 | srd_exception_catch("Protocol decoder instance %s: ", |
673 | di->inst_id); | |
b2c19614 BV |
674 | return SRD_ERR_PYTHON; /* TODO: More specific error? */ |
675 | } | |
d906d3f9 | 676 | Py_DecRef(py_res); |
bc5f5a43 | 677 | |
b2c19614 BV |
678 | return SRD_OK; |
679 | } | |
680 | ||
12243c22 | 681 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) |
fa12a21e BV |
682 | { |
683 | GSList *l; | |
684 | struct srd_pd_output *pdo; | |
685 | ||
a8b72b05 | 686 | srd_dbg("Freeing instance %s", di->inst_id); |
fa12a21e | 687 | |
a8b72b05 BV |
688 | Py_DecRef(di->py_inst); |
689 | g_free(di->inst_id); | |
fa12a21e BV |
690 | g_free(di->dec_probemap); |
691 | g_slist_free(di->next_di); | |
692 | for (l = di->pd_output; l; l = l->next) { | |
693 | pdo = l->data; | |
694 | g_free(pdo->proto_id); | |
695 | g_free(pdo); | |
696 | } | |
697 | g_slist_free(di->pd_output); | |
fa12a21e BV |
698 | } |
699 | ||
12243c22 | 700 | SRD_PRIV void srd_inst_free_all(GSList *stack) |
fa12a21e BV |
701 | { |
702 | GSList *l; | |
a8b72b05 | 703 | struct srd_decoder_inst *di; |
fa12a21e BV |
704 | |
705 | di = NULL; | |
706 | for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) { | |
707 | di = l->data; | |
708 | if (di->next_di) | |
a8b72b05 BV |
709 | srd_inst_free_all(di->next_di); |
710 | srd_inst_free(di); | |
fa12a21e BV |
711 | } |
712 | if (!stack) { | |
713 | g_slist_free(di_list); | |
714 | di_list = NULL; | |
715 | } | |
fa12a21e | 716 | } |
b2c19614 | 717 | |
582c8473 BV |
718 | /** |
719 | * Start a decoding session. | |
720 | * | |
721 | * Decoders, instances and stack must have been prepared beforehand. | |
722 | * | |
723 | * @param num_probes The number of probes which the incoming feed will contain. | |
724 | * @param unitsize The number of bytes per sample in the incoming feed. | |
361fdcaa | 725 | * @param samplerate The samplerate of the incoming feed. |
582c8473 BV |
726 | * |
727 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
728 | */ | |
55c3c5f4 | 729 | SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate) |
7ce7775c BV |
730 | { |
731 | PyObject *args; | |
2072ae0c | 732 | GSList *d; |
a8b72b05 | 733 | struct srd_decoder_inst *di; |
7ce7775c BV |
734 | int ret; |
735 | ||
7a1712c4 UH |
736 | srd_dbg("Calling start() on all instances with %d probes, " |
737 | "unitsize %d samplerate %d.", num_probes, unitsize, samplerate); | |
d906d3f9 | 738 | |
361fdcaa UH |
739 | /* |
740 | * Currently only one item of metadata is passed along to decoders, | |
d906d3f9 BV |
741 | * samplerate. This can be extended as needed. |
742 | */ | |
7ce7775c | 743 | if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) { |
511e2123 | 744 | srd_err("Unable to build Python object for metadata."); |
7ce7775c BV |
745 | return SRD_ERR_PYTHON; |
746 | } | |
747 | ||
748 | /* Run the start() method on all decoders receiving frontend data. */ | |
749 | for (d = di_list; d; d = d->next) { | |
750 | di = d->data; | |
f38ec285 BV |
751 | di->data_num_probes = num_probes; |
752 | di->data_unitsize = unitsize; | |
753 | di->data_samplerate = samplerate; | |
32fd715c | 754 | if ((ret = srd_inst_start(di, args)) != SRD_OK) |
2072ae0c | 755 | break; |
7ce7775c BV |
756 | } |
757 | ||
d906d3f9 | 758 | Py_DecRef(args); |
7ce7775c | 759 | |
2072ae0c | 760 | return ret; |
7ce7775c BV |
761 | } |
762 | ||
582c8473 | 763 | /** |
29dad0ac | 764 | * Send a chunk of logic sample data to a running decoder session. |
582c8473 BV |
765 | * |
766 | * @param start_samplenum The sample number of the first sample in this chunk. | |
767 | * @param inbuf Pointer to sample data. | |
29590b14 | 768 | * @param inbuflen Length in bytes of the buffer. |
582c8473 BV |
769 | * |
770 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
771 | */ | |
29dad0ac | 772 | SRD_API int srd_session_send(uint64_t start_samplenum, const uint8_t *inbuf, |
55c3c5f4 | 773 | uint64_t inbuflen) |
b2c19614 BV |
774 | { |
775 | GSList *d; | |
776 | int ret; | |
777 | ||
7a1712c4 | 778 | srd_dbg("Calling decode() on all instances with starting sample " |
c9bfccc6 UH |
779 | "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", |
780 | start_samplenum, inbuflen, inbuf); | |
d906d3f9 | 781 | |
e5080882 | 782 | for (d = di_list; d; d = d->next) { |
a8b72b05 | 783 | if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, |
361fdcaa | 784 | inbuflen)) != SRD_OK) |
b2c19614 BV |
785 | return ret; |
786 | } | |
787 | ||
788 | return SRD_OK; | |
789 | } | |
790 | ||
582c8473 | 791 | /** |
b33b8aa5 | 792 | * Register/add a decoder output callback function. |
582c8473 BV |
793 | * |
794 | * The function will be called when a protocol decoder sends output back | |
795 | * to the PD controller (except for Python objects, which only go up the | |
796 | * stack). | |
797 | * | |
798 | * @param output_type The output type this callback will receive. Only one | |
4c1d0670 | 799 | * callback per output type can be registered. |
361fdcaa UH |
800 | * @param cb The function to call. Must not be NULL. |
801 | * @param cb_data Private data for the callback function. Can be NULL. | |
582c8473 | 802 | */ |
b33b8aa5 UH |
803 | SRD_API int srd_pd_output_callback_add(int output_type, |
804 | srd_pd_output_callback_t cb, void *cb_data) | |
4fadb128 BV |
805 | { |
806 | struct srd_pd_callback *pd_cb; | |
807 | ||
7a1712c4 | 808 | srd_dbg("Registering new callback for output type %d.", output_type); |
4fadb128 | 809 | |
a61ece20 UH |
810 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { |
811 | srd_err("Failed to g_malloc() struct srd_pd_callback."); | |
4fadb128 | 812 | return SRD_ERR_MALLOC; |
a61ece20 | 813 | } |
4fadb128 BV |
814 | |
815 | pd_cb->output_type = output_type; | |
4c1d0670 | 816 | pd_cb->cb = cb; |
41a5d962 | 817 | pd_cb->cb_data = cb_data; |
4fadb128 BV |
818 | callbacks = g_slist_append(callbacks, pd_cb); |
819 | ||
820 | return SRD_OK; | |
821 | } | |
822 | ||
b33b8aa5 | 823 | SRD_PRIV void *srd_pd_output_callback_find(int output_type) |
4fadb128 BV |
824 | { |
825 | GSList *l; | |
826 | struct srd_pd_callback *pd_cb; | |
827 | void *(cb); | |
828 | ||
829 | cb = NULL; | |
830 | for (l = callbacks; l; l = l->next) { | |
831 | pd_cb = l->data; | |
832 | if (pd_cb->output_type == output_type) { | |
4c1d0670 | 833 | cb = pd_cb->cb; |
4fadb128 BV |
834 | break; |
835 | } | |
836 | } | |
837 | ||
838 | return cb; | |
839 | } | |
840 | ||
511e2123 | 841 | /* This is the backend function to Python sigrokdecode.add() call. */ |
aafeeaea UH |
842 | SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, |
843 | int output_type, const char *proto_id) | |
e5080882 | 844 | { |
e5080882 | 845 | struct srd_pd_output *pdo; |
e5080882 | 846 | |
7a1712c4 | 847 | srd_dbg("Instance %s creating new output type %d for %s.", |
a8b72b05 | 848 | di->inst_id, output_type, proto_id); |
d906d3f9 | 849 | |
a61ece20 UH |
850 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { |
851 | srd_err("Failed to g_malloc() struct srd_pd_output."); | |
e5080882 | 852 | return -1; |
a61ece20 | 853 | } |
e5080882 | 854 | |
b231546d | 855 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ |
15969949 | 856 | pdo->pdo_id = g_slist_length(di->pd_output); |
e5080882 | 857 | pdo->output_type = output_type; |
b3b2cae8 | 858 | pdo->di = di; |
94d43b37 | 859 | pdo->proto_id = g_strdup(proto_id); |
e5080882 BV |
860 | di->pd_output = g_slist_append(di->pd_output, pdo); |
861 | ||
15969949 | 862 | return pdo->pdo_id; |
e5080882 | 863 | } |