Change tap_state naming to be consistent with SVF documentation.
[fw/openocd] / src / jtag / bitbang.c
index c4f9ce94130a6a5768d92cde2abd9647b6321886..cc05dbeeaa93a0c4daf60e3a5ab6bc0e630ac056 100644 (file)
@@ -2,6 +2,9 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.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     *
 bitbang_interface_t *bitbang_interface;
 
 
-/* should the clock be high or low in idle? */
-#define CLOCK_IDLE() 0 
+/* DANGER!!!! clock absolutely *MUST* be 0 in idle or reset won't work!
+ *
+ * Set this to 1 and str912 reset halt will fail.
+ *
+ * If someone can submit a patch with an explanation it will be greatly
+ * appreciated, but as far as I can tell (ØH) DCLK is generated upon
+ * clk=0 in TAP_IDLE. Good luck deducing that from the ARM documentation!
+ * The ARM documentation uses the term "DCLK is asserted while in the TAP_IDLE
+ * state". With hardware there is no such thing as *while* in a state. There
+ * are only edges. So clk => 0 is in fact a very subtle state transition that
+ * happens *while* in the TAP_IDLE state. "#&¤"#¤&"#&"#&
+ *
+ * For "reset halt" the last thing that happens before srst is asserted
+ * is that the breakpoint is set up. If DCLK is not wiggled one last
+ * time before the reset, then the breakpoint is not set up and
+ * "reset halt" will fail to halt.
+ *
+ */
+#define CLOCK_IDLE() 0
 
 int bitbang_execute_queue(void);
 
@@ -56,10 +76,10 @@ void bitbang_end_state(enum tap_state state)
 }
 
 void bitbang_state_move(void) {
-       
+
        int i=0, tms=0;
        u8 tms_scan = TAP_MOVE(cur_state, end_state);
-       
+
        for (i = 0; i < 7; i++)
        {
                tms = (tms_scan >> i) & 1;
@@ -67,7 +87,7 @@ void bitbang_state_move(void) {
                bitbang_interface->write(1, tms, 0);
        }
        bitbang_interface->write(CLOCK_IDLE(), tms, 0);
-       
+
        cur_state = end_state;
 }
 
@@ -93,7 +113,7 @@ void bitbang_path_move(pathmove_command_t *cmd)
                        LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[cmd->path[state_count]]);
                        exit(-1);
                }
-               
+
                bitbang_interface->write(0, tms, 0);
                bitbang_interface->write(1, tms, 0);
 
@@ -101,7 +121,7 @@ void bitbang_path_move(pathmove_command_t *cmd)
                state_count++;
                num_states--;
        }
-       
+
        bitbang_interface->write(CLOCK_IDLE(), tms, 0);
 
        end_state = cur_state;
