Changed armv7m and cortexm3 to use nev arm_adi_v5 instead of cortex_swjdp.
[fw/openocd] / src / jtag / jtag.c
index 0c892b29f27a42cc0df2f6066b500c7c3fad7cbe..408f88fa5c351642d8f59ef08faabd0583283404 100644 (file)
@@ -80,8 +80,8 @@ tap_state_t cmd_queue_cur_state = TAP_RESET;
 int jtag_verify_capture_ir = 1;
 
 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
-int jtag_nsrst_delay = 0; /* default to no nSRST delay */
-int jtag_ntrst_delay = 0; /* default to no nTRST delay */
+static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
+static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
 
 /* maximum number of JTAG devices expected in the chain
  */
@@ -210,35 +210,35 @@ jtag_interface_t *jtag_interfaces[] = {
 jtag_interface_t *jtag = NULL;
 
 /* configuration */
-jtag_interface_t *jtag_interface = NULL;
+static jtag_interface_t *jtag_interface = NULL;
 int jtag_speed = 0;
 
 /* forward declarations */
-void jtag_add_pathmove(int num_states, tap_state_t *path);
-void jtag_add_runtest(int num_cycles, tap_state_t endstate);
-void jtag_add_end_state(tap_state_t endstate);
-void jtag_add_sleep(u32 us);
-int jtag_execute_queue(void);
-int tap_state_by_name(const char *name);
+//void jtag_add_pathmove(int num_states, tap_state_t *path);
+//void jtag_add_runtest(int num_cycles, tap_state_t endstate);
+//void jtag_add_end_state(tap_state_t endstate);
+//void jtag_add_sleep(u32 us);
+//int jtag_execute_queue(void);
+static tap_state_t tap_state_by_name(const char *name);
 
 /* jtag commands */
-int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
-int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
-int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
+static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
 
-int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 
 jtag_tap_t *jtag_AllTaps(void)
 {
@@ -510,7 +510,7 @@ static void jtag_prelude(tap_state_t state)
 {
        jtag_prelude1();
 
-       if (state != -1)
+       if (state != TAP_INVALID)
                jtag_add_end_state(state);
 
        cmd_queue_cur_state = cmd_queue_end_state;
@@ -1758,7 +1758,7 @@ static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
                                        jteap = tap->event_action;
                                        /* replace existing? */
                                        while (jteap) {
-                                               if (jteap->event == n->value) {
+                                               if (jteap->event == (enum jtag_tap_event)n->value) {
                                                        break;
                                                }
                                                jteap = jteap->next;
@@ -2305,7 +2305,7 @@ static int default_srst_asserted(int *srst_asserted)
        return ERROR_OK;
 }
 
-int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int i;
        int retval;
@@ -2368,7 +2368,7 @@ int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char
        return ERROR_JTAG_INVALID_INTERFACE;
 }
 
-int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int e;
        char buf[1024];
@@ -2429,7 +2429,7 @@ int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, cha
        return e;
 }
 
-int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        jtag_tap_t *tap;
 
@@ -2466,7 +2466,7 @@ int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char
        return ERROR_OK;
 }
 
-int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        if (argc < 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -2542,7 +2542,7 @@ int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, ch
        return ERROR_OK;
 }
 
-int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        if (argc < 1)
        {
@@ -2557,7 +2557,7 @@ int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd
        return ERROR_OK;
 }
 
-int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        if (argc < 1)
        {
@@ -2572,7 +2572,7 @@ int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd
        return ERROR_OK;
 }
 
-int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int retval=ERROR_OK;
 
@@ -2600,7 +2600,7 @@ int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char
        return retval;
 }
 
-int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int retval=ERROR_OK;
        LOG_DEBUG("handle jtag khz");
@@ -2650,9 +2650,9 @@ int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char *
 
 }
 
-int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
-       int state;
+       tap_state_t state;
 
        if (argc < 1)
        {
@@ -2665,7 +2665,7 @@ int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char *
                        command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
                        return ERROR_COMMAND_SYNTAX_ERROR;
                }
-               jtag_add_end_state( (tap_state_t)(state));
+               jtag_add_end_state(state);
                jtag_execute_queue();
        }
        command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
@@ -2673,7 +2673,7 @@ int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char *
        return ERROR_OK;
 }
 
-int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int trst = -1;
        int srst = -1;
@@ -2710,26 +2710,26 @@ int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char
        return ERROR_OK;
 }
 
-int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        if (argc < 1)
        {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       jtag_add_runtest(strtol(args[0], NULL, 0), -1);
+       jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
        jtag_execute_queue();
 
        return ERROR_OK;
 
 }
 
-int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        int i;
        scan_field_t *fields;
        jtag_tap_t *tap;
