add const keyword to some APIs
[openocd.git] / src / xsvf / xsvf.c
index eea5ff16d995353a19105d9401b1f3f783cb69ee..909d7a1e76973b95eb876a0d6795237f8b81f7cb 100644 (file)
@@ -1,31 +1,30 @@
-/***************************************************************************
- *      Copyright (C) 2005 by Dominic Rath                                                                        *
- *      Dominic.Rath@gmx.de                                                                                                       *
- *                                                                                                                                                *
- *      Copyright (C) 2007,2008 Øyvind Harboe                                                             *
- *      oyvind.harboe@zylin.com                                                                                                   *
- *                                                                                                                                                *
- *      Copyright (C) 2008 Peter Hettkamp                                                                         *
- *      peter.hettkamp@htp-tel.de                                                                                         *
- *                                                                                                                                                *
- *      Copyright (C) 2009 SoftPLC Corporation. http://softplc.com             *
- *      Dick Hollenbeck <dick@softplc.com>                                                                        *
- *                                                                          *
- *      This program is free software; you can redistribute it and/or modify   *
- *      it under the terms of the GNU General Public License as published by   *
- *      the Free Software Foundation; either version 2 of the License, or         *
- *      (at your option) any later version.                                                                       *
- *                                                                                                                                                *
- *      This program is distributed in the hope that it will be useful,                   *
- *      but WITHOUT ANY WARRANTY; without even the implied warranty of            *
- *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
- *      GNU General Public License for more details.                                              *
- *                                                                                                                                                *
- *      You should have received a copy of the GNU General Public License         *
- *      along with this program; if not, write to the                                             *
- *      Free Software Foundation, Inc.,                                                                                   *
- *      59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.                         *
- ***************************************************************************/
+/*
+ * Copyright (C) 2005 by Dominic Rath
+ * Dominic.Rath@gmx.de
+ *
+ * Copyright (C) 2007,2008 Øyvind Harboe
+ * oyvind.harboe@zylin.com
+ *
+ * Copyright (C) 2008 Peter Hettkamp
+ * peter.hettkamp@htp-tel.de
+ *
+ * Copyright (C) 2009 SoftPLC Corporation. http://softplc.com
+ * Dick Hollenbeck <dick@softplc.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
 
 
 /* The specification for SVF is available here:
 #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 "svf.h"
 
 
 /* XSVF commands, from appendix B of xapp503.pdf  */
@@ -95,7 +82,7 @@
 
 ! Set the maximum loop count to 25.
 LCOUNT 25;
-! Step to DRPAUSE give 5 clocks and wait for 1.00e+000 SEC.
+! Step to DRPAUSE give 5 clocks and wait for 1.00e + 000 SEC.
 LDELAY DRPAUSE 5 TCK   1.00E-003 SEC;
 ! Test for the completed status. Match means pass.
 ! Loop back to LDELAY line if not match and loop count less than 25.
@@ -136,17 +123,16 @@ 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;
 
 
 /* map xsvf tap state to an openocd "tap_state_t" */
-static tap_state_t xsvf_to_tap( int xsvf_state )
+static tap_state_t xsvf_to_tap(int xsvf_state)
 {
        tap_state_t     ret;
 
-       switch( xsvf_state )
+       switch (xsvf_state)
        {
        case XSV_RESET:                 ret = TAP_RESET;                        break;
        case XSV_IDLE:                  ret = TAP_IDLE;                 break;
@@ -165,7 +151,7 @@ static tap_state_t xsvf_to_tap( int xsvf_state )
        case XSV_IREXIT2:               ret = TAP_IREXIT2;              break;
        case XSV_IRUPDATE:              ret = TAP_IRUPDATE;             break;
        default:
-               LOG_ERROR( "UNKNOWN XSVF STATE 0x%02X", xsvf_state );
+               LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state);
                exit(1);
        }
 
@@ -173,55 +159,8 @@ 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().
- */
-static void xsvf_add_statemove(tap_state_t state)
-{
-       tap_state_t moves[7];   /* max # of transitions */
-       tap_state_t curstate = cmd_queue_cur_state;
-       int i;
-
-       u8 move = tap_get_tms_path(cmd_queue_cur_state, state);
-
-       if (state != TAP_RESET  &&  state==cmd_queue_cur_state)
-               return;
 
-       if(state==TAP_RESET)
-       {
-               jtag_add_tlr();
-               return;
-       }
-
-       for (i=0; i<7; i++)
-       {
-               int j = (move >> i) & 1;
-               if (j)
-               {
-                       curstate = tap_state_transition(curstate, true);
-               }
-               else
-               {
-                       curstate = tap_state_transition(curstate, false);
-               }
-               moves[i] = curstate;
-       }
-
-       jtag_add_pathmove(7, moves);
-}
-
-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, u8* buf)
+static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf)
 {
        int num_bytes;
 
@@ -236,43 +175,11 @@ 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) */
-       u8 *dr_in_buf = NULL;                           /* from device to host (TDO) */
-       u8 *dr_in_mask = NULL;
+       uint8_t *dr_out_buf = NULL;                             /* from host to device (TDI) */
+       uint8_t *dr_in_buf = NULL;                              /* from device to host (TDO) */
+       uint8_t *dr_in_mask = NULL;
 
        int xsdrsize = 0;
        int xruntest = 0;                                       /* number of TCK cycles OR microseconds */