@@ -110,16 +130,16 @@ void bitbang_path_move(pathmove_command_t *cmd)
 void bitbang_runtest(int num_cycles)
 {
        int i;
-       
+
        enum tap_state saved_end_state = end_state;
-       
+
        /* only do a state_move when we're not already in RTI */
-       if (cur_state != TAP_RTI)
+       if (cur_state != TAP_IDLE)
        {
-               bitbang_end_state(TAP_RTI);
+               bitbang_end_state(TAP_IDLE);
                bitbang_state_move();
        }
-       
+
        /* execute num_cycles */
        for (i = 0; i < num_cycles; i++)
        {
@@ -127,7 +147,7 @@ void bitbang_runtest(int num_cycles)
                bitbang_interface->write(1, 0, 0);
        }
        bitbang_interface->write(CLOCK_IDLE(), 0, 0);
-       
+
        /* finish in end_state */
        bitbang_end_state(saved_end_state);
        if (cur_state != end_state)
@@ -138,13 +158,13 @@ void bitbang_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
 {
        enum tap_state saved_end_state = end_state;
        int bit_cnt;
-       
-       if (!((!ir_scan && (cur_state == TAP_SD)) || (ir_scan && (cur_state == TAP_SI))))
+
+       if (!((!ir_scan && (cur_state == TAP_DRSHIFT)) || (ir_scan && (cur_state == TAP_IRSHIFT))))
        {
                if (ir_scan)
-                       bitbang_end_state(TAP_SI);
+                       bitbang_end_state(TAP_IRSHIFT);
                else
-                       bitbang_end_state(TAP_SD);
+                       bitbang_end_state(TAP_DRSHIFT);
 
                bitbang_state_move();
                bitbang_end_state(saved_end_state);
@@ -152,52 +172,50 @@ void bitbang_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
 
        for (bit_cnt = 0; bit_cnt < scan_size; bit_cnt++)
        {
+               int val=0;
+               int tms=(bit_cnt==scan_size-1) ? 1 : 0;
+               int tdi;
+               int bytec=bit_cnt/8;
+               int bcval=1<<(bit_cnt % 8);
+
                /* if we're just reading the scan, but don't care about the output
                 * default to outputting 'low', this also makes valgrind traces more readable,
                 * as it removes the dependency on an uninitialised value
-                */ 
-               if ((type != SCAN_IN) && ((buffer[bit_cnt/8] >> (bit_cnt % 8)) & 0x1))
-               {
-                       bitbang_interface->write(0, (bit_cnt==scan_size-1) ? 1 : 0, 1);
-                       bitbang_interface->write(1, (bit_cnt==scan_size-1) ? 1 : 0, 1);
-               } else {
-                       bitbang_interface->write(0, (bit_cnt==scan_size-1) ? 1 : 0, 0);
-                       bitbang_interface->write(1, (bit_cnt==scan_size-1) ? 1 : 0, 0);
-               }
-               
+                */
+               tdi=0;
+               if ((type != SCAN_IN) && (buffer[bytec] & bcval))
+                       tdi=1;
+
+               bitbang_interface->write(0, tms, tdi);
+
+               if (type!=SCAN_OUT)
+                       val=bitbang_interface->read();
+
+               bitbang_interface->write(1, tms, tdi);
+
                if (type != SCAN_OUT)
                {
-                       /*
-                       TDO should be sampled on the rising edge, and will change 
-                       on the falling edge. 
-                       
-                       Because there is no way to read the signal exactly at the rising edge,
-                       read after the rising edge.
-
-                       This is plain IEEE 1149 JTAG - nothing specific to the OpenOCD or its JTAG
-                       API. 
-                       */
-                       if (bitbang_interface->read())
-                               buffer[(bit_cnt)/8] |= 1 << ((bit_cnt) % 8);
+                       if (val)
+                               buffer[bytec] |= bcval;
                        else
-                               buffer[(bit_cnt)/8] &= ~(1 << ((bit_cnt) % 8));
+                               buffer[bytec] &= ~bcval;
                }
        }
-       
-       /* TAP_SD & TAP_SI are illegal end states, so we always transition to the pause
+
+       /* TAP_DRSHIFT & TAP_IRSHIFT are illegal end states, so we always transition to the pause
         * state which is a legal stable state from which statemove will work.
-        *  
-        * Exit1 -> Pause 
+        *
+        * Exit1 -> Pause
         */
        bitbang_interface->write(0, 0, 0);
        bitbang_interface->write(1, 0, 0);
        bitbang_interface->write(CLOCK_IDLE(), 0, 0);
-       
+
        if (ir_scan)
-               cur_state = TAP_PI;
+               cur_state = TAP_IRPAUSE;
        else
-               cur_state = TAP_PD;
-       
+               cur_state = TAP_DRPAUSE;
+
        if (cur_state != end_state)
                bitbang_state_move();
 }
@@ -209,18 +227,18 @@ int bitbang_execute_queue(void)
        enum scan_type type;
        u8 *buffer;
        int retval;
-       
+
        if (!bitbang_interface)
        {
                LOG_ERROR("BUG: Bitbang interface called, but not yet initialized");
                exit(-1);
        }
-       
+
        /* return ERROR_OK, unless a jtag_read_buffer returns a failed check
         * that wasn't handled by a caller-provided error handler
-        */ 
+        */
        retval = ERROR_OK;
-               
+
        if(bitbang_interface->blink)
                bitbang_interface->blink(1);
 
@@ -241,7 +259,7 @@ int bitbang_execute_queue(void)
 #endif
                                if ((cmd->cmd.reset->trst == 1) || (cmd->cmd.reset->srst && (jtag_reset_config & RESET_SRST_PULLS_TRST)))
                                {
-                                       cur_state = TAP_TLR;
+                                       cur_state = TAP_RESET;
                                }
                                bitbang_interface->reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
                                break;
@@ -295,7 +313,7 @@ int bitbang_execute_queue(void)
        }
        if(bitbang_interface->blink)
                bitbang_interface->blink(0);
-       
+
        return retval;
 }