Audit and eliminate redundant #include directives in src/{pld,svf,xsvf}.
[openocd.git] / src / xsvf / xsvf.c
index 4e1f23e069310f2a5e9c91bbab431e2ca957bb0a..b62de349d5d68466c29e2ba1e879ffffd8bb3e68 100644 (file)
 #endif
 
 #include "xsvf.h"
-
 #include "jtag.h"
-#include "command.h"
-#include "log.h"
-
-#include <stdlib.h>
-#include <unistd.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <string.h>
 
-#include <sys/time.h>
-#include <time.h>
+#include <assert.h>
 
 
 /* XSVF commands, from appendix B of xapp503.pdf  */
@@ -173,46 +162,92 @@ static tap_state_t xsvf_to_tap( int xsvf_state )
 }
 
 
-/* xsvf has it's own definition of a statemove. This needs
- * to be handled according to the xsvf spec, which has nothing
- * to do with the JTAG spec or OpenOCD as such.
- *
- * Implemented via jtag_add_pathmove().
+/**
+ * Function xsvf_add_statemove
+ * moves from the current state to the goal \a state. This needs
+ * to be handled according to the xsvf spec, see the XSTATE command
+ * description.
  */
-static void xsvf_add_statemove(tap_state_t state)
+static int xsvf_add_statemove(tap_state_t goal_state)
 {
-       tap_state_t moves[7];   /* max # of transitions */
-       tap_state_t curstate = cmd_queue_cur_state;
+       int retval = ERROR_OK;
+
+       tap_state_t moves[8];
+       tap_state_t cur_state = cmd_queue_cur_state;
        int i;
+       int tms_bits;
+       int     tms_count;
 
-       u8 move = tap_get_tms_path(cmd_queue_cur_state, state);
+       LOG_DEBUG( "cur_state=%s goal_state=%s",
+               tap_state_name(cur_state),
+               tap_state_name(goal_state) );
+
+
+       /*      From the XSVF spec, pertaining to XSTATE:
+
+               For special states known as stable states (Test-Logic-Reset,
+               Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
+               predefined TAP state paths when the starting state is a stable state and
+               when the XSTATE specifies a new stable state (see the STATE command in
+               the [Ref 5] for the TAP state paths between stable states). For
+               non-stable states, XSTATE should specify a state that is only one TAP
+               state transition distance from the current TAP state to avoid undefined
+               TAP state paths. A sequence of multiple XSTATE commands can be issued to
+               transition the TAP through a specific state path.
+       */
 
-       if (state != TAP_RESET  &&  state==cmd_queue_cur_state)
-               return;
+       if (goal_state==cur_state )
+               ;       /* nothing to do */
 
-       if(state==TAP_RESET)
+       else if( goal_state==TAP_RESET )
        {
                jtag_add_tlr();
-               return;
        }
 
-       for (i=0; i<7; i++)
+       else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
        {
-               int j = (move >> i) & 1;
-               if (j)
-               {
-                       curstate = tap_state_transition(curstate, true);
-               }
-               else
+               /*      note: unless tms_bits holds a path that agrees with [Ref 5] in above
+                       spec, then this code is not fully conformant to the xsvf spec.  This
+                       puts a burden on tap_get_tms_path() function from the xsvf spec.
+                       If in doubt, you should confirm that that burden is being met.
+               */
+
+               tms_bits  = tap_get_tms_path(cur_state, goal_state);
+               tms_count = tap_get_tms_path_len(cur_state, goal_state);
+
+               assert( (unsigned) tms_count < DIM(moves) );
+
+               for (i=0;   i<tms_count;   i++, tms_bits>>=1)
                {
-                       curstate = tap_state_transition(curstate, false);
+                       bool bit = tms_bits & 1;
+
+                       cur_state = tap_state_transition(cur_state, bit);
+                       moves[i] = cur_state;
                }
-               moves[i] = curstate;
+
+               jtag_add_pathmove(tms_count, moves);
+       }
+
+       /*      else state must be immediately reachable in one clock cycle, and does not
+               need to be a stable state.
+       */
+       else if( tap_state_transition(cur_state, true)  == goal_state
+               ||   tap_state_transition(cur_state, false) == goal_state )
+       {
+               /* move a single state */
+               moves[0] = goal_state;
+               jtag_add_pathmove( 1, moves );
+       }
+
+       else
+       {
+               retval = ERROR_FAIL;
        }
 
-       jtag_add_pathmove(7, moves);
+       return retval;
 }
 
+
 int xsvf_register_commands(struct command_context_s *cmd_ctx)
 {
        register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command,
@@ -236,38 +271,6 @@ static int xsvf_read_buffer(int num_bits, int fd, u8* buf)
 }
 
 
-static int xsvf_read_xstates(int fd, tap_state_t *path, int max_path, int *path_len)
-{
-       char c;
-       u8   uc;
-
-       while ((read(fd, &c, 1) > 0) && (c == XSTATE))
-       {
-               tap_state_t     mystate;
-
-               if (*path_len > max_path)
-               {
-                       LOG_WARNING("XSTATE path longer than max_path");
-                       break;
-               }
-               if (read(fd, &uc, 1) < 0)
-               {
-                       return ERROR_XSVF_EOF;
-               }
-
-               mystate = xsvf_to_tap(uc);
-
-               LOG_DEBUG("XSTATE %02X %s", uc, tap_state_name(mystate) );
-
-               path[(*path_len)++] = mystate;
-       }
-
-       lseek(fd, -1, SEEK_CUR);
-
-       return ERROR_OK;
-}
-
-
 static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        u8 *dr_out_buf = NULL;                          /* from host to device (TDI) */
