arm11_common_t -> struct arm11_common
[openocd.git] / src / target / arm11_dbgtap.c
index 3a50ea072327c49a7476e5b4cd38b228647fb8df..f9582381f53ca0c5224276d869b96edae25f2f8c 100644 (file)
@@ -1,7 +1,8 @@
 /***************************************************************************
  *   Copyright (C) 2008 digenius technology GmbH.                          *
+ *   Michael Bruck                                                         *
  *                                                                         *
- *   Copyright (C) 2008 Oyvind Harboe oyvind.harboe@zylin.com              *
+ *   Copyright (C) 2008,2009 Oyvind 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  *
 #include "config.h"
 #endif
 
-#include "arm11.h"
-#include "jtag.h"
-#include "log.h"
+#include "arm11_dbgtap.h"
 
-#include <stdlib.h>
-#include <string.h>
+#include "time_support.h"
 
 #if 0
 #define JTAG_DEBUG(expr ...)   DEBUG(expr)
 #else
-#define JTAG_DEBUG(expr ...)   do {} while(0)
+#define JTAG_DEBUG(expr ...)   do {} while (0)
 #endif
 
-tap_state_t arm11_move_pi_to_si_via_ci[] =
+/*
+This pathmove goes from Pause-IR to Shift-IR while avoiding RTI. The
+behavior of the FTDI driver IIRC was to go via RTI.
+
+Conversely there may be other places in this code where the ARM11 code relies
+on the driver to hit through RTI when coming from Update-?R.
+*/
+static const tap_state_t arm11_move_pi_to_si_via_ci[] =
 {
     TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IRSHIFT
 };
 
 
-int arm11_add_ir_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state)
+int arm11_add_ir_scan_vc(int num_fields, struct scan_field *fields, tap_state_t state)
 {
        if (cmd_queue_cur_state == TAP_IRPAUSE)
                jtag_add_pathmove(asizeof(arm11_move_pi_to_si_via_ci), arm11_move_pi_to_si_via_ci);
@@ -51,12 +56,12 @@ int arm11_add_ir_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state
        return ERROR_OK;
 }
 
-tap_state_t arm11_move_pd_to_sd_via_cd[] =
+static const tap_state_t arm11_move_pd_to_sd_via_cd[] =
 {
        TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DRSHIFT
 };
 
