]> git.sur5r.net Git - openocd/blobdiff - src/xsvf/xsvf.c
Change tap_state naming to be consistent with SVF documentation.
[openocd] / src / xsvf / xsvf.c
index 16012887a88e7e760dfb669af46083bb4215f87d..1f594be56152ebe5dc06de8a75e570f174580cbd 100644 (file)
@@ -2,6 +2,12 @@
  *   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                                             *
+ *                                                                         *
  *   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     *
@@ -56,9 +62,9 @@ int xenddr = 0;
 
 enum tap_state xsvf_to_tap[] =
 {
-       TAP_TLR, TAP_RTI,
-       TAP_SDS, TAP_CD, TAP_SD, TAP_E1D, TAP_PD, TAP_E2D, TAP_UD,
-       TAP_SIS, TAP_CI, TAP_SI, TAP_E1I, TAP_PI, TAP_E2I, TAP_UI,
+       TAP_RESET, TAP_IDLE,
+       TAP_DRSELECT, TAP_DRCAPTURE, TAP_DRSHIFT, TAP_DREXIT1, TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE,
+       TAP_IRSELECT, TAP_IRCAPTURE, TAP_IRSHIFT, TAP_IREXIT1, TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE,
 };
 
 int tap_to_xsvf[] =
@@ -66,6 +72,44 @@ int tap_to_xsvf[] =
        0x0, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x1, 0x9, 0xa, 0xb, 0xc, 0xe, 0xf
 };
 
+
+/* xsvf has it's own definition of a statemove. This needs
+ * to be handled according to the specs, which has nothing
+ * to do with the JTAG spec or OpenOCD as such.
+ *
+ * Implemented via jtag_add_pathmove().
+ */
+void xsvf_add_statemove(enum tap_state state)
+{
+       enum tap_state moves[7]; /* max # of transitions */
+       int i;
+       enum tap_state curstate = cmd_queue_cur_state;
+       u8 move = TAP_MOVE(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_transitions[curstate].high;
+               } else
+               {
+                       curstate = tap_transitions[curstate].low;
+               }
+               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,
@@ -91,12 +135,12 @@ int xsvf_read_xstates(int fd, enum tap_state *path, int max_path, int *path_len)
 {
        char c;
        unsigned char uc;
-       
+
        while ((read(fd, &c, 1) > 0) && (c == 0x12))
        {
                if (*path_len > max_path)
                {
-                       WARNING("XSTATE path longer than max_path");
+                       LOG_WARNING("XSTATE path longer than max_path");
                        break;
                }
                if (read(fd, &uc, 1) < 0)
@@ -105,9 +149,9 @@ int xsvf_read_xstates(int fd, enum tap_state *path, int max_path, int *path_len)
                }
                path[(*path_len)++] = xsvf_to_tap[uc];
        }
-       
+
        lseek(fd, -1, SEEK_CUR);
-       
+
        return ERROR_OK;
 }
 
@@ -122,10 +166,13 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
        int do_abort = 0;
        int unsupported = 0;
        int tdo_mismatch = 0;
-       
+
        int runtest_requires_tck = 0;
-       
-       int device = -1;        /* use -1 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;
+       /* use NULL to indicate a "plain" xsvf file which accounts for
+          additional devices in the scan chain, otherwise the device
+          that should be affected */
 
        if (argc < 2)
        {
@@ -135,7 +182,11 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
 
        if (strcmp(args[0], "plain") != 0)
        {
-               device = strtoul(args[0], NULL, 0);
+         tap = jtag_TapByString( args[0] );
+         if( !tap ){
+           command_print( cmd_ctx, "Tap: %s unknown", args[0] );
+           return ERROR_OK;
+         }
        }
 
        if ((xsvf_fd = open(args[1], O_RDONLY)) < 0)
@@ -143,7 +194,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                command_print(cmd_ctx, "file %s not found", args[0]);
                return ERROR_OK;
        }