@@ -281,8 +188,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
        tap_state_t     xendir = TAP_IDLE;              /* see page 8 of the SVF spec, initial xendir to be TAP_IDLE */
        tap_state_t xenddr = TAP_IDLE;
 
-       u8              opcode;
-       u8              uc;
+       uint8_t         opcode;
+       uint8_t         uc;
        long            file_offset = 0;
 
        int             loop_count = 0;
@@ -290,14 +197,20 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
        int             loop_clocks = 0;
        int             loop_usecs = 0;
 
-       int             do_abort = 0;
-       int             unsupported = 0;
-       int             tdo_mismatch = 0;
-       int             result;
+       int             do_abort = 0;
+       int             unsupported = 0;
+       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
@@ -312,14 +225,15 @@ 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)
        {
-               tap = jtag_TapByString( args[0] );
-               if (!tap )
+               tap = jtag_tap_by_string(args[0]);
+               if (!tap)
                {
-                       command_print( cmd_ctx, "Tap: %s unknown", args[0] );
+                       command_print(cmd_ctx, "Tap: %s unknown", args[0]);
                        return ERROR_FAIL;
                }
        }
@@ -345,11 +259,90 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
        LOG_USER("xsvf processing file: \"%s\"", filename);
 
-       while( read(xsvf_fd, &opcode, 1) > 0 )
+       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:
@@ -371,7 +364,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                case XRUNTEST:
                        {
-                               u8      xruntest_buf[4];
+                               uint8_t xruntest_buf[4];
 
                                if (read(xsvf_fd, xruntest_buf, 4) < 0)
                                {
@@ -386,21 +379,21 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                case XREPEAT:
                        {
-                               u8 myrepeat;
+                               uint8_t myrepeat;
 
                                if (read(xsvf_fd, &myrepeat, 1) < 0)
                                        do_abort = 1;
                                else
                                {
                                        xrepeat = myrepeat;
-                                       LOG_DEBUG("XREPEAT %d", xrepeat );
+                                       LOG_DEBUG("XREPEAT %d", xrepeat);
                                }
                        }
                        break;
 
                case XSDRSIZE:
                        {
-                               u8      xsdrsize_buf[4];
+                               uint8_t xsdrsize_buf[4];
 
                                if (read(xsvf_fd, xsdrsize_buf, 4) < 0)
                                {
@@ -411,9 +404,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                xsdrsize = be_to_h_u32(xsdrsize_buf);
                                LOG_DEBUG("XSDRSIZE %d", xsdrsize);
 
-                               if( dr_out_buf ) free(dr_out_buf);
-                               ifdr_in_buf)   free(dr_in_buf);
-                               ifdr_in_mask)  free(dr_in_mask);
+                               if (dr_out_buf) free(dr_out_buf);
+                               if (dr_in_buf)   free(dr_in_buf);
+                               if (dr_in_mask)  free(dr_in_mask);
 
                                dr_out_buf = malloc((xsdrsize + 7) / 8);
                                dr_in_buf = malloc((xsdrsize + 7) / 8);
@@ -438,7 +431,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                if (opcode == XSDRTDO)
                                {
-                                       if(xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf)  != ERROR_OK )
+                                       if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf)  != ERROR_OK)
                                        {
                                                do_abort = 1;
                                                break;
@@ -450,11 +443,11 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                LOG_DEBUG("%s %d", op_name, xsdrsize);
 
-                               for( attempt=0; attempt<limit;  ++attempt )
+                               for (attempt = 0; attempt < limit;  ++attempt)
                                {
                                        scan_field_t field;
 
-                                       if( attempt>0 )
+                                       if (attempt > 0)
                                        {
                                                /* perform the XC9500 exception handling sequence shown in xapp067.pdf and
                                                   illustrated in psuedo code at end of this file.  We start from state
@@ -477,7 +470,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,15 +479,17 @@ 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);
+                                               jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
                                        else
-                                               jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
+                                               jtag_add_dr_scan(1, &field, jtag_set_end_state(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();
@@ -507,7 +502,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                if (!matched)
                                {
-                                       LOG_USER( "%s mismatch", op_name);
+                                       LOG_USER("%s mismatch", op_name);
                                        tdo_mismatch = 1;
                                        break;
                                }
@@ -515,7 +510,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                /* See page 19 of XSVF spec regarding opcode "XSDR" */
                                if (xruntest)
                                {
-                                       xsvf_add_statemove(TAP_IDLE);
+                                       result = svf_add_statemove(TAP_IDLE);
 
                                        if (runtest_requires_tck)
                                                jtag_add_clocks(xruntest);
@@ -523,7 +518,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                                jtag_add_sleep(xruntest);
                                }
                                else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */
-                                       xsvf_add_statemove(xenddr);
+                                       result = svf_add_statemove(xenddr);
                        }
                        break;
 
@@ -570,8 +565,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;
+                               uint8_t                 uc;
 
                                if (read(xsvf_fd, &uc, 1) < 0)
                                {
@@ -581,40 +575,38 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                mystate = xsvf_to_tap(uc);
 
-                               LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) );
+                               LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate));
 
