command: print BUG warning when usage is missing
[fw/openocd] / src / target / xscale.c
index 2b8bff16a8a65fce5aba115f102da3e90eaf80af..93074ee21c6c258a0a3e27d5231c49d926c2960d 100644 (file)
@@ -244,7 +244,7 @@ static int xscale_read_dcsr(struct target *target)
 static void xscale_getbuf(jtag_callback_data_t arg)
 {
        uint8_t *in = (uint8_t *)arg;
-       *((uint32_t *)in) = buf_get_u32(in, 0, 32);
+       *((uint32_t *)arg) = buf_get_u32(in, 0, 32);
 }
 
 static int xscale_receive(struct target *target, uint32_t *buffer, int num_words)
@@ -273,12 +273,16 @@ static int xscale_receive(struct target *target, uint32_t *buffer, int num_words
        memset(&fields, 0, sizeof fields);
 
        fields[0].num_bits = 3;
+       uint8_t tmp;
+       fields[0].in_value = &tmp;
        fields[0].check_value = &field0_check_value;
        fields[0].check_mask = &field0_check_mask;
 
        fields[1].num_bits = 32;
 
        fields[2].num_bits = 1;
+       uint8_t tmp2;
+       fields[2].in_value = &tmp2;
        fields[2].check_value = &field2_check_value;
        fields[2].check_mask = &field2_check_mask;
 
@@ -317,7 +321,7 @@ static int xscale_receive(struct target *target, uint32_t *buffer, int num_words
                /* examine results */
                for (i = words_done; i < num_words; i++)
                {
-                       if (!(field0[0] & 1))
+                       if (!(field0[i] & 1))
                        {
                                /* move backwards if necessary */
                                int j;
@@ -528,7 +532,7 @@ static int xscale_write_rx(struct target *target)
 }
 
 /* send count elements of size byte to the debug handler */
-static int xscale_send(struct target *target, uint8_t *buffer, int count, int size)
+static int xscale_send(struct target *target, const uint8_t *buffer, int count, int size)
 {
        struct xscale_common *xscale = target_to_xscale(target);
        uint32_t t[3];
@@ -1044,21 +1048,20 @@ static int xscale_debug_entry(struct target *target)
        xscale->armv4_5_mmu.armv4_5_cache.i_cache_enabled = (xscale->cp15_control_reg & 0x1000U) ? 1 : 0;
 
        /* tracing enabled, read collected trace data */
-       if (xscale->trace.buffer_enabled)
+       if (xscale->trace.mode != XSCALE_TRACE_DISABLED)
        {
                xscale_read_trace(target);
-               xscale->trace.buffer_fill--;
 
-               /* resume if we're still collecting trace data */
-               if ((xscale->arch_debug_reason == XSCALE_DBG_REASON_TB_FULL)
-                       && (xscale->trace.buffer_fill > 0))
+               /* Resume if entered debug due to buffer fill and we're still collecting
+                * trace data.  Note that a debug exception due to trace buffer full
+                * can only happen in fill mode. */
+               if (xscale->arch_debug_reason == XSCALE_DBG_REASON_TB_FULL)
                {
+                 if (--xscale->trace.fill_counter > 0)
                        xscale_resume(target, 1, 0x0, 1, 0);
                }
-               else
-               {
-                       xscale->trace.buffer_enabled = 0;
-               }
+               else    /* entered debug for other reason; reset counter */
+                 xscale->trace.fill_counter = 0;
        }
 
        return ERROR_OK;
@@ -1162,12 +1165,25 @@ static void xscale_enable_breakpoints(struct target *target)
        }
 }
 
+static void xscale_free_trace_data(struct xscale_common *xscale)
+{
+   struct xscale_trace_data *td = xscale->trace.data;
+   while (td)
+   {
+         struct xscale_trace_data *next_td = td->next;
+         if (td->entries)
+                free(td->entries);
+         free(td);
+         td = next_td;
+   }
+   xscale->trace.data = NULL;
+}
+
 static int xscale_resume(struct target *target, int current,
                uint32_t address, int handle_breakpoints, int debug_execution)
 {
        struct xscale_common *xscale = target_to_xscale(target);
        struct arm *armv4_5 = &xscale->armv4_5_common;
-       struct breakpoint *breakpoint = target->breakpoints;
        uint32_t current_pc;
        int retval;
        int i;
@@ -1205,12 +1221,13 @@ static int xscale_resume(struct target *target, int current,
        /* the front-end may request us not to handle breakpoints */
        if (handle_breakpoints)
        {
+               struct breakpoint *breakpoint;
                breakpoint = breakpoint_find(target,
                                buf_get_u32(armv4_5->pc->value, 0, 32));
                if (breakpoint != NULL)
                {
                        uint32_t next_pc;
-                       int saved_trace_buffer_enabled;
+                       enum trace_mode saved_trace_mode;
 
                        /* there's a breakpoint at the current PC, we have to step over it */
                        LOG_DEBUG("unset breakpoint at 0x%8.8" PRIx32 "", breakpoint->address);
@@ -1229,6 +1246,8 @@ static int xscale_resume(struct target *target, int current,
 
                        /* restore banked registers */
                        retval = xscale_restore_banked(target);
+                       if (retval != ERROR_OK)
+                               return retval;
 
                        /* send resume request */
                        xscale_send_u32(target, 0x30);
@@ -1253,14 +1272,14 @@ static int xscale_resume(struct target *target, int current,
                                        buf_get_u32(armv4_5->pc->value, 0, 32));
 
                        /* disable trace data collection in xscale_debug_entry() */
-                       saved_trace_buffer_enabled = xscale->trace.buffer_enabled;
-                       xscale->trace.buffer_enabled = 0;
+                       saved_trace_mode = xscale->trace.mode;
+                       xscale->trace.mode = XSCALE_TRACE_DISABLED;
 
                        /* wait for and process debug entry */
                        xscale_debug_entry(target);
 
                        /* re-enable trace buffer, if enabled previously */
-                       xscale->trace.buffer_enabled = saved_trace_buffer_enabled;
+                       xscale->trace.mode = saved_trace_mode;
 
                        LOG_DEBUG("disable single-step");
                        xscale_disable_single_step(target);
@@ -1276,11 +1295,26 @@ static int xscale_resume(struct target *target, int current,
 
        /* restore banked registers */
        retval = xscale_restore_banked(target);
+       if (retval != ERROR_OK)
+               return retval;
 
        /* send resume request (command 0x30 or 0x31)
         * clean the trace buffer if it is to be enabled (0x62) */
-       if (xscale->trace.buffer_enabled)
+       if (xscale->trace.mode != XSCALE_TRACE_DISABLED)
        {
+               if (xscale->trace.mode == XSCALE_TRACE_FILL)
+               {
+                  /* If trace enabled in fill mode and starting collection of new set
+                       * of buffers, initialize buffer counter and free previous buffers */
+                  if (xscale->trace.fill_counter == 0)
+                  {
+                         xscale->trace.fill_counter = xscale->trace.buffer_fill;
+                         xscale_free_trace_data(xscale);
+                  }
+               }
+               else     /* wrap mode; free previous buffer */
+                  xscale_free_trace_data(xscale);
+
                xscale_send_u32(target, 0x62);
                xscale_send_u32(target, 0x31);
        }
@@ -1356,7 +1390,7 @@ static int xscale_step_inner(struct target *target, int current,
 
        /* send resume request (command 0x30 or 0x31)
         * clean the trace buffer if it is to be enabled (0x62) */
-       if (xscale->trace.buffer_enabled)
+       if (xscale->trace.mode != XSCALE_TRACE_DISABLED)
        {
                if ((retval = xscale_send_u32(target, 0x62)) != ERROR_OK)
                        return retval;
@@ -1436,6 +1470,7 @@ static int xscale_step(struct target *target, int current,
                if ((retval = arm_simulate_step(target, NULL)) != ERROR_OK)
                        return retval;
                current_pc = buf_get_u32(armv4_5->pc->value, 0, 32);
+               LOG_DEBUG("current pc %" PRIx32, current_pc);
 
                target->debug_reason = DBG_REASON_SINGLESTEP;
                target_call_event_callbacks(target, TARGET_EVENT_HALTED);
@@ -1454,6 +1489,8 @@ static int xscale_step(struct target *target, int current,
        }
 
        retval = xscale_step_inner(target, current, address, handle_breakpoints);
+       if (retval != ERROR_OK)
+               return retval;
 
        if (breakpoint)
        {
@@ -1533,6 +1570,9 @@ static int xscale_deassert_reset(struct target *target)
                breakpoint = breakpoint->next;
        }
 
+       xscale->trace.mode = XSCALE_TRACE_DISABLED;
+       xscale_free_trace_data(xscale);
+
        register_cache_invalidate(xscale->armv4_5_common.core_cache);
 
        /* FIXME mark hardware watchpoints got unset too.  Also,
@@ -1908,7 +1948,7 @@ static int xscale_read_phys_memory(struct target *target, uint32_t address,
 }
 
 static int xscale_write_memory(struct target *target, uint32_t address,
-               uint32_t size, uint32_t count, uint8_t *buffer)
+               uint32_t size, uint32_t count, const uint8_t *buffer)
 {
        struct xscale_common *xscale = target_to_xscale(target);
        int retval;
@@ -1979,6 +2019,7 @@ static int xscale_write_memory(struct target *target, uint32_t address,
                if ((retval = xscale_send_u32(target, 0x60)) != ERROR_OK)
                        return retval;
 
+               LOG_ERROR("data abort writing memory");
                return ERROR_TARGET_DATA_ABORT;
        }
 
@@ -1986,13 +2027,13 @@ static int xscale_write_memory(struct target *target, uint32_t address,
 }
 
 static int xscale_write_phys_memory(struct target *target, uint32_t address,
-               uint32_t size, uint32_t count, uint8_t *buffer)
+               uint32_t size, uint32_t count, const uint8_t *buffer)
 {
        struct xscale_common *xscale = target_to_xscale(target);
 
        /* with MMU inactive, there are only physical addresses */
        if (!xscale->armv4_5_mmu.mmu_enabled)
-               return xscale_read_memory(target, address, size, count, buffer);
+               return xscale_write_memory(target, address, size, count, buffer);
 
        /** \todo: provide a non-stub implementation of this routine. */
        LOG_ERROR("%s: %s is not implemented.  Disable MMU?",
@@ -2001,7 +2042,7 @@ static int xscale_write_phys_memory(struct target *target, uint32_t address,
 }
 
 static int xscale_bulk_write_memory(struct target *target, uint32_t address,
-               uint32_t count, uint8_t *buffer)
+               uint32_t count, const uint8_t *buffer)
 {
        return xscale_write_memory(target, address, 4, count, buffer);
 }
@@ -2141,9 +2182,9 @@ static int xscale_set_breakpoint(struct target *target,
                        breakpoint->set = 2;    /* breakpoint set on second breakpoint register */
                }
                else
-               {
+               {       /* bug: availability previously verified in xscale_add_breakpoint() */
                        LOG_ERROR("BUG: no hardware comparator available");
-                       return ERROR_OK;
+                       return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
                }
        }
        else if (breakpoint->type == BKPT_SOFT)
@@ -2169,7 +2210,7 @@ static int xscale_set_breakpoint(struct target *target,
                                return retval;
                        }
                        /* write the bkpt instruction in target endianness (arm7_9->arm_bkpt is host endian) */
-                       if ((retval = target_write_u32(target, breakpoint->address, xscale->thumb_bkpt)) != ERROR_OK)
+                       if ((retval = target_write_u16(target, breakpoint->address, xscale->thumb_bkpt)) != ERROR_OK)
                        {
                                return retval;
                        }
@@ -2192,13 +2233,13 @@ static int xscale_add_breakpoint(struct target *target,
 
        if ((breakpoint->type == BKPT_HARD) && (xscale->ibcr_available < 1))
        {
-               LOG_INFO("no breakpoint unit available for hardware breakpoint");
+               LOG_ERROR("no breakpoint unit available for hardware breakpoint");
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        }
 
        if ((breakpoint->length != 2) && (breakpoint->length != 4))
        {
-               LOG_INFO("only breakpoints of two (Thumb) or four (ARM) bytes length supported");
+               LOG_ERROR("only breakpoints of two (Thumb) or four (ARM) bytes length supported");
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        }
 
@@ -2207,7 +2248,7 @@ static int xscale_add_breakpoint(struct target *target,
                xscale->ibcr_available--;
        }
 
-       return ERROR_OK;
+       return xscale_set_breakpoint(target, breakpoint);
 }
 
 static int xscale_unset_breakpoint(struct target *target,
@@ -2276,7 +2317,7 @@ static int xscale_remove_breakpoint(struct target *target, struct breakpoint *br
 
        if (target->state != TARGET_HALTED)
        {
-               LOG_WARNING("target not halted");
+               LOG_ERROR("target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
@@ -2301,7 +2342,7 @@ static int xscale_set_watchpoint(struct target *target,
 
        if (target->state != TARGET_HALTED)
        {
-               LOG_WARNING("target not halted");
+               LOG_ERROR("target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
@@ -2370,7 +2411,8 @@ static int xscale_add_watchpoint(struct target *target,
 
        if (xscale->dbr_available < 1)
        {
-               return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
+          LOG_ERROR("no more watchpoint registers available");
+          return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        }
 
        if (watchpoint->value)
@@ -2394,8 +2436,18 @@ static int xscale_add_watchpoint(struct target *target,
 
        /* watchpoints across multiple words require both DBR registers */
        if (xscale->dbr_available < 2)
+       {
+          LOG_ERROR("insufficient watchpoint registers available");
           return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
+       }
        
+       if (watchpoint->length > watchpoint->address)
+       {
+          LOG_ERROR("xscale does not support watchpoints with length "
+                                "greater than address");
+          return ERROR_COMMAND_ARGUMENT_INVALID;
+       }
+          
        xscale->dbr_available = 0;
        return ERROR_OK;
 }
@@ -2449,7 +2501,7 @@ static int xscale_remove_watchpoint(struct target *target, struct watchpoint *wa
 
        if (target->state != TARGET_HALTED)
        {
-               LOG_WARNING("target not halted");
+               LOG_ERROR("target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
@@ -2712,7 +2764,7 @@ static int xscale_read_instruction(struct target *target, uint32_t pc,
                        pc - xscale->trace.image->sections[section].base_address,
                        4, buf, &size_read)) != ERROR_OK)
                {
-                       LOG_ERROR("error while reading instruction: %i", retval);
+                       LOG_ERROR("error while reading instruction");
                        return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
                }
                opcode = target_buffer_get_u32(target, buf);
@@ -2725,7 +2777,7 @@ static int xscale_read_instruction(struct target *target, uint32_t pc,
                        pc - xscale->trace.image->sections[section].base_address,
                        2, buf, &size_read)) != ERROR_OK)
                {
-                       LOG_ERROR("error while reading instruction: %i", retval);
+                       LOG_ERROR("error while reading instruction");
                        return ERROR_TRACE_INSTRUCTION_UNAVAILABLE;
                }
                opcode = target_buffer_get_u16(target, buf);
@@ -3108,11 +3160,11 @@ static int xscale_init_arch_info(struct target *target,
 
        xscale->vector_catch = 0x1;
 
-       xscale->trace.capture_status = TRACE_IDLE;
        xscale->trace.data = NULL;
        xscale->trace.image = NULL;
-       xscale->trace.buffer_enabled = 0;
+       xscale->trace.mode = XSCALE_TRACE_DISABLED;
        xscale->trace.buffer_fill = 0;
+       xscale->trace.fill_counter = 0;
 
        /* prepare ARMv4/5 specific information */
        armv4_5->arch_info = xscale;
@@ -3454,47 +3506,54 @@ COMMAND_HANDLER(xscale_handle_trace_buffer_command)
                return ERROR_OK;
        }
 
-       if ((CMD_ARGC >= 1) && (strcmp("enable", CMD_ARGV[0]) == 0))
-       {
-               struct xscale_trace_data *td, *next_td;
-               xscale->trace.buffer_enabled = 1;
-
-               /* free old trace data */
-               td = xscale->trace.data;
-               while (td)
-               {
-                       next_td = td->next;
-
-                       if (td->entries)
-                               free(td->entries);
-                       free(td);
-                       td = next_td;
-               }
-               xscale->trace.data = NULL;
-       }
-       else if ((CMD_ARGC >= 1) && (strcmp("disable", CMD_ARGV[0]) == 0))
+       if (CMD_ARGC >= 1)
        {
-               xscale->trace.buffer_enabled = 0;
+          if (strcmp("enable", CMD_ARGV[0]) == 0)
+                 xscale->trace.mode = XSCALE_TRACE_WRAP; /* default */
+          else if (strcmp("disable", CMD_ARGV[0]) == 0)
+                 xscale->trace.mode = XSCALE_TRACE_DISABLED;
+          else
+                 return ERROR_INVALID_ARGUMENTS;
        }
 
-       if ((CMD_ARGC >= 2) && (strcmp("fill", CMD_ARGV[1]) == 0))
+       if (CMD_ARGC >= 2 && xscale->trace.mode != XSCALE_TRACE_DISABLED)
        {
-               uint32_t fill = 1;
-               if (CMD_ARGC >= 3)
-                       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], fill);
-               xscale->trace.buffer_fill = fill;
+          if (strcmp("fill", CMD_ARGV[1]) == 0)
+          {
+                 int buffcount = 1;                    /* default */
+                 if (CMD_ARGC >= 3)
+                        COMMAND_PARSE_NUMBER(int, CMD_ARGV[2], buffcount);
+                 if (buffcount < 1)                    /* invalid */
+                 {
+                        command_print(CMD_CTX, "fill buffer count must be > 0");
+                        xscale->trace.mode = XSCALE_TRACE_DISABLED;
+                        return ERROR_INVALID_ARGUMENTS;
+                 }
+                 xscale->trace.buffer_fill = buffcount;
+                 xscale->trace.mode = XSCALE_TRACE_FILL;
+          }
+          else if (strcmp("wrap", CMD_ARGV[1]) == 0)
+                 xscale->trace.mode = XSCALE_TRACE_WRAP;
+          else
+          {
+                 xscale->trace.mode = XSCALE_TRACE_DISABLED;
+                 return ERROR_INVALID_ARGUMENTS;
+          }
        }
-       else if ((CMD_ARGC >= 2) && (strcmp("wrap", CMD_ARGV[1]) == 0))
+       
+       if (xscale->trace.mode != XSCALE_TRACE_DISABLED)
        {
-               xscale->trace.buffer_fill = -1;
+          char fill_string[12];
+          sprintf(fill_string, "fill %" PRId32, xscale->trace.buffer_fill); 
+          command_print(CMD_CTX, "trace buffer enabled (%s)",
+                                        (xscale->trace.mode == XSCALE_TRACE_FILL)
+                                        ? fill_string : "wrap");
        }
-
-       command_print(CMD_CTX, "trace buffer %s (%s)",
-               (xscale->trace.buffer_enabled) ? "enabled" : "disabled",
-               (xscale->trace.buffer_fill > 0) ? "fill" : "wrap");
-
+       else
+          command_print(CMD_CTX, "trace buffer disabled");
+          
        dcsr_value = buf_get_u32(xscale->reg_cache->reg_list[XSCALE_DCSR].value, 0, 32);
-       if (xscale->trace.buffer_fill >= 0)
+       if (xscale->trace.mode == XSCALE_TRACE_FILL)
                xscale_write_dcsr_sw(target, (dcsr_value & 0xfffffffc) | 2);
        else
                xscale_write_dcsr_sw(target, dcsr_value & 0xfffffffc);
@@ -3762,7 +3821,7 @@ static const struct command_registration xscale_exec_command_handlers[] = {
                .mode = COMMAND_EXEC,
                .help = "display trace buffer status, enable or disable "
                        "tracing, and optionally reconfigure trace mode",
-               .usage = "['enable'|'disable' ['fill' number|'wrap']]",
+               .usage = "['enable'|'disable' ['fill' [number]|'wrap']]",
        },
        {
                .name = "dump_trace",