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