-                               path = calloc(XSTATE_MAX_PATH, 4);
-                               path_len = 1;
-
-                               path[0] = mystate;
-                               if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK)
+                               if (mystate == TAP_INVALID) {
+                                       LOG_ERROR("XSVF: bad XSTATE %02x", uc);
                                        do_abort = 1;
-                               else
-                               {
-                                       int i,lasti;
+                                       break;
+                               }
 
-                                       /* 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);
-                                       }
+                               /* NOTE: the current state is SVF-stable! */
+
+                               /* no change == NOP */
+                               if (mystate == cmd_queue_cur_state
+                                               && mystate != TAP_RESET)
+                                       break;
+
+                               /* Hand off to SVF? */
+                               if (svf_tap_state_is_stable(mystate))
+                               {
+                                       result = svf_add_statemove(mystate);
+                                       if (result != ERROR_OK)
+                                               unsupported = 1;
+                                       break;
                                }
-                               free(path);
+
+                               /*
+                                * A sequence of XSTATE transitions, each TAP
+                                * state adjacent to the previous one.  Start
+                                * collecting them.
+                                */
+                               collecting_path = true;
+                               pathlen = 1;
+                               path[0] = mystate;
                        }
                        break;
 
@@ -627,9 +619,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                        }
 
                        /* see page 22 of XSVF spec */
-                       if( uc == 0 )
+                       if (uc == 0)
                                xendir = TAP_IDLE;
-                       else if( uc == 1 )
+                       else if (uc == 1)
                                xendir = TAP_IRPAUSE;
                        else
                        {
@@ -650,9 +642,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                        }
 
                        /* see page 22 of XSVF spec */
-                       if( uc == 0 )
+                       if (uc == 0)
                                xenddr = TAP_IDLE;
-                       else if( uc == 1 )
+                       else if (uc == 1)
                                xenddr = TAP_DRPAUSE;
                        else
                        {
@@ -667,12 +659,12 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                case XSIR:
                case XSIR2:
                        {
-                               u8      short_buf[2];
-                               u8*     ir_buf;
+                               uint8_t short_buf[2];
+                               uint8_t*        ir_buf;
                                int bitcount;
                                tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir;
 
-                               if( opcode == XSIR )
+                               if (opcode == XSIR)
                                {
                                        /* one byte bitcount */
                                        if (read(xsvf_fd, short_buf, 1) < 0)
@@ -694,7 +686,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        LOG_DEBUG("XSIR2 %d", bitcount);
                                }
 
-                               ir_buf = malloc((bitcount+7) / 8);
+                               ir_buf = malloc((bitcount + 7) / 8);
 
                                if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK)
                                        do_abort = 1;
@@ -705,12 +697,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);
@@ -732,7 +723,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                        /* LOG_DEBUG("FLUSHING QUEUE"); */
                                        result = jtag_execute_queue();
-                                       if(result != ERROR_OK)
+                                       if (result != ERROR_OK)
                                        {
                                                tdo_mismatch = 1;
                                        }
@@ -743,8 +734,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                case XCOMMENT:
                        {
-                               int             ndx = 0;
-                               char    comment[128];
+                               unsigned int ndx = 0;
+                               char    comment[128];
 
                                do
                                {
@@ -754,32 +745,32 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                                break;
                                        }
 
-                                       if ( ndx < sizeof(comment)-1 )
+                                       if (ndx < sizeof(comment)-1)
                                                comment[ndx++] = uc;
 
                                } while (uc != 0);
 
                                comment[sizeof(comment)-1] = 0;         /* regardless, terminate */
                                if (verbose)