-       
+
        if ((argc > 2) && (strcmp(args[2], "virt2") == 0))
        {
                runtest_requires_tck = 1;
@@ -154,20 +205,20 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                switch (c)
                {
                        case 0x00:      /* XCOMPLETE */
-                               DEBUG("XCOMPLETE");
+                               LOG_DEBUG("XCOMPLETE");
                                if (jtag_execute_queue() != ERROR_OK)
                                {
                                        tdo_mismatch = 1;
-                                       break;  
+                                       break;
                                }
                                break;
                        case 0x01:      /* XTDOMASK */
-                               DEBUG("XTDOMASK");
+                               LOG_DEBUG("XTDOMASK");
                                if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK))
                                        do_abort = 1;
                                break;
                        case 0x02:      /* XSIR */
-                               DEBUG("XSIR");
+                               LOG_DEBUG("XSIR");
                                if (read(xsvf_fd, &c, 1) < 0)
                                        do_abort = 1;
                                else
@@ -178,7 +229,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                        else
                                        {
                                                scan_field_t field;
-                                               field.device = device;
+                                               field.tap = tap;
                                                field.num_bits = c;
                                                field.out_value = ir_buf;
                                                field.out_mask = NULL;
@@ -187,10 +238,10 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                field.in_check_mask = NULL;
                                                field.in_handler = NULL;
                                                field.in_handler_priv = NULL;
-                                               if (device == -1)
-                                                       jtag_add_plain_ir_scan(1, &field, TAP_PI, NULL);
+                                               if (tap == NULL)
+                                                       jtag_add_plain_ir_scan(1, &field, TAP_IRPAUSE);
                                                else
-                                                       jtag_add_ir_scan(1, &field, TAP_PI, NULL);
+                                                       jtag_add_ir_scan(1, &field, TAP_IRPAUSE);
                                                if (jtag_execute_queue() != ERROR_OK)
                                                {
                                                        tdo_mismatch = 1;
@@ -203,38 +254,38 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                                jtag_add_runtest(xruntest, xsvf_to_tap[xendir]);
                                                        else
                                                        {
-                                                               jtag_add_statemove(TAP_RTI);
+                                                               xsvf_add_statemove(TAP_IDLE);
                                                                jtag_add_sleep(xruntest);
-                                                               jtag_add_statemove(xsvf_to_tap[xendir]);
+                                                               xsvf_add_statemove(xsvf_to_tap[xendir]);
                                                        }
                                                }
                                                else if (xendir != 0xd) /* Pause-IR */
-                                                       jtag_add_statemove(xsvf_to_tap[xendir]);
+                                                       xsvf_add_statemove(xsvf_to_tap[xendir]);
                                        }
                                        free(ir_buf);
                                }
                                break;
                        case 0x03:      /* XSDR */
-                               DEBUG("XSDR");
+                               LOG_DEBUG("XSDR");
                                if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
                                        do_abort = 1;
                                else
                                {
                                        scan_field_t field;
-                                       field.device = device;
+                                       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);
-                                       if (device == -1)
-                                               jtag_add_plain_dr_scan(1, &field, TAP_PD, NULL);
+                                       if (tap == NULL)
+                                               jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
                                        else
-                                               jtag_add_dr_scan(1, &field, TAP_PD, NULL);
+                                               jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
                                        if (jtag_execute_queue() != ERROR_OK)
                                        {
                                                tdo_mismatch = 1;
-                                               break;  
+                                               break;
                                        }
                                        if (xruntest)
                                        {
@@ -242,17 +293,17 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                        jtag_add_runtest(xruntest, xsvf_to_tap[xenddr]);
                                                else
                                                {
-                                                       jtag_add_statemove(TAP_RTI);
+                                                       xsvf_add_statemove(TAP_IDLE);
                                                        jtag_add_sleep(xruntest);
-                                                       jtag_add_statemove(xsvf_to_tap[xenddr]);
+                                                       xsvf_add_statemove(xsvf_to_tap[xenddr]);
                                                }
                                        }
                                        else if (xendir != 0x6) /* Pause-DR */
