target_t -> struct target
[fw/openocd] / src / target / armv7m.c
index 45722f54284e3924c0547616f4aeddaf701df190..9c2e95c38bfd0daf386f4faff150834601d9b117 100644 (file)
@@ -43,7 +43,8 @@
 #define _DEBUG_INSTRUCTION_EXECUTION_
 #endif
 
-char* armv7m_mode_strings[] =
+/** Maps from enum armv7m_mode (except ARMV7M_MODE_ANY) to name. */
+char *armv7m_mode_strings[] =
 {
        "Thread", "Thread (User)", "Handler",
 };
@@ -56,16 +57,18 @@ static char *armv7m_exception_strings[] =
        "DebugMonitor", "RESERVED", "PendSV", "SysTick"
 };
 
-uint8_t armv7m_gdb_dummy_fp_value[] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
+static uint8_t armv7m_gdb_dummy_fp_value[12] = {
+       0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+};
 
-reg_t armv7m_gdb_dummy_fp_reg =
+static struct reg armv7m_gdb_dummy_fp_reg =
 {
        "GDB dummy floating-point register", armv7m_gdb_dummy_fp_value, 0, 1, 96, NULL, 0, NULL, 0
 };
 
-uint8_t armv7m_gdb_dummy_fps_value[] = {0, 0, 0, 0};
+static uint8_t armv7m_gdb_dummy_fps_value[] = {0, 0, 0, 0};
 
-reg_t armv7m_gdb_dummy_fps_reg =
+static struct reg armv7m_gdb_dummy_fps_reg =
 {
        "GDB dummy floating-point status register", armv7m_gdb_dummy_fps_value, 0, 1, 32, NULL, 0, NULL, 0
 };
@@ -73,7 +76,7 @@ reg_t armv7m_gdb_dummy_fps_reg =
 #ifdef ARMV7_GDB_HACKS
 uint8_t armv7m_gdb_dummy_cpsr_value[] = {0, 0, 0, 0};
 
-reg_t armv7m_gdb_dummy_cpsr_reg =
+struct reg armv7m_gdb_dummy_cpsr_reg =
 {
        "GDB dummy cpsr register", armv7m_gdb_dummy_cpsr_value, 0, 1, 32, NULL, 0, NULL, 0
 };
@@ -83,6 +86,9 @@ reg_t armv7m_gdb_dummy_cpsr_reg =
  * These registers are not memory-mapped.  The ARMv7-M profile includes
  * memory mapped registers too, such as for the NVIC (interrupt controller)
  * and SysTick (timer) modules; those can mostly be treated as peripherals.