-                                       LOG_USER(comment);
+                                       LOG_USER("# %s", comment);
                        }
                        break;
 
                case XWAIT:
                        {
                                /* expected in stream:
-                                  XWAIT <u8 wait_state> <u8 end_state> <u32 usecs>
+                                  XWAIT <uint8_t wait_state> <uint8_t end_state> <uint32_t usecs>
                                */
 
-                               u8      wait;
-                               u8      end;
-                               u8      delay_buf[4];
+                               uint8_t wait;
+                               uint8_t end;
+                               uint8_t delay_buf[4];
 
                                tap_state_t wait_state;
                                tap_state_t end_state;
-                               int     delay;
+                               int     delay;
 
-                               if ( read(xsvf_fd, &wait, 1) < 0
+                               if (read(xsvf_fd, &wait, 1) < 0
                                  || read(xsvf_fd, &end, 1) < 0
                                  || read(xsvf_fd, delay_buf, 4) < 0)
                                {
@@ -793,15 +784,16 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                LOG_DEBUG("XWAIT %s %s usecs:%d", tap_state_name(wait_state), tap_state_name(end_state), delay);
 
-                               if (runtest_requires_tck && wait_state == TAP_IDLE )
+                               if (runtest_requires_tck && wait_state == TAP_IDLE)
                                {
                                        jtag_add_runtest(delay, end_state);
                                }
                                else
                                {
-                                       xsvf_add_statemove( wait_state );
+                                       /* FIXME handle statemove errors ... */
+                                       result = svf_add_statemove(wait_state);
                                        jtag_add_sleep(delay);
-                                       xsvf_add_statemove( end_state );
+                                       result = svf_add_statemove(end_state);
                                }
                        }
                        break;
@@ -809,29 +801,29 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                case XWAITSTATE:
                        {
                                /* expected in stream:
-                                  XWAITSTATE <u8 wait_state> <u8 end_state> <u32 clock_count> <u32 usecs>
+                                  XWAITSTATE <uint8_t wait_state> <uint8_t end_state> <uint32_t clock_count> <uint32_t usecs>
                                */
 
-                               u8  clock_buf[4];
-                               u8      usecs_buf[4];
-                               u8      wait;
-                               u8      end;
+                               uint8_t  clock_buf[4];
+                               uint8_t usecs_buf[4];
+                               uint8_t wait;
+                               uint8_t end;
                                tap_state_t wait_state;
                                tap_state_t end_state;
                                int clock_count;
                                int usecs;
 
-                               if ( read(xsvf_fd, &wait, 1) < 0
+                               if (read(xsvf_fd, &wait, 1) < 0
                                 ||  read(xsvf_fd, &end, 1) < 0
                                 ||  read(xsvf_fd, clock_buf, 4) < 0
-                                ||  read(xsvf_fd, usecs_buf, 4) < 0 )
+                                ||  read(xsvf_fd, usecs_buf, 4) < 0)
                                {
                                        do_abort = 1;
                                        break;
                                }
 
-                               wait_state = xsvf_to_tap( wait );
-                               end_state  = xsvf_to_tap( end );
+                               wait_state = xsvf_to_tap(wait);
+                               end_state  = xsvf_to_tap(end);
 
                                clock_count = be_to_h_u32(clock_buf);
                                usecs       = be_to_h_u32(usecs_buf);
@@ -846,30 +838,33 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                 * be issuing a number of clocks in this state.  This set of allowed states is also
                                 * determined by the SVF RUNTEST command's allowed states.
                                 */
-                               if (wait_state != TAP_IRPAUSE && wait_state != TAP_DRPAUSE && wait_state != TAP_RESET && wait_state != TAP_IDLE)
+                               if (!svf_tap_state_is_stable(wait_state))
                                {
-                                       LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name( wait_state ));
+                                       LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"",
+                                                       tap_state_name(wait_state));
                                        unsupported = 1;
+                                       /* REVISIT "break" so we won't run? */
                                }
 
-                               xsvf_add_statemove( wait_state );
+                               /* FIXME handle statemove errors ... */
+                               result = svf_add_statemove(wait_state);
 
-                               jtag_add_clocks( clock_count );
+                               jtag_add_clocks(clock_count);
 
-                               jtag_add_sleep( usecs );
+                               jtag_add_sleep(usecs);
 
-                               xsvf_add_statemove( end_state );
+                               result = svf_add_statemove(end_state);
                        }
                        break;
 
                case LCOUNT:
                        {
                                /* expected in stream:
-                                  LCOUNT <u32 loop_count>
+                                  LCOUNT <uint32_t loop_count>
                                */
-                               u8  count_buf[4];
+                               uint8_t  count_buf[4];
 
-                               if ( read(xsvf_fd, count_buf, 4) < 0 )
+                               if (read(xsvf_fd, count_buf, 4) < 0)
                                {
                                        do_abort = 1;
                                        break;
@@ -883,20 +878,21 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                case LDELAY:
                        {
                                /* expected in stream:
-                                  LDELAY <u8 wait_state> <u32 clock_count> <u32 usecs_to_sleep>
+                                  LDELAY <uint8_t wait_state> <uint32_t clock_count> <uint32_t usecs_to_sleep>
                                */
-                               u8      state;
-                               u8  clock_buf[4];
-                               u8  usecs_buf[4];
+                               uint8_t state;
+                               uint8_t  clock_buf[4];
+                               uint8_t  usecs_buf[4];
 
-                               if ( read(xsvf_fd, &state, 1) < 0
+                               if (read(xsvf_fd, &state, 1) < 0
                                  || read(xsvf_fd, clock_buf, 4) < 0
-                                 ||     read(xsvf_fd, usecs_buf, 4) < 0 )
+                                 ||     read(xsvf_fd, usecs_buf, 4) < 0)
                                {
                                        do_abort = 1;
                                        break;
                                }
 
+                               /* NOTE:  loop_state must be stable! */
                                loop_state  = xsvf_to_tap(state);
                                loop_clocks = be_to_h_u32(clock_buf);
                                loop_usecs  = be_to_h_u32(usecs_buf);
@@ -916,8 +912,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                                LOG_DEBUG("LSDR");
 
-                               if ( xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK
-                                 || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK )
+                               if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK
+                                 || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK)
                                {
                                        do_abort = 1;
                                        break;
@@ -926,41 +922,44 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                if (limit < 1)
                                        limit = 1;
 
-                               for( attempt=0; attempt<limit;  ++attempt )
+                               for (attempt = 0; attempt < limit;  ++attempt)
                                {
                                        scan_field_t field;
 
-                                       xsvf_add_statemove( loop_state );
+                                       result = svf_add_statemove(loop_state);
                                        jtag_add_clocks(loop_clocks);
                                        jtag_add_sleep(loop_usecs);
 
                                        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);
+                                               jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
                                        else
-                                               jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
+                                               jtag_add_dr_scan(1, &field, jtag_set_end_state(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)
+                                       if (result == ERROR_OK)
                                        {
                                                matched = 1;
                                                break;
                                        }
                                }
 
-                               if (!matched )
+                               if (!matched)
                                {
-                                       LOG_USER( "LSDR mismatch" );
+                                       LOG_USER("LSDR mismatch");
                                        tdo_mismatch = 1;
                                        break;
                                }
@@ -969,7 +968,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
 
                case XTRST:
                        {
-                               u8      trst_mode;
+                               uint8_t trst_mode;
 
                                if (read(xsvf_fd, &trst_mode, 1) < 0)
                                {
@@ -977,7 +976,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                        break;
                                }
 
-                               switch( trst_mode )
+                               switch (trst_mode)
                                {
                                case XTRST_ON:
                                        jtag_add_reset(1, 0);
@@ -989,7 +988,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                                case XTRST_ABSENT:
                                        break;
                                default:
-                                       LOG_ERROR( "XTRST mode argument (0x%02X) out of range", trst_mode );
+                                       LOG_ERROR("XTRST mode argument (0x%02X) out of range", trst_mode);
                                        do_abort = 1;
                                }
                        }
@@ -1005,8 +1004,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha
                        LOG_DEBUG("xsvf failed, setting taps to reasonable state");
 
                        /* upon error, return the TAPs to a reasonable state */
-                       xsvf_add_statemove( TAP_IDLE );
-                       jtag_execute_queue();
+                       result = svf_add_statemove(TAP_IDLE);
+                       result = jtag_execute_queue();
                        break;
                }
        }
@@ -1014,7 +1013,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",
-                                         file_offset );
+                                         file_offset);
 
 
                return ERROR_FAIL;
@@ -1022,9 +1021,10 @@ 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,
-                        "unsupported xsvf command: 0x%02X in xsvf file at offset %ld, aborting",
-                                         uc,  lseek(xsvf_fd, 0, SEEK_CUR)-1 );
+                               "unsupported xsvf command (0x%02X) at offset %jd, aborting",
+                               uc, (intmax_t)offset);
                return ERROR_FAIL;
        }
 
@@ -1050,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)