use COMMAND_REGISTER macro
[fw/openocd] / src / xsvf / xsvf.c
index d00c47c6dd55d69b32fe27da2d1756bf8c64bfb8..82ddb84b992a19a57de62b49921f4426296129db 100644 (file)
@@ -123,7 +123,6 @@ LSDR 1  TDI  (0)
 
 #define XSTATE_MAX_PATH 12
 
-static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 static int xsvf_fd = 0;
 
@@ -161,14 +160,6 @@ static tap_state_t xsvf_to_tap(int xsvf_state)
 
 
 
-int xsvf_register_commands(struct command_context_s *cmd_ctx)
-{
-       register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command,
-               COMMAND_EXEC, "run xsvf <file> [virt2] [quiet]");
-
-       return ERROR_OK;
-}
-
 static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf)
 {
        int num_bytes;
@@ -184,7 +175,7 @@ static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf)
 }
 
 
-static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_xsvf_command)
 {
        uint8_t *dr_out_buf = NULL;                             /* from host to device (TDI) */
        uint8_t *dr_in_buf = NULL;                              /* from device to host (TDO) */
@@ -211,50 +202,57 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
        int             tdo_mismatch = 0;
        int             result;
        int             verbose = 1;
-       char*   filename;
 
-       int             runtest_requires_tck = 0;       /* a flag telling whether to clock TCK during waits, or simply sleep, controled by virt2 */
+       bool            collecting_path = false;
+       tap_state_t     path[XSTATE_MAX_PATH];
+       unsigned        pathlen = 0;
+
+       /* a flag telling whether to clock TCK during waits,
+        * or simply sleep, controled by virt2
+        */
+       int             runtest_requires_tck = 0;
 
 
        /* use NULL to indicate a "plain" xsvf file which accounts for
           additional devices in the scan chain, otherwise the device
           that should be affected
        */
-       jtag_tap_t *tap = NULL;
+       struct jtag_tap *tap = NULL;
 
-       if (argc < 2)
+       if (CMD_ARGC < 2)
        {
-               command_print(cmd_ctx, "usage: xsvf <device#|plain> <file> [<variant>] [quiet]");
+               command_print(CMD_CTX, "usage: xsvf <device#|plain> <file> [<variant>] [quiet]");
                return ERROR_FAIL;
        }
 
-       filename = args[1];             /* we mess with args starting point below, snapshot filename here */
+       /* we mess with CMD_ARGV starting point below, snapshot filename here */
+       const char *filename = CMD_ARGV[1];
 
-       if (strcmp(args[0], "plain") != 0)
+       if (strcmp(CMD_ARGV[0], "plain") != 0)
        {
-               tap = jtag_tap_by_string(args[0]);
+               tap = jtag_tap_by_string(CMD_ARGV[0]);
                if (!tap)
                {
-                       command_print(cmd_ctx, "Tap: %s unknown", args[0]);
+                       command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[0]);
                        return ERROR_FAIL;
                }
        }
 
        if ((xsvf_fd = open(filename, O_RDONLY)) < 0)
        {
-               command_print(cmd_ctx, "file \"%s\" not found", filename);
+               command_print(CMD_CTX, "file \"%s\" not found", filename);
                return ERROR_FAIL;
        }
 
        /* if this argument is present, then interpret xruntest counts as TCK cycles rather than as usecs */
-       if ((argc > 2) && (strcmp(args[2], "virt2") == 0))
+       if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "virt2") == 0))
        {
                runtest_requires_tck = 1;
-               --argc;
-               ++args;
+               --CMD_ARGC;
+               ++CMD_ARGV;
        }
 
-       if ((argc > 2) && (strcmp(args[2], "quiet") == 0))
+       if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "quiet") == 0))
        {
                verbose = 0;
        }
