onewire: preparations for protocol separation between link and network layers

[libsigrokdecode.git] / controller.c

diff --git a/controller.c b/controller.c
index 277897c546abecc7199c96972dffb1c54d30f214..995ddd7f13667302a2c7cc271829aafb2148d9cb 100644 (file)
--- a/controller.c
+++ b/controller.c
@@ -35,7 +35,8 @@ static GSList *callbacks = NULL;
 extern SRD_PRIV GSList *pd_list;
 
 /* module_sigrokdecode.c */
-extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
+/* FIXME: SRD_PRIV causes issues on MinGW. Investigate. */
+extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
 
 /* type_logic.c */
 extern SRD_PRIV PyTypeObject srd_logic_type;
@@ -79,14 +80,14 @@ SRD_API int srd_init(const char *path)
        Py_Initialize();
 
        /* Installed decoders. */
-       if ((ret = add_modulepath(DECODERS_DIR)) != SRD_OK) {
+       if ((ret = srd_decoder_searchpath_add(DECODERS_DIR)) != SRD_OK) {
                Py_Finalize();
                return ret;
        }
 
        /* Path specified by the user. */
        if (path) {
-               if ((ret = add_modulepath(path)) != SRD_OK) {
+               if ((ret = srd_decoder_searchpath_add(path)) != SRD_OK) {
                        Py_Finalize();
                        return ret;
                }
@@ -94,7 +95,7 @@ SRD_API int srd_init(const char *path)
 
        /* Environment variable overrides everything, for debugging. */
        if ((env_path = getenv("SIGROKDECODE_DIR"))) {
-               if ((ret = add_modulepath(env_path)) != SRD_OK) {
+               if ((ret = srd_decoder_searchpath_add(env_path)) != SRD_OK) {
                        Py_Finalize();
                        return ret;
                }
@@ -144,7 +145,7 @@ SRD_API int srd_exit(void)
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-SRD_PRIV int add_modulepath(const char *path)
+SRD_PRIV int srd_decoder_searchpath_add(const char *path)
 {
        PyObject *py_cur_path, *py_item;
        GString *new_path;
@@ -311,7 +312,7 @@ err_out:
        Py_XDECREF(py_dec_options);
        g_free(key);
        if (PyErr_Occurred())
-               catch_exception("Stray exception in srd_inst_set_options().");
+               srd_exception_catch("Stray exception in srd_inst_option_set().");
 
        return ret;
 }
@@ -329,9 +330,9 @@ static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
  * it overwrites any probes that were already defined (if any).
  *
  * @param di Decoder instance.
- * @param probes A GHashTable of probes to set. Key is probe name, value is
- *               the probe number. Samples passed to this instance will be
- *               arranged in this order.
+ * @param new_probes A GHashTable of probes to set. Key is probe name, value is
+ *                   the probe number. Samples passed to this instance will be
+ *                   arranged in this order.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -343,6 +344,7 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
        struct srd_probe *p;
        int *new_probemap, new_probenum;
        char *probe_id, *probenum_str;
+       int i, num_required_probes;
 
        srd_dbg("set probes called for instance %s with list of %d probes",
                di->inst_id, g_hash_table_size(new_probes));
@@ -365,6 +367,13 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
                return SRD_ERR_MALLOC;
        }
 
+       /*
+        * For now, map all indexes to probe -1 (can be overridden later).
+        * This -1 is interpreted as an unspecified probe later.
+        */
+       for (i = 0; i < di->dec_num_probes; i++)
+               new_probemap[i] = -1;
+
        for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
                probe_id = l->data;
                probenum_str = g_hash_table_lookup(new_probes, probe_id);
@@ -389,9 +398,17 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
                }
                p = sl->data;
                new_probemap[p->order] = new_probenum;
-               srd_dbg("setting probe mapping for %d = probe %d", p->order,
-                       new_probenum);
+               srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
+                       p->id, p->order, new_probenum);
        }
+
+       srd_dbg("Final probe map:");
+       num_required_probes = g_slist_length(di->decoder->probes);
+       for (i = 0; i < di->dec_num_probes; i++) {
+               srd_dbg(" - index %d = probe %d (%s)", i, new_probemap[i],
+                       (i < num_required_probes) ? "required" : "optional");
+       }
+
        g_free(di->dec_probemap);
        di->dec_probemap = new_probemap;
 
@@ -401,7 +418,7 @@ SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
 /**
  * Create a new protocol decoder instance.
  *
- * @param id Decoder 'id' field.
+ * @param decoder_id Decoder 'id' field.
  * @param options GHashtable of options which override the defaults set in
  *                the decoder class.
  *
@@ -453,8 +470,8 @@ SRD_API struct srd_decoder_inst *srd_inst_new(const char *decoder_id,
        /* Create a new instance of this decoder class. */
        if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
                if (PyErr_Occurred())
-                       catch_exception("failed to create %s instance: ",
-                                       decoder_id);
+                       srd_exception_catch("failed to create %s instance: ",
+                                           decoder_id);
                g_free(di->dec_probemap);
                g_free(di);
                return NULL;
@@ -569,15 +586,15 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di, PyObject *args)
 
        if (!(py_name = PyUnicode_FromString("start"))) {
                srd_err("Unable to build Python object for 'start'.");
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON;
        }
 
        if (!(py_res = PyObject_CallMethodObjArgs(di->py_inst,
                                                  py_name, args, NULL))) {
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON;
        }
 
@@ -652,8 +669,8 @@ SRD_PRIV int srd_inst_decode(uint64_t start_samplenum,
        if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
                                           "KKO", logic->start_samplenum,
                                           end_samplenum, logic))) {
-               catch_exception("Protocol decoder instance %s: ",
-                               di->inst_id);
+               srd_exception_catch("Protocol decoder instance %s: ",
+                                   di->inst_id);
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
        Py_DecRef(py_res);
@@ -734,7 +751,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
                di->data_num_probes = num_probes;
                di->data_unitsize = unitsize;
                di->data_samplerate = samplerate;
-               if ((ret = srd_inst_start(di, args) != SRD_OK))
+               if ((ret = srd_inst_start(di, args)) != SRD_OK)
                        break;
        }
 
@@ -748,7 +765,7 @@ SRD_API int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
  *
  * @param start_samplenum The sample number of the first sample in this chunk.
  * @param inbuf Pointer to sample data.
- * @param inbuf Length in bytes of the buffer.
+ * @param inbuflen Length in bytes of the buffer.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
@@ -822,8 +839,8 @@ SRD_PRIV void *srd_pd_output_callback_find(int output_type)
 }
 
 /* This is the backend function to Python sigrokdecode.add() call. */
-SRD_PRIV int pd_add(struct srd_decoder_inst *di, int output_type,
-                   const char *proto_id)
+SRD_PRIV int srd_inst_pd_output_add(struct srd_decoder_inst *di,
+                                   int output_type, const char *proto_id)
 {
        struct srd_pd_output *pdo;