2 * This file is part of the libsigrokdecode project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
23 #include "libsigrokdecode.h"
31 extern SRD_PRIV GSList *sessions;
33 /* module_sigrokdecode.c */
34 extern SRD_PRIV PyObject *srd_logic_type;
41 * Decoder instance handling.
45 * @defgroup grp_instances Decoder instances
47 * Decoder instance handling.
53 * Set one or more options in a decoder instance.
55 * Handled options are removed from the hash.
57 * @param di Decoder instance.
58 * @param options A GHashTable of options to set.
60 * @return SRD_OK upon success, a (negative) error code otherwise.
64 SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
67 struct srd_decoder_option *sdo;
68 PyObject *py_di_options, *py_optval;
77 srd_err("Invalid decoder instance.");
82 srd_err("Invalid options GHashTable.");
86 if (!PyObject_HasAttrString(di->decoder->py_dec, "options")) {
87 /* Decoder has no options. */
88 if (g_hash_table_size(options) == 0) {
89 /* No options provided. */
92 srd_err("Protocol decoder has no options.");
102 * The 'options' tuple is a class variable, but we need to
103 * change it. Changing it directly will affect the entire class,
104 * so we need to create a new object for it, and populate that
107 if (!(py_di_options = PyObject_GetAttrString(di->py_inst, "options")))
109 Py_DECREF(py_di_options);
110 py_di_options = PyDict_New();
111 PyObject_SetAttrString(di->py_inst, "options", py_di_options);
113 for (l = di->decoder->options; l; l = l->next) {
115 if ((value = g_hash_table_lookup(options, sdo->id))) {
116 /* A value was supplied for this option. */
117 if (!g_variant_type_equal(g_variant_get_type(value),
118 g_variant_get_type(sdo->def))) {
119 srd_err("Option '%s' should have the same type "
120 "as the default value.", sdo->id);
124 /* Use default for this option. */
127 if (g_variant_is_of_type(value, G_VARIANT_TYPE_STRING)) {
128 val_str = g_variant_get_string(value, NULL);
129 if (!(py_optval = PyUnicode_FromString(val_str))) {
130 /* Some UTF-8 encoding error. */
132 srd_err("Option '%s' requires a UTF-8 string value.", sdo->id);
135 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_INT64)) {
136 val_int = g_variant_get_int64(value);
137 if (!(py_optval = PyLong_FromLong(val_int))) {
138 /* ValueError Exception */
140 srd_err("Option '%s' has invalid integer value.", sdo->id);
143 } else if (g_variant_is_of_type(value, G_VARIANT_TYPE_DOUBLE)) {
144 val_double = g_variant_get_double(value);
145 if (!(py_optval = PyFloat_FromDouble(val_double))) {
146 /* ValueError Exception */
148 srd_err("Option '%s' has invalid float value.",
153 if (PyDict_SetItemString(py_di_options, sdo->id, py_optval) == -1)
155 /* Not harmful even if we used the default. */
156 g_hash_table_remove(options, sdo->id);
158 if (g_hash_table_size(options) != 0)
159 srd_warn("Unknown options specified for '%s'", di->inst_id);
164 Py_XDECREF(py_optval);
165 if (PyErr_Occurred()) {
166 srd_exception_catch("Stray exception in srd_inst_option_set()");
167 ret = SRD_ERR_PYTHON;
173 /* Helper GComparefunc for g_slist_find_custom() in srd_inst_channel_set_all() */
174 static gint compare_channel_id(const struct srd_channel *pdch,
175 const char *channel_id)
177 return strcmp(pdch->id, channel_id);
181 * Set all channels in a decoder instance.
183 * This function sets _all_ channels for the specified decoder instance, i.e.,
184 * it overwrites any channels that were already defined (if any).
186 * @param di Decoder instance.
187 * @param new_channels A GHashTable of channels to set. Key is channel name,
188 * value is the channel number. Samples passed to this
189 * instance will be arranged in this order.
191 * @return SRD_OK upon success, a (negative) error code otherwise.
195 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
196 GHashTable *new_channels)
198 GVariant *channel_val;
201 struct srd_channel *pdch;
202 int *new_channelmap, new_channelnum, num_required_channels, i;
205 srd_dbg("Setting channels for instance %s with list of %d channels.",
206 di->inst_id, g_hash_table_size(new_channels));
208 if (g_hash_table_size(new_channels) == 0)
209 /* No channels provided. */
212 if (di->dec_num_channels == 0) {
213 /* Decoder has no channels. */
214 srd_err("Protocol decoder %s has no channels to define.",
219 new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
222 * For now, map all indexes to channel -1 (can be overridden later).
223 * This -1 is interpreted as an unspecified channel later.
225 for (i = 0; i < di->dec_num_channels; i++)
226 new_channelmap[i] = -1;
228 for (l = g_hash_table_get_keys(new_channels); l; l = l->next) {
229 channel_id = l->data;
230 channel_val = g_hash_table_lookup(new_channels, channel_id);
231 if (!g_variant_is_of_type(channel_val, G_VARIANT_TYPE_INT32)) {
232 /* Channel name was specified without a value. */
233 srd_err("No channel number was specified for %s.",
235 g_free(new_channelmap);
238 new_channelnum = g_variant_get_int32(channel_val);
239 if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
240 (GCompareFunc)compare_channel_id))) {
241 /* Fall back on optional channels. */
242 if (!(sl = g_slist_find_custom(di->decoder->opt_channels,
243 channel_id, (GCompareFunc)compare_channel_id))) {
244 srd_err("Protocol decoder %s has no channel "
245 "'%s'.", di->decoder->name, channel_id);
246 g_free(new_channelmap);
251 new_channelmap[pdch->order] = new_channelnum;
252 srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
253 pdch->id, pdch->order, new_channelnum);
256 srd_dbg("Final channel map:");
257 num_required_channels = g_slist_length(di->decoder->channels);
258 for (i = 0; i < di->dec_num_channels; i++) {
259 srd_dbg(" - index %d = channel %d (%s)", i, new_channelmap[i],
260 (i < num_required_channels) ? "required" : "optional");
263 /* Report an error if not all required channels were specified. */
264 for (i = 0; i < num_required_channels; i++) {
265 if (new_channelmap[i] != -1)
267 pdch = g_slist_nth(di->decoder->channels, i)->data;
268 srd_err("Required channel '%s' (index %d) was not specified.",
273 g_free(di->dec_channelmap);
274 di->dec_channelmap = new_channelmap;
280 * Create a new protocol decoder instance.
282 * @param sess The session holding the protocol decoder instance.
283 * @param decoder_id Decoder 'id' field.
284 * @param options GHashtable of options which override the defaults set in
285 * the decoder class. May be NULL.
287 * @return Pointer to a newly allocated struct srd_decoder_inst, or
288 * NULL in case of failure.
292 SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
293 const char *decoder_id, GHashTable *options)
296 struct srd_decoder *dec;
297 struct srd_decoder_inst *di;
300 srd_dbg("Creating new %s instance.", decoder_id);
302 if (session_is_valid(sess) != SRD_OK) {
303 srd_err("Invalid session.");
307 if (!(dec = srd_decoder_get_by_id(decoder_id))) {
308 srd_err("Protocol decoder %s not found.", decoder_id);
312 di = g_malloc0(sizeof(struct srd_decoder_inst));
317 inst_id = g_hash_table_lookup(options, "id");
318 di->inst_id = g_strdup(inst_id ? inst_id : decoder_id);
319 g_hash_table_remove(options, "id");
321 di->inst_id = g_strdup(decoder_id);
324 * Prepare a default channel map, where samples come in the
325 * order in which the decoder class defined them.
327 di->dec_num_channels = g_slist_length(di->decoder->channels) +
328 g_slist_length(di->decoder->opt_channels);
329 if (di->dec_num_channels) {
331 g_malloc(sizeof(int) * di->dec_num_channels);
332 for (i = 0; i < di->dec_num_channels; i++)
333 di->dec_channelmap[i] = i;
335 * Will be used to prepare a sample at every iteration
336 * of the instance's decode() method.
338 di->channel_samples = g_malloc(di->dec_num_channels);
341 /* Create a new instance of this decoder class. */
342 if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
343 if (PyErr_Occurred())
344 srd_exception_catch("Failed to create %s instance",
346 g_free(di->dec_channelmap);
351 if (options && srd_inst_option_set(di, options) != SRD_OK) {
352 g_free(di->dec_channelmap);
357 /* Instance takes input from a frontend by default. */
358 sess->di_list = g_slist_append(sess->di_list, di);
364 * Stack a decoder instance on top of another.
366 * @param sess The session holding the protocol decoder instances.
367 * @param di_bottom The instance on top of which di_top will be stacked.
368 * @param di_top The instance to go on top.
370 * @return SRD_OK upon success, a (negative) error code otherwise.
374 SRD_API int srd_inst_stack(struct srd_session *sess,
375 struct srd_decoder_inst *di_bottom,
376 struct srd_decoder_inst *di_top)
379 if (session_is_valid(sess) != SRD_OK) {
380 srd_err("Invalid session.");
384 if (!di_bottom || !di_top) {
385 srd_err("Invalid from/to instance pair.");
389 if (g_slist_find(sess->di_list, di_top)) {
390 /* Remove from the unstacked list. */
391 sess->di_list = g_slist_remove(sess->di_list, di_top);
394 /* Stack on top of source di. */
395 di_bottom->next_di = g_slist_append(di_bottom->next_di, di_top);
397 srd_dbg("Stacked %s onto %s.", di_top->inst_id, di_bottom->inst_id);
403 * Find a decoder instance by its instance ID.
405 * Only the bottom level of instances are searched -- instances already stacked
406 * on top of another one will not be found.
408 * @param sess The session holding the protocol decoder instance.
409 * @param inst_id The instance ID to be found.
411 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
415 SRD_API struct srd_decoder_inst *srd_inst_find_by_id(struct srd_session *sess,
419 struct srd_decoder_inst *tmp, *di;
421 if (session_is_valid(sess) != SRD_OK) {
422 srd_err("Invalid session.");
427 for (l = sess->di_list; l; l = l->next) {
429 if (!strcmp(tmp->inst_id, inst_id)) {
438 static struct srd_decoder_inst *srd_sess_inst_find_by_obj(
439 struct srd_session *sess, const GSList *stack,
443 struct srd_decoder_inst *tmp, *di;
445 if (session_is_valid(sess) != SRD_OK) {
446 srd_err("Invalid session.");
451 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
453 if (tmp->py_inst == obj)
455 else if (tmp->next_di)
456 di = srd_sess_inst_find_by_obj(sess, tmp->next_di, obj);
463 * Find a decoder instance by its Python object.
465 * I.e. find that instance's instantiation of the sigrokdecode.Decoder class.
466 * This will recurse to find the instance anywhere in the stack tree of all
469 * @param stack Pointer to a GSList of struct srd_decoder_inst, indicating the
470 * stack to search. To start searching at the bottom level of
471 * decoder instances, pass NULL.
472 * @param obj The Python class instantiation.
474 * @return Pointer to struct srd_decoder_inst, or NULL if not found.
480 SRD_PRIV struct srd_decoder_inst *srd_inst_find_by_obj(const GSList *stack,
483 struct srd_decoder_inst *di;
484 struct srd_session *sess;
488 for (l = sessions; di == NULL && l != NULL; l = l->next) {
490 di = srd_sess_inst_find_by_obj(sess, stack, obj);
497 SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
501 struct srd_decoder_inst *next_di;
504 srd_dbg("Calling start() method on protocol decoder instance %s.",
507 if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
508 srd_exception_catch("Protocol decoder instance %s",
510 return SRD_ERR_PYTHON;
514 /* Start all the PDs stacked on top of this one. */
515 for (l = di->next_di; l; l = l->next) {
517 if ((ret = srd_inst_start(next_di)) != SRD_OK)
525 * Decode a chunk of samples.
527 * @param di The decoder instance to call. Must not be NULL.
528 * @param start_samplenum The starting sample number for the buffer's sample
529 * set, relative to the start of capture.
530 * @param end_samplenum The ending sample number for the buffer's sample
531 * set, relative to the start of capture.
532 * @param inbuf The buffer to decode. Must not be NULL.
533 * @param inbuflen Length of the buffer. Must be > 0.
534 * @param unitsize The number of bytes per sample. Must be > 0.
536 * @return SRD_OK upon success, a (negative) error code otherwise.
540 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
541 uint64_t start_samplenum, uint64_t end_samplenum,
542 const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
548 /* Return an error upon unusable input. */
550 srd_dbg("empty decoder instance");
554 srd_dbg("NULL buffer pointer");
558 srd_dbg("empty buffer");
562 srd_dbg("unitsize 0");
566 ((struct srd_decoder_inst *)di)->data_unitsize = unitsize;
568 srd_dbg("Decoding: start sample %" PRIu64 ", end sample %"
569 PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
570 "%d), instance %s.", start_samplenum, end_samplenum,
571 end_samplenum - start_samplenum, inbuflen, di->data_unitsize,
574 apiver = srd_decoder_apiver(di->decoder);
578 * Create new srd_logic object. Each iteration around the PD's
579 * loop will fill one sample into this object.
581 logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type);
583 logic->di = (struct srd_decoder_inst *)di;
584 logic->start_samplenum = start_samplenum;
586 logic->inbuf = (uint8_t *)inbuf;
587 logic->inbuflen = inbuflen;
588 logic->sample = PyList_New(2);
589 Py_INCREF(logic->sample);
591 Py_IncRef(di->py_inst);
592 if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
593 "KKO", start_samplenum, end_samplenum, logic))) {
594 srd_exception_catch("Protocol decoder instance %s",
596 return SRD_ERR_PYTHON;
605 SRD_PRIV void srd_inst_free(struct srd_decoder_inst *di)
608 struct srd_pd_output *pdo;
610 srd_dbg("Freeing instance %s", di->inst_id);
612 Py_DecRef(di->py_inst);
614 g_free(di->dec_channelmap);
615 g_slist_free(di->next_di);
616 for (l = di->pd_output; l; l = l->next) {
618 g_free(pdo->proto_id);
621 g_slist_free(di->pd_output);
626 SRD_PRIV void srd_inst_free_all(struct srd_session *sess, GSList *stack)
629 struct srd_decoder_inst *di;
631 if (session_is_valid(sess) != SRD_OK) {
632 srd_err("Invalid session.");
637 for (l = stack ? stack : sess->di_list; di == NULL && l != NULL; l = l->next) {
640 srd_inst_free_all(sess, di->next_di);
644 g_slist_free(sess->di_list);
645 sess->di_list = NULL;