+ *
+ * The ARMv6-M profile is almost identical in this respect, except that it
+ * doesn't include basepri or faultmask registers.
  */
 static const struct {
        unsigned id;
@@ -121,15 +127,16 @@ static const struct {
 
 #define ARMV7M_NUM_REGS        ARRAY_SIZE(armv7m_regs)
 
-int armv7m_core_reg_arch_type = -1;
-int armv7m_dummy_core_reg_arch_type = -1;
+static int armv7m_core_reg_arch_type = -1;
 
-int armv7m_restore_context(target_t *target)
+/**
+ * Restores target context using the cache of core registers set up
+ * by armv7m_build_reg_cache(), calling optional core-specific hooks.
+ */
+int armv7m_restore_context(struct target *target)
 {
        int i;
-
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
 
        LOG_DEBUG(" ");
 
@@ -151,6 +158,14 @@ int armv7m_restore_context(target_t *target)
 }
 
 /* Core state functions */
+
+/**
+ * Maps ISR number (from xPSR) to name.
+ * Note that while names and meanings for the first sixteen are standardized
+ * (with zero not a true exception), external interrupts are only numbered.
+ * They are assigned by vendors, which generally assign different numbers to
+ * peripherals (such as UART0 or a USB peripheral controller).
+ */
 char *armv7m_exception_string(int number)
 {
        static char enamebuf[32];
@@ -163,27 +178,27 @@ char *armv7m_exception_string(int number)
        return enamebuf;
 }
 
-int armv7m_get_core_reg(reg_t *reg)
+static int armv7m_get_core_reg(struct reg *reg)
 {
        int retval;
-       armv7m_core_reg_t *armv7m_reg = reg->arch_info;
-       target_t *target = armv7m_reg->target;
-       armv7m_common_t *armv7m_target = target->arch_info;
+       struct armv7m_core_reg *armv7m_reg = reg->arch_info;
+       struct target *target = armv7m_reg->target;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
 
        if (target->state != TARGET_HALTED)
        {
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       retval = armv7m_target->read_core_reg(target, armv7m_reg->num);
+       retval = armv7m->read_core_reg(target, armv7m_reg->num);
 
        return retval;
 }
 
-int armv7m_set_core_reg(reg_t *reg, uint8_t *buf)
+static int armv7m_set_core_reg(struct reg *reg, uint8_t *buf)
 {
-       armv7m_core_reg_t *armv7m_reg = reg->arch_info;
-       target_t *target = armv7m_reg->target;
+       struct armv7m_core_reg *armv7m_reg = reg->arch_info;
+       struct target *target = armv7m_reg->target;
        uint32_t value = buf_get_u32(buf, 0, 32);
 
        if (target->state != TARGET_HALTED)
@@ -198,14 +213,12 @@ int armv7m_set_core_reg(reg_t *reg, uint8_t *buf)
        return ERROR_OK;
 }
 
-int armv7m_read_core_reg(struct target_s *target, int num)
+static int armv7m_read_core_reg(struct target *target, int num)
 {
        uint32_t reg_value;
        int retval;
-       armv7m_core_reg_t * armv7m_core_reg;
-
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_core_reg * armv7m_core_reg;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
 
        if ((num < 0) || (num >= ARMV7M_NUM_REGS))
                return ERROR_INVALID_ARGUMENTS;
@@ -219,14 +232,12 @@ int armv7m_read_core_reg(struct target_s *target, int num)
        return retval;
 }
 
-int armv7m_write_core_reg(struct target_s *target, int num)
+static int armv7m_write_core_reg(struct target *target, int num)
 {
        int retval;
        uint32_t reg_value;
-       armv7m_core_reg_t *armv7m_core_reg;
-
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_core_reg *armv7m_core_reg;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
 
        if ((num < 0) || (num >= ARMV7M_NUM_REGS))
                return ERROR_INVALID_ARGUMENTS;
@@ -247,10 +258,10 @@ int armv7m_write_core_reg(struct target_s *target, int num)
        return ERROR_OK;
 }
 
-int armv7m_invalidate_core_regs(target_t *target)
+/** Invalidates cache of core registers set up by armv7m_build_reg_cache(). */
+int armv7m_invalidate_core_regs(struct target *target)
 {
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
        int i;
 
        for (i = 0; i < armv7m->core_cache->num_regs; i++)
@@ -262,14 +273,19 @@ int armv7m_invalidate_core_regs(target_t *target)
        return ERROR_OK;
 }
 
-int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_size)
+/**
+ * Returns generic ARM userspace registers to GDB.
+ * GDB doesn't quite understand that most ARMs don't have floating point
+ * hardware, so this also fakes a set of long-obsolete FPA registers that
+ * are not used in EABI based software stacks.
+ */
+int armv7m_get_gdb_reg_list(struct target *target, struct reg **reg_list[], int *reg_list_size)
 {
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
        int i;
 
        *reg_list_size = 26;
-       *reg_list = malloc(sizeof(reg_t*) * (*reg_list_size));
+       *reg_list = malloc(sizeof(struct reg*) * (*reg_list_size));
 
        /*
         * GDB register packet format for ARM:
@@ -305,7 +321,7 @@ int armv7m_get_gdb_reg_list(target_t *target, reg_t **reg_list[], int *reg_list_
 }
 
 /* run to exit point. return error if exit point was not reached. */
-static int armv7m_run_and_wait(struct target_s *target, uint32_t entry_point, int timeout_ms, uint32_t exit_point, armv7m_common_t *armv7m)
+static int armv7m_run_and_wait(struct target *target, uint32_t entry_point, int timeout_ms, uint32_t exit_point, struct armv7m_common *armv7m)
 {
        uint32_t pc;
        int retval;
@@ -339,11 +355,15 @@ static int armv7m_run_and_wait(struct target_s *target, uint32_t entry_point, in
        return ERROR_OK;
 }
 
-int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_params, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info)
+/** Runs a Thumb algorithm in the target. */
+int armv7m_run_algorithm(struct target *target,
+       int num_mem_params, struct mem_param *mem_params,
+       int num_reg_params, struct reg_param *reg_params,
+       uint32_t entry_point, uint32_t exit_point,
+       int timeout_ms, void *arch_info)
 {
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
-       armv7m_algorithm_t *armv7m_algorithm_info = arch_info;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct armv7m_algorithm *armv7m_algorithm_info = arch_info;
        enum armv7m_mode core_mode = armv7m->core_mode;
        int retval = ERROR_OK;
        int i;
@@ -378,7 +398,7 @@ int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_
 
        for (i = 0; i < num_reg_params; i++)
        {
-               reg_t *reg = register_get_by_name(armv7m->core_cache, reg_params[i].reg_name, 0);
+               struct reg *reg = register_get_by_name(armv7m->core_cache, reg_params[i].reg_name, 0);
 //             uint32_t regvalue;
 
                if (!reg)
@@ -406,6 +426,11 @@ int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_
                armv7m->core_cache->reg_list[ARMV7M_CONTROL].valid = 1;
        }
 
+       /* REVISIT speed things up (3% or so in one case) by requiring
+        * algorithms to include a BKPT instruction at each exit point.
+        * This eliminates overheads of adding/removing a breakpoint.
+        */
+
        /* ARMV7M always runs in Thumb state */
        if ((retval = breakpoint_add(target, exit_point, 2, BKPT_SOFT)) != ERROR_OK)
        {
@@ -437,7 +462,7 @@ int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_
        {
                if (reg_params[i].direction != PARAM_OUT)
                {
-                       reg_t *reg = register_get_by_name(armv7m->core_cache, reg_params[i].reg_name, 0);
+                       struct reg *reg = register_get_by_name(armv7m->core_cache, reg_params[i].reg_name, 0);
 
                        if (!reg)
                        {
@@ -475,10 +500,10 @@ int armv7m_run_algorithm(struct target_s *target, int num_mem_params, mem_param_
        return retval;
 }
 
-int armv7m_arch_state(struct target_s *target)
+/** Logs summary of ARMv7-M state for a halted target. */
+int armv7m_arch_state(struct target *target)
 {
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
+       struct armv7m_common *armv7m = target_to_armv7m(target);
        uint32_t ctrl, sp;
 
        ctrl = buf_get_u32(armv7m->core_cache->reg_list[ARMV7M_CONTROL].value, 0, 32);
@@ -498,16 +523,15 @@ int armv7m_arch_state(struct target_s *target)
        return ERROR_OK;
 }
 
-reg_cache_t *armv7m_build_reg_cache(target_t *target)
+/** Builds cache of architecturally defined registers.  */
+struct reg_cache *armv7m_build_reg_cache(struct target *target)
 {
-       /* get pointers to arch-specific information */
-       armv7m_common_t *armv7m = target->arch_info;
-
+       struct armv7m_common *armv7m = target_to_armv7m(target);
        int num_regs = ARMV7M_NUM_REGS;
-       reg_cache_t **cache_p = register_get_last_cache_p(&target->reg_cache);
-       reg_cache_t *cache = malloc(sizeof(reg_cache_t));
-       reg_t *reg_list = calloc(num_regs, sizeof(reg_t));
-       armv7m_core_reg_t *arch_info = calloc(num_regs, sizeof(armv7m_core_reg_t));
+       struct reg_cache **cache_p = register_get_last_cache_p(&target->reg_cache);
+       struct reg_cache *cache = malloc(sizeof(struct reg_cache));
+       struct reg *reg_list = calloc(num_regs, sizeof(struct reg));
+       struct armv7m_core_reg *arch_info = calloc(num_regs, sizeof(struct armv7m_core_reg));
        int i;
 
        if (armv7m_core_reg_arch_type == -1)
@@ -548,14 +572,8 @@ reg_cache_t *armv7m_build_reg_cache(target_t *target)
        return cache;
 }
 
-int armv7m_init_target(struct command_context_s *cmd_ctx, struct target_s *target)
-{
-       armv7m_build_reg_cache(target);
-
-       return ERROR_OK;
-}
-
-int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m)
+/** Sets up target as a generic ARMv7-M core */
+int armv7m_init_arch_info(struct target *target, struct armv7m_common *armv7m)
 {
        /* register arch-specific functions */
 
@@ -566,14 +584,16 @@ int armv7m_init_arch_info(target_t *target, armv7m_common_t *armv7m)
        return ERROR_OK;
 }
 
-int armv7m_checksum_memory(struct target_s *target, uint32_t address, uint32_t count, uint32_t* checksum)
+/** Generates a CRC32 checksum of a memory region. */
+int armv7m_checksum_memory(struct target *target,
+               uint32_t address, uint32_t count, uint32_t* checksum)
 {
-       working_area_t *crc_algorithm;
-       armv7m_algorithm_t armv7m_info;
-       reg_param_t reg_params[2];
+       struct working_area *crc_algorithm;
+       struct armv7m_algorithm armv7m_info;
+       struct reg_param reg_params[2];
        int retval;
 
-       uint16_t cortex_m3_crc_code[] = {
+       static const uint16_t cortex_m3_crc_code[] = {
                0x4602,                                 /* mov  r2, r0 */
                0xF04F, 0x30FF,                 /* mov  r0, #0xffffffff */
                0x460B,                                 /* mov  r3, r1 */
@@ -647,23 +667,25 @@ int armv7m_checksum_memory(struct target_s *target, uint32_t address, uint32_t c
        return ERROR_OK;
 }
 
-int armv7m_blank_check_memory(struct target_s *target, uint32_t address, uint32_t count, uint32_t* blank)
+/** Checks whether a memory region is zeroed. */
+int armv7m_blank_check_memory(struct target *target,
+               uint32_t address, uint32_t count, uint32_t* blank)
 {
-       working_area_t *erase_check_algorithm;
-       reg_param_t reg_params[3];
-       armv7m_algorithm_t armv7m_info;
+       struct working_area *erase_check_algorithm;
+       struct reg_param reg_params[3];
+       struct armv7m_algorithm armv7m_info;
        int retval;
        uint32_t i;
 
-       uint16_t erase_check_code[] =
+       static const uint16_t erase_check_code[] =
        {
-                                                       /* loop: */
-               0xF810, 0x3B01,         /* ldrb         r3, [r0], #1 */
-               0xEA02, 0x0203,         /* and  r2, r2, r3 */
-               0x3901,                         /* subs         r1, r1, #1 */
-               0xD1F9,                         /* bne          loop */
-                                                       /* end: */
-               0xE7FE,                         /* b            end */
+               /* loop: */
+               0xF810, 0x3B01,         /* ldrb r3, [r0], #1 */
+               0xEA02, 0x0203,         /* and  r2, r2, r3 */
+               0x3901,                         /* subs r1, r1, #1 */
+               0xD1F9,                         /* bne  loop */
+               /* end: */
+               0xE7FE,                         /* b    end */
        };
 
        /* make sure we have a working area */
@@ -709,93 +731,107 @@ int armv7m_blank_check_memory(struct target_s *target, uint32_t address, uint32_
        return ERROR_OK;
 }
 
+/*--------------------------------------------------------------------------*/
+
+/*
+ * Only stuff below this line should need to verify that its target
+ * is an ARMv7-M node.
+ *
+ * FIXME yet none of it _does_ verify target types yet!
+ */
+
+
 /*
  * Return the debug ap baseaddress in hexadecimal;
  * no extra output to simplify script processing
  */
-static int handle_dap_baseaddr_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_dap_baseaddr_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
-       armv7m_common_t *armv7m = target->arch_info;
-       swjdp_common_t *swjdp = &armv7m->swjdp_info;
+       struct target *target = get_current_target(cmd_ctx);
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct swjdp_common *swjdp = &armv7m->swjdp_info;
        uint32_t apsel, apselsave, baseaddr;
        int retval;
 
-       apsel = swjdp->apsel;
        apselsave = swjdp->apsel;
-       if (argc > 0)
-       {
-               apsel = strtoul(args[0], NULL, 0);
+       switch (argc) {
+       case 0:
+               apsel = swjdp->apsel;
+               break;
+       case 1:
+               COMMAND_PARSE_NUMBER(u32, args[0], apsel);
+               break;
+       default:
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
+
        if (apselsave != apsel)
-       {
                dap_ap_select(swjdp, apsel);
-       }
 
        dap_ap_read_reg_u32(swjdp, 0xF8, &baseaddr);
        retval = swjdp_transaction_endcheck(swjdp);
        command_print(cmd_ctx, "0x%8.8" PRIx32 "", baseaddr);
 
        if (apselsave != apsel)
-       {
                dap_ap_select(swjdp, apselsave);
-       }
 
        return retval;
 }
 
-
 /*
  * Return the debug ap id in hexadecimal;
  * no extra output to simplify script processing
  */
-extern int handle_dap_apid_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_dap_apid_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
-       armv7m_common_t *armv7m = target->arch_info;
-       swjdp_common_t *swjdp = &armv7m->swjdp_info;
+       struct target *target = get_current_target(cmd_ctx);
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct swjdp_common *swjdp = &armv7m->swjdp_info;
 
-       return dap_apid_command(cmd_ctx, swjdp, args, argc);
+       return CALL_COMMAND_HANDLER(dap_apid_command, swjdp);
 }
 
-static int handle_dap_apsel_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_dap_apsel_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
-       armv7m_common_t *armv7m = target->arch_info;
-       swjdp_common_t *swjdp = &armv7m->swjdp_info;
+       struct target *target = get_current_target(cmd_ctx);
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct swjdp_common *swjdp = &armv7m->swjdp_info;
 
-       return dap_apsel_command(cmd_ctx, swjdp, args, argc);
+       return CALL_COMMAND_HANDLER(dap_apsel_command, swjdp);
 }
 
-static int handle_dap_memaccess_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_dap_memaccess_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
-       armv7m_common_t *armv7m = target->arch_info;
-       swjdp_common_t *swjdp = &armv7m->swjdp_info;
+       struct target *target = get_current_target(cmd_ctx);
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct swjdp_common *swjdp = &armv7m->swjdp_info;
 
-       return dap_memaccess_command(cmd_ctx, swjdp, args, argc);
+       return CALL_COMMAND_HANDLER(dap_memaccess_command, swjdp);
 }
 
 
-static int handle_dap_info_command(struct command_context_s *cmd_ctx,
-               char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_dap_info_command)
 {
-       target_t *target = get_current_target(cmd_ctx);
-       armv7m_common_t *armv7m = target->arch_info;
-       swjdp_common_t *swjdp = &armv7m->swjdp_info;
+       struct target *target = get_current_target(cmd_ctx);
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       struct swjdp_common *swjdp = &armv7m->swjdp_info;
        uint32_t apsel;
 
-       apsel =  swjdp->apsel;
-       if (argc > 0)
-               apsel = strtoul(args[0], NULL, 0);
+       switch (argc) {
+       case 0:
+               apsel = swjdp->apsel;
+               break;
+       case 1:
+               COMMAND_PARSE_NUMBER(u32, args[0], apsel);
+               break;
+       default:
+               return ERROR_COMMAND_SYNTAX_ERROR;
+       }
 
        return dap_info_command(cmd_ctx, swjdp, apsel);
 }
 
+/** Registers commands used to access DAP resources. */
 int armv7m_register_commands(struct command_context_s *cmd_ctx)
 {
        command_t *arm_adi_v5_dap_cmd;