-                                               jtag_add_statemove(xsvf_to_tap[xenddr]);
+                                               xsvf_add_statemove(xsvf_to_tap[xenddr]);
                                }
                                break;
                        case 0x04:      /* XRUNTEST */
-                               DEBUG("XRUNTEST");
+                               LOG_DEBUG("XRUNTEST");
                                if (read(xsvf_fd, buf4, 4) < 0)
                                        do_abort = 1;
                                else
@@ -261,7 +312,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                }
                                break;
                        case 0x07:      /* XREPEAT */
-                               DEBUG("XREPEAT");
+                               LOG_DEBUG("XREPEAT");
                                if (read(xsvf_fd, &c, 1) < 0)
                                        do_abort = 1;
                                else
@@ -270,7 +321,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                }
                                break;
                        case 0x08:      /* XSDRSIZE */
-                               DEBUG("XSDRSIZE");
+                               LOG_DEBUG("XSDRSIZE");
                                if (read(xsvf_fd, buf4, 4) < 0)
                                        do_abort = 1;
                                else
@@ -285,7 +336,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                }
                                break;
                        case 0x09:      /* XSDRTDO */
-                               DEBUG("XSDRTDO");
+                               LOG_DEBUG("XSDRTDO");
                                if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
                                        do_abort = 1;
                                else
@@ -295,20 +346,20 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                        else
                                        {
                                                scan_field_t field;
-                                               field.device = device;
+                                               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);
-                                               if (device == -1)
-                                                       jtag_add_plain_dr_scan(1, &field, TAP_PD, NULL);
+                                               if (tap == NULL)
+                                                       jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
                                                else
-                                                       jtag_add_dr_scan(1, &field, TAP_PD, NULL);
+                                                       jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
                                                if (jtag_execute_queue() != ERROR_OK)
                                                {
                                                        tdo_mismatch = 1;
-                                                       break;  
+                                                       break;
                                                }
                                                if (xruntest)
                                                {
@@ -316,22 +367,22 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                                jtag_add_runtest(xruntest, xsvf_to_tap[xenddr]);
                                                        else
                                                        {
-                                                               jtag_add_statemove(TAP_RTI);
+                                                               xsvf_add_statemove(TAP_IDLE);
                                                                jtag_add_sleep(xruntest);
-                                                               jtag_add_statemove(xsvf_to_tap[xenddr]);
+                                                               xsvf_add_statemove(xsvf_to_tap[xenddr]);
                                                        }
                                                }
                                                else if (xendir != 0x6) /* Pause-DR */
-                                                       jtag_add_statemove(xsvf_to_tap[xenddr]);
+                                                       xsvf_add_statemove(xsvf_to_tap[xenddr]);
                                        }
                                }
                                break;
                        case 0x0a:      /* XSETDRMASKS */
-                               printf("unsupported XSETSDRMASKS\n");
+                               LOG_ERROR("unsupported XSETSDRMASKS\n");
                                unsupported = 1;
                                break;
                        case 0x0b:      /* XSDRINC */
-                               printf("unsupported XSDRINC\n");
+                               LOG_ERROR("unsupported XSDRINC\n");
                                unsupported = 1;
                                break;
                        case 0x0c:      /* XSDRB */
@@ -353,7 +404,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                unsupported = 1;
                                break;
                        case 0x12:      /* XSTATE */
-                               DEBUG("XSTATE");
+                               LOG_DEBUG("XSTATE");
                                if (read(xsvf_fd, &uc, 1) < 0)
                                        do_abort = 1;
                                else
@@ -365,13 +416,33 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                do_abort = 1;
                                        else
                                        {
-                                               jtag_add_pathmove(path_len, path);
+                                               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);
+                                               }
                                        }
                                        free(path);
                                }
                                break;
                        case 0x13:      /* XENDIR */
-                               DEBUG("XENDIR");
+                               LOG_DEBUG("XENDIR");
                                if (read(xsvf_fd, &c, 1) < 0)
                                        do_abort = 1;
                                else
