srd: PDs now explicitly register with sigrok module.
authorGareth McMullin <gareth@blacksphere.co.nz>
Thu, 1 Dec 2011 10:09:40 +0000 (23:09 +1300)
committerGareth McMullin <gareth@blacksphere.co.nz>
Thu, 1 Dec 2011 10:10:28 +0000 (23:10 +1300)
decode.c
decoders/i2c.py
decoders/spi.py
decoders/srd_usb.py
sigrokdecode.h

index 6a86b348dbbff48c838bdab4840bc44d0bb28596..f4b9cdf983d8df41e8a86d21465a3210a9339485 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -49,7 +49,21 @@ static GSList *decoders;
  *    Py_XDECREF()ing it (someone else will do it for you at some point).
  */
 
-static int srd_load_decoder(const char *name, struct srd_decoder **dec);
+static int srd_load_decoder(PyObject *py_res);
+
+static PyObject *emb_register(PyObject *self, PyObject *args)
+{
+       PyObject *arg;
+
+       (void)self;
+
+       if (!PyArg_ParseTuple(args, "O:decoder", &arg))
+               return NULL;
+
+       srd_load_decoder(arg);
+
+       Py_RETURN_NONE;
+}
 
 static PyObject *emb_put(PyObject *self, PyObject *args)
 {
@@ -60,7 +74,6 @@ static PyObject *emb_put(PyObject *self, PyObject *args)
        if (!PyArg_ParseTuple(args, "O:put", &arg))
                return NULL;
 
-       // fprintf(stdout, "sigrok.put() called by decoder:\n");
        PyObject_Print(arg, stdout, Py_PRINT_RAW);
        puts("");
 
@@ -68,6 +81,8 @@ static PyObject *emb_put(PyObject *self, PyObject *args)
 }
 
 static PyMethodDef EmbMethods[] = {
+       {"register", emb_register, METH_VARARGS,
+        "Register a protocol decoder object with libsigrokdecode."},
        {"put", emb_put, METH_VARARGS,
         "Accepts a dictionary with the following keys: time, duration, data"},
        {NULL, NULL, 0, NULL}
@@ -141,12 +156,15 @@ int srd_init(void)
                }
 
                /* Load the decoder. */
-               /* TODO: Warning if loading fails for a decoder. */
-               ret = srd_load_decoder(decodername, &dec);
-               if (!ret) {
-                       /* Append it to the list of supported/loaded decoders. */
-                       list_pds = g_slist_append(list_pds, dec);
+               /* "Import" the Python module. */
+               PyObject *py_mod;
+               if (!(py_mod = PyImport_ImportModule(decodername))) { /* NEWREF */
+                       PyErr_Print(); /* Returns void. */
+                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
                }
+               /* We release here.  If any decoders were registered they
+                * will hold references. */
+               Py_XDECREF(py_mod);
        }
        closedir(dir);
 
@@ -193,8 +211,7 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id)
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *         The 'outstr' argument points to a malloc()ed string upon success.
  */
-static int h_str(PyObject *py_res, PyObject *py_mod,
-                const char *key, char **outstr)
+static int h_str(PyObject *py_res, const char *key, char **outstr)
 {
        PyObject *py_str;
        char *str;
@@ -228,7 +245,6 @@ static int h_str(PyObject *py_res, PyObject *py_mod,
 err_h_decref_str:
        Py_XDECREF(py_str);
 err_h_decref_mod:
-       Py_XDECREF(py_mod);
 
        if (PyErr_Occurred())
                PyErr_Print(); /* Returns void. */
@@ -243,60 +259,40 @@ err_h_decref_mod:
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  */
-static int srd_load_decoder(const char *name, struct srd_decoder **dec)
+static int srd_load_decoder(PyObject *py_res)
 {
        struct srd_decoder *d;
-       PyObject *py_mod, *py_res;
        int r;
 
-       fprintf(stdout, "%s: %s\n", __func__, name);
-
-       /* "Import" the Python module. */
-       if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
-               PyErr_Print(); /* Returns void. */
-               return SRD_ERR_PYTHON; /* TODO: More specific error? */
-       }
-
-       /* Get the 'Decoder' class as Python object. */
-       py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
-       if (!py_res) {
-               if (PyErr_Occurred())
-                       PyErr_Print(); /* Returns void. */
-               Py_XDECREF(py_mod);
-               fprintf(stderr, "Decoder class not found in PD module %s\n", name);
-               return SRD_ERR_PYTHON; /* TODO: More specific error? */
-       }
-
        if (!(d = malloc(sizeof(struct srd_decoder))))
                return SRD_ERR_MALLOC;
 
-       /* We'll just use the name of the module for the ID. */
-       d->id = strdup(name);
+       if ((r = h_str(py_res, "id", &(d->id))) < 0)
+               return r;
 
-       if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
+       if ((r = h_str(py_res, "name", &(d->name))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "longname",
+       if ((r = h_str(py_res, "longname",
                       &(d->longname))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "desc", &(d->desc))) < 0)
+       if ((r = h_str(py_res, "desc", &(d->desc))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "longdesc",
+       if ((r = h_str(py_res, "longdesc",
                       &(d->longdesc))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "author", &(d->author))) < 0)
+       if ((r = h_str(py_res, "author", &(d->author))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "email", &(d->email))) < 0)
+       if ((r = h_str(py_res, "email", &(d->email))) < 0)
                return r;
 
-       if ((r = h_str(py_res, py_mod, "license", &(d->license))) < 0)
+       if ((r = h_str(py_res, "license", &(d->license))) < 0)
                return r;
 
-       d->py_mod = py_mod;
        d->py_decobj = py_res;
 
        /* TODO: Handle func, inputformats, outputformats. */
@@ -305,7 +301,9 @@ static int srd_load_decoder(const char *name, struct srd_decoder **dec)
        d->inputformats = NULL;
        d->outputformats = NULL;
 
-       *dec = d;
+       Py_INCREF(py_res);
+       fprintf(stderr, "srd: registered '%s'\n", d->id);
+       list_pds = g_slist_append(list_pds, d);
 
        return SRD_OK;
 }
@@ -455,10 +453,12 @@ int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen)
                int ret = srd_run_decoder(d->data, inbuf, inbuflen);
 
                if (ret != SRD_OK) {
+                       /* This probably shouldn't fail catastrophically. */
                        fprintf(stderr, "Decoder runtime error (%d)\n", ret);
                        exit(1);
                }
        }
