jtag_tap_t -> struct jtag_tap
[openocd.git] / src / xsvf / xsvf.c
index d00c47c6dd55d69b32fe27da2d1756bf8c64bfb8..e1a30e6e0caf37426a5a2834e718acf5da68ccfd 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,16 +202,22 @@ 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)
        {
@@ -228,7 +225,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                return ERROR_FAIL;
        }
 
-       filename = args[1];             /* we mess with args starting point below, snapshot filename here */
+       /* we mess with args starting point below, snapshot filename here */
+       const char *filename = args[1];
 
        if (strcmp(args[0], "plain") != 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:
@@ -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;
 
@@ -974,6 +1050,14 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
        return ERROR_OK;
 }
 
+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;
+}
 
 #if 0   /* this comment style used to try and keep uncrustify from adding * at begin of line */
 

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)