@@ -263,9 +261,88 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        while (read(xsvf_fd, &opcode, 1) > 0)
        {
-               /* record the position of the just read opcode within the file */
+               /* record the position of this opcode within the file */
                file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1;
 
+               /* maybe collect another state for a pathmove();
+                * or terminate a path.
+                */
+               if (collecting_path) {
+                       tap_state_t     mystate;
+                       uint8_t         uc;
+
+                       switch (opcode) {
+                       case XCOMMENT:
+                               /* ignore/show comments between XSTATE ops */
+                               break;
+                       case XSTATE:
+                               /* try to collect another transition */
+                               if (pathlen == XSTATE_MAX_PATH) {
+                                       LOG_ERROR("XSVF: path too long");
+                                       do_abort = 1;
+                                       break;
+                               }
+
+                               if (read(xsvf_fd, &uc, 1) < 0)
+                               {
+                                       do_abort = 1;
+                                       break;
+                               }
+
+                               mystate = xsvf_to_tap(uc);
+                               path[pathlen++] = mystate;
+
+                               LOG_DEBUG("XSTATE 0x%02X %s", uc,
+                                               tap_state_name(mystate));
+
+                               /* If path is incomplete, collect more */
+                               if (!svf_tap_state_is_stable(mystate))
+                                       continue;
+
+                               /* Else execute the path transitions we've
+                                * collected so far.
+                                *
+                                * NOTE:  Punting on the saved path is not
+                                * strictly correct, but we must to do this
+                                * unless jtag_add_pathmove() stops rejecting
+                                * paths containing RESET.  This is probably
+                                * harmless, since there aren't many options
+                                * for going from a stable state to reset;
+                                * at the worst, we may issue extra clocks
+                                * once we get to RESET.
+                                */
+                               if (mystate == TAP_RESET) {
+                                       LOG_WARNING("XSVF: dodgey RESET");
+                                       path[0] = mystate;
+                               }
+
+                               /* FALL THROUGH */
+                       default:
+                               /* Execute the path we collected
+                                *
+                                * NOTE: OpenOCD requires something that XSVF
+                                * doesn't:  the last TAP state in the path
+                                * must be stable.  In practice, tools that
+                                * create XSVF seem to follow that rule too.
+                                */
+                               collecting_path = false;
+
+                               if (path[0] == TAP_RESET)
+                                       jtag_add_tlr();
+                               else
+                                       jtag_add_pathmove(pathlen, path);
+
+                               result = jtag_get_error();
+                               if (result != ERROR_OK) {
+                                       LOG_ERROR("XSVF: pathmove error %d",
+                                                       result);
+                                       do_abort = 1;
+                                       break;
+                               }
+                               continue;
+                       }
+               }
+
                switch (opcode)
                {
                case XCOMPLETE:
@@ -368,7 +445,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                for (attempt = 0; attempt < limit;  ++attempt)
                                {
-                                       scan_field_t field;
+                                       struct scan_field field;
 
                                        if (attempt > 0)
                                        {
@@ -393,7 +470,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                                        TAP_IDLE,
                                                };
 
-                                               jtag_add_pathmove(DIM(exception_path), exception_path);
+                                               jtag_add_pathmove(ARRAY_SIZE(exception_path), exception_path);
 
                                                if (verbose)
                                                        LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt);
@@ -402,7 +479,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        field.tap = tap;
                                        field.num_bits = xsdrsize;
                                        field.out_value = dr_out_buf;
-                                       field.in_value = calloc(CEIL(field.num_bits, 8), 1);
+                                       field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
 
                                        if (tap == NULL)
                                                jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
@@ -500,6 +577,12 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate));
 
+                               if (mystate == TAP_INVALID) {
+                                       LOG_ERROR("XSVF: bad XSTATE %02x", uc);
+                                       do_abort = 1;
+                                       break;
+                               }
+
                                /* NOTE: the current state is SVF-stable! */
 
                                /* no change == NOP */
@@ -518,19 +601,12 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                /*
                                 * A sequence of XSTATE transitions, each TAP
-                                * state adjacent to the previous one.
-                                *
-                                * NOTE: OpenOCD requires something that XSVF
-                                * doesn't:  the last TAP state in the path
-                                * must be stable.
-                                *
-                                * FIXME Implement path collection; submit via
-                                * jtag_add_pathmove() after teaching it to
-                                * report errors.
+                                * state adjacent to the previous one.  Start
+                                * collecting them.
                                 */
-                               LOG_ERROR("XSVF: 'XSTATE %s' ... NYET",
-                                               tap_state_name(mystate));
-                               unsupported = 1;
+                               collecting_path = true;
+                               pathlen = 1;
+                               path[0] = mystate;
                        }
                        break;
 
@@ -616,7 +692,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        do_abort = 1;
                                else
                                {
-                                       scan_field_t field;
+                                       struct scan_field field;
 
                                        field.tap = tap;
                                        field.num_bits = bitcount;
@@ -848,7 +924,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                for (attempt = 0; attempt < limit;  ++attempt)
                                {
-                                       scan_field_t field;
+                                       struct scan_field field;
 
                                        result = svf_add_statemove(loop_state);
                                        jtag_add_clocks(loop_clocks);
@@ -857,7 +933,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        field.tap = tap;
                                        field.num_bits = xsdrsize;
                                        field.out_value = dr_out_buf;
-                                       field.in_value = calloc(CEIL(field.num_bits, 8), 1);
+                                       field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
 
                                        if (attempt > 0 && verbose)
                                                LOG_USER("LSDR retry %d", attempt);
@@ -936,7 +1012,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        if (tdo_mismatch)
        {
-               command_print(cmd_ctx, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting",
+               command_print(CMD_CTX, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting",
                                          file_offset);
 
 
@@ -946,7 +1022,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
        if (unsupported)
        {
                off_t offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1;
-               command_print(cmd_ctx,
+               command_print(CMD_CTX,
                                "unsupported xsvf command (0x%02X) at offset %jd, aborting",
                                uc, (intmax_t)offset);
                return ERROR_FAIL;
@@ -954,7 +1030,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        if (do_abort)
        {
-               command_print(cmd_ctx, "premature end of xsvf file detected, aborting");
+               command_print(CMD_CTX, "premature end of xsvf file detected, aborting");
                return ERROR_FAIL;
        }
 
@@ -969,11 +1045,19 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        close(xsvf_fd);
 
-       command_print(cmd_ctx, "XSVF file programmed successfully");
+       command_print(CMD_CTX, "XSVF file programmed successfully");
 
        return ERROR_OK;
 }
 
+int xsvf_register_commands(struct command_context *cmd_ctx)
+{
+       COMMAND_REGISTER(cmd_ctx, NULL, "xsvf",
+                       &handle_xsvf_command, COMMAND_EXEC,
+                       "run xsvf <file> [virt2] [quiet]");
+
+       return ERROR_OK;
+}
 
 #if 0   /* this comment style used to try and keep uncrustify from adding * at begin of line */