@@ -382,13 +453,13 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                xendir = 0xd;
                                        else
                                        {
-                                               ERROR("unknown XENDIR endstate");
+                                               LOG_ERROR("unknown XENDIR endstate");
                                                unsupported = 1;
                                        }
                                }
                                break;
                        case 0x14:      /* XENDDR */
-                               DEBUG("XENDDR");
+                               LOG_DEBUG("XENDDR");
                                if (read(xsvf_fd, &c, 1) < 0)
                                        do_abort = 1;
                                else
@@ -399,13 +470,13 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                xenddr = 0x6;
                                        else
                                        {
-                                               ERROR("unknown XENDDR endstate");
+                                               LOG_ERROR("unknown XENDDR endstate");
                                                unsupported = 1;
                                        }
                                }
                                break;
                        case 0x15:      /* XSIR2 */
-                               DEBUG("XSIR2");
+                               LOG_DEBUG("XSIR2");
                                if (read(xsvf_fd, buf2, 2) < 0)
                                        do_abort = 1;
                                else
@@ -418,7 +489,7 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                        else
                                        {
                                                scan_field_t field;
-                                               field.device = device;
+                                               field.tap = tap;
                                                field.num_bits = us;
                                                field.out_value = ir_buf;
                                                field.out_mask = NULL;
@@ -427,10 +498,10 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                                field.in_check_mask = NULL;
                                                field.in_handler = NULL;
                                                field.in_handler_priv = NULL;
-                                               if (device == -1)
-                                                       jtag_add_plain_ir_scan(1, &field, xsvf_to_tap[xendir], NULL);
+                                               if (tap == NULL)
+                                                       jtag_add_plain_ir_scan(1, &field, xsvf_to_tap[xendir]);
                                                else
-                                                       jtag_add_ir_scan(1, &field, xsvf_to_tap[xendir], NULL);
+                                                       jtag_add_ir_scan(1, &field, xsvf_to_tap[xendir]);
                                        }
                                        free(ir_buf);
                                }
@@ -446,58 +517,55 @@ int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **arg
                                } while (c != 0);
                                break;
                        case 0x17:      /* XWAIT */
-                               DEBUG("XWAIT");
+                               LOG_DEBUG("XWAIT");
                                if ((read(xsvf_fd, &uc, 1) < 0) || (read(xsvf_fd, &uc2, 1) < 0) || (read(xsvf_fd, buf4, 4) < 0))
                                        do_abort = 1;
                                else
                                {
-                                       jtag_add_statemove(xsvf_to_tap[uc]);
+                                       xsvf_add_statemove(xsvf_to_tap[uc]);
                                        ui = be_to_h_u32(buf4);
                                        jtag_add_sleep(ui);
-                                       jtag_add_statemove(xsvf_to_tap[uc2]);
+                                       xsvf_add_statemove(xsvf_to_tap[uc2]);
                                }
                                break;
                        default:
-                               printf("unknown xsvf command (0x%2.2x)\n", c);
+                               LOG_ERROR("unknown xsvf command (0x%2.2x)\n", c);
                                unsupported = 1;
                }
 
                if (do_abort || unsupported || tdo_mismatch)
                        break;
        }
-       
+
        if (tdo_mismatch)
        {
                command_print(cmd_ctx, "TDO mismatch, aborting");
-               jtag_cancel_queue();
                return ERROR_OK;
        }
 
        if (unsupported)
        {
                command_print(cmd_ctx, "unsupported xsvf command encountered, aborting");
-               jtag_cancel_queue();
                return ERROR_OK;
        }
 
        if (do_abort)
        {
                command_print(cmd_ctx, "premature end detected, aborting");
-               jtag_cancel_queue();
                return ERROR_OK;
        }
-       
+
        if (dr_out_buf)
                free(dr_out_buf);
-       
+
        if (dr_in_buf)
                free(dr_in_buf);
-       
+
        if (dr_in_mask)
                free(dr_in_mask);
 
        close(xsvf_fd);
-       
+
        command_print(cmd_ctx, "XSVF file programmed successfully");
 
        return ERROR_OK;