* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include <config.h>
+
#include <Python.h>
#include <libsigrokdecode/libsigrokdecode.h>
#include <libsigrok/libsigrok.h>
GVariant *value;
};
+struct initial_pin_info {
+ char *name;
+ int value;
+};
+
struct pd {
const char *name;
GSList *channels;
GSList *options;
+ GSList *initial_pins;
};
struct output {
const char *pd;
+ const char *pd_id;
int type;
- const char *class;
+ const char *class_;
int class_idx;
const char *outfile;
int outfd;
printf(" -P <protocol decoder>\n");
printf(" -p <channelname=channelnum> (optional)\n");
printf(" -o <channeloption=value> (optional)\n");
+ printf(" -N <channelname=initial-pin-value> (optional)\n");
printf(" -i <input file>\n");
printf(" -O <output-pd:output-type[:output-class]>\n");
printf(" -f <output file> (optional)\n");
return outstr;
}
+/*
+ * The following routines are callbacks for libsigrokdecode. They receive
+ * output from protocol decoders, optionally dropping data to only forward
+ * a selected decoder's or class' information. Output is written to either
+ * a specified file or stdout, an external process will compare captured
+ * output against expectations.
+ *
+ * Note that runtc(1) output emits the decoder "class" name instead of the
+ * instance name. So that generated output remains compatible with existing
+ * .output files which hold expected output of test cases. Without this
+ * approach, developers had to "anticipate" instance names from test.conf
+ * setups (and knowledge about internal implementation details of the srd
+ * library), and adjust .output files to reflect those names. Or specify
+ * instance names in each and every test.conf description (-o inst_id=ID).
+ *
+ * It's assumed that runtc(1) is used to check stacked decoders, but not
+ * multiple stacks in parallel and no stacks with multiple instances of
+ * decoders of the same type. When such configurations become desirable,
+ * runtc(1) needs to emit the instance name, and test configurations and
+ * output expectations need adjustment.
+ */
+
static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data)
{
struct output *op;
GString *out;
char *s;
- DBG("Python output from %s", pdata->pdo->di->decoder->id);
+ DBG("Python output from %s", pdata->pdo->di->inst_id);
op = cb_data;
pydata = pdata->data;
DBG("ptr %p", pydata);
- if (strcmp(pdata->pdo->di->decoder->id, op->pd))
+ if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
/* This is not the PD selected for output. */
return;
s = py_str_as_str(pyrepr);
Py_DecRef(pyrepr);
- /* Output format for testing is '<ss>-<es> <inst-id>: <repr>\n'. */
+ /* Output format for testing is '<ss>-<es> <decoder-id>: <repr>\n'. */
out = g_string_sized_new(128);
g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s: %s\n",
pdata->start_sample, pdata->end_sample,
GString *out;
unsigned int i;
- DBG("Binary output from %s", pdata->pdo->di->decoder->id);
+ DBG("Binary output from %s", pdata->pdo->di->inst_id);
op = cb_data;
pdb = pdata->data;
- if (strcmp(pdata->pdo->di->decoder->id, op->pd))
+ if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
/* This is not the PD selected for output. */
return;
static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data)
{
+ struct srd_decoder_inst *di;
struct srd_decoder *dec;
struct srd_proto_data_annotation *pda;
struct output *op;
int i;
char **dec_ann;
- DBG("Annotation output from %s", pdata->pdo->di->decoder->id);
+ /*
+ * Only inspect received annotations when they originate from
+ * the selected protocol decoder, and an optionally specified
+ * annotation class matches the received data.
+ */
op = cb_data;
pda = pdata->data;
- dec = pdata->pdo->di->decoder;
- if (strcmp(pdata->pdo->di->decoder->id, op->pd))
+ di = pdata->pdo->di;
+ dec = di->decoder;
+ DBG("Annotation output from %s", di->inst_id);
+ if (strcmp(di->inst_id, op->pd_id))
/* This is not the PD selected for output. */
return;
*/
return;
+ /*
+ * Print the annotation information in textual representation
+ * to the specified output file. Prefix the annotation strings
+ * with the start and end sample number, the decoder name, and
+ * the annotation name.
+ */
dec_ann = g_slist_nth_data(dec->annotations, pda->ann_class);
line = g_string_sized_new(256);
g_string_printf(line, "%" PRIu64 "-%" PRIu64 " %s: %s:",
pdata->start_sample, pdata->end_sample,
- pdata->pdo->di->decoder->id, dec_ann[0]);
+ dec->id, dec_ann[0]);
for (i = 0; pda->ann_text[i]; i++)
g_string_append_printf(line, " \"%s\"", pda->ann_text[i]);
g_string_append(line, "\n");
const struct sr_datafeed_packet *packet, void *cb_data)
{
static int samplecnt = 0;
+ static gboolean start_sent;
+
const struct sr_datafeed_logic *logic;
struct srd_session *sess;
+ const struct sr_datafeed_meta *meta;
+ struct sr_config *src;
+ GSList *l;
GVariant *gvar;
uint64_t samplerate;
+ int ret;
int num_samples;
struct sr_dev_driver *driver;
driver = sr_dev_inst_driver_get(sdi);
switch (packet->type) {
+ case SR_DF_META:
+ DBG("Received SR_DF_META");
+ meta = packet->payload;
+ for (l = meta->config; l; l = l->next) {
+ src = l->data;
+ switch (src->key) {
+ case SR_CONF_SAMPLERATE:
+ samplerate = g_variant_get_uint64(src->data);
+ ret = srd_session_metadata_set(sess,
+ SRD_CONF_SAMPLERATE,
+ g_variant_new_uint64(samplerate));
+ if (ret != SRD_OK)
+ ERR("Setting samplerate failed (meta)");
+ break;
+ default:
+ /* EMPTY */
+ break;
+ }
+ }
+ break;
case SR_DF_HEADER:
DBG("Received SR_DF_HEADER");
if (sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
&gvar) != SR_OK) {
- ERR("Getting samplerate failed");
+ DBG("Getting samplerate failed (SR_DF_HEADER)");
break;
}
samplerate = g_variant_get_uint64(gvar);
g_variant_unref(gvar);
- if (srd_session_metadata_set(sess, SRD_CONF_SAMPLERATE,
- g_variant_new_uint64(samplerate)) != SRD_OK) {
- ERR("Setting samplerate failed");
- break;
- }
- if (srd_session_start(sess) != SRD_OK) {
- ERR("Session start failed");
- break;
- }
+ ret = srd_session_metadata_set(sess, SRD_CONF_SAMPLERATE,
+ g_variant_new_uint64(samplerate));
+ if (ret != SRD_OK)
+ ERR("Setting samplerate failed (header)");
break;
case SR_DF_LOGIC:
+ DBG("Received SR_DF_LOGIC");
+ if (!start_sent) {
+ if (srd_session_start(sess) != SRD_OK) {
+ ERR("Session start failed");
+ break;
+ }
+ start_sent = TRUE;
+ }
logic = packet->payload;
num_samples = logic->length / logic->unitsize;
DBG("Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
break;
case SR_DF_END:
DBG("Received SR_DF_END");
+#if defined HAVE_SRD_SESSION_SEND_EOF && HAVE_SRD_SESSION_SEND_EOF
+ (void)srd_session_send_eof(sess);
+#endif
break;
}
struct option *option;
GVariant *gvar;
GHashTable *channels, *opts;
- GSList *pdl, *l, *devices;
+ GSList *pdl, *l, *l2, *devices;
int idx, i;
int max_channel;
char **decoder_class;
struct sr_session *sr_sess;
gboolean is_number;
const char *s;
+ GArray *initial_pins;
+ struct initial_pin_info *initial_pin;
if (op->outfile) {
if ((op->outfd = open(op->outfile, O_CREAT|O_WRONLY, 0600)) == -1) {
}
}
- if (sr_session_load(ctx, infile, &sr_sess) != SR_OK)
+ if (sr_session_load(ctx, infile, &sr_sess) != SR_OK){
+ ERR("sr_session_load() failed");
return FALSE;
+ }
sr_session_dev_list(sr_sess, &devices);
- if (srd_session_new(&sess) != SRD_OK)
+ if (srd_session_new(&sess) != SRD_OK) {
+ ERR("srd_session_new() failed");
return FALSE;
+ }
sr_session_datafeed_callback_add(sr_sess, sr_cb, sess);
switch (op->type) {
case SRD_OUTPUT_ANN:
cb = srd_cb_py;
break;
default:
+ ERR("Invalid op->type");
return FALSE;
}
srd_pd_output_callback_add(sess, op->type, cb, op);
pd = NULL;
for (pdl = pdlist; pdl; pdl = pdl->next) {
pd = pdl->data;
- if (srd_decoder_load(pd->name) != SRD_OK)
+ if (srd_decoder_load(pd->name) != SRD_OK) {
+ ERR("srd_decoder_load() failed");
return FALSE;
+ }
/* Instantiate decoder and pass in options. */
opts = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
g_hash_table_insert(opts, option->key, option->value);
}
}
- if (!(di = srd_inst_new(sess, pd->name, opts)))
+ if (!(di = srd_inst_new(sess, pd->name, opts))) {
+ ERR("srd_inst_new() failed");
return FALSE;
+ }
g_hash_table_destroy(opts);
+ /*
+ * Get (a reference to) the decoder instance's ID if we
+ * are about to receive PD output from it. We need to
+ * filter output that carries the decoder instance's name.
+ */
+ if (strcmp(pd->name, op->pd) == 0) {
+ op->pd_id = di->inst_id;
+ DBG("Decoder of type \"%s\" has instance ID \"%s\".",
+ op->pd, op->pd_id);
+ }
+
/* Map channels. */
if (pd->channels) {
channels = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
g_hash_table_insert(channels, channel->name, gvar);
}
- if (srd_inst_channel_set_all(di, channels) != SRD_OK)
+ if (srd_inst_channel_set_all(di, channels) != SRD_OK) {
+ ERR("srd_inst_channel_set_all() failed");
return FALSE;
+ }
g_hash_table_destroy(channels);
}
+ /* Set initial pins. */
+ if (pd->initial_pins) {
+ initial_pins = g_array_sized_new(FALSE, TRUE, sizeof(uint8_t),
+ di->dec_num_channels);
+ g_array_set_size(initial_pins, di->dec_num_channels);
+ memset(initial_pins->data, SRD_INITIAL_PIN_SAME_AS_SAMPLE0,
+ di->dec_num_channels);
+
+ for (l = pd->channels, idx = 0; l; l = l->next, idx++) {
+ channel = l->data;
+ for (l2 = pd->initial_pins; l2; l2 = l2->next) {
+ initial_pin = l2->data;
+ if (!strcmp(initial_pin->name, channel->name))
+ initial_pins->data[idx] = initial_pin->value;
+ }
+ }
+
+ if (srd_inst_initial_pins_set_all(di, initial_pins) != SRD_OK) {
+ ERR("srd_inst_initial_pins_set_all() failed");
+ return FALSE;
+ }
+ g_array_free(initial_pins, TRUE);
+ }
+
/*
* If this is not the first decoder in the list, stack it
* on top of the previous one.
}
prev_di = di;
}
+ /*
+ * Bail out if we haven't created an instance of the selected
+ * decoder type of which we shall grab output data from.
+ */
+ if (!op->pd_id) {
+ ERR("No / invalid decoder");
+ return FALSE;
+ }
- /* Resolve top decoder's class index, so we can match. */
+ /* Resolve selected decoder's class index, so we can match. */
dec = srd_decoder_get_by_id(pd->name);
- if (op->class) {
+ if (op->class_) {
if (op->type == SRD_OUTPUT_ANN)
l = dec->annotations;
else if (op->type == SRD_OUTPUT_BINARY)
l = dec->binary;
- else
+ else {
/* Only annotations and binary can have a class. */
+ ERR("Invalid decoder class");
return FALSE;
+ }
idx = 0;
while (l) {
decoder_class = l->data;
- if (!strcmp(decoder_class[0], op->class)) {
+ if (!strcmp(decoder_class[0], op->class_)) {
op->class_idx = idx;
break;
}
}
if (op->class_idx == -1) {
ERR("Output class '%s' not found in decoder %s.",
- op->class, pd->name);
+ op->class_, pd->name);
return FALSE;
}
- DBG("Class %s index is %d", op->class, op->class_idx);
+ DBG("Class %s index is %d", op->class_, op->class_idx);
}
sr_session_start(sr_sess);
struct output *op;
int ret, c;
char *opt_infile, **kv, **opstr;
+ struct initial_pin_info *initial_pin;
op = malloc(sizeof(struct output));
op->pd = NULL;
+ op->pd_id = NULL;
op->type = -1;
- op->class = NULL;
+ op->class_ = NULL;
op->class_idx = -1;
op->outfd = 1;
opt_infile = NULL;
pd = NULL;
coverage = NULL;
- while ((c = getopt(argc, argv, "dP:p:o:i:O:f:c:S")) != -1) {
+ while ((c = getopt(argc, argv, "dP:p:o:N:i:O:f:c:S")) != -1) {
switch (c) {
case 'd':
debug = TRUE;
case 'P':
pd = g_malloc(sizeof(struct pd));
pd->name = g_strdup(optarg);
- pd->channels = pd->options = NULL;
+ pd->channels = pd->options = pd->initial_pins = NULL;
pdlist = g_slist_append(pdlist, pd);
break;
case 'p':
case 'o':
+ case 'N':
if (g_slist_length(pdlist) == 0) {
/* No previous -P. */
ERR("Syntax error at '%s'", optarg);
channel->channel = strtoul(kv[1], NULL, 10);
/* Apply to last PD. */
pd->channels = g_slist_append(pd->channels, channel);
- } else {
+ } else if (c == 'o') {
option = malloc(sizeof(struct option));
option->key = g_strdup(kv[0]);
option->value = g_variant_new_string(kv[1]);
g_variant_ref_sink(option->value);
/* Apply to last PD. */
pd->options = g_slist_append(pd->options, option);
+ } else {
+ initial_pin = malloc(sizeof(struct initial_pin_info));
+ initial_pin->name = g_strdup(kv[0]);
+ initial_pin->value = strtoul(kv[1], NULL, 10);
+ /* Apply to last PD. */
+ pd->initial_pins = g_slist_append(pd->initial_pins, initial_pin);
}
break;
case 'i':
usage(NULL);
}
if (opstr[2])
- op->class = g_strdup(opstr[2]);
+ op->class_ = g_strdup(opstr[2]);
g_strfreev(opstr);
break;
case 'f':