]> sigrok.org Git - sigrok-test.git/blobdiff - decoder/runtc.c
usb_{signalling,packet,request}: Add another test-case.
[sigrok-test.git] / decoder / runtc.c
index bbeb40ef04ecc3929ce86707b73685f2c4eb5d02..ec8c812f745b031985eb392ed62ee02fe47e3216 100644 (file)
@@ -52,14 +52,21 @@ struct option {
        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;
        int class_idx;
@@ -136,15 +143,17 @@ static void usage(const char *msg)
        if (msg)
                fprintf(stderr, "%s\n", msg);
 
-       printf("Usage: runtc [-dPpoiOf]\n");
-       printf("  -d  Debug\n");
-       printf("  -P  <protocol decoder>\n");
-       printf("  -p  <channelname=channelnum> (optional)\n");
-       printf("  -o  <channeloption=value> (optional)\n");
+       printf("Usage: runtc [-dPpoiOfcS]\n");
+       printf("  -d  (enables debug output)\n");
+       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");
        printf("  -c <coverage report> (optional)\n");
+       printf("  -S  (enables statistics)\n");
        exit(msg ? 1 : 0);
 
 }
@@ -167,6 +176,28 @@ static char *py_str_as_str(const PyObject *py_str)
        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;
@@ -179,7 +210,7 @@ static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data)
        pydata = pdata->data;
        DBG("ptr %p", pydata);
 
-       if (strcmp(pdata->pdo->di->inst_id, op->pd))
+       if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
                /* This is not the PD selected for output. */
                return;
 
@@ -190,11 +221,11 @@ static void srd_cb_py(struct srd_proto_data *pdata, void *cb_data)
        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,
-                       pdata->pdo->di->inst_id, s);
+                       pdata->pdo->di->decoder->id, s);
        g_free(s);
        if (write(op->outfd, out->str, out->len) == -1)
                ERR("SRD_OUTPUT_PYTHON callback write failure!");
@@ -214,7 +245,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data)
        op = cb_data;
        pdb = pdata->data;
 
-       if (strcmp(pdata->pdo->di->inst_id, op->pd))
+       if (strcmp(pdata->pdo->di->inst_id, op->pd_id))
                /* This is not the PD selected for output. */
                return;
 
@@ -228,7 +259,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data)
        out = g_string_sized_new(128);
        g_string_printf(out, "%" PRIu64 "-%" PRIu64 " %s:",
                        pdata->start_sample, pdata->end_sample,
-                       pdata->pdo->di->inst_id);
+                       pdata->pdo->di->decoder->id);
        for (i = 0; i < pdb->size; i++) {
                g_string_append_printf(out, " %.2x", pdb->data[i]);
        }
@@ -240,6 +271,7 @@ static void srd_cb_bin(struct srd_proto_data *pdata, void *cb_data)
 
 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;
@@ -247,11 +279,17 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data)
        int i;
        char **dec_ann;
 
-       DBG("Annotation output from %s", pdata->pdo->di->inst_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->inst_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;
 
@@ -262,11 +300,17 @@ static void srd_cb_ann(struct srd_proto_data *pdata, void *cb_data)
                 */
                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->inst_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");
@@ -338,13 +382,15 @@ static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
        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) {
@@ -410,6 +456,17 @@ static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
                        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,
@@ -429,6 +486,28 @@ static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
                        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)
+                               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.
@@ -441,8 +520,14 @@ static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
                }
                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)
+               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->type == SRD_OUTPUT_ANN)
@@ -458,16 +543,16 @@ static int run_testcase(const char *infile, GSList *pdlist, struct output *op)
                        if (!strcmp(decoder_class[0], op->class)) {
                                op->class_idx = idx;
                                break;
-                       } else
-                               idx++;
+                       }
+                       idx++;
                        l = l->next;
                }
                if (op->class_idx == -1) {
                        ERR("Output class '%s' not found in decoder %s.",
                                        op->class, pd->name);
                        return FALSE;
-               } else
-                       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);
@@ -714,9 +799,11 @@ int main(int argc, char **argv)
        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_idx = -1;
@@ -726,7 +813,7 @@ int main(int argc, char **argv)
        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;
@@ -734,11 +821,12 @@ int main(int argc, char **argv)
                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);
@@ -754,16 +842,22 @@ int main(int argc, char **argv)
                        if (c == 'p') {
                                channel = malloc(sizeof(struct channel));
                                channel->name = g_strdup(kv[0]);
-                               channel->channel = strtoul(kv[1], 0, 10);
+                               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);
+                               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':