]> sigrok.org Git - libsigrokdecode.git/blobdiff - controller.c
srd: Remove manual log domain ("srd: ") prefixes.
[libsigrokdecode.git] / controller.c
index f3c1446f9ac40a952180fad8415369965fb33b57..e325e0a6208cf98248101673c0c9714c27ffdfc0 100644 (file)
@@ -68,7 +68,7 @@ int srd_init(void)
 {
        int ret;
 
-       srd_dbg("srd: initializing");
+       srd_dbg("Initializing libsigrokdecode.");
 
        /* Add our own module to the list of built-in modules. */
        PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
@@ -105,7 +105,7 @@ int srd_init(void)
 int srd_exit(void)
 {
 
-       srd_dbg("srd: exiting");
+       srd_dbg("Exiting libsigrokdecode.");
 
        srd_unload_all_decoders();
        g_slist_free(pd_list);
@@ -275,7 +275,7 @@ err_out:
        if (key)
                g_free(key);
        if (PyErr_Occurred())
-               catch_exception("srd: stray exception in srd_instance_set_options()");
+               catch_exception("Stray exception in srd_instance_set_options().");
 
        return ret;
 }
@@ -371,7 +371,7 @@ struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
        int i;
        char *instance_id;
 
-       srd_dbg("srd: creating new %s instance", decoder_id);
+       srd_dbg("Creating new %s instance.", decoder_id);
 
        if (!(dec = srd_get_decoder_by_id(decoder_id))) {
                srd_err("Protocol decoder %s not found.", decoder_id);
@@ -433,23 +433,27 @@ int srd_instance_stack(struct srd_decoder_instance *di_from,
                return SRD_ERR_ARG;
        }
 
-       if (!g_slist_find(di_list, di_from)) {
-               srd_err("Unstacked instance not found.");
-               return SRD_ERR_ARG;
+       if (g_slist_find(di_list, di_to)) {
+               /* Remove from the unstacked list. */
+               di_list = g_slist_remove(di_list, di_to);
        }
 
-       /* Remove from the unstacked list. */
-       di_list = g_slist_remove(di_list, di_to);
-
        /* Stack on top of source di. */
        di_from->next_di = g_slist_append(di_from->next_di, di_to);
 
        return SRD_OK;
 }
 
-
-/* TODO: this should go into the PD stack */
-struct srd_decoder_instance *srd_instance_find(char *instance_id)
+/**
+ * Finds a decoder instance by its instance id, but only in the bottom
+ * level of instances -- instances already stacked on top of another one
+ * will not be found.
+ *
+ * @param instance_id The instance id to be found.
+ *
+ * @return Pointer to struct srd_decoder_instance, or NULL if not found.
+ */
+struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id)
 {
        GSList *l;
        struct srd_decoder_instance *tmp, *di;
@@ -466,12 +470,44 @@ struct srd_decoder_instance *srd_instance_find(char *instance_id)
        return di;
 }
 
+/**
+ * Finds a decoder instance by its python object, i.e. that instance's
+ * instantiation of the sigrokdecode.Decoder class. This will recurse
+ * to find the instance anywhere in the stack tree.
+ *
+ * @param stack Pointer to a GSList of struct srd_decoder_instance,
+ *             indicating the stack to search. To start searching at the bottom
+ *             level of decoder instances, pass NULL.
+ * @param obj The python class instantiation.
+ *
+ * @return Pointer to struct srd_decoder_instance, or NULL if not found.
+ */
+struct srd_decoder_instance *srd_instance_find_by_obj(GSList *stack,
+               PyObject *obj)
+{
+       GSList *l;
+       struct srd_decoder_instance *tmp, *di;
+
+       di = NULL;
+       for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
+               tmp = l->data;
+               if (tmp->py_instance == obj)
+                       di = tmp;
+               else if (tmp->next_di)
+                       di = srd_instance_find_by_obj(tmp->next_di, obj);
+       }
+
+       return di;
+}
+
 int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
 {
        PyObject *py_name, *py_res;
+       GSList *l;
+       struct srd_decoder_instance *next_di;
 
-       srd_dbg("srd: calling start() method on protocol decoder instance %s",
-                       di->instance_id);
+       srd_dbg("Calling start() method on protocol decoder instance %s.",
+               di->instance_id);
 
        if (!(py_name = PyUnicode_FromString("start"))) {
                srd_err("Unable to build python object for 'start'.");
@@ -488,6 +524,15 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
        Py_DecRef(py_res);
        Py_DecRef(py_name);
 
+       /* Start all the PDs stacked on top of this one. Pass along the
+        * metadata all the way from the bottom PD, even though it's only
+        * applicable to logic data for now.
+        */
+       for (l = di->next_di; l; l = l->next) {
+               next_di = l->data;
+               srd_instance_start(next_di, args);
+       }
+
        return SRD_OK;
 }
 
@@ -495,34 +540,34 @@ int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
  * Run the specified decoder function.
  *
  * @param start_samplenum The starting sample number for the buffer's sample
- *             set, relative to the start of capture.
- * @param di The decoder instance to call.
- * @param inbuf The buffer to decode.
- * @param inbuflen Length of the buffer.
+ *                       set, relative to the start of capture.
+ * @param di The decoder instance to call. Must not be NULL.
+ * @param inbuf The buffer to decode. Must not be NULL.
+ * @param inbuflen Length of the buffer. Must be > 0.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
 int srd_instance_decode(uint64_t start_samplenum,
-               struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
+       struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
 {
        PyObject *py_res;
        srd_logic *logic;
        uint64_t end_samplenum;
 
-       srd_dbg("srd: calling decode() on instance %s with %d bytes starting "
-                       "at sample %d", di->instance_id, inbuflen, start_samplenum);
+       srd_dbg("Calling decode() on instance %s with %d bytes starting "
+               "at sample %d.", di->instance_id, inbuflen, start_samplenum);
 
        /* Return an error upon unusable input. */
-       if (di == NULL) {
-               srd_dbg("srd: empty decoder instance");
+       if (!di) {
+               srd_dbg("empty decoder instance");
                return SRD_ERR_ARG;
        }
-       if (inbuf == NULL) {
-               srd_dbg("srd: NULL buffer pointer");
+       if (!inbuf) {
+               srd_dbg("NULL buffer pointer");
                return SRD_ERR_ARG;
        }
        if (inbuflen == 0) {
-               srd_dbg("srd: empty buffer");
+               srd_dbg("empty buffer");
                return SRD_ERR_ARG;
        }
 
@@ -555,12 +600,12 @@ int srd_instance_decode(uint64_t start_samplenum,
 int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
 {
        PyObject *args;
-       GSList *d, *s;
+       GSList *d;
        struct srd_decoder_instance *di;
        int ret;
 
-       srd_dbg("srd: calling start() on all instances with %d probes, "
-                       "unitsize %d samplerate %d", num_probes, unitsize, samplerate);
+       srd_dbg("Calling start() on all instances with %d probes, "
+               "unitsize %d samplerate %d.", num_probes, unitsize, samplerate);
 
        /* Currently only one item of metadata is passed along to decoders,
         * samplerate. This can be extended as needed.
@@ -577,20 +622,12 @@ int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
                di->data_unitsize = unitsize;
                di->data_samplerate = samplerate;
                if ((ret = srd_instance_start(di, args) != SRD_OK))
-                       return ret;
-
-               /* Run the start() method on all decoders up the stack from this one. */
-               for (s = di->next_di; s; s = s->next) {
-                       /* These don't need probes, unitsize and samplerate. */
-                       di = s->data;
-                       if ((ret = srd_instance_start(di, args) != SRD_OK))
-                               return ret;
-               }
+                       break;
        }
 
        Py_DecRef(args);
 
-       return SRD_OK;
+       return ret;
 }
 
 /* Feed logic samples to decoder session. */
@@ -599,9 +636,9 @@ int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen
        GSList *d;
        int ret;
 
-       srd_dbg("srd: calling decode() on all instances with starting sample "
-                       "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum,
-                       inbuflen, inbuf);
+       srd_dbg("Calling decode() on all instances with starting sample "
+               "number %"PRIu64", %"PRIu64" bytes at 0x%p", start_samplenum,
+               inbuflen, inbuf);
 
        for (d = di_list; d; d = d->next) {
                if ((ret = srd_instance_decode(start_samplenum, d->data, inbuf,
@@ -617,7 +654,7 @@ int srd_register_callback(int output_type, void *cb)
 {
        struct srd_pd_callback *pd_cb;
 
-       srd_dbg("srd: registering new callback for output type %d", output_type);
+       srd_dbg("Registering new callback for output type %d.", output_type);
 
        if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
                return SRD_ERR_MALLOC;
@@ -649,13 +686,12 @@ void *srd_find_callback(int output_type)
 
 
 /* This is the backend function to python sigrokdecode.add() call. */
-int pd_add(struct srd_decoder_instance *di, int output_type,
-               char *proto_id)
+int pd_add(struct srd_decoder_instance *di, int output_type, char *proto_id)
 {
        struct srd_pd_output *pdo;
 
-       srd_dbg("srd: instance %s creating new output type %d for %s",
-                       di->instance_id, output_type, proto_id);
+       srd_dbg("Instance %s creating new output type %d for %s.",
+               di->instance_id, output_type, proto_id);
 
        if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
                return -1;
@@ -663,30 +699,10 @@ int pd_add(struct srd_decoder_instance *di, int output_type,
        /* pdo_id is just a simple index, nothing is deleted from this list anyway. */
        pdo->pdo_id = g_slist_length(di->pd_output);
        pdo->output_type = output_type;
-       pdo->decoder = di->decoder;
+       pdo->di = di;
        pdo->proto_id = g_strdup(proto_id);
        di->pd_output = g_slist_append(di->pd_output, pdo);
 
        return pdo->pdo_id;
 }
 
-struct srd_decoder_instance *get_di_by_decobject(void *decobject)
-{
-       GSList *l, *s;
-       struct srd_decoder_instance *di;
-
-       for (l = di_list; l; l = l->next) {
-               di = l->data;
-               if (decobject == di->py_instance)
-                       return di;
-               /* Check decoders stacked on top of this one. */
-               for (s = di->next_di; s; s = s->next) {
-                       di = s->data;
-                       if (decobject == di->py_instance)
-                               return di;
-               }
-       }
-
-       return NULL;
-}
-