+       return SRD_OK;
 }
 
 /**
@@ -479,7 +479,6 @@ static int srd_unload_decoder(struct srd_decoder *dec)
                g_slist_free(dec->outputformats);
 
        Py_XDECREF(dec->py_decobj);
-       Py_XDECREF(dec->py_mod);
 
        /* TODO: (g_)free dec itself? */
 
index 93cf16757a438dbafcbb5d70e431bdc4bc6dca59..16e74913deb27a1799fd847f4d1c1efd54e2498a 100644 (file)
@@ -143,6 +143,7 @@ def sampleiter(data, unitsize):
         yield(Sample(data[i:i+unitsize]))
 
 class Decoder():
+    id = 'i2c'
     name = 'I2C'
     longname = 'Inter-Integrated Circuit (I2C) bus'
     desc = 'I2C is a two-wire, multi-master, serial bus.'
@@ -351,3 +352,5 @@ class Decoder():
 
 import sigrok
 
+sigrok.register(Decoder)
+
index 383206b1914a6069e642f435516b594d575d9304..d9891b38cd36bb4bc8921e8504e20fb13158f7d9 100644 (file)
@@ -18,6 +18,8 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
+import sigrok
+
 class Sample():
     def __init__(self, data):
         self.data = data
@@ -30,6 +32,7 @@ def sampleiter(data, unitsize):
         yield(Sample(data[i:i+unitsize]))
 
 class Decoder():
+    id = 'spi'
     name = 'SPI Decoder'
     desc = '...desc...'
     longname = '...longname...'
@@ -93,22 +96,5 @@ class Decoder():
             # Keep stats for summary
             self.bytesreceived += 1
 
-if __name__ == '__main__':
-    data = open('spi_dump.bin').read()
-
-    # dummy class to keep Decoder happy for test
-    class Sigrok():
-        def put(self, data):
-            print "\t", data
-    sigrok = Sigrok()
-
-    dec = Decoder(driver='ols', unitsize=1, starttime=0)
-    dec.decode({'time':0, 'duration':len(data), 'data':data, 'type':'logic'})
-
-    print dec.summary()
-else:
-    import sigrok
-
-#Tested with:
-#  sigrok-cli -d 0:samplerate=1000000:rle=on --time=1s -p 1,2 -a spidec
+sigrok.register(Decoder)
 
index 128b337e50b83ee8c724ce5e3c9daa4ae0b0eeb5..07fc732a04531cb6ce3a9bbfd7a0adc1165a12f4 100644 (file)
@@ -111,6 +111,7 @@ def packet_decode(packet):
     return pid + ' ' + data
 
 class Decoder():
+    id = 'usb'
     name = 'USB'
     desc = 'Universal Serial Bus'
     longname = '...longname...'
@@ -184,3 +185,5 @@ class Decoder():
             self.scount = 0
             self.sym = sym
 
+sigrok.register(Decoder)
+
index b7ed2dc8e0376caf59008c1f81e9d176a0327e78..b856f4f79bee73d5954d9393ae2438a4baed9ef9 100644 (file)
@@ -88,9 +88,6 @@ struct srd_decoder {
        /** TODO */
        GSList *outputformats;
 
-       /** TODO */
-       PyObject *py_mod;
-
        /** Python object that performs the decoding */
        PyObject *py_decobj;
 };