-int arm11_add_dr_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state)
+int arm11_add_dr_scan_vc(int num_fields, struct scan_field *fields, tap_state_t state)
 {
        if (cmd_queue_cur_state == TAP_DRPAUSE)
                jtag_add_pathmove(asizeof(arm11_move_pd_to_sd_via_cd), arm11_move_pd_to_sd_via_cd);
@@ -66,26 +71,20 @@ int arm11_add_dr_scan_vc(int num_fields, scan_field_t *fields, tap_state_t state
 }
 
 
-/** Code de-clutter: Construct scan_field_t to write out a value
+/** Code de-clutter: Construct struct scan_field to write out a value
  *
  * \param arm11                        Target state variable.
  * \param num_bits             Length of the data field
  * \param out_data             pointer to the data that will be sent out
- *                                             <em>(data is read when it is added to the JTAG queue)</em>
+ *                                             <em > (data is read when it is added to the JTAG queue)</em>
  * \param in_data              pointer to the memory that will receive data that was clocked in
- *                                             <em>(data is written when the JTAG queue is executed)</em>
+ *                                             <em > (data is written when the JTAG queue is executed)</em>
  * \param field                        target data structure that will be initialized
  */
-void arm11_setup_field(arm11_common_t * arm11, int num_bits, void * out_data, void * in_data, scan_field_t * field)
+void arm11_setup_field(struct arm11_common * arm11, int num_bits, void * out_data, void * in_data, struct scan_field * field)
 {
-       field->tap                      = arm11->jtag_info.tap;
+       field->tap                      = arm11->target->tap;
        field->num_bits                 = num_bits;
-       field->out_mask                 = NULL;
-       field->in_check_mask    = NULL;
-       field->in_check_value   = NULL;
-       field->in_handler               = NULL;
-       field->in_handler_priv  = NULL;
-
        field->out_value                = out_data;
        field->in_value                 = in_data;
 }
@@ -99,10 +98,10 @@ void arm11_setup_field(arm11_common_t * arm11, int num_bits, void * out_data, vo
  *
  * \remarks                    This adds to the JTAG command queue but does \em not execute it.
  */
-void arm11_add_IR(arm11_common_t * arm11, u8 instr, tap_state_t state)
+void arm11_add_IR(struct arm11_common * arm11, uint8_t instr, tap_state_t state)
 {
-       jtag_tap_t *tap;
-       tap = arm11->jtag_info.tap;
+       struct jtag_tap *tap;
+       tap = arm11->target->tap;
 
        if (buf_get_u32(tap->cur_instr, 0, 5) == instr)
        {
@@ -112,7 +111,7 @@ void arm11_add_IR(arm11_common_t * arm11, u8 instr, tap_state_t state)
 
        JTAG_DEBUG("IR <= 0x%02x", instr);
 
-       scan_field_t field;
+       struct scan_field field;
 
        arm11_setup_field(arm11, 5, &instr, NULL, &field);
 
@@ -120,23 +119,22 @@ void arm11_add_IR(arm11_common_t * arm11, u8 instr, tap_state_t state)
 }
 
 /** Verify shifted out data from Scan Chain Register (SCREG)
- *  Used as parameter to scan_field_t::in_handler in
+ *  Used as parameter to struct scan_field::in_handler in
  *  arm11_add_debug_SCAN_N().
  *
  */
-static int arm11_in_handler_SCAN_N(u8 *in_value, void *priv, struct scan_field_s *field)
+static void arm11_in_handler_SCAN_N(uint8_t *in_value)
 {
-       /** \todo TODO: clarify why this isnt properly masked in jtag.c jtag_read_buffer() */
-       u8 v = *in_value & 0x1F;
+       /** \todo TODO: clarify why this isnt properly masked in core.c jtag_read_buffer() */
+       uint8_t v = *in_value & 0x1F;
 
        if (v != 0x10)
        {
                LOG_ERROR("'arm11 target' JTAG communication error SCREG SCAN OUT 0x%02x (expected 0x10)", v);
-               return ERROR_FAIL;
+               jtag_set_error(ERROR_FAIL);
        }
 
        JTAG_DEBUG("SCREG SCAN OUT 0x%02x", v);
-       return ERROR_OK;
 }
 
 /** Select and write to Scan Chain Register (SCREG)
@@ -163,19 +161,24 @@ static int arm11_in_handler_SCAN_N(u8 *in_value, void *priv, struct scan_field_s
  * \remarks                    This adds to the JTAG command queue but does \em not execute it.
  */
 
-void arm11_add_debug_SCAN_N(arm11_common_t * arm11, u8 chain, tap_state_t state)
+int arm11_add_debug_SCAN_N(struct arm11_common * arm11, uint8_t chain, tap_state_t state)
 {
        JTAG_DEBUG("SCREG <= 0x%02x", chain);
 
        arm11_add_IR(arm11, ARM11_SCAN_N, ARM11_TAP_DEFAULT);
 
-       scan_field_t            field;
-
-       arm11_setup_field(arm11, 5, &chain, NULL, &field);
+       struct scan_field               field;
 
-       field.in_handler = arm11_in_handler_SCAN_N;
+       uint8_t tmp[1];
+       arm11_setup_field(arm11, 5, &chain, &tmp, &field);
 
        arm11_add_dr_scan_vc(1, &field, state == ARM11_TAP_DEFAULT ? TAP_DRPAUSE : state);
+
+       jtag_execute_queue_noclear();
+
+       arm11_in_handler_SCAN_N(tmp);
+
+       return jtag_execute_queue();
 }
 
 /** Write an instruction into the ITR register
@@ -195,11 +198,11 @@ void arm11_add_debug_SCAN_N(arm11_common_t * arm11, u8 chain, tap_state_t state)
  *
  * \remarks                    This adds to the JTAG command queue but does \em not execute it.
  */
-void arm11_add_debug_INST(arm11_common_t * arm11, u32 inst, u8 * flag, tap_state_t state)
+void arm11_add_debug_INST(struct arm11_common * arm11, uint32_t inst, uint8_t * flag, tap_state_t state)
 {
        JTAG_DEBUG("INST <= 0x%08x", inst);
 
-       scan_field_t            itr[2];
+       struct scan_field               itr[2];
 
        arm11_setup_field(arm11, 32,    &inst,  NULL, itr + 0);
        arm11_setup_field(arm11, 1,         NULL,       flag, itr + 1);
@@ -212,37 +215,37 @@ void arm11_add_debug_INST(arm11_common_t * arm11, u32 inst, u8 * flag, tap_state
  * same as CP14 c1
  *
  * \param arm11                Target state variable.
- * \return                     DSCR content
+ * \param value                DSCR content
+ * \return                     Error status
  *
  * \remarks                    This is a stand-alone function that executes the JTAG command queue.
  */
-int arm11_read_DSCR(arm11_common_t * arm11, u32 *value)
+int arm11_read_DSCR(struct arm11_common * arm11, uint32_t *value)
 {
-       arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
+       int retval;
+       retval = arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
+       if (retval != ERROR_OK)
+               return retval;
 
        arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
 
-       u32                             dscr;
-       scan_field_t    chain1_field;
+       uint32_t                                dscr;
+       struct scan_field       chain1_field;
 
        arm11_setup_field(arm11, 32, NULL, &dscr, &chain1_field);
 
        arm11_add_dr_scan_vc(1, &chain1_field, TAP_DRPAUSE);
 
-       int retval;
-       if ((retval=jtag_execute_queue())!=ERROR_OK)
-       {
-               return retval;
-       }
+       CHECK_RETVAL(jtag_execute_queue());
 
        if (arm11->last_dscr != dscr)
                JTAG_DEBUG("DSCR  = %08x (OLD %08x)", dscr, arm11->last_dscr);
 
        arm11->last_dscr = dscr;
 
-       *value=dscr;
+       *value = dscr;
 
-       return retval;
+       return ERROR_OK;
 }
 
 /** Write the Debug Status and Control Register (DSCR)
@@ -254,21 +257,22 @@ int arm11_read_DSCR(arm11_common_t * arm11, u32 *value)
  *
  * \remarks                    This is a stand-alone function that executes the JTAG command queue.
  */
-int arm11_write_DSCR(arm11_common_t * arm11, u32 dscr)
+int arm11_write_DSCR(struct arm11_common * arm11, uint32_t dscr)
 {
-       arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
+       int retval;
+       retval = arm11_add_debug_SCAN_N(arm11, 0x01, ARM11_TAP_DEFAULT);
+       if (retval != ERROR_OK)
+               return retval;
 
        arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
 
-       scan_field_t                chain1_field;
+       struct scan_field                   chain1_field;
 
        arm11_setup_field(arm11, 32, &dscr, NULL, &chain1_field);
 
        arm11_add_dr_scan_vc(1, &chain1_field, TAP_DRPAUSE);
 
-       int retval;
-       if ((retval=jtag_execute_queue())!=ERROR_OK)
-               return retval;
+       CHECK_RETVAL(jtag_execute_queue());
 
        JTAG_DEBUG("DSCR <= %08x (OLD %08x)", dscr, arm11->last_dscr);
 
@@ -285,7 +289,7 @@ int arm11_write_DSCR(arm11_common_t * arm11, u32 dscr)
  * \return                     Debug reason
  *
  */
-enum target_debug_reason arm11_get_DSCR_debug_reason(u32 dscr)
+enum target_debug_reason arm11_get_DSCR_debug_reason(uint32_t dscr)
 {
        switch (dscr & ARM11_DSCR_METHOD_OF_DEBUG_ENTRY_MASK)
        {
@@ -335,9 +339,9 @@ enum target_debug_reason arm11_get_DSCR_debug_reason(u32 dscr)
  * \param arm11                Target state variable.
  *
  */
-void arm11_run_instr_data_prepare(arm11_common_t * arm11)
+int arm11_run_instr_data_prepare(struct arm11_common * arm11)
 {
-       arm11_add_debug_SCAN_N(arm11, 0x05, ARM11_TAP_DEFAULT);
+       return arm11_add_debug_SCAN_N(arm11, 0x05, ARM11_TAP_DEFAULT);
 }
 
 /** Cleanup after ITR/DTR operations
@@ -354,12 +358,13 @@ void arm11_run_instr_data_prepare(arm11_common_t * arm11)
  * \param arm11                Target state variable.
  *
  */
-void arm11_run_instr_data_finish(arm11_common_t * arm11)
+int arm11_run_instr_data_finish(struct arm11_common * arm11)
 {
-       arm11_add_debug_SCAN_N(arm11, 0x00, ARM11_TAP_DEFAULT);
+       return arm11_add_debug_SCAN_N(arm11, 0x00, ARM11_TAP_DEFAULT);
 }
 
 
+
 /** Execute one or multiple instructions via ITR
  *
  * \pre arm11_run_instr_data_prepare() /  arm11_run_instr_data_finish() block
@@ -369,7 +374,7 @@ void arm11_run_instr_data_finish(arm11_common_t * arm11)
  * \param count                Number of opcodes to execute
  *
  */
-int arm11_run_instr_no_data(arm11_common_t * arm11, u32 * opcode, size_t count)
+int arm11_run_instr_no_data(struct arm11_common * arm11, uint32_t * opcode, size_t count)
 {
        arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
 
@@ -377,18 +382,34 @@ int arm11_run_instr_no_data(arm11_common_t * arm11, u32 * opcode, size_t count)
        {
                arm11_add_debug_INST(arm11, *opcode++, NULL, TAP_IDLE);
 
+               int i = 0;
                while (1)
                {
-                       u8 flag;
+                       uint8_t flag;
 
                        arm11_add_debug_INST(arm11, 0, &flag, count ? TAP_IDLE : TAP_DRPAUSE);
 
-                       int retval;
-                       if ((retval=jtag_execute_queue())!=ERROR_OK)
-                               return retval;
+                       CHECK_RETVAL(jtag_execute_queue());
 
                        if (flag)
                                break;
+
+                       long long then = 0;
+
+                       if (i == 1000)
+                       {
+                               then = timeval_ms();
+                       }
+                       if (i >= 1000)
+                       {
+                               if ((timeval_ms()-then) > 1000)
+                               {
+                                       LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
+                                       return ERROR_FAIL;
+                               }
+                       }
+
+                       i++;
                }
        }
 
@@ -403,9 +424,9 @@ int arm11_run_instr_no_data(arm11_common_t * arm11, u32 * opcode, size_t count)
  * \param opcode       ARM opcode
  *
  */
-void arm11_run_instr_no_data1(arm11_common_t * arm11, u32 opcode)
+int arm11_run_instr_no_data1(struct arm11_common * arm11, uint32_t opcode)
 {
-       arm11_run_instr_no_data(arm11, &opcode, 1);
+       return arm11_run_instr_no_data(arm11, &opcode, 1);
 }
 
 
@@ -422,7 +443,7 @@ void arm11_run_instr_no_data1(arm11_common_t * arm11, u32 opcode)
  * \param count                Number of data words and instruction repetitions
  *
  */
-int arm11_run_instr_data_to_core(arm11_common_t * arm11, u32 opcode, u32 * data, size_t count)
+int arm11_run_instr_data_to_core(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
 {
        arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
 
@@ -430,11 +451,11 @@ int arm11_run_instr_data_to_core(arm11_common_t * arm11, u32 opcode, u32 * data,
 
        arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
 
-       scan_field_t    chain5_fields[3];
+       struct scan_field       chain5_fields[3];
 
-       u32                             Data;
-       u8                              Ready;
-       u8                              nRetry;
+       uint32_t                                Data;
+       uint8_t                         Ready;
+       uint8_t                         nRetry;
 
        arm11_setup_field(arm11, 32,    &Data,  NULL,           chain5_fields + 0);
        arm11_setup_field(arm11,  1,    NULL,   &Ready,         chain5_fields + 1);
@@ -442,16 +463,33 @@ int arm11_run_instr_data_to_core(arm11_common_t * arm11, u32 opcode, u32 * data,
 
        while (count--)
        {
+               int i = 0;
                do
                {
                        Data        = *data;
 
-                       arm11_add_dr_scan_vc(asizeof(chain5_fields), chain5_fields, TAP_IDLE);
-                       int retval;
-                       if ((retval=jtag_execute_queue())!=ERROR_OK)
-                               return retval;
+                       arm11_add_dr_scan_vc(asizeof(chain5_fields), chain5_fields, jtag_set_end_state(TAP_IDLE));
+
+                       CHECK_RETVAL(jtag_execute_queue());
 
                        JTAG_DEBUG("DTR  Ready %d  nRetry %d", Ready, nRetry);
+
+                       long long then = 0;
+
+                       if (i == 1000)
+                       {
+                               then = timeval_ms();
+                       }
+                       if (i >= 1000)
+                       {
+                               if ((timeval_ms()-then) > 1000)
+                               {
+                                       LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
+                                       return ERROR_FAIL;
+                               }
+                       }
+
+                       i++;
                }
                while (!Ready);
 
@@ -460,16 +498,33 @@ int arm11_run_instr_data_to_core(arm11_common_t * arm11, u32 opcode, u32 * data,
 
        arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
 
+       int i = 0;
        do
        {
                Data        = 0;
 
                arm11_add_dr_scan_vc(asizeof(chain5_fields), chain5_fields, TAP_DRPAUSE);
-               int retval;
-               if ((retval=jtag_execute_queue())!=ERROR_OK)
-                       return retval;
+
+               CHECK_RETVAL(jtag_execute_queue());
 
                JTAG_DEBUG("DTR  Data %08x  Ready %d  nRetry %d", Data, Ready, nRetry);
+
+               long long then = 0;
+
+               if (i == 1000)
+               {
+                       then = timeval_ms();
+               }
+               if (i >= 1000)
+               {
+                       if ((timeval_ms()-then) > 1000)
+                       {
+                               LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
+                               return ERROR_FAIL;
+                       }
+               }
+
+               i++;
        }
        while (!Ready);
 
@@ -486,8 +541,14 @@ int arm11_run_instr_data_to_core(arm11_common_t * arm11, u32 opcode, u32 * data,
  *  layer (FT2232) that is long enough to finish execution on
  *  the core but still shorter than any manually inducible delays.
  *
+ *  To disable this code, try "memwrite burst false"
+ *
+ *  FIX!!! should we use multiple TAP_IDLE here or not???
+ *
+ *  https://lists.berlios.de/pipermail/openocd-development/2009-July/009698.html
+ *  https://lists.berlios.de/pipermail/openocd-development/2009-August/009865.html
  */
-tap_state_t arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay[] =
+static const tap_state_t arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay[] =
 {
        TAP_DREXIT2, TAP_DRUPDATE, TAP_IDLE, TAP_IDLE, TAP_IDLE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DRSHIFT
 };
@@ -509,7 +570,7 @@ tap_state_t arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay[] =
  * \param count                Number of data words and instruction repetitions
  *
  */
-int arm11_run_instr_data_to_core_noack(arm11_common_t * arm11, u32 opcode, u32 * data, size_t count)
+int arm11_run_instr_data_to_core_noack(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
 {
        arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
 
@@ -517,14 +578,23 @@ int arm11_run_instr_data_to_core_noack(arm11_common_t * arm11, u32 opcode, u32 *
 
        arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
 
-       scan_field_t    chain5_fields[3];
+       struct scan_field       chain5_fields[3];
 
        arm11_setup_field(arm11, 32,    NULL/*&Data*/,  NULL,                           chain5_fields + 0);
        arm11_setup_field(arm11,  1,    NULL,                   NULL /*&Ready*/,        chain5_fields + 1);
        arm11_setup_field(arm11,  1,    NULL,                   NULL,                           chain5_fields + 2);
 
-       u8                      Readies[count + 1];
-       u8      *               ReadyPos                        = Readies;
+       uint8_t                 *Readies;
+       size_t readiesNum = (count + 1);
+       size_t bytes = sizeof(*Readies)*readiesNum;
+       Readies = (uint8_t *) malloc(bytes);
+       if (Readies == NULL)
+       {
+               LOG_ERROR("Out of memory allocating " ZU " bytes", bytes);
+               return ERROR_FAIL;
+       }
+
+       uint8_t *               ReadyPos                        = Readies;
 
        while (count--)
        {
@@ -533,13 +603,13 @@ int arm11_run_instr_data_to_core_noack(arm11_common_t * arm11, u32 opcode, u32 *
 
                if (count)
                {
-                       jtag_add_dr_scan(asizeof(chain5_fields), chain5_fields, TAP_DRPAUSE);
+                       jtag_add_dr_scan(asizeof(chain5_fields), chain5_fields, jtag_set_end_state(TAP_DRPAUSE));
                        jtag_add_pathmove(asizeof(arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay),
                                arm11_MOVE_DRPAUSE_IDLE_DRPAUSE_with_delay);
                }
                else
                {
-                       jtag_add_dr_scan(asizeof(chain5_fields), chain5_fields, TAP_IDLE);
+                       jtag_add_dr_scan(asizeof(chain5_fields), chain5_fields, jtag_set_end_state(TAP_IDLE));
                }
        }
 
@@ -550,25 +620,27 @@ int arm11_run_instr_data_to_core_noack(arm11_common_t * arm11, u32 opcode, u32 *
 
        arm11_add_dr_scan_vc(asizeof(chain5_fields), chain5_fields, TAP_DRPAUSE);
 
-       int retval;
-       if ((retval=jtag_execute_queue())!=ERROR_OK)
-               return retval;
-
-       size_t error_count = 0;
-
-       {size_t i;
-       for (i = 0; i < asizeof(Readies); i++)
+       int retval = jtag_execute_queue();
+       if (retval == ERROR_OK)
        {
-               if (Readies[i] != 1)
+               size_t error_count = 0;
+
+               for (size_t i = 0; i < readiesNum; i++)
                {
-                       error_count++;
+                       if (Readies[i] != 1)
+                       {
+                               error_count++;
+                       }
                }
-       }}
 
-       if (error_count)
-               LOG_ERROR("Transfer errors " ZU, error_count);
+               if (error_count > 0 )
+                       LOG_ERROR(ZU " words out of " ZU " not transferred", error_count, readiesNum);
 
-       return ERROR_OK;
+       }
+
+       free(Readies);
+
+       return retval;
 }
 
 
@@ -583,7 +655,7 @@ int arm11_run_instr_data_to_core_noack(arm11_common_t * arm11, u32 opcode, u32 *
  * \param data         Data word to be passed to the core via DTR
  *
  */
-int arm11_run_instr_data_to_core1(arm11_common_t * arm11, u32 opcode, u32 data)
+int arm11_run_instr_data_to_core1(struct arm11_common * arm11, uint32_t opcode, uint32_t data)
 {
        return arm11_run_instr_data_to_core(arm11, opcode, &data, 1);
 }
@@ -602,7 +674,7 @@ int arm11_run_instr_data_to_core1(arm11_common_t * arm11, u32 opcode, u32 data)
  * \param count                Number of data words and instruction repetitions
  *
  */
-int arm11_run_instr_data_from_core(arm11_common_t * arm11, u32 opcode, u32 * data, size_t count)
+int arm11_run_instr_data_from_core(struct arm11_common * arm11, uint32_t opcode, uint32_t * data, size_t count)
 {
        arm11_add_IR(arm11, ARM11_ITRSEL, ARM11_TAP_DEFAULT);
 
@@ -610,11 +682,11 @@ int arm11_run_instr_data_from_core(arm11_common_t * arm11, u32 opcode, u32 * dat
 
        arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
 
-       scan_field_t    chain5_fields[3];
+       struct scan_field       chain5_fields[3];
 
-       u32                     Data;
-       u8                      Ready;
-       u8                      nRetry;
+       uint32_t                        Data;
+       uint8_t                 Ready;
+       uint8_t                 nRetry;
 
        arm11_setup_field(arm11, 32,    NULL,   &Data,      chain5_fields + 0);
        arm11_setup_field(arm11,  1,    NULL,   &Ready,     chain5_fields + 1);
@@ -622,14 +694,31 @@ int arm11_run_instr_data_from_core(arm11_common_t * arm11, u32 opcode, u32 * dat
 
        while (count--)
        {
+               int i = 0;
                do
                {
                        arm11_add_dr_scan_vc(asizeof(chain5_fields), chain5_fields, count ? TAP_IDLE : TAP_DRPAUSE);
-                       int retval;
-                       if ((retval=jtag_execute_queue())!=ERROR_OK)
-                               return retval;
+
+                       CHECK_RETVAL(jtag_execute_queue());
 
                        JTAG_DEBUG("DTR  Data %08x  Ready %d  nRetry %d", Data, Ready, nRetry);
+
+                       long long then = 0;
+
+                       if (i == 1000)
+                       {
+                               then = timeval_ms();
+                       }
+                       if (i >= 1000)
+                       {
+                               if ((timeval_ms()-then) > 1000)
+                               {
+                                       LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
+                                       return ERROR_FAIL;
+                               }
+                       }
+
+                       i++;
                }
                while (!Ready);
 
@@ -651,12 +740,17 @@ int arm11_run_instr_data_from_core(arm11_common_t * arm11, u32 opcode, u32 * dat
  * \param data         Pointer to a data word that receives the value from r0 after \p opcode was executed.
  *
  */
-void arm11_run_instr_data_from_core_via_r0(arm11_common_t * arm11, u32 opcode, u32 * data)
+int arm11_run_instr_data_from_core_via_r0(struct arm11_common * arm11, uint32_t opcode, uint32_t * data)
 {
-       arm11_run_instr_no_data1(arm11, opcode);
+       int retval;
+       retval = arm11_run_instr_no_data1(arm11, opcode);
+       if (retval != ERROR_OK)
+               return retval;
 
        /* MCR p14,0,R0,c0,c5,0 (move r0 -> wDTR -> local var) */
        arm11_run_instr_data_from_core(arm11, 0xEE000E15, data, 1);
+
+       return ERROR_OK;
 }
 
 /** Load data into core via DTR then move it to r0 then
@@ -671,12 +765,19 @@ void arm11_run_instr_data_from_core_via_r0(arm11_common_t * arm11, u32 opcode, u
  * \param data         Data word that will be written to r0 before \p opcode is executed
  *
  */
-void arm11_run_instr_data_to_core_via_r0(arm11_common_t * arm11, u32 opcode, u32 data)
+int arm11_run_instr_data_to_core_via_r0(struct arm11_common * arm11, uint32_t opcode, uint32_t data)
 {
+       int retval;
        /* MRC p14,0,r0,c0,c5,0 */
-       arm11_run_instr_data_to_core1(arm11, 0xEE100E15, data);
+       retval = arm11_run_instr_data_to_core1(arm11, 0xEE100E15, data);
+       if (retval != ERROR_OK)
+               return retval;
 
-       arm11_run_instr_no_data1(arm11, opcode);
+       retval = arm11_run_instr_no_data1(arm11, opcode);
+       if (retval != ERROR_OK)
+               return retval;
+
+       return ERROR_OK;
 }
 
 /** Apply reads and writes to scan chain 7
@@ -688,27 +789,30 @@ void arm11_run_instr_data_to_core_via_r0(arm11_common_t * arm11, u32 opcode, u32
  * \param count                Number of instructions in the list.
  *
  */
-int arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t count)
+int arm11_sc7_run(struct arm11_common * arm11, arm11_sc7_action_t * actions, size_t count)
 {
-       arm11_add_debug_SCAN_N(arm11, 0x07, ARM11_TAP_DEFAULT);
+       int retval;
+
+       retval = arm11_add_debug_SCAN_N(arm11, 0x07, ARM11_TAP_DEFAULT);
+       if (retval != ERROR_OK)
+               return retval;
 
        arm11_add_IR(arm11, ARM11_EXTEST, ARM11_TAP_DEFAULT);
 
-       scan_field_t    chain7_fields[3];
+       struct scan_field       chain7_fields[3];
 
-       u8                              nRW;
-       u32                             DataOut;
-       u8                              AddressOut;
-       u8                              Ready;
-       u32                             DataIn;
-       u8                              AddressIn;
+       uint8_t                         nRW;
+       uint32_t                                DataOut;
+       uint8_t                         AddressOut;
+       uint8_t                         Ready;
+       uint32_t                                DataIn;
+       uint8_t                         AddressIn;
 
        arm11_setup_field(arm11,  1, &nRW,                      &Ready,         chain7_fields + 0);
        arm11_setup_field(arm11, 32, &DataOut,          &DataIn,        chain7_fields + 1);
        arm11_setup_field(arm11,  7, &AddressOut,       &AddressIn,     chain7_fields + 2);
 
-       {size_t i;
-       for (i = 0; i < count + 1; i++)
+       for (size_t i = 0; i < count + 1; i++)
        {
                if (i < count)
                {
@@ -728,9 +832,8 @@ int arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t c
                        JTAG_DEBUG("SC7 <= Address %02x  Data %08x    nRW %d", AddressOut, DataOut, nRW);
 
                        arm11_add_dr_scan_vc(asizeof(chain7_fields), chain7_fields, TAP_DRPAUSE);
-                       int retval;
-                       if ((retval=jtag_execute_queue())!=ERROR_OK)
-                               return retval;
+
+                       CHECK_RETVAL(jtag_execute_queue());
 
                        JTAG_DEBUG("SC7 => Address %02x  Data %08x  Ready %d", AddressIn, DataIn, Ready);
                }
@@ -755,13 +858,12 @@ int arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t c
                                }
                        }
                }
-       }}
+       }
 
-       {size_t i;
-       for (i = 0; i < count; i++)
+       for (size_t i = 0; i < count; i++)
        {
                JTAG_DEBUG("SC7 %02d: %02x %s %08x", i, actions[i].address, actions[i].write ? "<=" : "=>", actions[i].value);
-       }}
+       }
 
        return ERROR_OK;
 }
@@ -771,27 +873,24 @@ int arm11_sc7_run(arm11_common_t * arm11, arm11_sc7_action_t * actions, size_t c
  * \param arm11                Target state variable.
  *
  */
-void arm11_sc7_clear_vbw(arm11_common_t * arm11)
+void arm11_sc7_clear_vbw(struct arm11_common * arm11)
 {
        arm11_sc7_action_t              clear_bw[arm11->brp + arm11->wrp + 1];
        arm11_sc7_action_t *    pos = clear_bw;
 
-       {size_t i;
-       for (i = 0; i < asizeof(clear_bw); i++)
+       for (size_t i = 0; i < asizeof(clear_bw); i++)
        {
                clear_bw[i].write       = true;
                clear_bw[i].value       = 0;
-       }}
+       }
 
-       {size_t i;
-       for (i = 0; i < arm11->brp; i++)
+       for (size_t i = 0; i < arm11->brp; i++)
                (pos++)->address = ARM11_SC7_BCR0 + i;
-       }
 
-       {size_t i;
-       for (i = 0; i < arm11->wrp; i++)
+
+       for (size_t i = 0; i < arm11->wrp; i++)
                (pos++)->address = ARM11_SC7_WCR0 + i;
-       }
+
 
        (pos++)->address = ARM11_SC7_VCR;
 
@@ -803,7 +902,7 @@ void arm11_sc7_clear_vbw(arm11_common_t * arm11)
  * \param arm11                Target state variable.
  * \param value                Value to be written
  */
-void arm11_sc7_set_vcr(arm11_common_t * arm11, u32 value)
+void arm11_sc7_set_vcr(struct arm11_common * arm11, uint32_t value)
 {
        arm11_sc7_action_t              set_vcr;
 
@@ -824,22 +923,96 @@ void arm11_sc7_set_vcr(arm11_common_t * arm11, u32 value)
  * \param result       Pointer where to store result
  *
  */
-int arm11_read_memory_word(arm11_common_t * arm11, u32 address, u32 * result)
+int arm11_read_memory_word(struct arm11_common * arm11, uint32_t address, uint32_t * result)
 {
        int retval;
-       arm11_run_instr_data_prepare(arm11);
+       retval = arm11_run_instr_data_prepare(arm11);
+       if (retval != ERROR_OK)
+               return retval;
 
        /* MRC p14,0,r0,c0,c5,0 (r0 = address) */
-       if ((retval=arm11_run_instr_data_to_core1(arm11, 0xee100e15, address))!=ERROR_OK)
-               return retval;
+       CHECK_RETVAL(arm11_run_instr_data_to_core1(arm11, 0xee100e15, address));
 
        /* LDC p14,c5,[R0],#4 (DTR = [r0]) */
-       if ((retval=arm11_run_instr_data_from_core(arm11, 0xecb05e01, result, 1))!=ERROR_OK)
-               return retval;
+       CHECK_RETVAL(arm11_run_instr_data_from_core(arm11, 0xecb05e01, result, 1));
+
+       return arm11_run_instr_data_finish(arm11);
+}
 
-       arm11_run_instr_data_finish(arm11);
+
+/** Write Embedded Trace Macrocell (ETM) via Scan chain 6
+ *
+ * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0318e/Bcfddjeh.html#Bcfggcbe
+ *
+ * \param arm11                Target state variable.
+ * \param address      7 bit ETM register address
+ * \param value                Value to be written
+ *                                     
+ * \return                     Error status
+ *
+ * \remarks                    This is a stand-alone function that executes the JTAG command queue.
+ */
+int arm11_write_etm(struct arm11_common * arm11, uint8_t address, uint32_t value)
+{
+       CHECK_RETVAL(arm11_add_debug_SCAN_N(arm11, 0x06, ARM11_TAP_DEFAULT));
+
+       /* Uses INTEST for read and write */
+       arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
+
+       struct scan_field               chain6_fields[3];
+
+       uint8_t                         nRW                     = 1;
+
+       arm11_setup_field(arm11, 32, &value,            NULL,           chain6_fields + 0);
+       arm11_setup_field(arm11,  7, &address,          NULL,           chain6_fields + 1);
+       arm11_setup_field(arm11,  1, &nRW,                      NULL,           chain6_fields + 2);
+
+       arm11_add_dr_scan_vc(asizeof(chain6_fields), chain6_fields, TAP_IDLE);
+
+       CHECK_RETVAL(jtag_execute_queue());
 
        return ERROR_OK;
 }
 
+/** Read Embedded Trace Macrocell (ETM) via Scan chain 6
+ *
+ * http://infocenter.arm.com/help/topic/com.arm.doc.ddi0318e/Bcfddjeh.html#Bcfggcbe
+ *
+ * \param arm11                Target state variable.
+ * \param address      7 bit ETM register address
+ * \param value                Pointer that receives value that was read
+ *                                     
+ * \return                     Error status
+ *
+ * \remarks                    This is a stand-alone function that executes the JTAG command queue.
+ */
+int arm11_read_etm(struct arm11_common * arm11, uint8_t address, uint32_t * value)
+{
+       CHECK_RETVAL(arm11_add_debug_SCAN_N(arm11, 0x06, ARM11_TAP_DEFAULT));
+
+       /* Uses INTEST for read and write */
+       arm11_add_IR(arm11, ARM11_INTEST, ARM11_TAP_DEFAULT);
+
+       struct scan_field               chain6_fields[3];
+
+       uint8_t                         nRW                     = 0;
+
+       arm11_setup_field(arm11, 32, NULL,                      NULL,           chain6_fields + 0);
+       arm11_setup_field(arm11,  7, &address,          NULL,           chain6_fields + 1);
+       arm11_setup_field(arm11,  1, &nRW,                      NULL,           chain6_fields + 2);
+
+       arm11_add_dr_scan_vc(asizeof(chain6_fields), chain6_fields, TAP_IDLE);
+
+       /* Data is made available in Capture-DR and shifted out on the next access */
+
+       arm11_setup_field(arm11, 32, NULL,                      value,          chain6_fields + 0);
+       arm11_setup_field(arm11,  7, &address,          NULL,           chain6_fields + 1);
+       arm11_setup_field(arm11,  1, &nRW,                      NULL,           chain6_fields + 2);
+
+       arm11_add_dr_scan_vc(asizeof(chain6_fields), chain6_fields, TAP_IDLE);
+
+       CHECK_RETVAL(jtag_execute_queue());
+
+       return ERROR_OK;
+}
 

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)