2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
22 #include "libsigrokdecode-internal.h"
30 * @mainpage libsigrokdecode API
32 * @section sec_intro Introduction
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).
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.
43 * The <a href="http://sigrok.org/wiki/Protocol_decoders">protocol decoders</a>
44 * are written in Python (>= 3.0).
46 * @section sec_api API reference
48 * See the "Modules" page for an introduction to various libsigrokdecode
49 * related topics and the detailed API documentation of the respective
52 * You can also browse the API documentation by file, or review all
55 * @section sec_mailinglists Mailing lists
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>.
59 * @section sec_irc IRC
61 * You can find the sigrok developers in the
62 * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
63 * IRC channel on Freenode.
65 * @section sec_website Website
67 * <a href="http://sigrok.org/wiki/Libsigrokdecode">sigrok.org/wiki/Libsigrokdecode</a>
73 * Initializing and shutting down libsigrokdecode.
77 * @defgroup grp_init Initialization
79 * Initializing and shutting down libsigrokdecode.
81 * Before using any of the libsigrokdecode functionality, srd_init() must
82 * be called to initialize the library.
84 * When libsigrokdecode functionality is no longer needed, srd_exit() should
92 SRD_PRIV GSList *sessions = NULL;
93 static int max_session_id = -1;
95 static int session_is_valid(struct srd_session *sess);
98 extern SRD_PRIV GSList *pd_list;
100 /* module_sigrokdecode.c */
101 extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
104 extern SRD_PRIV PyTypeObject srd_logic_type;
109 * Initialize libsigrokdecode.
111 * This initializes the Python interpreter, and creates and initializes
112 * a "sigrokdecode" Python module.
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().
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.
122 * Multiple calls to srd_init(), without calling srd_exit() in between,
125 * @param path Path to an extra directory containing protocol decoders
126 * which will be added to the Python sys.path. May be NULL.
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.
135 SRD_API int srd_init(const char *path)
140 if (max_session_id != -1) {
141 srd_err("libsigrokdecode is already initialized.");
145 srd_dbg("Initializing libsigrokdecode.");
147 /* Add our own module to the list of built-in modules. */
148 PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
150 /* Initialize the Python interpreter. */
153 /* Installed decoders. */
154 if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
159 /* Path specified by the user. */
161 if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
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) {
181 * Shutdown libsigrokdecode.
183 * This frees all the memory allocated for protocol decoders and shuts down
184 * the Python interpreter.
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.
190 * @return SRD_OK upon success, a (negative) error code otherwise.
194 SRD_API int srd_exit(void)
198 srd_dbg("Exiting libsigrokdecode.");
200 for (l = sessions; l; l = l->next)
201 srd_session_destroy((struct srd_session *)l->data);
203 srd_decoder_unload_all();
204 g_slist_free(pd_list);
207 /* Py_Finalize() returns void, any finalization errors are ignored. */
216 * Add an additional search directory for the protocol decoders.
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.
225 * @param path Path to the directory containing protocol decoders which shall
226 * be added to the Python sys.path, or NULL.
228 * @return SRD_OK upon success, a (negative) error code otherwise.
234 SRD_PRIV int srd_decoder_searchpath_add(const char *path)
236 PyObject *py_cur_path, *py_item;
239 wchar_t *wc_new_path;
242 srd_dbg("Adding '%s' to module path.", path);
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. */
253 if (py_str_as_str(py_item, &item) != SRD_OK)
255 g_string_append(new_path, item);
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;
265 mbstowcs(wc_new_path, new_path->str, wc_len);
266 PySys_SetPath(wc_new_path);
267 g_string_free(new_path, TRUE);
276 * @defgroup grp_instances Decoder instances
278 * Decoder instance handling.
284 * Set one or more options in a decoder instance.
286 * Handled options are removed from the hash.
288 * @param di Decoder instance.
289 * @param options A GHashTable of options to set.
291 * @return SRD_OK upon success, a (negative) error code otherwise.
295 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
298 PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
299 PyObject *py_optlist, *py_classval;
302 unsigned long long int val_ull;
304 int num_optkeys, ret, size, i;
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. */
314 srd_err("Protocol decoder has no options.");
320 ret = SRD_ERR_PYTHON;
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");
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 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
331 for (i = 0; i < num_optkeys; i++) {
332 /* Get the default class value for this option. */
333 py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
334 if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
336 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
338 if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
339 srd_err("Options of type %s are not yet supported.",
340 Py_TYPE(py_classval)->tp_name);
344 if ((value = g_hash_table_lookup(options, key))) {
345 dbg = g_variant_print(value, TRUE);
346 srd_dbg("got option '%s' = %s", key, dbg);
348 /* An override for this option was provided. */
349 if (PyUnicode_Check(py_classval)) {
350 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
351 srd_err("Option '%s' requires a string value.", key);
354 val_str = g_variant_get_string(value, NULL);
355 if (!(py_optval = PyUnicode_FromString(val_str))) {
356 /* Some UTF-8 encoding error. */
358 srd_err("Option '%s' requires a UTF-8 string value.", key);
361 } else if (PyLong_Check(py_classval)) {
362 if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
363 srd_err("Option '%s' requires an integer value.", key);
366 val_int = g_variant_get_int64(value);
367 if (!(py_optval = PyLong_FromLong(val_int))) {
368 /* ValueError Exception */
370 srd_err("Option '%s' has invalid integer value.", key);
374 g_hash_table_remove(options, key);
376 /* Use the class default for this option. */
377 if (PyUnicode_Check(py_classval)) {
378 /* Make a brand new copy of the string. */
379 py_ustr = PyUnicode_AS_UNICODE(py_classval);
380 size = PyUnicode_GET_SIZE(py_classval);
381 py_optval = PyUnicode_FromUnicode(py_ustr, size);
382 } else if (PyLong_Check(py_classval)) {
383 /* Make a brand new copy of the integer. */
384 val_ull = PyLong_AsUnsignedLongLong(py_classval);
385 if (val_ull == (unsigned long long)-1) {
386 /* OverFlowError exception */
388 srd_err("Invalid integer value for %s: "
389 "expected integer.", key);
392 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
398 * If we got here, py_optval holds a known good new reference
399 * to the instance option to set.
401 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
410 Py_XDECREF(py_optlist);
411 Py_XDECREF(py_di_options);
412 Py_XDECREF(py_dec_optkeys);
413 Py_XDECREF(py_dec_options);
415 if (PyErr_Occurred()) {
416 srd_exception_catch("Stray exception in srd_inst_option_set().");
417 ret = SRD_ERR_PYTHON;
423 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
424 static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
426 return strcmp(a->id, probe_id);
430 * Set all probes in a decoder instance.
432 * This function sets _all_ probes for the specified decoder instance, i.e.,
433 * it overwrites any probes that were already defined (if any).
435 * @param di Decoder instance.
436 * @param new_probes A GHashTable of probes to set. Key is probe name, value is
437 * the probe number. Samples passed to this instance will be
438 * arranged in this order.
440 * @return SRD_OK upon success, a (negative) error code otherwise.
444 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
445 GHashTable *new_probes)
451 int *new_probemap, new_probenum;
453 int i, num_required_probes;
455 srd_dbg("set probes called for instance %s with list of %d probes",
456 di->inst_id, g_hash_table_size(new_probes));
458 if (g_hash_table_size(new_probes) == 0)
459 /* No probes provided. */
462 if (di->dec_num_probes == 0) {
463 /* Decoder has no probes. */
464 srd_err("Protocol decoder %s has no probes to define.",
471 if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
472 srd_err("Failed to g_malloc() new probe map.");
473 return SRD_ERR_MALLOC;
477 * For now, map all indexes to probe -1 (can be overridden later).
478 * This -1 is interpreted as an unspecified probe later.
480 for (i = 0; i < di->dec_num_probes; i++)
481 new_probemap[i] = -1;
483 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
485 probe_val= g_hash_table_lookup(new_probes, probe_id);
486 if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
487 /* Probe name was specified without a value. */
488 srd_err("No probe number was specified for %s.",
490 g_free(new_probemap);
493 new_probenum = g_variant_get_int32(probe_val);
494 if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
495 (GCompareFunc)compare_probe_id))) {
496 /* Fall back on optional probes. */
497 if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
498 probe_id, (GCompareFunc) compare_probe_id))) {
499 srd_err("Protocol decoder %s has no probe "
500 "'%s'.", di->decoder->name, probe_id);
501 g_free(new_probemap);
506 new_probemap[p->order] = new_probenum;
507 srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
508 p->id, p->order, new_probenum);
511 srd_dbg("Final probe map:");
512 num_required_probes = g_slist_length(di->decoder->probes);
513 for (i = 0; i < di->dec_num_probes; i++) {
514 srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
515 (i < num_required_probes) ? "required" : "optional");
518 g_free(di->dec_probemap);
519 di->dec_probemap = new_probemap;
525 * Create a new protocol decoder instance.
527 * @param sess The session holding the protocol decoder instance.
528 * @param decoder_id Decoder 'id' field.
529 * @param options GHashtable of options which override the defaults set in
530 * the decoder class. May be NULL.
532 * @return Pointer to a newly allocated struct srd_decoder_inst, or
533 * NULL in case of failure.
537 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
538 const char *decoder_id, GHashTable *options)
541 struct srd_decoder *dec;
542 struct srd_decoder_inst *di;
545 srd_dbg("Creating new %s instance.", decoder_id);
547 if (session_is_valid(sess) != SRD_OK) {
548 srd_err("Invalid session.");
552 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
553 srd_err("Protocol decoder %s not found.", decoder_id);
557 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
558 srd_err("Failed to g_malloc() instance.");
565 inst_id = g_hash_table_lookup(options, "id");
566 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
567 g_hash_table_remove(options, "id");
569 di->inst_id = g_strdup(decoder_id);
572 * Prepare a default probe map, where samples come in the
573 * order in which the decoder class defined them.
575 di->dec_num_probes = g_slist_length(di->decoder->probes) +
576 g_slist_length(di->decoder->opt_probes);
577 if (di->dec_num_probes) {
578 if (!(di->dec_probemap =
579 g_try_malloc(sizeof(int) * di->dec_num_probes))) {
580 srd_err("Failed to g_malloc() probe map.");
584 for (i = 0; i < di->dec_num_probes; i++)
585 di->dec_probemap[i] = i;
588 /* Create a new instance of this decoder class. */
589 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
590 if (PyErr_Occurred())
591 srd_exception_catch("failed to create %s instance: ",
593 g_free(di->dec_probemap);
598 if (options && srd_inst_option_set(di, options) != SRD_OK) {
599 g_free(di->dec_probemap);
604 /* Instance takes input from a frontend by default. */
605 sess->di_list = g_slist_append(sess->di_list, di);
611 * Stack a decoder instance on top of another.
613 * @param sess The session holding the protocol decoder instances.
614 * @param di_from The instance to move.
615 * @param di_to The instance on top of which di_from will be stacked.
617 * @return SRD_OK upon success, a (negative) error code otherwise.
621 SRD_API int srd_inst_stack(struct srd_session *sess,
622 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to)
625 if (session_is_valid(sess) != SRD_OK) {
626 srd_err("Invalid session.");
630 if (!di_from || !di_to) {
631 srd_err("Invalid from/to instance pair.");
635 if (g_slist_find(sess->di_list, di_to)) {
636 /* Remove from the unstacked list. */
637 sess->di_list = g_slist_remove(sess->di_list, di_to);
640 /* Stack on top of source di. */
641 di_from->next_di = g_slist_append(di_from->next_di, di_to);
647 * Find a decoder instance by its instance ID.
649 * Only the bottom level of instances are searched -- instances already stacked
650 * on top of another one will not be found.
652 * @param sess The session holding the protocol decoder instance.
653 * @param inst_id The instance ID to be found.
655 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
659 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
663 struct srd_decoder_inst *tmp, *di;
665 if (session_is_valid(sess) != SRD_OK) {
666 srd_err("Invalid session.");
671 for (l = sess->di_list; l; l = l->next) {
673 if (!strcmp(tmp->inst_id, inst_id)) {
682 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
683 struct srd_session *sess, const GSList *stack,
687 struct srd_decoder_inst *tmp, *di;
689 if (session_is_valid(sess) != SRD_OK) {
690 srd_err("Invalid session.");
695 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
697 if (tmp->py_inst == obj)
699 else if (tmp->next_di)
700 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
707 * Find a decoder instance by its Python object.
709 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
710 * This will recurse to find the instance anywhere in the stack tree of all
713 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
714 * stack to search. To start searching at the bottom level of
715 * decoder instances, pass NULL.
716 * @param obj The Python class instantiation.
718 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
724 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
727 struct srd_decoder_inst *di;
728 struct srd_session *sess;
732 for (l = sessions; di == NULL && l != NULL; l = l->next) {
734 di = srd_sess_inst_find_by_obj(sess, stack, obj);
741 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
743 PyObject *py_name, *py_res;
745 struct srd_decoder_inst *next_di;
747 srd_dbg("Calling start() method on protocol decoder instance %s.",
750 if (!(py_name = PyUnicode_FromString("start"))) {
751 srd_err("Unable to build Python object for 'start'.");
752 srd_exception_catch("Protocol decoder instance %s: ",
754 return SRD_ERR_PYTHON;
757 if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
758 py_name, args, NULL))) {
759 srd_exception_catch("Protocol decoder instance %s: ",
761 return SRD_ERR_PYTHON;
768 * Start all the PDs stacked on top of this one. Pass along the
769 * metadata all the way from the bottom PD, even though it's only
770 * applicable to logic data for now.
772 for (l = di->next_di; l; l = l->next) {
774 srd_inst_start(next_di, args);
781 * Run the specified decoder function.
783 * @param start_samplenum The starting sample number for the buffer's sample
784 * set, relative to the start of capture.
785 * @param di The decoder instance to call. Must not be NULL.
786 * @param inbuf The buffer to decode. Must not be NULL.
787 * @param inbuflen Length of the buffer. Must be > 0.
789 * @return SRD_OK upon success, a (negative) error code otherwise.
795 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
796 const struct srd_decoder_inst *di, const uint8_t *inbuf,
801 uint64_t end_samplenum;
803 srd_dbg("Calling decode() on instance %s with %d bytes starting "
804 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
806 /* Return an error upon unusable input. */
808 srd_dbg("empty decoder instance");
812 srd_dbg("NULL buffer pointer");
816 srd_dbg("empty buffer");
821 * Create new srd_logic object. Each iteration around the PD's loop
822 * will fill one sample into this object.
824 logic = PyObject_New(srd_logic, &srd_logic_type);
826 logic->di = (struct srd_decoder_inst *)di;
827 logic->start_samplenum = start_samplenum;
829 logic->inbuf = (uint8_t *)inbuf;
830 logic->inbuflen = inbuflen;
831 logic->sample = PyList_New(2);
832 Py_INCREF(logic->sample);
834 Py_IncRef(di->py_inst);
835 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
836 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
837 "KKO", logic->start_samplenum,
838 end_samplenum, logic))) {
839 srd_exception_catch("Protocol decoder instance %s: ",
841 return SRD_ERR_PYTHON;
849 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
852 struct srd_pd_output *pdo;
854 srd_dbg("Freeing instance %s", di->inst_id);
856 Py_DecRef(di->py_inst);
858 g_free(di->dec_probemap);
859 g_slist_free(di->next_di);
860 for (l = di->pd_output; l; l = l->next) {
862 g_free(pdo->proto_id);
865 g_slist_free(di->pd_output);
870 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
873 struct srd_decoder_inst *di;
875 if (session_is_valid(sess) != SRD_OK) {
876 srd_err("Invalid session.");
881 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
884 srd_inst_free_all(sess, di->next_di);
888 g_slist_free(sess->di_list);
889 sess->di_list = NULL;
896 * @defgroup grp_session Session handling
898 * Starting and handling decoding sessions.
903 static int session_is_valid(struct srd_session *sess)
906 if (!sess || sess->session_id < 1)
913 * Create a decoding session.
915 * A session holds all decoder instances, their stack relationships and
918 * @param sess. A pointer which will hold a pointer to a newly
919 * initialized session on return.
921 * @return SRD_OK upon success, a (negative) error code otherwise.
925 SRD_API int srd_session_new(struct srd_session **sess)
929 srd_err("Invalid session pointer.");
933 if (!(*sess = g_try_malloc(sizeof(struct srd_session))))
934 return SRD_ERR_MALLOC;
935 (*sess)->session_id = ++max_session_id;
936 (*sess)->num_probes = (*sess)->unitsize = (*sess)->samplerate = 0;
937 (*sess)->di_list = (*sess)->callbacks = NULL;
939 /* Keep a list of all sessions, so we can clean up as needed. */
940 sessions = g_slist_append(sessions, *sess);
942 srd_dbg("Created session %d.", (*sess)->session_id);
948 * Start a decoding session.
950 * Decoders, instances and stack must have been prepared beforehand,
951 * and all SRD_CONF parameters set.
953 * @param sess The session to start.
955 * @return SRD_OK upon success, a (negative) error code otherwise.
959 SRD_API int srd_session_start(struct srd_session *sess)
963 struct srd_decoder_inst *di;
966 if (session_is_valid(sess) != SRD_OK) {
967 srd_err("Invalid session pointer.");
970 if (sess->num_probes == 0) {
971 srd_err("Session has invalid number of probes.");
974 if (sess->unitsize == 0) {
975 srd_err("Session has invalid unitsize.");
978 if (sess->samplerate == 0) {
979 srd_err("Session has invalid samplerate.");
985 srd_dbg("Calling start() on all instances in session %d with "
986 "%d probes, unitsize %d samplerate %d.", sess->session_id,
987 sess->num_probes, sess->unitsize, sess->samplerate);
990 * Currently only one item of metadata is passed along to decoders,
991 * samplerate. This can be extended as needed.
993 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)sess->samplerate))) {
994 srd_err("Unable to build Python object for metadata.");
995 return SRD_ERR_PYTHON;
998 /* Run the start() method on all decoders receiving frontend data. */
999 for (d = sess->di_list; d; d = d->next) {
1001 di->data_num_probes = sess->num_probes;
1002 di->data_unitsize = sess->unitsize;
1003 di->data_samplerate = sess->samplerate;
1004 if ((ret = srd_inst_start(di, args)) != SRD_OK)
1014 * Set a configuration key in a session.
1016 * @param sess The session to configure.
1017 * @param key The configuration key (SRD_CONF_*).
1018 * @param data The new value for the key, as a GVariant with GVariantType
1019 * appropriate to that key. A floating reference can be passed
1020 * in; its refcount will be sunk and unreferenced after use.
1022 * @return SRD_OK upon success, a (negative) error code otherwise.
1026 SRD_API int srd_session_config_set(struct srd_session *sess, int key,
1030 if (session_is_valid(sess) != SRD_OK) {
1031 srd_err("Invalid session.");
1035 if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
1036 srd_err("Value for key %d should be of type uint64.");
1041 case SRD_CONF_NUM_PROBES:
1042 sess->num_probes = g_variant_get_uint64(data);
1044 case SRD_CONF_UNITSIZE:
1045 sess->unitsize = g_variant_get_uint64(data);
1047 case SRD_CONF_SAMPLERATE:
1048 sess->samplerate = g_variant_get_uint64(data);
1052 g_variant_unref(data);
1058 * Send a chunk of logic sample data to a running decoder session.
1060 * @param sess The session to use.
1061 * @param start_samplenum The sample number of the first sample in this chunk.
1062 * @param inbuf Pointer to sample data.
1063 * @param inbuflen Length in bytes of the buffer.
1065 * @return SRD_OK upon success, a (negative) error code otherwise.
1069 SRD_API int srd_session_send(struct srd_session *sess, uint64_t start_samplenum,
1070 const uint8_t *inbuf, uint64_t inbuflen)
1075 if (session_is_valid(sess) != SRD_OK) {
1076 srd_err("Invalid session.");
1080 srd_dbg("Calling decode() on all instances with starting sample "
1081 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
1082 start_samplenum, inbuflen, inbuf);
1084 for (d = sess->di_list; d; d = d->next) {
1085 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
1086 inbuflen)) != SRD_OK)
1094 * Destroy a decoding session.
1096 * All decoder instances and output callbacks are properly released.
1098 * @param sess. The session to be destroyed.
1100 * @return SRD_OK upon success, a (negative) error code otherwise.
1104 SRD_API int srd_session_destroy(struct srd_session *sess)
1108 session_id = sess->session_id;
1110 srd_inst_free_all(sess, NULL);
1111 if (sess->callbacks)
1112 g_slist_free_full(sess->callbacks, g_free);
1113 sessions = g_slist_remove(sessions, sess);
1116 srd_dbg("Destroyed session %d.", session_id);
1122 * Register/add a decoder output callback function.
1124 * The function will be called when a protocol decoder sends output back
1125 * to the PD controller (except for Python objects, which only go up the
1128 * @param sess The output session in which to register the callback.
1129 * @param output_type The output type this callback will receive. Only one
1130 * callback per output type can be registered.
1131 * @param cb The function to call. Must not be NULL.
1132 * @param cb_data Private data for the callback function. Can be NULL.
1136 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
1137 int output_type, srd_pd_output_callback_t cb, void *cb_data)
1139 struct srd_pd_callback *pd_cb;
1141 if (session_is_valid(sess) != SRD_OK) {
1142 srd_err("Invalid session.");
1146 srd_dbg("Registering new callback for output type %d.", output_type);
1148 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
1149 srd_err("Failed to g_malloc() struct srd_pd_callback.");
1150 return SRD_ERR_MALLOC;
1153 pd_cb->output_type = output_type;
1155 pd_cb->cb_data = cb_data;
1156 sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
1162 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
1163 struct srd_session *sess, int output_type)
1166 struct srd_pd_callback *tmp, *pd_cb;
1168 if (session_is_valid(sess) != SRD_OK) {
1169 srd_err("Invalid session.");
1174 for (l = sess->callbacks; l; l = l->next) {
1176 if (tmp->output_type == output_type) {
1185 /* This is the backend function to Python sigrokdecode.add() call. */
1187 SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
1188 int output_type, const char *proto_id)
1190 struct srd_pd_output *pdo;
1192 srd_dbg("Instance %s creating new output type %d for %s.",
1193 di->inst_id, output_type, proto_id);
1195 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
1196 srd_err("Failed to g_malloc() struct srd_pd_output.");
1200 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
1201 pdo->pdo_id = g_slist_length(di->pd_output);
1202 pdo->output_type = output_type;
1204 pdo->proto_id = g_strdup(proto_id);
1205 di->pd_output = g_slist_append(di->pd_output, pdo);