]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrokdecode 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 "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */ | |
22 | #include "libsigrokdecode-internal.h" | |
23 | #include "config.h" | |
24 | #include <glib.h> | |
25 | #include <inttypes.h> | |
26 | #include <stdlib.h> | |
27 | #include <stdint.h> | |
28 | ||
29 | /** | |
30 | * @mainpage libsigrokdecode API | |
31 | * | |
32 | * @section sec_intro Introduction | |
33 | * | |
34 | * The <a href="http://sigrok.org">sigrok</a> project aims at creating a | |
35 | * portable, cross-platform, Free/Libre/Open-Source signal analysis software | |
36 | * suite that supports various device types (such as logic analyzers, | |
37 | * oscilloscopes, multimeters, and more). | |
38 | * | |
39 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">libsigrokdecode</a> is a | |
40 | * shared library written in C which provides the basic API for (streaming) | |
41 | * protocol decoding functionality. | |
42 | * | |
43 | * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a> | |
44 | * are written in Python (>= 3.0). | |
45 | * | |
46 | * @section sec_api API reference | |
47 | * | |
48 | * See the "Modules" page for an introduction to various libsigrokdecode | |
49 | * related topics and the detailed API documentation of the respective | |
50 | * functions. | |
51 | * | |
52 | * You can also browse the API documentation by file, or review all | |
53 | * data structures. | |
54 | * | |
55 | * @section sec_mailinglists Mailing lists | |
56 | * | |
57 | * 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>. | |
58 | * | |
59 | * @section sec_irc IRC | |
60 | * | |
61 | * You can find the sigrok developers in the | |
62 | * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a> | |
63 | * IRC channel on Freenode. | |
64 | * | |
65 | * @section sec_website Website | |
66 | * | |
67 | * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a> | |
68 | */ | |
69 | ||
70 | /** | |
71 | * @file | |
72 | * | |
73 | * Initializing and shutting down libsigrokdecode. | |
74 | */ | |
75 | ||
76 | /** | |
77 | * @defgroup grp_init Initialization | |
78 | * | |
79 | * Initializing and shutting down libsigrokdecode. | |
80 | * | |
81 | * Before using any of the libsigrokdecode functionality, srd_init() must | |
82 | * be called to initialize the library. | |
83 | * | |
84 | * When libsigrokdecode functionality is no longer needed, srd_exit() should | |
85 | * be called. | |
86 | * | |
87 | * @{ | |
88 | */ | |
89 | ||
90 | /** @cond PRIVATE */ | |
91 | ||
92 | SRD_PRIV GSList *sessions = NULL; | |
93 | static int max_session_id = -1; | |
94 | ||
95 | static int session_is_valid(struct srd_session *sess); | |
96 | ||
97 | /* decoder.c */ | |
98 | extern SRD_PRIV GSList *pd_list; | |
99 | ||
100 | /* module_sigrokdecode.c */ | |
101 | extern PyMODINIT_FUNC PyInit_sigrokdecode(void); | |
102 | ||
103 | /* type_logic.c */ | |
104 | extern SRD_PRIV PyTypeObject srd_logic_type; | |
105 | ||
106 | /** @endcond */ | |
107 | ||
108 | /** | |
109 | * Initialize libsigrokdecode. | |
110 | * | |
111 | * This initializes the Python interpreter, and creates and initializes | |
112 | * a "sigrokdecode" Python module. | |
113 | * | |
114 | * Then, it searches for sigrok protocol decoders in the "decoders" | |
115 | * subdirectory of the the libsigrokdecode installation directory. | |
116 | * All decoders that are found are loaded into memory and added to an | |
117 | * internal list of decoders, which can be queried via srd_decoder_list(). | |
118 | * | |
119 | * The caller is responsible for calling the clean-up function srd_exit(), | |
120 | * which will properly shut down libsigrokdecode and free its allocated memory. | |
121 | * | |
122 | * Multiple calls to srd_init(), without calling srd_exit() in between, | |
123 | * are not allowed. | |
124 | * | |
125 | * @param path Path to an extra directory containing protocol decoders | |
126 | * which will be added to the Python sys.path. May be NULL. | |
127 | * | |
128 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
129 | * Upon Python errors, SRD_ERR_PYTHON is returned. If the decoders | |
130 | * directory cannot be accessed, SRD_ERR_DECODERS_DIR is returned. | |
131 | * If not enough memory could be allocated, SRD_ERR_MALLOC is returned. | |
132 | * | |
133 | * @since 0.1.0 | |
134 | */ | |
135 | SRD_API int srd_init(const char *path) | |
136 | { | |
137 | int ret; | |
138 | char *env_path; | |
139 | ||
140 | if (max_session_id != -1) { | |
141 | srd_err("libsigrokdecode is already initialized."); | |
142 | return SRD_ERR; | |
143 | } | |
144 | ||
145 | srd_dbg("Initializing libsigrokdecode."); | |
146 | ||
147 | /* Add our own module to the list of built-in modules. */ | |
148 | PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode); | |
149 | ||
150 | /* Initialize the Python interpreter. */ | |
151 | Py_Initialize(); | |
152 | ||
153 | /* Installed decoders. */ | |
154 | if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) { | |
155 | Py_Finalize(); | |
156 | return ret; | |
157 | } | |
158 | ||
159 | /* Path specified by the user. */ | |
160 | if (path) { | |
161 | if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) { | |
162 | Py_Finalize(); | |
163 | return ret; | |
164 | } | |
165 | } | |
166 | ||
167 | /* Environment variable overrides everything, for debugging. */ | |
168 | if ((env_path = getenv("SIGROKDECODE_DIR"))) { | |
169 | if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) { | |
170 | Py_Finalize(); | |
171 | return ret; | |
172 | } | |
173 | } | |
174 | ||
175 | max_session_id = 0; | |
176 | ||
177 | return SRD_OK; | |
178 | } | |
179 | ||
180 | /** | |
181 | * Shutdown libsigrokdecode. | |
182 | * | |
183 | * This frees all the memory allocated for protocol decoders and shuts down | |
184 | * the Python interpreter. | |
185 | * | |
186 | * This function should only be called if there was a (successful!) invocation | |
187 | * of srd_init() before. Calling this function multiple times in a row, without | |
188 | * any successful srd_init() calls in between, is not allowed. | |
189 | * | |
190 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
191 | * | |
192 | * @since 0.1.0 | |
193 | */ | |
194 | SRD_API int srd_exit(void) | |
195 | { | |
196 | GSList *l; | |
197 | ||
198 | srd_dbg("Exiting libsigrokdecode."); | |
199 | ||
200 | for (l = sessions; l; l = l->next) | |
201 | srd_session_destroy((struct srd_session *)l->data); | |
202 | ||
203 | srd_decoder_unload_all(); | |
204 | g_slist_free(pd_list); | |
205 | pd_list = NULL; | |
206 | ||
207 | /* Py_Finalize() returns void, any finalization errors are ignored. */ | |
208 | Py_Finalize(); | |
209 | ||
210 | max_session_id = -1; | |
211 | ||
212 | return SRD_OK; | |
213 | } | |
214 | ||
215 | /** | |
216 | * Add an additional search directory for the protocol decoders. | |
217 | * | |
218 | * The specified directory is prepended (not appended!) to Python's sys.path, | |
219 | * in order to search for sigrok protocol decoders in the specified | |
220 | * directories first, and in the generic Python module directories (and in | |
221 | * the current working directory) last. This avoids conflicts if there are | |
222 | * Python modules which have the same name as a sigrok protocol decoder in | |
223 | * sys.path or in the current working directory. | |
224 | * | |
225 | * @param path Path to the directory containing protocol decoders which shall | |
226 | * be added to the Python sys.path, or NULL. | |
227 | * | |
228 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
229 | * | |
230 | * @private | |
231 | * | |
232 | * @since 0.1.0 | |
233 | */ | |
234 | SRD_PRIV int srd_decoder_searchpath_add(const char *path) | |
235 | { | |
236 | PyObject *py_cur_path, *py_item; | |
237 | GString *new_path; | |
238 | int wc_len, i; | |
239 | wchar_t *wc_new_path; | |
240 | char *item; | |
241 | ||
242 | srd_dbg("Adding '%s' to module path.", path); | |
243 | ||
244 | new_path = g_string_sized_new(256); | |
245 | g_string_assign(new_path, path); | |
246 | py_cur_path = PySys_GetObject("path"); | |
247 | for (i = 0; i < PyList_Size(py_cur_path); i++) { | |
248 | g_string_append(new_path, G_SEARCHPATH_SEPARATOR_S); | |
249 | py_item = PyList_GetItem(py_cur_path, i); | |
250 | if (!PyUnicode_Check(py_item)) | |
251 | /* Shouldn't happen. */ | |
252 | continue; | |
253 | if (py_str_as_str(py_item, &item) != SRD_OK) | |
254 | continue; | |
255 | g_string_append(new_path, item); | |
256 | g_free(item); | |
257 | } | |
258 | ||
259 | /* Convert to wide chars. */ | |
260 | wc_len = sizeof(wchar_t) * (new_path->len + 1); | |
261 | if (!(wc_new_path = g_try_malloc(wc_len))) { | |
262 | srd_dbg("malloc failed"); | |
263 | return SRD_ERR_MALLOC; | |
264 | } | |
265 | mbstowcs(wc_new_path, new_path->str, wc_len); | |
266 | PySys_SetPath(wc_new_path); | |
267 | g_string_free(new_path, TRUE); | |
268 | g_free(wc_new_path); | |
269 | ||
270 | return SRD_OK; | |
271 | } | |
272 | ||
273 | /** @} */ | |
274 | ||
275 | /** | |
276 | * @defgroup grp_instances Decoder instances | |
277 | * | |
278 | * Decoder instance handling. | |
279 | * | |
280 | * @{ | |
281 | */ | |
282 | ||
283 | /** | |
284 | * Set one or more options in a decoder instance. | |
285 | * | |
286 | * Handled options are removed from the hash. | |
287 | * | |
288 | * @param di Decoder instance. | |
289 | * @param options A GHashTable of options to set. | |
290 | * | |
291 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
292 | * | |
293 | * @since 0.1.0 | |
294 | */ | |
295 | SRD_API int srd_inst_option_set(struct srd_decoder_inst *di, | |
296 | GHashTable *options) | |
297 | { | |
298 | PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval; | |
299 | PyObject *py_optlist, *py_classval; | |
300 | Py_UNICODE *py_ustr; | |
301 | GVariant *value; | |
302 | unsigned long long int val_ull; | |
303 | gint64 val_int; | |
304 | int num_optkeys, ret, size, i; | |
305 | const char *val_str; | |
306 | char *dbg, *key; | |
307 | ||
308 | if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) { | |
309 | /* Decoder has no options. */ | |
310 | if (g_hash_table_size(options) == 0) { | |
311 | /* No options provided. */ | |
312 | return SRD_OK; | |
313 | } else { | |
314 | srd_err("Protocol decoder has no options."); | |
315 | return SRD_ERR_ARG; | |
316 | } | |
317 | return SRD_OK; | |
318 | } | |
319 | ||
320 | ret = SRD_ERR_PYTHON; | |
321 | key = NULL; | |
322 | py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL; | |
323 | py_optlist = py_classval = NULL; | |
324 | py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options"); | |
325 | ||
326 | /* All of these are synthesized objects, so they're good. */ | |
327 | py_dec_optkeys = PyDict_Keys(py_dec_options); | |
328 | num_optkeys = PyList_Size(py_dec_optkeys); | |
329 | ||
330 | /* | |
331 | * The 'options' dictionary is a class variable, but we need to | |
332 | * change it. Changing it directly will affect the entire class, | |
333 | * so we need to create a new object for it, and populate that | |
334 | * instead. | |
335 | */ | |
336 | if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options"))) | |
337 | goto err_out; | |
338 | Py_DECREF(py_di_options); | |
339 | py_di_options = PyDict_New(); | |
340 | PyObject_SetAttrString(di->py_inst, "options", py_di_options); | |
341 | for (i = 0; i < num_optkeys; i++) { | |
342 | /* Get the default class value for this option. */ | |
343 | py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key); | |
344 | if (!(py_optlist = PyDict_GetItemString(py_dec_options, key))) | |
345 | goto err_out; | |
346 | if (!(py_classval = PyList_GetItem(py_optlist, 1))) | |
347 | goto err_out; | |
348 | if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) { | |
349 | srd_err("Options of type %s are not yet supported.", | |
350 | Py_TYPE(py_classval)->tp_name); | |
351 | goto err_out; | |
352 | } | |
353 | ||
354 | if ((value = g_hash_table_lookup(options, key))) { | |
355 | dbg = g_variant_print(value, TRUE); | |
356 | srd_dbg("got option '%s' = %s", key, dbg); | |
357 | g_free(dbg); | |
358 | /* An override for this option was provided. */ | |
359 | if (PyUnicode_Check(py_classval)) { | |
360 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) { | |
361 | srd_err("Option '%s' requires a string value.", key); | |
362 | goto err_out; | |
363 | } | |
364 | val_str = g_variant_get_string(value, NULL); | |
365 | if (!(py_optval = PyUnicode_FromString(val_str))) { | |
366 | /* Some UTF-8 encoding error. */ | |
367 | PyErr_Clear(); | |
368 | srd_err("Option '%s' requires a UTF-8 string value.", key); | |
369 | goto err_out; | |
370 | } | |
371 | } else if (PyLong_Check(py_classval)) { | |
372 | if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) { | |
373 | srd_err("Option '%s' requires an integer value.", key); | |
374 | goto err_out; | |
375 | } | |
376 | val_int = g_variant_get_int64(value); | |
377 | if (!(py_optval = PyLong_FromLong(val_int))) { | |
378 | /* ValueError Exception */ | |
379 | PyErr_Clear(); | |
380 | srd_err("Option '%s' has invalid integer value.", key); | |
381 | goto err_out; | |
382 | } | |
383 | } | |
384 | g_hash_table_remove(options, key); | |
385 | } else { | |
386 | /* Use the class default for this option. */ | |
387 | if (PyUnicode_Check(py_classval)) { | |
388 | /* Make a brand new copy of the string. */ | |
389 | py_ustr = PyUnicode_AS_UNICODE(py_classval); | |
390 | size = PyUnicode_GET_SIZE(py_classval); | |
391 | py_optval = PyUnicode_FromUnicode(py_ustr, size); | |
392 | } else if (PyLong_Check(py_classval)) { | |
393 | /* Make a brand new copy of the integer. */ | |
394 | val_ull = PyLong_AsUnsignedLongLong(py_classval); | |
395 | if (val_ull == (unsigned long long)-1) { | |
396 | /* OverFlowError exception */ | |
397 | PyErr_Clear(); | |
398 | srd_err("Invalid integer value for %s: " | |
399 | "expected integer.", key); | |
400 | goto err_out; | |
401 | } | |
402 | if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull))) | |
403 | goto err_out; | |
404 | } | |
405 | } | |
406 | ||
407 | /* | |
408 | * If we got here, py_optval holds a known good new reference | |
409 | * to the instance option to set. | |
410 | */ | |
411 | if (PyDict_SetItemString(py_di_options, key, py_optval) == -1) | |
412 | goto err_out; | |
413 | g_free(key); | |
414 | key = NULL; | |
415 | } | |
416 | ||
417 | ret = SRD_OK; | |
418 | ||
419 | err_out: | |
420 | Py_XDECREF(py_di_options); | |
421 | Py_XDECREF(py_dec_optkeys); | |
422 | Py_XDECREF(py_dec_options); | |
423 | g_free(key); | |
424 | if (PyErr_Occurred()) { | |
425 | srd_exception_catch("Stray exception in srd_inst_option_set()."); | |
426 | ret = SRD_ERR_PYTHON; | |
427 | } | |
428 | ||
429 | return ret; | |
430 | } | |
431 | ||
432 | /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */ | |
433 | static gint compare_probe_id(const struct srd_probe *a, const char *probe_id) | |
434 | { | |
435 | return strcmp(a->id, probe_id); | |
436 | } | |
437 | ||
438 | /** | |
439 | * Set all probes in a decoder instance. | |
440 | * | |
441 | * This function sets _all_ probes for the specified decoder instance, i.e., | |
442 | * it overwrites any probes that were already defined (if any). | |
443 | * | |
444 | * @param di Decoder instance. | |
445 | * @param new_probes A GHashTable of probes to set. Key is probe name, value is | |
446 | * the probe number. Samples passed to this instance will be | |
447 | * arranged in this order. | |
448 | * | |
449 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
450 | * | |
451 | * @since 0.1.0 | |
452 | */ | |
453 | SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di, | |
454 | GHashTable *new_probes) | |
455 | { | |
456 | GVariant *probe_val; | |
457 | GList *l; | |
458 | GSList *sl; | |
459 | struct srd_probe *p; | |
460 | int *new_probemap, new_probenum; | |
461 | char *probe_id; | |
462 | int i, num_required_probes; | |
463 | ||
464 | srd_dbg("set probes called for instance %s with list of %d probes", | |
465 | di->inst_id, g_hash_table_size(new_probes)); | |
466 | ||
467 | if (g_hash_table_size(new_probes) == 0) | |
468 | /* No probes provided. */ | |
469 | return SRD_OK; | |
470 | ||
471 | if (di->dec_num_probes == 0) { | |
472 | /* Decoder has no probes. */ | |
473 | srd_err("Protocol decoder %s has no probes to define.", | |
474 | di->decoder->name); | |
475 | return SRD_ERR_ARG; | |
476 | } | |
477 | ||
478 | new_probemap = NULL; | |
479 | ||
480 | if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
481 | srd_err("Failed to g_malloc() new probe map."); | |
482 | return SRD_ERR_MALLOC; | |
483 | } | |
484 | ||
485 | /* | |
486 | * For now, map all indexes to probe -1 (can be overridden later). | |
487 | * This -1 is interpreted as an unspecified probe later. | |
488 | */ | |
489 | for (i = 0; i < di->dec_num_probes; i++) | |
490 | new_probemap[i] = -1; | |
491 | ||
492 | for (l = g_hash_table_get_keys(new_probes); l; l = l->next) { | |
493 | probe_id = l->data; | |
494 | probe_val= g_hash_table_lookup(new_probes, probe_id); | |
495 | if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) { | |
496 | /* Probe name was specified without a value. */ | |
497 | srd_err("No probe number was specified for %s.", | |
498 | probe_id); | |
499 | g_free(new_probemap); | |
500 | return SRD_ERR_ARG; | |
501 | } | |
502 | new_probenum = g_variant_get_int32(probe_val); | |
503 | if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id, | |
504 | (GCompareFunc)compare_probe_id))) { | |
505 | /* Fall back on optional probes. */ | |
506 | if (!(sl = g_slist_find_custom(di->decoder->opt_probes, | |
507 | probe_id, (GCompareFunc) compare_probe_id))) { | |
508 | srd_err("Protocol decoder %s has no probe " | |
509 | "'%s'.", di->decoder->name, probe_id); | |
510 | g_free(new_probemap); | |
511 | return SRD_ERR_ARG; | |
512 | } | |
513 | } | |
514 | p = sl->data; | |
515 | new_probemap[p->order] = new_probenum; | |
516 | srd_dbg("Setting probe mapping: %s (index %d) = probe %d.", | |
517 | p->id, p->order, new_probenum); | |
518 | } | |
519 | ||
520 | srd_dbg("Final probe map:"); | |
521 | num_required_probes = g_slist_length(di->decoder->probes); | |
522 | for (i = 0; i < di->dec_num_probes; i++) { | |
523 | srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i], | |
524 | (i < num_required_probes) ? "required" : "optional"); | |
525 | } | |
526 | ||
527 | g_free(di->dec_probemap); | |
528 | di->dec_probemap = new_probemap; | |
529 | ||
530 | return SRD_OK; | |
531 | } | |
532 | ||
533 | /** | |
534 | * Create a new protocol decoder instance. | |
535 | * | |
536 | * @param sess The session holding the protocol decoder instance. | |
537 | * @param decoder_id Decoder 'id' field. | |
538 | * @param options GHashtable of options which override the defaults set in | |
539 | * the decoder class. May be NULL. | |
540 | * | |
541 | * @return Pointer to a newly allocated struct srd_decoder_inst, or | |
542 | * NULL in case of failure. | |
543 | * | |
544 | * @since 0.1.0 (the API changed in 0.3.0, though) | |
545 | */ | |
546 | SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess, | |
547 | const char *decoder_id, GHashTable *options) | |
548 | { | |
549 | int i; | |
550 | struct srd_decoder *dec; | |
551 | struct srd_decoder_inst *di; | |
552 | char *inst_id; | |
553 | ||
554 | srd_dbg("Creating new %s instance.", decoder_id); | |
555 | ||
556 | if (session_is_valid(sess) != SRD_OK) { | |
557 | srd_err("Invalid session."); | |
558 | return NULL; | |
559 | } | |
560 | ||
561 | if (!(dec = srd_decoder_get_by_id(decoder_id))) { | |
562 | srd_err("Protocol decoder %s not found.", decoder_id); | |
563 | return NULL; | |
564 | } | |
565 | ||
566 | if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) { | |
567 | srd_err("Failed to g_malloc() instance."); | |
568 | return NULL; | |
569 | } | |
570 | ||
571 | di->decoder = dec; | |
572 | di->sess = sess; | |
573 | if (options) { | |
574 | inst_id = g_hash_table_lookup(options, "id"); | |
575 | di->inst_id = g_strdup(inst_id ? inst_id : decoder_id); | |
576 | g_hash_table_remove(options, "id"); | |
577 | } else | |
578 | di->inst_id = g_strdup(decoder_id); | |
579 | ||
580 | /* | |
581 | * Prepare a default probe map, where samples come in the | |
582 | * order in which the decoder class defined them. | |
583 | */ | |
584 | di->dec_num_probes = g_slist_length(di->decoder->probes) + | |
585 | g_slist_length(di->decoder->opt_probes); | |
586 | if (di->dec_num_probes) { | |
587 | if (!(di->dec_probemap = | |
588 | g_try_malloc(sizeof(int) * di->dec_num_probes))) { | |
589 | srd_err("Failed to g_malloc() probe map."); | |
590 | g_free(di); | |
591 | return NULL; | |
592 | } | |
593 | for (i = 0; i < di->dec_num_probes; i++) | |
594 | di->dec_probemap[i] = i; | |
595 | } | |
596 | ||
597 | /* Create a new instance of this decoder class. */ | |
598 | if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) { | |
599 | if (PyErr_Occurred()) | |
600 | srd_exception_catch("failed to create %s instance: ", | |
601 | decoder_id); | |
602 | g_free(di->dec_probemap); | |
603 | g_free(di); | |
604 | return NULL; | |
605 | } | |
606 | ||
607 | if (options && srd_inst_option_set(di, options) != SRD_OK) { | |
608 | g_free(di->dec_probemap); | |
609 | g_free(di); | |
610 | return NULL; | |
611 | } | |
612 | ||
613 | /* Instance takes input from a frontend by default. */ | |
614 | sess->di_list = g_slist_append(sess->di_list, di); | |
615 | ||
616 | return di; | |
617 | } | |
618 | ||
619 | /** | |
620 | * Stack a decoder instance on top of another. | |
621 | * | |
622 | * @param sess The session holding the protocol decoder instances. | |
623 | * @param di_from The instance to move. | |
624 | * @param di_to The instance on top of which di_from will be stacked. | |
625 | * | |
626 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
627 | * | |
628 | * @since 0.1.0 (the API changed in 0.3.0, though) | |
629 | */ | |
630 | SRD_API int srd_inst_stack(struct srd_session *sess, | |
631 | struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to) | |
632 | { | |
633 | ||
634 | if (session_is_valid(sess) != SRD_OK) { | |
635 | srd_err("Invalid session."); | |
636 | return SRD_ERR_ARG; | |
637 | } | |
638 | ||
639 | if (!di_from || !di_to) { | |
640 | srd_err("Invalid from/to instance pair."); | |
641 | return SRD_ERR_ARG; | |
642 | } | |
643 | ||
644 | if (g_slist_find(sess->di_list, di_to)) { | |
645 | /* Remove from the unstacked list. */ | |
646 | sess->di_list = g_slist_remove(sess->di_list, di_to); | |
647 | } | |
648 | ||
649 | /* Stack on top of source di. */ | |
650 | di_from->next_di = g_slist_append(di_from->next_di, di_to); | |
651 | ||
652 | return SRD_OK; | |
653 | } | |
654 | ||
655 | /** | |
656 | * Find a decoder instance by its instance ID. | |
657 | * | |
658 | * Only the bottom level of instances are searched -- instances already stacked | |
659 | * on top of another one will not be found. | |
660 | * | |
661 | * @param sess The session holding the protocol decoder instance. | |
662 | * @param inst_id The instance ID to be found. | |
663 | * | |
664 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. | |
665 | * | |
666 | * @since 0.1.0 (the API changed in 0.3.0, though) | |
667 | */ | |
668 | SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess, | |
669 | const char *inst_id) | |
670 | { | |
671 | GSList *l; | |
672 | struct srd_decoder_inst *tmp, *di; | |
673 | ||
674 | if (session_is_valid(sess) != SRD_OK) { | |
675 | srd_err("Invalid session."); | |
676 | return NULL; | |
677 | } | |
678 | ||
679 | di = NULL; | |
680 | for (l = sess->di_list; l; l = l->next) { | |
681 | tmp = l->data; | |
682 | if (!strcmp(tmp->inst_id, inst_id)) { | |
683 | di = tmp; | |
684 | break; | |
685 | } | |
686 | } | |
687 | ||
688 | return di; | |
689 | } | |
690 | ||
691 | static struct srd_decoder_inst *srd_sess_inst_find_by_obj( | |
692 | struct srd_session *sess, const GSList *stack, | |
693 | const PyObject *obj) | |
694 | { | |
695 | const GSList *l; | |
696 | struct srd_decoder_inst *tmp, *di; | |
697 | ||
698 | if (session_is_valid(sess) != SRD_OK) { | |
699 | srd_err("Invalid session."); | |
700 | return NULL; | |
701 | } | |
702 | ||
703 | di = NULL; | |
704 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
705 | tmp = l->data; | |
706 | if (tmp->py_inst == obj) | |
707 | di = tmp; | |
708 | else if (tmp->next_di) | |
709 | di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj); | |
710 | } | |
711 | ||
712 | return di; | |
713 | } | |
714 | ||
715 | /** | |
716 | * Find a decoder instance by its Python object. | |
717 | * | |
718 | * I.e. find that instance's instantiation of the sigrokdecode.Decoder class. | |
719 | * This will recurse to find the instance anywhere in the stack tree of all | |
720 | * sessions. | |
721 | * | |
722 | * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the | |
723 | * stack to search. To start searching at the bottom level of | |
724 | * decoder instances, pass NULL. | |
725 | * @param obj The Python class instantiation. | |
726 | * | |
727 | * @return Pointer to struct srd_decoder_inst, or NULL if not found. | |
728 | * | |
729 | * @private | |
730 | * | |
731 | * @since 0.1.0 | |
732 | */ | |
733 | SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack, | |
734 | const PyObject *obj) | |
735 | { | |
736 | struct srd_decoder_inst *di; | |
737 | struct srd_session *sess; | |
738 | GSList *l; | |
739 | ||
740 | di = NULL; | |
741 | for (l = sessions; di == NULL && l != NULL; l = l->next) { | |
742 | sess = l->data; | |
743 | di = srd_sess_inst_find_by_obj(sess, stack, obj); | |
744 | } | |
745 | ||
746 | return di; | |
747 | } | |
748 | ||
749 | /** @private */ | |
750 | SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args) | |
751 | { | |
752 | PyObject *py_name, *py_res; | |
753 | GSList *l; | |
754 | struct srd_decoder_inst *next_di; | |
755 | ||
756 | srd_dbg("Calling start() method on protocol decoder instance %s.", | |
757 | di->inst_id); | |
758 | ||
759 | if (!(py_name = PyUnicode_FromString("start"))) { | |
760 | srd_err("Unable to build Python object for 'start'."); | |
761 | srd_exception_catch("Protocol decoder instance %s: ", | |
762 | di->inst_id); | |
763 | return SRD_ERR_PYTHON; | |
764 | } | |
765 | ||
766 | if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst, | |
767 | py_name, args, NULL))) { | |
768 | srd_exception_catch("Protocol decoder instance %s: ", | |
769 | di->inst_id); | |
770 | return SRD_ERR_PYTHON; | |
771 | } | |
772 | ||
773 | Py_DecRef(py_res); | |
774 | Py_DecRef(py_name); | |
775 | ||
776 | /* | |
777 | * Start all the PDs stacked on top of this one. Pass along the | |
778 | * metadata all the way from the bottom PD, even though it's only | |
779 | * applicable to logic data for now. | |
780 | */ | |
781 | for (l = di->next_di; l; l = l->next) { | |
782 | next_di = l->data; | |
783 | srd_inst_start(next_di, args); | |
784 | } | |
785 | ||
786 | return SRD_OK; | |
787 | } | |
788 | ||
789 | /** | |
790 | * Run the specified decoder function. | |
791 | * | |
792 | * @param start_samplenum The starting sample number for the buffer's sample | |
793 | * set, relative to the start of capture. | |
794 | * @param di The decoder instance to call. Must not be NULL. | |
795 | * @param inbuf The buffer to decode. Must not be NULL. | |
796 | * @param inbuflen Length of the buffer. Must be > 0. | |
797 | * | |
798 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
799 | * | |
800 | * @private | |
801 | * | |
802 | * @since 0.1.0 | |
803 | */ | |
804 | SRD_PRIV int srd_inst_decode(uint64_t start_samplenum, | |
805 | const struct srd_decoder_inst *di, const uint8_t *inbuf, | |
806 | uint64_t inbuflen) | |
807 | { | |
808 | PyObject *py_res; | |
809 | srd_logic *logic; | |
810 | uint64_t end_samplenum; | |
811 | ||
812 | srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes " | |
813 | "starting at sample %" PRIu64 ".", di->inst_id, inbuflen, | |
814 | start_samplenum); | |
815 | ||
816 | /* Return an error upon unusable input. */ | |
817 | if (!di) { | |
818 | srd_dbg("empty decoder instance"); | |
819 | return SRD_ERR_ARG; | |
820 | } | |
821 | if (!inbuf) { | |
822 | srd_dbg("NULL buffer pointer"); | |
823 | return SRD_ERR_ARG; | |
824 | } | |
825 | if (inbuflen == 0) { | |
826 | srd_dbg("empty buffer"); | |
827 | return SRD_ERR_ARG; | |
828 | } | |
829 | ||
830 | /* | |
831 | * Create new srd_logic object. Each iteration around the PD's loop | |
832 | * will fill one sample into this object. | |
833 | */ | |
834 | logic = PyObject_New(srd_logic, &srd_logic_type); | |
835 | Py_INCREF(logic); | |
836 | logic->di = (struct srd_decoder_inst *)di; | |
837 | logic->start_samplenum = start_samplenum; | |
838 | logic->itercnt = 0; | |
839 | logic->inbuf = (uint8_t *)inbuf; | |
840 | logic->inbuflen = inbuflen; | |
841 | logic->sample = PyList_New(2); | |
842 | Py_INCREF(logic->sample); | |
843 | ||
844 | Py_IncRef(di->py_inst); | |
845 | end_samplenum = start_samplenum + inbuflen / di->data_unitsize; | |
846 | if (!(py_res = PyObject_CallMethod(di->py_inst, "decode", | |
847 | "KKO", logic->start_samplenum, | |
848 | end_samplenum, logic))) { | |
849 | srd_exception_catch("Protocol decoder instance %s: ", | |
850 | di->inst_id); | |
851 | return SRD_ERR_PYTHON; | |
852 | } | |
853 | Py_DecRef(py_res); | |
854 | ||
855 | return SRD_OK; | |
856 | } | |
857 | ||
858 | /** @private */ | |
859 | SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di) | |
860 | { | |
861 | GSList *l; | |
862 | struct srd_pd_output *pdo; | |
863 | ||
864 | srd_dbg("Freeing instance %s", di->inst_id); | |
865 | ||
866 | Py_DecRef(di->py_inst); | |
867 | g_free(di->inst_id); | |
868 | g_free(di->dec_probemap); | |
869 | g_slist_free(di->next_di); | |
870 | for (l = di->pd_output; l; l = l->next) { | |
871 | pdo = l->data; | |
872 | g_free(pdo->proto_id); | |
873 | g_free(pdo); | |
874 | } | |
875 | g_slist_free(di->pd_output); | |
876 | g_free(di); | |
877 | } | |
878 | ||
879 | /** @private */ | |
880 | SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack) | |
881 | { | |
882 | GSList *l; | |
883 | struct srd_decoder_inst *di; | |
884 | ||
885 | if (session_is_valid(sess) != SRD_OK) { | |
886 | srd_err("Invalid session."); | |
887 | return; | |
888 | } | |
889 | ||
890 | di = NULL; | |
891 | for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) { | |
892 | di = l->data; | |
893 | if (di->next_di) | |
894 | srd_inst_free_all(sess, di->next_di); | |
895 | srd_inst_free(di); | |
896 | } | |
897 | if (!stack) { | |
898 | g_slist_free(sess->di_list); | |
899 | sess->di_list = NULL; | |
900 | } | |
901 | } | |
902 | ||
903 | /** @} */ | |
904 | ||
905 | /** | |
906 | * @defgroup grp_session Session handling | |
907 | * | |
908 | * Starting and handling decoding sessions. | |
909 | * | |
910 | * @{ | |
911 | */ | |
912 | ||
913 | static int session_is_valid(struct srd_session *sess) | |
914 | { | |
915 | ||
916 | if (!sess || sess->session_id < 1) | |
917 | return SRD_ERR; | |
918 | ||
919 | return SRD_OK; | |
920 | } | |
921 | ||
922 | /** | |
923 | * Create a decoding session. | |
924 | * | |
925 | * A session holds all decoder instances, their stack relationships and | |
926 | * output callbacks. | |
927 | * | |
928 | * @param sess A pointer which will hold a pointer to a newly | |
929 | * initialized session on return. | |
930 | * | |
931 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
932 | * | |
933 | * @since 0.3.0 | |
934 | */ | |
935 | SRD_API int srd_session_new(struct srd_session **sess) | |
936 | { | |
937 | ||
938 | if (!sess) { | |
939 | srd_err("Invalid session pointer."); | |
940 | return SRD_ERR_ARG; | |
941 | } | |
942 | ||
943 | if (!(*sess = g_try_malloc(sizeof(struct srd_session)))) | |
944 | return SRD_ERR_MALLOC; | |
945 | (*sess)->session_id = ++max_session_id; | |
946 | (*sess)->num_probes = (*sess)->unitsize = (*sess)->samplerate = 0; | |
947 | (*sess)->di_list = (*sess)->callbacks = NULL; | |
948 | ||
949 | /* Keep a list of all sessions, so we can clean up as needed. */ | |
950 | sessions = g_slist_append(sessions, *sess); | |
951 | ||
952 | srd_dbg("Created session %d.", (*sess)->session_id); | |
953 | ||
954 | return SRD_OK; | |
955 | } | |
956 | ||
957 | /** | |
958 | * Start a decoding session. | |
959 | * | |
960 | * Decoders, instances and stack must have been prepared beforehand, | |
961 | * and all SRD_CONF parameters set. | |
962 | * | |
963 | * @param sess The session to start. | |
964 | * | |
965 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
966 | * | |
967 | * @since 0.1.0 (the API changed in 0.3.0, though) | |
968 | */ | |
969 | SRD_API int srd_session_start(struct srd_session *sess) | |
970 | { | |
971 | PyObject *args; | |
972 | GSList *d; | |
973 | struct srd_decoder_inst *di; | |
974 | int ret; | |
975 | ||
976 | if (session_is_valid(sess) != SRD_OK) { | |
977 | srd_err("Invalid session pointer."); | |
978 | return SRD_ERR; | |
979 | } | |
980 | if (sess->num_probes == 0) { | |
981 | srd_err("Session has invalid number of probes."); | |
982 | return SRD_ERR; | |
983 | } | |
984 | if (sess->unitsize == 0) { | |
985 | srd_err("Session has invalid unitsize."); | |
986 | return SRD_ERR; | |
987 | } | |
988 | if (sess->samplerate == 0) { | |
989 | srd_err("Session has invalid samplerate."); | |
990 | return SRD_ERR; | |
991 | } | |
992 | ||
993 | ret = SRD_OK; | |
994 | ||
995 | srd_dbg("Calling start() on all instances in session %d with " | |
996 | "%" PRIu64 " probes, unitsize %" PRIu64 | |
997 | ", samplerate %" PRIu64 ".", sess->session_id, | |
998 | sess->num_probes, sess->unitsize, sess->samplerate); | |
999 | ||
1000 | /* | |
1001 | * Currently only one item of metadata is passed along to decoders, | |
1002 | * samplerate. This can be extended as needed. | |
1003 | */ | |
1004 | if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)sess->samplerate))) { | |
1005 | srd_err("Unable to build Python object for metadata."); | |
1006 | return SRD_ERR_PYTHON; | |
1007 | } | |
1008 | ||
1009 | /* Run the start() method on all decoders receiving frontend data. */ | |
1010 | for (d = sess->di_list; d; d = d->next) { | |
1011 | di = d->data; | |
1012 | di->data_num_probes = sess->num_probes; | |
1013 | di->data_unitsize = sess->unitsize; | |
1014 | di->data_samplerate = sess->samplerate; | |
1015 | if ((ret = srd_inst_start(di, args)) != SRD_OK) | |
1016 | break; | |
1017 | } | |
1018 | ||
1019 | Py_DecRef(args); | |
1020 | ||
1021 | return ret; | |
1022 | } | |
1023 | ||
1024 | /** | |
1025 | * Set a configuration key in a session. | |
1026 | * | |
1027 | * @param sess The session to configure. | |
1028 | * @param key The configuration key (SRD_CONF_*). | |
1029 | * @param data The new value for the key, as a GVariant with GVariantType | |
1030 | * appropriate to that key. A floating reference can be passed | |
1031 | * in; its refcount will be sunk and unreferenced after use. | |
1032 | * | |
1033 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
1034 | * | |
1035 | * @since 0.3.0 | |
1036 | */ | |
1037 | SRD_API int srd_session_config_set(struct srd_session *sess, int key, | |
1038 | GVariant *data) | |
1039 | { | |
1040 | ||
1041 | if (session_is_valid(sess) != SRD_OK) { | |
1042 | srd_err("Invalid session."); | |
1043 | return SRD_ERR_ARG; | |
1044 | } | |
1045 | ||
1046 | if (!data) { | |
1047 | srd_err("Invalid config data."); | |
1048 | return SRD_ERR_ARG; | |
1049 | } | |
1050 | ||
1051 | if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) { | |
1052 | srd_err("Value for key %d should be of type uint64.", key); | |
1053 | return SRD_ERR_ARG; | |
1054 | } | |
1055 | ||
1056 | switch (key) { | |
1057 | case SRD_CONF_NUM_PROBES: | |
1058 | sess->num_probes = g_variant_get_uint64(data); | |
1059 | break; | |
1060 | case SRD_CONF_UNITSIZE: | |
1061 | sess->unitsize = g_variant_get_uint64(data); | |
1062 | break; | |
1063 | case SRD_CONF_SAMPLERATE: | |
1064 | sess->samplerate = g_variant_get_uint64(data); | |
1065 | break; | |
1066 | default: | |
1067 | srd_err("Cannot set config for unknown key %d.", key); | |
1068 | return SRD_ERR_ARG; | |
1069 | } | |
1070 | ||
1071 | g_variant_unref(data); | |
1072 | ||
1073 | return SRD_OK; | |
1074 | } | |
1075 | ||
1076 | /** | |
1077 | * Send a chunk of logic sample data to a running decoder session. | |
1078 | * | |
1079 | * @param sess The session to use. | |
1080 | * @param start_samplenum The sample number of the first sample in this chunk. | |
1081 | * @param inbuf Pointer to sample data. | |
1082 | * @param inbuflen Length in bytes of the buffer. | |
1083 | * | |
1084 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
1085 | * | |
1086 | * @since 0.1.0 | |
1087 | */ | |
1088 | SRD_API int srd_session_send(struct srd_session *sess, uint64_t start_samplenum, | |
1089 | const uint8_t *inbuf, uint64_t inbuflen) | |
1090 | { | |
1091 | GSList *d; | |
1092 | int ret; | |
1093 | ||
1094 | if (session_is_valid(sess) != SRD_OK) { | |
1095 | srd_err("Invalid session."); | |
1096 | return SRD_ERR_ARG; | |
1097 | } | |
1098 | ||
1099 | srd_dbg("Calling decode() on all instances with starting sample " | |
1100 | "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p", | |
1101 | start_samplenum, inbuflen, inbuf); | |
1102 | ||
1103 | for (d = sess->di_list; d; d = d->next) { | |
1104 | if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf, | |
1105 | inbuflen)) != SRD_OK) | |
1106 | return ret; | |
1107 | } | |
1108 | ||
1109 | return SRD_OK; | |
1110 | } | |
1111 | ||
1112 | /** | |
1113 | * Destroy a decoding session. | |
1114 | * | |
1115 | * All decoder instances and output callbacks are properly released. | |
1116 | * | |
1117 | * @param sess The session to be destroyed. | |
1118 | * | |
1119 | * @return SRD_OK upon success, a (negative) error code otherwise. | |
1120 | * | |
1121 | * @since 0.3.0 | |
1122 | */ | |
1123 | SRD_API int srd_session_destroy(struct srd_session *sess) | |
1124 | { | |
1125 | int session_id; | |
1126 | ||
1127 | if (!sess) { | |
1128 | srd_err("Invalid session."); | |
1129 | return SRD_ERR_ARG; | |
1130 | } | |
1131 | ||
1132 | session_id = sess->session_id; | |
1133 | if (sess->di_list) | |
1134 | srd_inst_free_all(sess, NULL); | |
1135 | if (sess->callbacks) | |
1136 | g_slist_free_full(sess->callbacks, g_free); | |
1137 | sessions = g_slist_remove(sessions, sess); | |
1138 | g_free(sess); | |
1139 | ||
1140 | srd_dbg("Destroyed session %d.", session_id); | |
1141 | ||
1142 | return SRD_OK; | |
1143 | } | |
1144 | ||
1145 | /** | |
1146 | * Register/add a decoder output callback function. | |
1147 | * | |
1148 | * The function will be called when a protocol decoder sends output back | |
1149 | * to the PD controller (except for Python objects, which only go up the | |
1150 | * stack). | |
1151 | * | |
1152 | * @param sess The output session in which to register the callback. | |
1153 | * @param output_type The output type this callback will receive. Only one | |
1154 | * callback per output type can be registered. | |
1155 | * @param cb The function to call. Must not be NULL. | |
1156 | * @param cb_data Private data for the callback function. Can be NULL. | |
1157 | * | |
1158 | * @since 0.1.0 (the API changed in 0.3.0, though) | |
1159 | */ | |
1160 | SRD_API int srd_pd_output_callback_add(struct srd_session *sess, | |
1161 | int output_type, srd_pd_output_callback_t cb, void *cb_data) | |
1162 | { | |
1163 | struct srd_pd_callback *pd_cb; | |
1164 | ||
1165 | if (session_is_valid(sess) != SRD_OK) { | |
1166 | srd_err("Invalid session."); | |
1167 | return SRD_ERR_ARG; | |
1168 | } | |
1169 | ||
1170 | srd_dbg("Registering new callback for output type %d.", output_type); | |
1171 | ||
1172 | if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) { | |
1173 | srd_err("Failed to g_malloc() struct srd_pd_callback."); | |
1174 | return SRD_ERR_MALLOC; | |
1175 | } | |
1176 | ||
1177 | pd_cb->output_type = output_type; | |
1178 | pd_cb->cb = cb; | |
1179 | pd_cb->cb_data = cb_data; | |
1180 | sess->callbacks = g_slist_append(sess->callbacks, pd_cb); | |
1181 | ||
1182 | return SRD_OK; | |
1183 | } | |
1184 | ||
1185 | /** @private */ | |
1186 | SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find( | |
1187 | struct srd_session *sess, int output_type) | |
1188 | { | |
1189 | GSList *l; | |
1190 | struct srd_pd_callback *tmp, *pd_cb; | |
1191 | ||
1192 | if (session_is_valid(sess) != SRD_OK) { | |
1193 | srd_err("Invalid session."); | |
1194 | return NULL; | |
1195 | } | |
1196 | ||
1197 | pd_cb = NULL; | |
1198 | for (l = sess->callbacks; l; l = l->next) { | |
1199 | tmp = l->data; | |
1200 | if (tmp->output_type == output_type) { | |
1201 | pd_cb = tmp; | |
1202 | break; | |
1203 | } | |
1204 | } | |
1205 | ||
1206 | return pd_cb; | |
1207 | } | |
1208 | ||
1209 | /* This is the backend function to Python sigrokdecode.add() call. */ | |
1210 | /** @private */ | |
1211 | SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di, | |
1212 | int output_type, const char *proto_id) | |
1213 | { | |
1214 | struct srd_pd_output *pdo; | |
1215 | ||
1216 | srd_dbg("Instance %s creating new output type %d for %s.", | |
1217 | di->inst_id, output_type, proto_id); | |
1218 | ||
1219 | if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) { | |
1220 | srd_err("Failed to g_malloc() struct srd_pd_output."); | |
1221 | return -1; | |
1222 | } | |
1223 | ||
1224 | /* pdo_id is just a simple index, nothing is deleted from this list anyway. */ | |
1225 | pdo->pdo_id = g_slist_length(di->pd_output); | |
1226 | pdo->output_type = output_type; | |
1227 | pdo->di = di; | |
1228 | pdo->proto_id = g_strdup(proto_id); | |
1229 | di->pd_output = g_slist_append(di->pd_output, pdo); | |
1230 | ||
1231 | return pdo->pdo_id; | |
1232 | } | |
1233 | ||
1234 | /** @} */ |