]> sigrok.org Git - libsigrokdecode.git/commitdiff
Add support for OO based PDs.
authorKristoffer Sjöberg <redacted>
Mon, 14 Nov 2011 09:07:29 +0000 (10:07 +0100)
committerGareth McMullin <redacted>
Sun, 20 Nov 2011 03:31:47 +0000 (16:31 +1300)
decode.c
decoders/Makefile.am
decoders/spi.py [new file with mode: 0644]

index 6ed7e8209c71918eb951bc5bd4d076d7258929df..b706124121dcff48ff2185b9c4057dea033dc08c 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -51,41 +51,6 @@ static int srd_load_decoder(const char *name, struct srd_decoder **dec);
 
 static int _unitsize = 1;
 
-static PyObject*
-emb_getmeta(PyObject *self, PyObject *args)
-{
-       if (!PyArg_ParseTuple(args, ":get"))
-               return NULL;
-
-       return Py_BuildValue("{sssisd}", 
-                                                "driver", "demo",
-                                                "unitsize", _unitsize,
-                                                "starttime", 129318231823.0 //TODO: Fill with something reasonable.
-                                                );
-}
-
-#if 0
-static PyObject*
-emb_get(PyObject *self, PyObject *args)
-{
-       PyObject *r;
-       if (!PyArg_ParseTuple(args, ":get"))
-               return NULL;
-
-       fprintf(stderr, "get called, returns %d\n", _bufoffset);
-       if ((_bufoffset + _unitsize) <= _buflen) {
-               r = Py_BuildValue("{sisiss#}", 
-                                                        "time", _bufoffset / _unitsize,
-                                                        "duration", 10,
-                                                        "data", &_buf[_bufoffset], _unitsize
-                                                        );
-               _bufoffset += _unitsize;
-               return r;
-       }
-       Py_RETURN_NONE;
-}
-#endif
-
 static PyObject*
 emb_put(PyObject *self, PyObject *args)
 {
@@ -94,15 +59,13 @@ emb_put(PyObject *self, PyObject *args)
        if (!PyArg_ParseTuple(args, "O:put", &arg))
                return NULL;
 
-       fprintf(stderr, "put called, got passed %d\n", arg);
+       fprintf(stderr, "sigrok.put() called by decoder:\n", arg);
+       PyObject_Print(arg, stdout, Py_PRINT_RAW);
+
        Py_RETURN_NONE;
 }
 
 static PyMethodDef EmbMethods[] = {
-       {"get_meta", emb_getmeta, METH_VARARGS,
-               "Returns information about the stream."},
-       /*{"get", emb_get, METH_VARARGS,
-               "Returns a dictionary with the following keys: time, duration, data"},*/
        {"put", emb_put, METH_VARARGS,
                "Accepts a dictionary with the following keys: time, duration, data"},
        {NULL, NULL, 0, NULL}
@@ -147,9 +110,11 @@ int srd_init(void)
 
                /* Load the decoder. */
                ret = srd_load_decoder(decodername, &dec);
-
-               /* Append it to the list of supported/loaded decoders. */
-               list_pds = g_slist_append(list_pds, dec);
+               if (!ret)
+               {
+                       /* Append it to the list of supported/loaded decoders. */
+                       list_pds = g_slist_append(list_pds, dec);
+               }
        }
        closedir(dir);
 