@@ -477,7 +480,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                                        TAP_IDLE,
                                                };
 
-                                               jtag_add_pathmove( sizeof(exception_path)/sizeof(exception_path[0]), exception_path);
+                                               jtag_add_pathmove( DIM(exception_path), exception_path );
 
                                                if (verbose)
                                                        LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt);
@@ -486,16 +489,18 @@ 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.out_mask = NULL;
-                                       field.in_value = NULL;
-
-                                       jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
+                                       field.in_value = calloc(CEIL(field.num_bits, 8), 1);
 
                                        if (tap == NULL)
                                                jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
                                        else
                                                jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
 
+                                       jtag_check_value_mask(&field, dr_in_buf, dr_in_mask);
+
+                                       free(field.in_value);
+
+
                                        /* LOG_DEBUG("FLUSHING QUEUE"); */
                                        result = jtag_execute_queue();
                                        if (result == ERROR_OK)
@@ -570,8 +575,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                case XSTATE:
                        {
                                tap_state_t     mystate;
-                               tap_state_t*    path;
-                               int                     path_len;
+                               u8                      uc;
 
                                if (read(xsvf_fd, &uc, 1) < 0)
                                {
@@ -583,38 +587,32 @@ 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) );
 
-                               path = calloc(XSTATE_MAX_PATH, 4);
-                               path_len = 1;
+                               /*      there is no need for the lookahead code that was here since we
+                                       queue up the jtag commands anyway.  This is a simple way to handle
+                                       the XSTATE.
+                               */
 
-                               path[0] = mystate;
-                               if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK)
-                                       do_abort = 1;
-                               else
+                               if( xsvf_add_statemove( mystate ) != ERROR_OK )
                                {
-                                       int i,lasti;
-
-                                       /* here the trick is that jtag_add_pathmove() must end in a stable
-                                        * state, so we must only invoke jtag_add_tlr() when we absolutely
-                                        * have to
-                                        */
-                                       for(i=0,lasti=0;  i<path_len;  i++)
-                                       {
-                                               if(path[i]==TAP_RESET)
-                                               {
-                                                       if(i>lasti)
-                                                       {
-                                                               jtag_add_pathmove(i-lasti,path+lasti);
-                                                       }
-                                                       lasti=i+1;
-                                                       jtag_add_tlr();
-                                               }
-                                       }
-                                       if(i>=lasti)
-                                       {
-                                               jtag_add_pathmove(i-lasti, path+lasti);
-                                       }
+                                       /*      For special states known as stable states
+                                               (Test-Logic-Reset, Run-Test/Idle, Pause-DR, Pause- IR),
+                                               an XSVF interpreter follows predefined TAP state paths
+                                               when the starting state is a stable state and when the
+                                               XSTATE specifies a new stable state (see the STATE
+                                               command in the [Ref 5] for the TAP state paths between
+                                               stable states). For non-stable states, XSTATE should
+                                               specify a state that is only one TAP state transition
+                                               distance from the current TAP state to avoid undefined
+                                               TAP state paths. A sequence of multiple XSTATE commands
+                                               can be issued to transition the TAP through a specific
+                                               state path.
+                                       */
+
+                                       LOG_ERROR("XSTATE %s is not reachable from current state %s in one clock cycle",
+                                               tap_state_name(mystate),
+                                               tap_state_name(cmd_queue_cur_state)
+                                               );
                                }
-                               free(path);
                        }
                        break;
 
@@ -705,12 +703,11 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        field.tap = tap;
                                        field.num_bits = bitcount;
                                        field.out_value = ir_buf;
-                                       field.out_mask = NULL;
+
                                        field.in_value = NULL;
-                                       field.in_check_value = NULL;
-                                       field.in_check_mask = NULL;
-                                       field.in_handler = NULL;
-                                       field.in_handler_priv = NULL;
+
+
+                                       
 
                                        if (tap == NULL)
                                                jtag_add_plain_ir_scan(1, &field, my_end_state);
@@ -761,7 +758,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                comment[sizeof(comment)-1] = 0;         /* regardless, terminate */
                                if (verbose)
-                                       LOG_USER(comment);
+                                       LOG_USER("# %s", comment);
                        }
                        break;
 
@@ -937,18 +934,21 @@ 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.out_mask = NULL;
-                                       field.in_value = NULL;
+                                       field.in_value = calloc(CEIL(field.num_bits, 8), 1);
 
                                        if (attempt > 0 && verbose)
                                                LOG_USER("LSDR retry %d", attempt);
 
-                                       jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
                                        if (tap == NULL)
                                                jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
                                        else
                                                jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
 
+                                       jtag_check_value_mask(&field, dr_in_buf, dr_in_mask);
+
+                                       free(field.in_value);
+
+
                                        /* LOG_DEBUG("FLUSHING QUEUE"); */
                                        result = jtag_execute_queue();
                                        if(result == ERROR_OK)

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)