#include <inttypes.h>
#include <stdlib.h>
-
/* List of decoder instances. */
static GSList *di_list = NULL;
/* List of frontend callbacks to receive PD output. */
static GSList *callbacks = NULL;
-/* lives in decoder.c */
-extern GSList *pd_list;
-
-/* lives in module_sigrokdecode.c */
-extern PyMODINIT_FUNC PyInit_sigrokdecode(void);
+/* decoder.c */
+extern SRD_PRIV GSList *pd_list;
-/* lives in type_logic.c */
-extern PyTypeObject srd_logic_type;
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyMODINIT_FUNC PyInit_sigrokdecode(void);
+/* type_logic.c */
+extern SRD_PRIV PyTypeObject srd_logic_type;
/**
* Initialize libsigrokdecode.
* directory cannot be accessed, return SRD_ERR_DECODERS_DIR.
* If not enough memory could be allocated, return SRD_ERR_MALLOC.
*/
-int srd_init(void)
+SRD_API 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);
return SRD_OK;
}
-
/**
* Shutdown libsigrokdecode.
*
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_exit(void)
+SRD_API int srd_exit(void)
{
-
- srd_dbg("srd: exiting");
+ srd_dbg("Exiting libsigrokdecode.");
srd_unload_all_decoders();
g_slist_free(pd_list);
return SRD_OK;
}
-
/**
* Add an additional search directory for the protocol decoders.
*
*
* @return TODO.
*/
-int set_modulepath(void)
+SRD_API int set_modulepath(void)
{
int ret;
gchar *path, *s;
return ret;
}
-
/**
* Set options in a decoder instance.
*
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_instance_set_options(struct srd_decoder_instance *di,
- GHashTable *options)
+SRD_API int srd_instance_set_options(struct srd_decoder_instance *di,
+ GHashTable *options)
{
PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
PyObject *py_optlist, *py_classval;
int num_optkeys, ret, size, i;
char *key, *value;
- if(!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
+ if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
/* Decoder has no options. */
if (g_hash_table_size(options) == 0) {
/* No options provided. */
if (!(py_classval = PyList_GetItem(py_optlist, 1)))
goto err_out;
if (!PyUnicode_Check(py_classval) && !PyLong_Check(py_classval)) {
- srd_err("Options of type %s are not yet supported.", Py_TYPE(py_classval)->tp_name);
+ srd_err("Options of type %s are not yet supported.",
+ Py_TYPE(py_classval)->tp_name);
goto err_out;
}
if (!(py_optval = PyLong_FromString(value, NULL, 0))) {
/* ValueError Exception */
PyErr_Clear();
- srd_err("Option %s has invalid value %s: expected integer.",
- key, value);
+ srd_err("Option %s has invalid value "
+ "%s: expected integer.",
+ key, value);
goto err_out;
}
}
if (val_ull == (unsigned long long)-1) {
/* OverFlowError exception */
PyErr_Clear();
- srd_err("Invalid integer value for %s: expected integer.", key);
+ srd_err("Invalid integer value for %s: "
+ "expected integer.", key);
goto err_out;
}
if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
Py_XDECREF(py_di_options);
Py_XDECREF(py_dec_optkeys);
Py_XDECREF(py_dec_options);
- if (key)
- g_free(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;
}
/* Helper GComparefunc for g_slist_find_custom() in srd_instance_set_probes() */
static gint compare_probe_id(struct srd_probe *a, char *probe_id)
{
-
return strcmp(a->id, probe_id);
}
*
* @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.
- *
+ * the probe number. Samples passed to this instance will be
+ * arranged in this order.
* @return SRD_OK upon success, a (negative) error code otherwise.
*/
-int srd_instance_set_probes(struct srd_decoder_instance *di,
- GHashTable *new_probes)
+SRD_API int srd_instance_set_probes(struct srd_decoder_instance *di,
+ GHashTable *new_probes)
{
GList *l;
GSList *sl;
int *new_probemap, new_probenum;
char *probe_id, *probenum_str;
+ srd_dbg("set probes called for instance %s with list of %d probes",
+ di->instance_id, g_hash_table_size(new_probes));
+
if (g_hash_table_size(new_probes) == 0)
/* No probes provided. */
return SRD_OK;
- if(di->dec_num_probes == 0) {
+ if (di->dec_num_probes == 0) {
/* Decoder has no probes. */
srd_err("Protocol decoder %s has no probes to define.",
- di->decoder->name);
+ di->decoder->name);
return SRD_ERR_ARG;
}
probenum_str = g_hash_table_lookup(new_probes, probe_id);
if (!probenum_str) {
/* Probe name was specified without a value. */
- srd_err("No probe number was specified for %s.", probe_id);
+ srd_err("No probe number was specified for %s.",
+ probe_id);
g_free(new_probemap);
return SRD_ERR_ARG;
}
if (!(sl = g_slist_find_custom(di->decoder->probes, probe_id,
(GCompareFunc)compare_probe_id))) {
/* Fall back on optional probes. */
- if (!(sl = g_slist_find_custom(di->decoder->extra_probes,
- probe_id, (GCompareFunc)compare_probe_id))) {
- srd_err("Protocol decoder %s has no probe '%s'.",
- di->decoder->name, probe_id);
+ if (!(sl = g_slist_find_custom(di->decoder->opt_probes,
+ probe_id, (GCompareFunc) compare_probe_id))) {
+ srd_err("Protocol decoder %s has no probe "
+ "'%s'.", di->decoder->name, probe_id);
g_free(new_probemap);
return SRD_ERR_ARG;
}
}
p = sl->data;
new_probemap[p->order] = new_probenum;
+ srd_dbg("setting probe mapping for %d = probe %d", p->order,
+ new_probenum);
}
g_free(di->dec_probemap);
di->dec_probemap = new_probemap;
*
* @param id Decoder 'id' field.
* @param options GHashtable of options which override the defaults set in
- * the decoder class.
+ * the decoder class.
* @return Pointer to a newly allocated struct srd_decoder_instance, or
- * NULL in case of failure.
+ * NULL in case of failure.
*/
-struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
- GHashTable *options)
+SRD_API struct srd_decoder_instance *srd_instance_new(const char *decoder_id,
+ GHashTable *options)
{
+ int i;
struct srd_decoder *dec;
struct srd_decoder_instance *di;
- 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);
* order in which the decoder class defined them.
*/
di->dec_num_probes = g_slist_length(di->decoder->probes) +
- g_slist_length(di->decoder->extra_probes);
+ g_slist_length(di->decoder->opt_probes);
if (di->dec_num_probes) {
- if (!(di->dec_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
+ if (!(di->dec_probemap =
+ g_try_malloc(sizeof(int) * di->dec_num_probes))) {
srd_err("Failed to malloc probe map.");
g_free(di);
return NULL;
/* Create a new instance of this decoder class. */
if (!(di->py_instance = PyObject_CallObject(dec->py_dec, NULL))) {
if (PyErr_Occurred())
- catch_exception("failed to create %s instance: ", decoder_id);
+ catch_exception("failed to create %s instance: ",
+ decoder_id);
g_free(di->dec_probemap);
g_free(di);
return NULL;
return di;
}
-int srd_instance_stack(struct srd_decoder_instance *di_from,
- struct srd_decoder_instance *di_to)
+SRD_API 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;
+ 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.
+ */
+SRD_API struct srd_decoder_instance *srd_instance_find_by_id(char *instance_id)
{
GSList *l;
struct srd_decoder_instance *tmp, *di;
return di;
}
-int srd_instance_start(struct srd_decoder_instance *di, PyObject *args)
+/**
+ * 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.
+ */
+SRD_API 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;
+}
+
+SRD_API 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'.");
- catch_exception("Protocol decoder instance %s: ", di->instance_id);
+ catch_exception("Protocol decoder instance %s: ",
+ di->instance_id);
return SRD_ERR_PYTHON;
}
if (!(py_res = PyObject_CallMethodObjArgs(di->py_instance,
- py_name, args, NULL))) {
- catch_exception("Protocol decoder instance %s: ", di->instance_id);
+ py_name, args, NULL))) {
+ catch_exception("Protocol decoder instance %s: ",
+ di->instance_id);
return SRD_ERR_PYTHON;
}
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;
}
* 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)
+SRD_API int srd_instance_decode(uint64_t start_samplenum,
+ 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;
}
Py_IncRef(di->py_instance);
end_samplenum = start_samplenum + inbuflen / di->data_unitsize;
if (!(py_res = PyObject_CallMethod(di->py_instance, "decode",
- "KKO", logic->start_samplenum, end_samplenum, logic))) {
- catch_exception("Protocol decoder instance %s: ", di->instance_id);
+ "KKO", logic->start_samplenum,
+ end_samplenum, logic))) {
+ catch_exception("Protocol decoder instance %s: ",
+ di->instance_id);
return SRD_ERR_PYTHON; /* TODO: More specific error? */
}
Py_DecRef(py_res);
return SRD_OK;
}
+SRD_API void srd_instance_free(struct srd_decoder_instance *di)
+{
+ GSList *l;
+ struct srd_pd_output *pdo;
+
+ srd_dbg("Freeing instance %s", di->instance_id);
+
+ Py_DecRef(di->py_instance);
+ g_free(di->instance_id);
+ g_free(di->dec_probemap);
+ g_slist_free(di->next_di);
+ for (l = di->pd_output; l; l = l->next) {
+ pdo = l->data;
+ g_free(pdo->proto_id);
+ g_free(pdo);
+ }
+ g_slist_free(di->pd_output);
+}
-int srd_session_start(int num_probes, int unitsize, uint64_t samplerate)
+SRD_API void srd_instance_free_all(GSList *stack)
+{
+ GSList *l;
+ struct srd_decoder_instance *di;
+
+ di = NULL;
+ for (l = stack ? stack : di_list; di == NULL && l != NULL; l = l->next) {
+ di = l->data;
+ if (di->next_di)
+ srd_instance_free_all(di->next_di);
+ srd_instance_free(di);
+ }
+ if (!stack) {
+ g_slist_free(di_list);
+ di_list = NULL;
+ }
+}
+
+SRD_API 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.
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. */
-int srd_session_feed(uint64_t start_samplenum, uint8_t *inbuf, uint64_t inbuflen)
+SRD_API 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,
- inbuflen)) != SRD_OK)
+ inbuflen)) != SRD_OK)
return ret;
}
return SRD_OK;
}
-
-int srd_register_callback(int output_type, void *cb)
+SRD_API int srd_register_callback(int output_type, srd_pd_output_callback_t 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;
return SRD_OK;
}
-void *srd_find_callback(int output_type)
+SRD_API void *srd_find_callback(int output_type)
{
GSList *l;
struct srd_pd_callback *pd_cb;
return cb;
}
-
/* This is the backend function to python sigrokdecode.add() call. */
-int pd_add(struct srd_decoder_instance *di, int output_type,
- char *proto_id)
+SRD_PRIV 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;
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;
-}
-
projects / libsigrokdecode.git / blobdiff