* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "libsigrokdecode-internal.h"
-#include "config.h"
+#include <config.h>
+#include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode.h"
#include <glib.h>
#include <inttypes.h>
#include <stdlib.h>
/** @cond PRIVATE */
-extern GSList *sessions;
+extern SRD_PRIV GSList *sessions;
-/* type_logic.c */
-extern SRD_PRIV PyTypeObject srd_logic_type;
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *srd_logic_type;
/** @endcond */
SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
GHashTable *options)
{
- PyObject *py_dec_options, *py_dec_optkeys, *py_di_options, *py_optval;
- PyObject *py_optlist, *py_classval;
- Py_UNICODE *py_ustr;
+ struct srd_decoder_option *sdo;
+ PyObject *py_di_options, *py_optval;
GVariant *value;
- unsigned long long int val_ull;
+ GSList *l;
+ double val_double;
gint64 val_int;
- int num_optkeys, ret, size, i;
+ int ret;
const char *val_str;
- char *dbg, *key;
if (!di) {
srd_err("Invalid decoder instance.");
}
ret = SRD_ERR_PYTHON;
- key = NULL;
- py_dec_options = py_dec_optkeys = py_di_options = py_optval = NULL;
- py_optlist = py_classval = NULL;
- py_dec_options = PyObject_GetAttrString(di->decoder->py_dec, "options");
-
- /* All of these are synthesized objects, so they're good. */
- py_dec_optkeys = PyDict_Keys(py_dec_options);
- num_optkeys = PyList_Size(py_dec_optkeys);
+ py_optval = NULL;
/*
- * The 'options' dictionary is a class variable, but we need to
+ * The 'options' tuple is a class variable, but we need to
* change it. Changing it directly will affect the entire class,
* so we need to create a new object for it, and populate that
* instead.
Py_DECREF(py_di_options);
py_di_options = PyDict_New();
PyObject_SetAttrString(di->py_inst, "options", py_di_options);
- for (i = 0; i < num_optkeys; i++) {
- /* Get the default class value for this option. */
- py_str_as_str(PyList_GetItem(py_dec_optkeys, i), &key);
- if (!(py_optlist = PyDict_GetItemString(py_dec_options, key)))
- goto err_out;
- 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);
- goto err_out;
- }
- if ((value = g_hash_table_lookup(options, key))) {
- dbg = g_variant_print(value, TRUE);
- srd_dbg("got option '%s' = %s", key, dbg);
- g_free(dbg);
- /* An override for this option was provided. */
- if (PyUnicode_Check(py_classval)) {
- if (!g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
- srd_err("Option '%s' requires a string value.", key);
- goto err_out;
- }
- val_str = g_variant_get_string(value, NULL);
- if (!(py_optval = PyUnicode_FromString(val_str))) {
- /* Some UTF-8 encoding error. */
- PyErr_Clear();
- srd_err("Option '%s' requires a UTF-8 string value.", key);
- goto err_out;
- }
- } else if (PyLong_Check(py_classval)) {
- if (!g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
- srd_err("Option '%s' requires an integer value.", key);
- goto err_out;
- }
- val_int = g_variant_get_int64(value);
- if (!(py_optval = PyLong_FromLong(val_int))) {
- /* ValueError Exception */
- PyErr_Clear();
- srd_err("Option '%s' has invalid integer value.", key);
- goto err_out;
- }
+ for (l = di->decoder->options; l; l = l->next) {
+ sdo = l->data;
+ if ((value = g_hash_table_lookup(options, sdo->id))) {
+ /* A value was supplied for this option. */
+ if (!g_variant_type_equal(g_variant_get_type(value),
+ g_variant_get_type(sdo->def))) {
+ srd_err("Option '%s' should have the same type "
+ "as the default value.", sdo->id);
+ goto err_out;
}
- g_hash_table_remove(options, key);
} else {
- /* Use the class default for this option. */
- if (PyUnicode_Check(py_classval)) {
- /* Make a brand new copy of the string. */
- py_ustr = PyUnicode_AS_UNICODE(py_classval);
- size = PyUnicode_GET_SIZE(py_classval);
- py_optval = PyUnicode_FromUnicode(py_ustr, size);
- } else if (PyLong_Check(py_classval)) {
- /* Make a brand new copy of the integer. */
- val_ull = PyLong_AsUnsignedLongLong(py_classval);
- if (val_ull == (unsigned long long)-1) {
- /* OverFlowError exception */
- PyErr_Clear();
- srd_err("Invalid integer value for %s: "
- "expected integer.", key);
- goto err_out;
- }
- if (!(py_optval = PyLong_FromUnsignedLongLong(val_ull)))
- goto err_out;
+ /* Use default for this option. */
+ value = sdo->def;
+ }
+ if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
+ val_str = g_variant_get_string(value, NULL);
+ if (!(py_optval = PyUnicode_FromString(val_str))) {
+ /* Some UTF-8 encoding error. */
+ PyErr_Clear();
+ srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
+ goto err_out;
+ }
+ } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
+ val_int = g_variant_get_int64(value);
+ if (!(py_optval = PyLong_FromLong(val_int))) {
+ /* ValueError Exception */
+ PyErr_Clear();
+ srd_err("Option '%s' has invalid integer value.", sdo->id);
+ goto err_out;
+ }
+ } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
+ val_double = g_variant_get_double(value);
+ if (!(py_optval = PyFloat_FromDouble(val_double))) {
+ /* ValueError Exception */
+ PyErr_Clear();
+ srd_err("Option '%s' has invalid float value.",
+ sdo->id);
+ goto err_out;
}
}
-
- /*
- * If we got here, py_optval holds a known good new reference
- * to the instance option to set.
- */
- if (PyDict_SetItemString(py_di_options, key, py_optval) == -1)
+ if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
goto err_out;
- g_free(key);
- key = NULL;
+ /* Not harmful even if we used the default. */
+ g_hash_table_remove(options, sdo->id);
}
+ if (g_hash_table_size(options) != 0)
+ srd_warn("Unknown options specified for '%s'", di->inst_id);
ret = SRD_OK;
err_out:
- Py_XDECREF(py_di_options);
- Py_XDECREF(py_dec_optkeys);
- Py_XDECREF(py_dec_options);
- g_free(key);
+ Py_XDECREF(py_optval);
if (PyErr_Occurred()) {
- srd_exception_catch("Stray exception in srd_inst_option_set().");
+ srd_exception_catch("Stray exception in srd_inst_option_set()");
ret = SRD_ERR_PYTHON;
}
return ret;
}
-/* Helper GComparefunc for g_slist_find_custom() in srd_inst_probe_set_all() */
-static gint compare_probe_id(const struct srd_probe *a, const char *probe_id)
+/* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
+static gint compare_channel_id(const struct srd_channel *pdch,
+ const char *channel_id)
{
- return strcmp(a->id, probe_id);
+ return strcmp(pdch->id, channel_id);
}
/**
- * Set all probes in a decoder instance.
+ * Set all channels in a decoder instance.
*
- * This function sets _all_ probes for the specified decoder instance, i.e.,
- * it overwrites any probes that were already defined (if any).
+ * This function sets _all_ channels for the specified decoder instance, i.e.,
+ * it overwrites any channels that were already defined (if any).
*
* @param di Decoder instance.
- * @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.
+ * @param new_channels A GHashTable of channels to set. Key is channel name,
+ * value is the channel number. Samples passed to this
+ * instance will be arranged in this order.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
- * @since 0.1.0
+ * @since 0.4.0
*/
-SRD_API int srd_inst_probe_set_all(struct srd_decoder_inst *di,
- GHashTable *new_probes)
+SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
+ GHashTable *new_channels)
{
- GVariant *probe_val;
+ GVariant *channel_val;
GList *l;
GSList *sl;
- struct srd_probe *p;
- int *new_probemap, new_probenum, num_required_probes, num_probes, i;
- char *probe_id;
+ struct srd_channel *pdch;
+ int *new_channelmap, new_channelnum, num_required_channels, i;
+ char *channel_id;
- srd_dbg("set probes called for instance %s with list of %d probes",
- di->inst_id, g_hash_table_size(new_probes));
+ srd_dbg("Setting channels for instance %s with list of %d channels.",
+ di->inst_id, g_hash_table_size(new_channels));
- if (g_hash_table_size(new_probes) == 0)
- /* No probes provided. */
+ if (g_hash_table_size(new_channels) == 0)
+ /* No channels provided. */
return SRD_OK;
- if (di->dec_num_probes == 0) {
- /* Decoder has no probes. */
- srd_err("Protocol decoder %s has no probes to define.",
+ if (di->dec_num_channels == 0) {
+ /* Decoder has no channels. */
+ srd_err("Protocol decoder %s has no channels to define.",
di->decoder->name);
return SRD_ERR_ARG;
}
- new_probemap = NULL;
-
- if (!(new_probemap = g_try_malloc(sizeof(int) * di->dec_num_probes))) {
- srd_err("Failed to g_malloc() new probe map.");
- return SRD_ERR_MALLOC;
- }
+ new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
/*
- * For now, map all indexes to probe -1 (can be overridden later).
- * This -1 is interpreted as an unspecified probe later.
+ * For now, map all indexes to channel -1 (can be overridden later).
+ * This -1 is interpreted as an unspecified channel later.
*/
- for (i = 0; i < di->dec_num_probes; i++)
- new_probemap[i] = -1;
-
- num_probes = 0;
- for (l = g_hash_table_get_keys(new_probes); l; l = l->next) {
- probe_id = l->data;
- probe_val = g_hash_table_lookup(new_probes, probe_id);
- if (!g_variant_is_of_type(probe_val, G_VARIANT_TYPE_INT32)) {
- /* Probe name was specified without a value. */
- srd_err("No probe number was specified for %s.",
- probe_id);
- g_free(new_probemap);
+ for (i = 0; i < di->dec_num_channels; i++)
+ new_channelmap[i] = -1;
+
+ for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
+ channel_id = l->data;
+ channel_val = g_hash_table_lookup(new_channels, channel_id);
+ if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
+ /* Channel name was specified without a value. */
+ srd_err("No channel number was specified for %s.",
+ channel_id);
+ g_free(new_channelmap);
return SRD_ERR_ARG;
}
- new_probenum = g_variant_get_int32(probe_val);
- 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->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);
+ new_channelnum = g_variant_get_int32(channel_val);
+ if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
+ (GCompareFunc)compare_channel_id))) {
+ /* Fall back on optional channels. */
+ if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
+ channel_id, (GCompareFunc)compare_channel_id))) {
+ srd_err("Protocol decoder %s has no channel "
+ "'%s'.", di->decoder->name, channel_id);
+ g_free(new_channelmap);
return SRD_ERR_ARG;
}
}
- p = sl->data;
- new_probemap[p->order] = new_probenum;
- srd_dbg("Setting probe mapping: %s (index %d) = probe %d.",
- p->id, p->order, new_probenum);
- num_probes++;
+ pdch = sl->data;
+ new_channelmap[pdch->order] = new_channelnum;
+ srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
+ pdch->id, pdch->order, new_channelnum);
}
- di->data_unitsize = (num_probes + 7) / 8;
- 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");
+ srd_dbg("Final channel map:");
+ num_required_channels = g_slist_length(di->decoder->channels);
+ for (i = 0; i < di->dec_num_channels; i++) {
+ srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
+ (i < num_required_channels) ? "required" : "optional");
}
- /* Report an error if not all required probes were specified. */
- for (i = 0; i < num_required_probes; i++) {
- if (new_probemap[i] != -1)
+ /* Report an error if not all required channels were specified. */
+ for (i = 0; i < num_required_channels; i++) {
+ if (new_channelmap[i] != -1)
continue;
- p = g_slist_nth(di->decoder->probes, i)->data;
- srd_err("Required probe '%s' (index %d) was not specified.",
- p->id, i);
+ pdch = g_slist_nth(di->decoder->channels, i)->data;
+ srd_err("Required channel '%s' (index %d) was not specified.",
+ pdch->id, i);
return SRD_ERR;
}
- g_free(di->dec_probemap);
- di->dec_probemap = new_probemap;
+ g_free(di->dec_channelmap);
+ di->dec_channelmap = new_channelmap;
return SRD_OK;
}
return NULL;
}
- if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
- srd_err("Failed to g_malloc() instance.");
- return NULL;
- }
+ di = g_malloc0(sizeof(struct srd_decoder_inst));
di->decoder = dec;
di->sess = sess;
di->inst_id = g_strdup(decoder_id);
/*
- * Prepare a default probe map, where samples come in the
+ * Prepare a default channel map, where samples come in the
* order in which the decoder class defined them.
*/
- di->dec_num_probes = g_slist_length(di->decoder->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))) {
- srd_err("Failed to g_malloc() probe map.");
- g_free(di);
- return NULL;
- }
- for (i = 0; i < di->dec_num_probes; i++)
- di->dec_probemap[i] = i;
- di->data_unitsize = (di->dec_num_probes + 7) / 8;
+ di->dec_num_channels = g_slist_length(di->decoder->channels) +
+ g_slist_length(di->decoder->opt_channels);
+ if (di->dec_num_channels) {
+ di->dec_channelmap =
+ g_malloc(sizeof(int) * di->dec_num_channels);
+ for (i = 0; i < di->dec_num_channels; i++)
+ di->dec_channelmap[i] = i;
/*
* Will be used to prepare a sample at every iteration
* of the instance's decode() method.
*/
- if (!(di->probe_samples = g_try_malloc(di->dec_num_probes))) {
- srd_err("Failed to g_malloc() sample buffer.");
- g_free(di->dec_probemap);
- g_free(di);
- return NULL;
- }
+ di->channel_samples = g_malloc(di->dec_num_channels);
}
/* Create a new instance of this decoder class. */
if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
if (PyErr_Occurred())
- srd_exception_catch("failed to create %s instance: ",
+ srd_exception_catch("Failed to create %s instance",
decoder_id);
- g_free(di->dec_probemap);
+ g_free(di->dec_channelmap);
g_free(di);
return NULL;
}
if (options && srd_inst_option_set(di, options) != SRD_OK) {
- g_free(di->dec_probemap);
+ g_free(di->dec_channelmap);
g_free(di);
return NULL;
}
/* Stack on top of source di. */
di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
- srd_dbg("Stacked %s on top of %s.", di_top->inst_id, di_bottom->inst_id);
+ srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
return SRD_OK;
}
di->inst_id);
if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
- srd_exception_catch("Protocol decoder instance %s: ",
+ srd_exception_catch("Protocol decoder instance %s",
di->inst_id);
return SRD_ERR_PYTHON;
}
* set, relative to the start of capture.
* @param inbuf The buffer to decode. Must not be NULL.
* @param inbuflen Length of the buffer. Must be > 0.
+ * @param unitsize The number of bytes per sample.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
*
* @private
*
- * @since 0.1.0
+ * @since 0.4.0
*/
SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
uint64_t start_samplenum, uint64_t end_samplenum,
- const uint8_t *inbuf, uint64_t inbuflen)
+ const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
{
PyObject *py_res;
srd_logic *logic;
- srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
- "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
- start_samplenum);
-
/* Return an error upon unusable input. */
if (!di) {
srd_dbg("empty decoder instance");
return SRD_ERR_ARG;
}
+ ((struct srd_decoder_inst *)di)->data_unitsize = unitsize;
+
+ srd_dbg("Calling decode(), start sample %" PRIu64 ", end sample %"
+ PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
+ "%d), instance %s.", start_samplenum, end_samplenum,
+ end_samplenum - start_samplenum, inbuflen, di->data_unitsize,
+ di->inst_id);
+
/*
* Create new srd_logic object. Each iteration around the PD's loop
* will fill one sample into this object.
*/
- logic = PyObject_New(srd_logic, &srd_logic_type);
+ logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type);
Py_INCREF(logic);
logic->di = (struct srd_decoder_inst *)di;
logic->start_samplenum = start_samplenum;
Py_IncRef(di->py_inst);
if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
"KKO", start_samplenum, end_samplenum, logic))) {
- srd_exception_catch("Protocol decoder instance %s: ", di->inst_id);
+ srd_exception_catch("Protocol decoder instance %s",
+ di->inst_id);
return SRD_ERR_PYTHON;
}
Py_DecRef(py_res);
Py_DecRef(di->py_inst);
g_free(di->inst_id);
- g_free(di->dec_probemap);
+ g_free(di->dec_channelmap);
g_slist_free(di->next_di);
for (l = di->pd_output; l; l = l->next) {
pdo = l->data;
}
/** @} */
-