-       int endstate;
+       tap_state_t endstate;
 
        if ((argc < 2) || (argc % 2))
        {
@@ -2740,7 +2740,7 @@ int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **a
        /*          "statename" */
        /* at the end of the arguments. */
        /* assume none. */
-       endstate = -1;
+       endstate = TAP_INVALID;
        if( argc >= 4 ){
                /* have at least one pair of numbers. */
                /* is last pair the magic text? */
@@ -2748,13 +2748,13 @@ int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **a
                        const char *cpA;
                        const char *cpS;
                        cpA = args[ argc-1 ];
-                       for( endstate = 0 ; endstate < 16 ; endstate++ ){
+                       for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
                                cpS = tap_state_name( endstate );
                                if( 0 == strcmp( cpA, cpS ) ){
                                        break;
                                }
                        }
-                       if( endstate >= 16 ){
+                       if( endstate >= TAP_NUM_STATES ){
                                return ERROR_COMMAND_SYNTAX_ERROR;
                        } else {
                                /* found - remove the last 2 args */
@@ -2784,11 +2784,11 @@ int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **a
                fields[i].in_handler_priv = NULL;
        }
 
-       jtag_add_ir_scan(argc / 2, fields, -1);
+       jtag_add_ir_scan(argc / 2, fields, TAP_INVALID);
        /* did we have an endstate? */
-       if( endstate >= 0 ){
+       if (endstate != TAP_INVALID)
                jtag_add_end_state(endstate);
-       }
+
        jtag_execute_queue();
 
        for (i = 0; i < argc / 2; i++)
@@ -2799,7 +2799,7 @@ int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **a
        return ERROR_OK;
 }
 
-int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
+static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
 {
        int retval;
        scan_field_t *fields;
@@ -2807,7 +2807,7 @@ int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
        int field_count = 0;
        int i, e;
        jtag_tap_t *tap;
-       int endstate;
+       tap_state_t endstate;
 
        /* args[1] = device
         * args[2] = num_bits
@@ -2825,7 +2825,7 @@ int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
        }
 
        /* assume no endstate */
-       endstate = -1;
+       endstate = TAP_INVALID;
        /* validate arguments as numbers */
        e = JIM_OK;
        for (i = 2; i < argc; i+=2)
@@ -2901,11 +2901,11 @@ int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
                fields[field_count++].in_handler_priv = NULL;
        }
 
-       jtag_add_dr_scan(num_fields, fields, -1);
+       jtag_add_dr_scan(num_fields, fields, TAP_INVALID);
        /* did we get an end state? */
-       if( endstate >= 0 ){
-               jtag_add_end_state( (tap_state_t)endstate );
-       }
+       if (endstate != TAP_INVALID)
+               jtag_add_end_state(endstate);
+
        retval = jtag_execute_queue();
        if (retval != ERROR_OK)
        {
@@ -2936,7 +2936,7 @@ int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
        return JIM_OK;
 }
 
-int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 {
        if (argc == 1)
        {
@@ -3089,7 +3089,7 @@ int tap_get_tms_path( tap_state_t from, tap_state_t to )
         *
         * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
         */
-       const static u8 tms_seqs[6][6] =
+       static const u8 tms_seqs[6][6] =
        {
                /* value clocked to TMS to move from one of six stable states to another */
 
@@ -3248,7 +3248,7 @@ const char* tap_state_name(tap_state_t state)
        switch( state )
        {
        case TAP_RESET:         ret = "RESET";                  break;
-       case TAP_IDLE:          ret = "IDLE";                   break;
+       case TAP_IDLE:          ret = "RUN/IDLE";                       break;
        case TAP_DRSELECT:      ret = "DRSELECT";               break;
        case TAP_DRCAPTURE: ret = "DRCAPTURE";          break;
        case TAP_DRSHIFT:       ret = "DRSHIFT";                        break;
@@ -3269,18 +3269,103 @@ const char* tap_state_name(tap_state_t state)
        return ret;
 }
 
-int tap_state_by_name( const char *name )
+static tap_state_t tap_state_by_name( const char *name )
 {
-       int x;
+       tap_state_t x;
 
-       for( x = 0 ; x < 16 ; x++ ){
+       for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
                /* be nice to the human */
                if( 0 == strcasecmp( name, tap_state_name(x) ) ){
                        return x;
                }
        }
        /* not found */
-       return -1;
+       return TAP_INVALID;
+}
+
+#ifdef _DEBUG_JTAG_IO_
+
+#define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
+               do { buf[len] = bit ? '1' : '0'; } while(0)
+#define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
+               DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
+                       tap_state_name(a), tap_state_name(b), astr, bstr)
+
+tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
+               unsigned tap_bits, tap_state_t next_state)
+{
+       const u8 *tms_buffer;
+       const u8 *tdi_buffer;
+       unsigned tap_bytes;
+       unsigned cur_byte;
+       unsigned cur_bit;
+
+       unsigned tap_out_bits;
+       char tms_str[33];
+       char tdi_str[33];
+
+       tap_state_t last_state;
+
+       // set startstate (and possibly last, if tap_bits == 0) 
+       last_state = next_state;
+       DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
+
+       tms_buffer = (const u8 *)tms_buf;
+       tdi_buffer = (const u8 *)tdi_buf;
+
+       tap_bytes = TAP_SCAN_BYTES(tap_bits);
+       DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
+
+       tap_out_bits = 0;
+       for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
+       {
+               for(cur_bit = 0; cur_bit < 8; cur_bit++)
+               {
+                       // make sure we do not run off the end of the buffers
+                       unsigned tap_bit = cur_byte * 8 + cur_bit;
+                       if (tap_bit == tap_bits)
+                               break;
+
+                       // check and save TMS bit
+                       tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
+                       JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
+
+                       // use TMS bit to find the next TAP state
+                       next_state = tap_state_transition(last_state, tap_bit);
+
+                       // check and store TDI bit
+                       tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
+                       JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
+
+                       // increment TAP bits
+                       tap_out_bits++;
+
+                       // Only show TDO bits on state transitions, or
+                       // after some number of bits in the same state.
+                       if ((next_state == last_state) && (tap_out_bits < 32))
+                               continue;
+
+                       // terminate strings and display state transition
+                       tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
+                       JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
+
+                       // reset state
+                       last_state = next_state;
+                       tap_out_bits = 0;
+               }
+       }
+
+       if (tap_out_bits)
+       {
+               // terminate strings and display state transition
+               tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
+               JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
+       }
+
+       DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
+
+       return next_state;
 }
+#endif // _DEBUG_JTAG_IO_
 
 /*-----</Cable Helper API>--------------------------------------*/