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);
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
336 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
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)))
346 if (!(py_classval = PyList_GetItem(py_optlist, 1)))
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);
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);
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);
364 val_str = g_variant_get_string(value, NULL);
365 if (!(py_optval = PyUnicode_FromString(val_str))) {
366 /* Some UTF-8 encoding error. */
368 srd_err("Option '%s' requires a UTF-8 string value.", key);
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);
376 val_int = g_variant_get_int64(value);
377 if (!(py_optval = PyLong_FromLong(val_int))) {
378 /* ValueError Exception */
380 srd_err("Option '%s' has invalid integer value.", key);
384 g_hash_table_remove(options, key);
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 */
398 srd_err("Invalid integer value for %s: "
399 "expected integer.", key);
402 if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
408 * If we got here, py_optval holds a known good new reference
409 * to the instance option to set.
411 if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
420 Py_XDECREF(py_di_options);
421 Py_XDECREF(py_dec_optkeys);
422 Py_XDECREF(py_dec_options);
424 if (PyErr_Occurred()) {
425 srd_exception_catch("Stray exception in srd_inst_option_set().");
426 ret = SRD_ERR_PYTHON;
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)
435 return strcmp(a->id, probe_id);
439 * Set all probes in a decoder instance.
441 * This function sets _all_ probes for the specified decoder instance, i.e.,
442 * it overwrites any probes that were already defined (if any).
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.
449 * @return SRD_OK upon success, a (negative) error code otherwise.
453 SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
454 GHashTable *new_probes)
460 int *new_probemap, new_probenum;
462 int i, num_required_probes;
464 srd_dbg("set probes called for instance %s with list of %d probes",
465 di->inst_id, g_hash_table_size(new_probes));
467 if (g_hash_table_size(new_probes) == 0)
468 /* No probes provided. */
471 if (di->dec_num_probes == 0) {
472 /* Decoder has no probes. */
473 srd_err("Protocol decoder %s has no probes to define.",
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;
486 * For now, map all indexes to probe -1 (can be overridden later).
487 * This -1 is interpreted as an unspecified probe later.
489 for (i = 0; i < di->dec_num_probes; i++)
490 new_probemap[i] = -1;
492 for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
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.",
499 g_free(new_probemap);
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);
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);
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");
527 g_free(di->dec_probemap);
528 di->dec_probemap = new_probemap;
534 * Create a new protocol decoder instance.
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.
541 * @return Pointer to a newly allocated struct srd_decoder_inst, or
542 * NULL in case of failure.
544 * @since 0.1.0 (the API changed in 0.3.0, though)
546 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
547 const char *decoder_id, GHashTable *options)
550 struct srd_decoder *dec;
551 struct srd_decoder_inst *di;
554 srd_dbg("Creating new %s instance.", decoder_id);
556 if (session_is_valid(sess) != SRD_OK) {
557 srd_err("Invalid session.");
561 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
562 srd_err("Protocol decoder %s not found.", decoder_id);
566 if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
567 srd_err("Failed to g_malloc() instance.");
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");
578 di->inst_id = g_strdup(decoder_id);
581 * Prepare a default probe map, where samples come in the
582 * order in which the decoder class defined them.
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.");
593 for (i = 0; i < di->dec_num_probes; i++)
594 di->dec_probemap[i] = i;
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: ",
602 g_free(di->dec_probemap);
607 if (options && srd_inst_option_set(di, options) != SRD_OK) {
608 g_free(di->dec_probemap);
613 /* Instance takes input from a frontend by default. */
614 sess->di_list = g_slist_append(sess->di_list, di);
620 * Stack a decoder instance on top of another.
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.
626 * @return SRD_OK upon success, a (negative) error code otherwise.
628 * @since 0.1.0 (the API changed in 0.3.0, though)
630 SRD_API int srd_inst_stack(struct srd_session *sess,
631 struct srd_decoder_inst *di_from, struct srd_decoder_inst *di_to)
634 if (session_is_valid(sess) != SRD_OK) {
635 srd_err("Invalid session.");
639 if (!di_from || !di_to) {
640 srd_err("Invalid from/to instance pair.");
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);
649 /* Stack on top of source di. */
650 di_from->next_di = g_slist_append(di_from->next_di, di_to);
656 * Find a decoder instance by its instance ID.
658 * Only the bottom level of instances are searched -- instances already stacked
659 * on top of another one will not be found.
661 * @param sess The session holding the protocol decoder instance.
662 * @param inst_id The instance ID to be found.
664 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
666 * @since 0.1.0 (the API changed in 0.3.0, though)
668 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
672 struct srd_decoder_inst *tmp, *di;
674 if (session_is_valid(sess) != SRD_OK) {
675 srd_err("Invalid session.");
680 for (l = sess->di_list; l; l = l->next) {
682 if (!strcmp(tmp->inst_id, inst_id)) {
691 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
692 struct srd_session *sess, const GSList *stack,
696 struct srd_decoder_inst *tmp, *di;
698 if (session_is_valid(sess) != SRD_OK) {
699 srd_err("Invalid session.");
704 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
706 if (tmp->py_inst == obj)
708 else if (tmp->next_di)
709 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
716 * Find a decoder instance by its Python object.
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
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.
727 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
733 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
736 struct srd_decoder_inst *di;
737 struct srd_session *sess;
741 for (l = sessions; di == NULL && l != NULL; l = l->next) {
743 di = srd_sess_inst_find_by_obj(sess, stack, obj);
750 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
752 PyObject *py_name, *py_res;
754 struct srd_decoder_inst *next_di;
756 srd_dbg("Calling start() method on protocol decoder instance %s.",
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: ",
763 return SRD_ERR_PYTHON;
766 if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
767 py_name, args, NULL))) {
768 srd_exception_catch("Protocol decoder instance %s: ",
770 return SRD_ERR_PYTHON;
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.
781 for (l = di->next_di; l; l = l->next) {
783 srd_inst_start(next_di, args);
790 * Run the specified decoder function.
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.
798 * @return SRD_OK upon success, a (negative) error code otherwise.
804 SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
805 const struct srd_decoder_inst *di, const uint8_t *inbuf,
810 uint64_t end_samplenum;
812 srd_dbg("Calling decode() on instance %s with %d bytes starting "
813 "at sample %d.", di->inst_id, inbuflen, start_samplenum);
815 /* Return an error upon unusable input. */
817 srd_dbg("empty decoder instance");
821 srd_dbg("NULL buffer pointer");
825 srd_dbg("empty buffer");
830 * Create new srd_logic object. Each iteration around the PD's loop
831 * will fill one sample into this object.
833 logic = PyObject_New(srd_logic, &srd_logic_type);
835 logic->di = (struct srd_decoder_inst *)di;
836 logic->start_samplenum = start_samplenum;
838 logic->inbuf = (uint8_t *)inbuf;
839 logic->inbuflen = inbuflen;
840 logic->sample = PyList_New(2);
841 Py_INCREF(logic->sample);
843 Py_IncRef(di->py_inst);
844 end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
845 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
846 "KKO", logic->start_samplenum,
847 end_samplenum, logic))) {
848 srd_exception_catch("Protocol decoder instance %s: ",
850 return SRD_ERR_PYTHON;
858 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
861 struct srd_pd_output *pdo;
863 srd_dbg("Freeing instance %s", di->inst_id);
865 Py_DecRef(di->py_inst);
867 g_free(di->dec_probemap);
868 g_slist_free(di->next_di);
869 for (l = di->pd_output; l; l = l->next) {
871 g_free(pdo->proto_id);
874 g_slist_free(di->pd_output);
879 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
882 struct srd_decoder_inst *di;
884 if (session_is_valid(sess) != SRD_OK) {
885 srd_err("Invalid session.");
890 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
893 srd_inst_free_all(sess, di->next_di);
897 g_slist_free(sess->di_list);
898 sess->di_list = NULL;
905 * @defgroup grp_session Session handling
907 * Starting and handling decoding sessions.
912 static int session_is_valid(struct srd_session *sess)
915 if (!sess || sess->session_id < 1)
922 * Create a decoding session.
924 * A session holds all decoder instances, their stack relationships and
927 * @param sess A pointer which will hold a pointer to a newly
928 * initialized session on return.
930 * @return SRD_OK upon success, a (negative) error code otherwise.
934 SRD_API int srd_session_new(struct srd_session **sess)
938 srd_err("Invalid session pointer.");
942 if (!(*sess = g_try_malloc(sizeof(struct srd_session))))
943 return SRD_ERR_MALLOC;
944 (*sess)->session_id = ++max_session_id;
945 (*sess)->num_probes = (*sess)->unitsize = (*sess)->samplerate = 0;
946 (*sess)->di_list = (*sess)->callbacks = NULL;
948 /* Keep a list of all sessions, so we can clean up as needed. */
949 sessions = g_slist_append(sessions, *sess);
951 srd_dbg("Created session %d.", (*sess)->session_id);
957 * Start a decoding session.
959 * Decoders, instances and stack must have been prepared beforehand,
960 * and all SRD_CONF parameters set.
962 * @param sess The session to start.
964 * @return SRD_OK upon success, a (negative) error code otherwise.
966 * @since 0.1.0 (the API changed in 0.3.0, though)
968 SRD_API int srd_session_start(struct srd_session *sess)
972 struct srd_decoder_inst *di;
975 if (session_is_valid(sess) != SRD_OK) {
976 srd_err("Invalid session pointer.");
979 if (sess->num_probes == 0) {
980 srd_err("Session has invalid number of probes.");
983 if (sess->unitsize == 0) {
984 srd_err("Session has invalid unitsize.");
987 if (sess->samplerate == 0) {
988 srd_err("Session has invalid samplerate.");
994 srd_dbg("Calling start() on all instances in session %d with "
995 "%d probes, unitsize %d, samplerate %d.", sess->session_id,
996 sess->num_probes, sess->unitsize, sess->samplerate);
999 * Currently only one item of metadata is passed along to decoders,
1000 * samplerate. This can be extended as needed.
1002 if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)sess->samplerate))) {
1003 srd_err("Unable to build Python object for metadata.");
1004 return SRD_ERR_PYTHON;
1007 /* Run the start() method on all decoders receiving frontend data. */
1008 for (d = sess->di_list; d; d = d->next) {
1010 di->data_num_probes = sess->num_probes;
1011 di->data_unitsize = sess->unitsize;
1012 di->data_samplerate = sess->samplerate;
1013 if ((ret = srd_inst_start(di, args)) != SRD_OK)
1023 * Set a configuration key in a session.
1025 * @param sess The session to configure.
1026 * @param key The configuration key (SRD_CONF_*).
1027 * @param data The new value for the key, as a GVariant with GVariantType
1028 * appropriate to that key. A floating reference can be passed
1029 * in; its refcount will be sunk and unreferenced after use.
1031 * @return SRD_OK upon success, a (negative) error code otherwise.
1035 SRD_API int srd_session_config_set(struct srd_session *sess, int key,
1039 if (session_is_valid(sess) != SRD_OK) {
1040 srd_err("Invalid session.");
1044 if (!g_variant_is_of_type(data, G_VARIANT_TYPE_UINT64)) {
1045 srd_err("Value for key %d should be of type uint64.");
1050 case SRD_CONF_NUM_PROBES:
1051 sess->num_probes = g_variant_get_uint64(data);
1053 case SRD_CONF_UNITSIZE:
1054 sess->unitsize = g_variant_get_uint64(data);
1056 case SRD_CONF_SAMPLERATE:
1057 sess->samplerate = g_variant_get_uint64(data);
1061 g_variant_unref(data);
1067 * Send a chunk of logic sample data to a running decoder session.
1069 * @param sess The session to use.
1070 * @param start_samplenum The sample number of the first sample in this chunk.
1071 * @param inbuf Pointer to sample data.
1072 * @param inbuflen Length in bytes of the buffer.
1074 * @return SRD_OK upon success, a (negative) error code otherwise.
1078 SRD_API int srd_session_send(struct srd_session *sess, uint64_t start_samplenum,
1079 const uint8_t *inbuf, uint64_t inbuflen)
1084 if (session_is_valid(sess) != SRD_OK) {
1085 srd_err("Invalid session.");
1089 srd_dbg("Calling decode() on all instances with starting sample "
1090 "number %" PRIu64 ", %" PRIu64 " bytes at 0x%p",
1091 start_samplenum, inbuflen, inbuf);
1093 for (d = sess->di_list; d; d = d->next) {
1094 if ((ret = srd_inst_decode(start_samplenum, d->data, inbuf,
1095 inbuflen)) != SRD_OK)
1103 * Destroy a decoding session.
1105 * All decoder instances and output callbacks are properly released.
1107 * @param sess The session to be destroyed.
1109 * @return SRD_OK upon success, a (negative) error code otherwise.
1113 SRD_API int srd_session_destroy(struct srd_session *sess)
1117 session_id = sess->session_id;
1119 srd_inst_free_all(sess, NULL);
1120 if (sess->callbacks)
1121 g_slist_free_full(sess->callbacks, g_free);
1122 sessions = g_slist_remove(sessions, sess);
1125 srd_dbg("Destroyed session %d.", session_id);
1131 * Register/add a decoder output callback function.
1133 * The function will be called when a protocol decoder sends output back
1134 * to the PD controller (except for Python objects, which only go up the
1137 * @param sess The output session in which to register the callback.
1138 * @param output_type The output type this callback will receive. Only one
1139 * callback per output type can be registered.
1140 * @param cb The function to call. Must not be NULL.
1141 * @param cb_data Private data for the callback function. Can be NULL.
1143 * @since 0.1.0 (the API changed in 0.3.0, though)
1145 SRD_API int srd_pd_output_callback_add(struct srd_session *sess,
1146 int output_type, srd_pd_output_callback_t cb, void *cb_data)
1148 struct srd_pd_callback *pd_cb;
1150 if (session_is_valid(sess) != SRD_OK) {
1151 srd_err("Invalid session.");
1155 srd_dbg("Registering new callback for output type %d.", output_type);
1157 if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback)))) {
1158 srd_err("Failed to g_malloc() struct srd_pd_callback.");
1159 return SRD_ERR_MALLOC;
1162 pd_cb->output_type = output_type;
1164 pd_cb->cb_data = cb_data;
1165 sess->callbacks = g_slist_append(sess->callbacks, pd_cb);
1171 SRD_PRIV struct srd_pd_callback *srd_pd_output_callback_find(
1172 struct srd_session *sess, int output_type)
1175 struct srd_pd_callback *tmp, *pd_cb;
1177 if (session_is_valid(sess) != SRD_OK) {
1178 srd_err("Invalid session.");
1183 for (l = sess->callbacks; l; l = l->next) {
1185 if (tmp->output_type == output_type) {
1194 /* This is the backend function to Python sigrokdecode.add() call. */
1196 SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
1197 int output_type, const char *proto_id)
1199 struct srd_pd_output *pdo;
1201 srd_dbg("Instance %s creating new output type %d for %s.",
1202 di->inst_id, output_type, proto_id);
1204 if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output)))) {
1205 srd_err("Failed to g_malloc() struct srd_pd_output.");
1209 /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
1210 pdo->pdo_id = g_slist_length(di->pd_output);
1211 pdo->output_type = output_type;
1213 pdo->proto_id = g_strdup(proto_id);
1214 di->pd_output = g_slist_append(di->pd_output, pdo);