@@ -250,8 +215,9 @@ static int srd_load_decoder(const char *name,
                              struct srd_decoder **dec)
 {
        struct srd_decoder *d;
-       PyObject *py_mod, *py_func, *py_res /* , *py_tuple */;
+       PyObject *py_mod, *py_func, *py_res, *py_instance = NULL, *py_args, *py_value/* , *py_tuple */;
        int r;
+       fprintf(stdout, "\n%s\n", name);
 
        /* "Import" the Python module. */
        if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
@@ -302,15 +268,82 @@ static int srd_load_decoder(const char *name,
        d->py_mod = py_mod;
 
        Py_XDECREF(py_res);
-
-
-       /* Get the 'decode' function name as Python callable object. */
-       py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
-       if (!py_func || !PyCallable_Check(py_func)) {
+       
+       
+       /* 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);
-               return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               //Py_XDECREF(py_mod);
+               fprintf(stderr, "Decoder class not found in PD module %s\n", name);
+               //return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               
+               
+               /* Get the 'decode' function name as Python callable object. */
+               py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
+               if (!py_func || !PyCallable_Check(py_func)) {
+                       if (PyErr_Occurred())
+                               PyErr_Print(); /* Returns void. */
+                       Py_XDECREF(py_mod);
+                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               }
+       } else {
+               PyObject_Print(py_res, stdout, Py_PRINT_RAW);
+               fprintf(stdout, "\n");
+               
+               /* Create a Python tuple of size 1. */
+               if (!(py_args = PyTuple_New(1))) { /* NEWREF */
+                       if (PyErr_Occurred())
+                               PyErr_Print(); /* Returns void. */
+                       
+                       Py_XDECREF(py_res);
+                       Py_XDECREF(py_mod);
+                       
+                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               }
+               
+               py_value = Py_BuildValue("{sssisd}", 
+                                         "driver", "demo",
+                                         "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
+                                         "starttime", 129318231823.0 //TODO: Fill with something reasonable.
+                                         );
+               /*
+                * IMPORTANT: PyTuple_SetItem() "steals" a reference to py_value!
+                * That means we are no longer responsible for Py_XDECREF()'ing it.
+                * It will automatically be free'd when the 'py_args' tuple is free'd.
+                */
+               if (PyTuple_SetItem(py_args, 0, py_value) != 0) { /* STEAL */
+                       Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
+                       Py_XDECREF(py_res);
+                       Py_XDECREF(py_mod);
+                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               }
+               
+               /* Create an instance of the Decoder class */
+               py_instance = PyObject_CallObject(py_res, py_args);
+               if (!py_instance) {
+                       if (PyErr_Occurred())
+                               PyErr_Print(); /* Returns void. */
+                       Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
+                       Py_XDECREF(py_res);
+                       Py_XDECREF(py_mod);
+                       fprintf(stderr, "Unable to create instance of Decoder class in PD module %s\n", name);
+                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
+               } else {
+                       /* OK, we have successfully created an instance of the Decoder object */
+                       
+                       /* Get the 'decode' function name as Python callable object. */
+                       py_func = PyObject_GetAttrString(py_instance, "decode"); /* NEWREF */
+                       if (!py_func || !PyCallable_Check(py_func)) {
+                               if (PyErr_Occurred())
+                                       PyErr_Print(); /* Returns void. */
+                               fprintf(stderr, "Unable to find decode function in instance of Decoder class in PD module %s\n", name);
+                               Py_XDECREF(py_instance);
+                               Py_XDECREF(py_mod);
+                               return SRD_ERR_PYTHON; /* TODO: More specific error? */
+                       }
+               }
        }
 
        d->py_decodefunc = py_func;
index 14622edc35837ea45d3e4f12dce00f28dce5926b..194442bf2f940ad33f26e16bffb2937019342454 100644 (file)
@@ -20,7 +20,7 @@
 
 pkgdatadir = $(DECODERS_DIR)
 
-dist_pkgdata_DATA = i2c.py nunchuk.py transitioncounter.py
+dist_pkgdata_DATA = i2c.py nunchuk.py transitioncounter.py spi.py
 
 CLEANFILES = *.pyc
 
diff --git a/decoders/spi.py b/decoders/spi.py
new file mode 100644 (file)
index 0000000..152b263
--- /dev/null
@@ -0,0 +1,109 @@
+class Sample():
+       def __init__(self, data):
+               self.data = data
+       def probe(self, probe):
+               s = ord(self.data[probe / 8]) & (1 << (probe % 8))
+               return True if s else False
+
+def sampleiter(data, unitsize):
+       for i in range(0, len(data), unitsize):
+               yield(Sample(data[i:i+unitsize]))
+
+class Decoder():
+       # Probe names with a set of defaults
+       probes = {'sdata':0, 'sck':1}
+
+       def __init__(self, metadata, **kwargs):
+               # Metadata comes in here, we don't care for now
+               #print kwargs
+               self.unitsize = metadata['unitsize']
+
+               self.probes = Decoder.probes
+               self.oldsck = True
+               self.rxcount = 0
+               self.rxdata = 0
+               self.bytesreceived = 0
+
+       def summary(self):
+               return "SPI: %d bytes received" % self.bytesreceived
+
+       def decode(self, data):
+               # We should accept a list of samples and iterate...
+               for sample in sampleiter(data["data"], self.unitsize):
+
+                       sck = sample.probe(self.probes["sck"])
+                       # Sample SDATA on rising SCK
+                       if sck == self.oldsck:
+                               continue
+                       self.oldsck = sck
+                       if not sck: 
+                               continue        
+
+                       # If this is first bit, save timestamp
+                       if self.rxcount == 0:
+                               self.time = data["time"]
+                       # Receive bit into our shift register
+                       sdata = sample.probe(self.probes["sdata"])
+                       if sdata:
+                               self.rxdata |= 1 << (7 - self.rxcount)
+                       self.rxcount += 1
+                       # Continue to receive if not a byte yet
+                       if self.rxcount != 8:
+                               continue
+                       # Received a byte, pass up to sigrok
+                       outdata = {"time":self.time,
+                               "duration":data["time"] + data["duration"] - self.time,
+                               "data":self.rxdata,
+                               "display":("%02X" % self.rxdata),
+                               "type":"spi",
+                       }
+                       print outdata
+                       sigrok.put(outdata)
+                       # Reset decoder state
+                       self.rxdata = 0
+                       self.rxcount = 0
+                       # Keep stats for summary
+                       self.bytesreceived += 1
+                       
+
+register = {
+       'id': 'spi',
+       'name': 'SPI Decoder',
+       'longname': '...',
+       'desc': 'Decodes SPI frames',
+       'longdesc': '...',
+       'author': 'Gareth McMullin',
+       'email': 'gareth@blacksphere.co.nz',
+       'license': 'gplv2+',
+       'in': ['logic'],
+       'out': ['spi'],
+       'probes': [
+               # All probes.
+       ],
+       'options': {
+               # No options so far.
+       },
+       # 'start': start,
+       # 'report': report,
+}
+
+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
+
+