* This file is part of the sigrok project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2011 Bert Vermeulen <bert@biot.com>
+ * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "sigrokdecode-internal.h"
#include "config.h"
-#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <glib.h>
+#include <inttypes.h>
-/* TODO: this should probably be in sigrokdecode.h */
-/* Re-define some string functions for Python >= 3.0. */
-#if PY_VERSION_HEX >= 0x03000000
-#define PyString_AsString PyBytes_AsString
-#define PyString_FromString PyBytes_FromString
-#define PyString_Check PyBytes_Check
-#endif
-
-static GSList *pipelines = NULL;
+static GSList *di_list = NULL;
+static GSList *callbacks = NULL;
/* lives in decoder.c */
-extern GSList *list_pds;
-extern GSList *decoders;
-
-struct srd_pipeline {
- int id;
- GSList *decoders;
-};
-
-
-
-static PyObject *Decoder_init(PyObject *self, PyObject *args)
-{
- (void)self;
- (void)args;
-// printf("init object %x\n", self);
-
- Py_RETURN_NONE;
-}
-
+extern GSList *pd_list;
-static PyObject *Decoder_put(PyObject *self, PyObject *args)
-{
- PyObject *arg;
+/* lives in module_sigrokdecode.c */
+extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
-// printf("put object %x\n", self);
-
- 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("");
-
- Py_RETURN_NONE;
-}
-
-static PyMethodDef no_methods[] = { {NULL, NULL, 0, NULL} };
-static PyMethodDef Decoder_methods[] = {
- {"__init__", Decoder_init, METH_VARARGS, ""},
- {"put", Decoder_put, METH_VARARGS,
- "Accepts a dictionary with the following keys: time, duration, data"},
- {NULL, NULL, 0, NULL}
-};
-
-
-// class Decoder(sigrok.Decoder):
-typedef struct {
- PyObject_HEAD
-} sigrok_Decoder_object;
-
-static PyTypeObject sigrok_Decoder_type = {
- PyObject_HEAD_INIT(NULL)
- .tp_name = "sigrok.Decoder",
- .tp_basicsize = sizeof(sigrok_Decoder_object),
- .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
- .tp_doc = "Sigrok Decoder object",
- .tp_methods = Decoder_methods,
-};
-
-PyMODINIT_FUNC init_sigrok_Decoder(void)
-{
- PyObject *mod;
-
- sigrok_Decoder_type.tp_new = PyType_GenericNew;
- if (PyType_Ready(&sigrok_Decoder_type) < 0)
- return;
-
- mod = Py_InitModule3("sigrok", no_methods, "sigrok base classes");
- Py_INCREF(&sigrok_Decoder_type);
- PyModule_AddObject(mod, "Decoder", (PyObject *)&sigrok_Decoder_type);
-
-}
+/* lives in type_logic.c */
+extern PyTypeObject srd_logic_type;
/**
* The caller is responsible for calling the clean-up function srd_exit(),
* which will properly shut down libsigrokdecode and free its allocated memory.
*
- * Multiple calls to srd_init(), without calling srd_exit() inbetween,
+ * Multiple calls to srd_init(), without calling srd_exit() in between,
* are not allowed.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
{
int ret;
+ PyImport_AppendInittab("sigrokdecode", PyInit_sigrokdecode);
+
/* Py_Initialize() returns void and usually cannot fail. */
Py_Initialize();
- init_sigrok_Decoder();
-
- PyRun_SimpleString("import sys;");
if ((ret = set_modulepath()) != SRD_OK) {
Py_Finalize();
return ret;
*
* This function should only be called if there was a (successful!) invocation
* of srd_init() before. Calling this function multiple times in a row, without
- * any successful srd_init() calls inbetween, is not allowed.
+ * any successful srd_init() calls in between, is not allowed.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
/* Unload/free all decoders, and then the list of decoders itself. */
/* TODO: Error handling. */
srd_unload_all_decoders();
- g_slist_free(list_pds);
+ g_slist_free(pd_list);
/* Py_Finalize() returns void, any finalization errors are ignored. */
Py_Finalize();
{
int ret;
+ PyRun_SimpleString("import sys");
ret = PyRun_SimpleString("sys.path.append(r'" DECODERS_DIR "');");
return ret;
}
-struct srd_decoder_instance *srd_instance_new(const char *id)
+/**
+ * Create a new protocol decoder instance.
+ *
+ * TODO: this should be a decoder name, as decoder ids will disappear.
+ *
+ * @param id Decoder 'id' field.
+ * @param instance_id Optional unique identifier for this instance. If NULL,
+ * the 'id' parameter is used.
+ * @return Pointer to a newly allocated struct srd_decoder_instance, or
+ * NULL in case of failure.
+ */
+struct srd_decoder_instance *srd_instance_new(const char *id,
+ const char *instance_id)
{
struct srd_decoder *dec;
struct srd_decoder_instance *di;
PyObject *py_args;
- fprintf(stdout, "%s: %s\n", __func__, id);
+ srd_dbg("%s: creating new %s instance", __func__, id);
if (!(dec = srd_get_decoder_by_id(id)))
return NULL;
- /* TODO: Error handling. Use g_try_malloc(). */
- di = g_malloc(sizeof(*di));
+ if (!(di = g_try_malloc(sizeof(*di)))) {
+ srd_err("failed to malloc instance");
+ return NULL;
+ }
di->decoder = dec;
+ di->instance_id = g_strdup(instance_id ? instance_id : id);
di->pd_output = NULL;
+ di->num_probes = 0;
+ di->unitsize = 0;
+ di->samplerate = 0;
+ di->next_di = NULL;
/* Create an empty Python tuple. */
if (!(py_args = PyTuple_New(0))) { /* NEWREF */
if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
-
- return NULL; /* TODO: More specific error? */
+ PyErr_Print();
+ return NULL;
}
/* Create an instance of the 'Decoder' class. */
di->py_instance = PyObject_Call(dec->py_decobj, py_args, NULL);
if (!di->py_instance) {
if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
+ PyErr_Print();
Py_XDECREF(py_args);
- return NULL; /* TODO: More specific error? */
+ return NULL;
}
- decoders = g_slist_append(decoders, di);
+
+ /* Instance takes input from a frontend by default. */
+ di_list = g_slist_append(di_list, di);
Py_XDECREF(py_args);
return di;
}
+int srd_instance_stack(struct srd_decoder_instance *di_from,
+ struct srd_decoder_instance *di_to)
+{
+
+ if (!di_from || !di_to) {
+ srd_err("invalid from/to instance pair");
+ return SRD_ERR_ARG;
+ }
+
+ if (!g_slist_find(di_list, di_from)) {
+ srd_err("unstacked instance not found");
+ return SRD_ERR_ARG;
+ }
+
+ /* 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;
+}
+
int srd_instance_set_probe(struct srd_decoder_instance *di,
const char *probename, int num)
return SRD_ERR_PYTHON; /* TODO: More specific error? */
}
- probenum = PyInt_FromLong(num);
+ probenum = PyLong_FromLong(num);
PyMapping_SetItemString(probedict, (char *)probename, probenum);
Py_XDECREF(probenum);
return SRD_OK;
}
+struct srd_decoder_instance *srd_instance_find(char *instance_id)
+{
+ GSList *l;
+ struct srd_decoder_instance *tmp, *di;
+
+ di = NULL;
+ for (l = di_list; l; l = l->next) {
+ tmp = l->data;
+ if (!strcmp(tmp->instance_id, instance_id)) {
+ di = tmp;
+ break;
+ }
+ }
+
+ return di;
+}
-int srd_session_start(const char *driver, int unitsize, uint64_t starttime,
- uint64_t samplerate)
+int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
{
- PyObject *py_res;
- GSList *d;
- struct srd_decoder_instance *di;
+ PyObject *py_name, *py_res;
- fprintf(stdout, "%s: %s\n", __func__, driver);
+ srd_dbg("calling start() method on protocol decoder instance %s", di->instance_id);
- for (d = decoders; d; d = d->next) {
- di = d->data;
- if (!(py_res = PyObject_CallMethod(di->py_instance, "start",
- "{s:s,s:l,s:l,s:l}",
- "driver", driver,
- "unitsize", (long)unitsize,
- "starttime", (long)starttime,
- "samplerate", (long)samplerate))) {
- if (PyErr_Occurred())
- PyErr_Print(); /* Returns void. */
-
- return SRD_ERR_PYTHON; /* TODO: More specific error? */
- }
- Py_XDECREF(py_res);
+ if (!(py_name = PyUnicode_FromString("start"))) {
+ srd_err("unable to build python object for 'start'");
+ if (PyErr_Occurred())
+ PyErr_Print();
+ return SRD_ERR_PYTHON;
}
+ if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
+ py_name, args, NULL))) {
+ if (PyErr_Occurred())
+ PyErr_Print();
+ return SRD_ERR_PYTHON;
+ }
+
+ Py_XDECREF(py_res);
+ Py_DECREF(py_name);
+
return SRD_OK;
}
-
/**
* Run the specified decoder function.
*
* @param dec TODO
* @param inbuf TODO
* @param inbuflen TODO
- * @param outbuf TODO
- * @param outbuflen TODO
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_run_decoder(struct srd_decoder_instance *dec,
- uint8_t *inbuf, uint64_t inbuflen)
+int srd_instance_decode(uint64_t timeoffset, uint64_t duration,
+ struct srd_decoder_instance *di, uint8_t *inbuf, uint64_t inbuflen)
{
PyObject *py_instance, *py_res;
- /* FIXME: Don't have a timebase available here. Make one up. */
- static int _timehack = 0;
-
- _timehack += inbuflen;
-
-// fprintf(stdout, "%s: %s\n", __func__, dec->decoder->name);
+ srd_logic *logic;
/* Return an error upon unusable input. */
- if (dec == NULL)
- return SRD_ERR_ARGS; /* TODO: More specific error? */
+ if (di == NULL)
+ return SRD_ERR_ARG; /* TODO: More specific error? */
if (inbuf == NULL)
- return SRD_ERR_ARGS; /* TODO: More specific error? */
+ return SRD_ERR_ARG; /* TODO: More specific error? */
if (inbuflen == 0) /* No point in working on empty buffers. */
- return SRD_ERR_ARGS; /* TODO: More specific error? */
+ return SRD_ERR_ARG; /* TODO: More specific error? */
/* TODO: Error handling. */
- py_instance = dec->py_instance;
+ py_instance = di->py_instance;
Py_XINCREF(py_instance);
+ logic = PyObject_New(srd_logic, &srd_logic_type);
+ Py_INCREF(logic);
+ logic->di = di;
+ logic->itercnt = 0;
+ logic->inbuf = inbuf;
+ logic->inbuflen = inbuflen;
+ logic->sample = PyList_New(2);
+ Py_INCREF(logic->sample);
+
if (!(py_res = PyObject_CallMethod(py_instance, "decode",
- "{s:i,s:i,s:s#}",
- "time", _timehack,
- "duration", 10,
- "data", inbuf, inbuflen))) { /* NEWREF */
+ "KKO", timeoffset, duration, logic))) {
if (PyErr_Occurred())
PyErr_Print(); /* Returns void. */
}
Py_XDECREF(py_res);
+
return SRD_OK;
}
+int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
+{
+ PyObject *args;
+ GSList *d, *s;
+ struct srd_decoder_instance *di;
+ int ret;
+
+ if (!(args = Py_BuildValue("{s:l}", "samplerate", (long)samplerate))) {
+ srd_err("unable to build python object for metadata");
+ return SRD_ERR_PYTHON;
+ }
+
+ /* Run the start() method on all decoders receiving frontend data. */
+ for (d = di_list; d; d = d->next) {
+ di = d->data;
+ di->num_probes = num_probes;
+ di->unitsize = unitsize;
+ di->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;
+ }
+ }
+
+ Py_DECREF(args);
+
+ return SRD_OK;
+}
+
/* Feed logic samples to decoder session. */
-int srd_session_feed(uint8_t *inbuf, uint64_t inbuflen)
+int srd_session_feed(uint64_t timeoffset, uint64_t duration, uint8_t *inbuf,
+ uint64_t inbuflen)
{
GSList *d;
int ret;
-// fprintf(stdout, "%s: %d bytes\n", __func__, inbuflen);
-
- for (d = decoders; d; d = d->next) {
- if ((ret = srd_run_decoder(d->data, inbuf, inbuflen)) != SRD_OK)
+ for (d = di_list; d; d = d->next) {
+ if ((ret = srd_instance_decode(timeoffset, duration, d->data, inbuf,
+ inbuflen)) != SRD_OK)
return ret;
}
}
-//int srd_pipeline_new(int plid)
-//{
-//
-//
-//}
-//
-//
-//int pd_output_new(int output_type, char *output_id, char *description)
-//{
-//
-//
-//}
+int pd_add(struct srd_decoder_instance *di, int output_type,
+ char *proto_id)
+{
+ struct srd_pd_output *pdo;
+
+ if (!(pdo = g_try_malloc(sizeof(struct srd_pd_output))))
+ return -1;
+
+ /* 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->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;
+}
+
+int srd_register_callback(int output_type, void *cb)
+{
+ struct srd_pd_callback *pd_cb;
+
+ if (!(pd_cb = g_try_malloc(sizeof(struct srd_pd_callback))))
+ return SRD_ERR_MALLOC;
+ pd_cb->output_type = output_type;
+ pd_cb->callback = cb;
+ callbacks = g_slist_append(callbacks, pd_cb);
+ return SRD_OK;
+}
+
+void *srd_find_callback(int output_type)
+{
+ GSList *l;
+ struct srd_pd_callback *pd_cb;
+ void *(cb);
+
+ cb = NULL;
+ for (l = callbacks; l; l = l->next) {
+ pd_cb = l->data;
+ if (pd_cb->output_type == output_type) {
+ cb = pd_cb->callback;
+ break;
+ }
+ }
+ return cb;
+}