openocd: remove CamelCase symbols *xPSR*
[fw/openocd] / src / target / hla_target.c
index 725c2d2feb54338438e3830f9685a3e977361e32..d3a16cd9b8194d902ce0147e2854d3f11314a023 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2011 by Mathias Kuester                                 *
  *   Mathias Kuester <kesmtp@freenet.de>                                   *
@@ -6,19 +8,6 @@
  *   spen@spen-soft.co.uk                                                  *
  *                                                                         *
  *   revised:  4/25/13 by brent@mbari.org [DCC target request support]    *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "target_type.h"
 #include "armv7m.h"
 #include "cortex_m.h"
+#include "arm_adi_v5.h"
 #include "arm_semihosting.h"
 #include "target_request.h"
+#include <rtt/rtt.h>
 
-#define savedDCRDR  dbgbase  /* FIXME: using target->dbgbase to preserve DCRDR */
+#define SAVED_DCRDR  dbgbase  /* FIXME: using target->dbgbase to preserve DCRDR */
 
 #define ARMV7M_SCS_DCRSR       DCB_DCRSR
 #define ARMV7M_SCS_DCRDR       DCB_DCRDR
@@ -53,123 +44,15 @@ static inline struct hl_interface_s *target_to_adapter(struct target *target)
 static int adapter_load_core_reg_u32(struct target *target,
                uint32_t regsel, uint32_t *value)
 {
-       int retval;
        struct hl_interface_s *adapter = target_to_adapter(target);
-
-       LOG_DEBUG("%s", __func__);
-
-       /* NOTE:  we "know" here that the register identifiers used
-        * in the v7m header match the Cortex-M3 Debug Core Register
-        * Selector values for R0..R15, xPSR, MSP, and PSP.
-        */
-       switch (regsel) {
-       case ARMV7M_REGSEL_R0 ... ARMV7M_REGSEL_PSP:
-               /* read a normal core register */
-               retval = adapter->layout->api->read_reg(adapter->handle, regsel, value);
-
-               if (retval != ERROR_OK) {
-                       LOG_ERROR("JTAG failure %i", retval);
-                       return ERROR_JTAG_DEVICE_ERROR;
-               }
-               LOG_DEBUG("load from core reg %" PRIu32 " value 0x%" PRIx32 "", regsel, *value);
-               break;
-
-       case ARMV7M_REGSEL_FPSCR:
-               /* Floating-point Status and Registers */
-               retval = target_write_u32(target, ARMV7M_SCS_DCRSR, regsel);
-               if (retval != ERROR_OK)
-                       return retval;
-               retval = target_read_u32(target, ARMV7M_SCS_DCRDR, value);
-               if (retval != ERROR_OK)
-                       return retval;
-               LOG_DEBUG("load from FPSCR  value 0x%" PRIx32, *value);
-               break;
-
-       case ARMV7M_REGSEL_S0 ... ARMV7M_REGSEL_S31:
-               /* Floating-point Status and Registers */
-               retval = target_write_u32(target, ARMV7M_SCS_DCRSR, regsel);
-               if (retval != ERROR_OK)
-                       return retval;
-               retval = target_read_u32(target, ARMV7M_SCS_DCRDR, value);
-               if (retval != ERROR_OK)
-                       return retval;
-               LOG_DEBUG("load from FPU reg S%d  value 0x%" PRIx32,
-                         (int)(regsel - ARMV7M_REGSEL_S0), *value);
-               break;
-
-       case ARMV7M_REGSEL_PMSK_BPRI_FLTMSK_CTRL:
-               retval = adapter->layout->api->read_reg(adapter->handle, ARMV7M_REGSEL_PMSK_BPRI_FLTMSK_CTRL, value);
-               if (retval != ERROR_OK)
-                       return retval;
-
-               LOG_DEBUG("load from special reg PRIMASK/BASEPRI/FAULTMASK/CONTROL value 0x%" PRIx32, *value);
-               break;
-
-       default:
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       return ERROR_OK;
+       return adapter->layout->api->read_reg(adapter->handle, regsel, value);
 }
 
 static int adapter_store_core_reg_u32(struct target *target,
                uint32_t regsel, uint32_t value)
 {
-       int retval;
-       struct armv7m_common *armv7m = target_to_armv7m(target);
        struct hl_interface_s *adapter = target_to_adapter(target);
-
-       LOG_DEBUG("%s", __func__);
-
-       switch (regsel) {
-       case ARMV7M_REGSEL_R0 ... ARMV7M_REGSEL_PSP:
-               retval = adapter->layout->api->write_reg(adapter->handle, regsel, value);
-
-               if (retval != ERROR_OK) {
-                       struct reg *r;
-
-                       LOG_ERROR("JTAG failure");
-                       r = armv7m->arm.core_cache->reg_list + regsel; /* TODO: don't use regsel as register index */
-                       r->dirty = r->valid;
-                       return ERROR_JTAG_DEVICE_ERROR;
-               }
-               LOG_DEBUG("write core reg %" PRIu32 " value 0x%" PRIx32 "", regsel, value);
-               break;
-
-       case ARMV7M_REGSEL_FPSCR:
-               /* Floating-point Status and Registers */
-               retval = target_write_u32(target, ARMV7M_SCS_DCRDR, value);
-               if (retval != ERROR_OK)
-                       return retval;
-               retval = target_write_u32(target, ARMV7M_SCS_DCRSR, ARMV7M_REGSEL_FPSCR | DCRSR_WnR);
-               if (retval != ERROR_OK)
-                       return retval;
-               LOG_DEBUG("write FPSCR value 0x%" PRIx32, value);
-               break;
-
-       case ARMV7M_REGSEL_S0 ... ARMV7M_REGSEL_S31:
-               /* Floating-point Status and Registers */
-               retval = target_write_u32(target, ARMV7M_SCS_DCRDR, value);
-               if (retval != ERROR_OK)
-                       return retval;
-               retval = target_write_u32(target, ARMV7M_SCS_DCRSR, regsel | DCRSR_WnR);
-               if (retval != ERROR_OK)
-                       return retval;
-               LOG_DEBUG("write FPU reg S%d  value 0x%" PRIx32,
-                         (int)(regsel - ARMV7M_REGSEL_S0), value);
-               break;
-
-       case ARMV7M_REGSEL_PMSK_BPRI_FLTMSK_CTRL:
-               adapter->layout->api->write_reg(adapter->handle, ARMV7M_REGSEL_PMSK_BPRI_FLTMSK_CTRL, value);
-
-               LOG_DEBUG("write special reg PRIMASK/BASEPRI/FAULTMASK/CONTROL value 0x%" PRIx32, value);
-               break;
-
-       default:
-               return ERROR_COMMAND_SYNTAX_ERROR;
-       }
-
-       return ERROR_OK;
+       return adapter->layout->api->write_reg(adapter->handle, regsel, value);
 }
 
 static int adapter_examine_debug_reason(struct target *target)
@@ -286,7 +169,7 @@ static int adapter_init_arch_info(struct target *target,
        armv7m->store_core_reg_u32 = adapter_store_core_reg_u32;
 
        armv7m->examine_debug_reason = adapter_examine_debug_reason;
-       armv7m->stlink = true;
+       armv7m->is_hla_target = true;
 
        target_register_timer_callback(hl_handle_target_request, 1,
                TARGET_TIMER_TYPE_PERIODIC, target);
@@ -309,17 +192,19 @@ static int adapter_target_create(struct target *target,
 {
        LOG_DEBUG("%s", __func__);
        struct adiv5_private_config *pc = target->private_config;
-       if (pc != NULL && pc->ap_num > 0) {
+       if (pc && pc->ap_num != DP_APSEL_INVALID && pc->ap_num != 0) {
                LOG_ERROR("hla_target: invalid parameter -ap-num (> 0)");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        struct cortex_m_common *cortex_m = calloc(1, sizeof(struct cortex_m_common));
-       if (cortex_m == NULL) {
+       if (!cortex_m) {
                LOG_ERROR("No memory creating target");
                return ERROR_FAIL;
        }
 
+       cortex_m->common_magic = CORTEX_M_COMMON_MAGIC;
+
        adapter_init_arch_info(target, cortex_m, target->tap);
 
        return ERROR_OK;
@@ -333,7 +218,7 @@ static int adapter_load_context(struct target *target)
        for (int i = 0; i < num_regs; i++) {
 
                struct reg *r = &armv7m->arm.core_cache->reg_list[i];
-               if (!r->valid)
+               if (r->exist && !r->valid)
                        armv7m->arm.read_core_reg(target, r, i, ARM_MODE_ANY);
        }
 
@@ -346,11 +231,11 @@ static int adapter_debug_entry(struct target *target)
        struct armv7m_common *armv7m = target_to_armv7m(target);
        struct arm *arm = &armv7m->arm;
        struct reg *r;
-       uint32_t xPSR;
+       uint32_t xpsr;
        int retval;
 
        /* preserve the DCRDR across halts */
-       retval = target_read_u32(target, DCB_DCRDR, &target->savedDCRDR);
+       retval = target_read_u32(target, DCB_DCRDR, &target->SAVED_DCRDR);
        if (retval != ERROR_OK)
                return retval;
 
@@ -364,11 +249,11 @@ static int adapter_debug_entry(struct target *target)
        adapter->layout->api->write_debug_reg(adapter->handle, DCB_DEMCR, TRCENA);
 
        r = arm->cpsr;
-       xPSR = buf_get_u32(r->value, 0, 32);
+       xpsr = buf_get_u32(r->value, 0, 32);
 
        /* Are we in an exception handler */
-       if (xPSR & 0x1FF) {
-               armv7m->exception_number = (xPSR & 0x1FF);
+       if (xpsr & 0x1FF) {
+               armv7m->exception_number = (xpsr & 0x1FF);
 
                arm->core_mode = ARM_MODE_HANDLER;
                arm->map = armv7m_msp_reg_map;
@@ -512,7 +397,7 @@ static int hl_deassert_reset(struct target *target)
        if (jtag_reset_config & RESET_HAS_SRST)
                adapter_deassert_reset();
 
-       target->savedDCRDR = 0;  /* clear both DCC busy bits on initial resume */
+       target->SAVED_DCRDR = 0;  /* clear both DCC busy bits on initial resume */
 
        return target->reset_halt ? ERROR_OK : target_resume(target, 1, 0, 0, 0);
 }
@@ -588,8 +473,8 @@ static int adapter_resume(struct target *target, int current,
 
        armv7m_restore_context(target);
 
-       /* restore savedDCRDR */
-       res = target_write_u32(target, DCB_DCRDR, target->savedDCRDR);
+       /* restore SAVED_DCRDR */
+       res = target_write_u32(target, DCB_DCRDR, target->SAVED_DCRDR);
        if (res != ERROR_OK)
                return res;
 
@@ -671,8 +556,8 @@ static int adapter_step(struct target *target, int current,
 
        armv7m_restore_context(target);
 
-       /* restore savedDCRDR */
-       res = target_write_u32(target, DCB_DCRDR, target->savedDCRDR);
+       /* restore SAVED_DCRDR */
+       res = target_write_u32(target, DCB_DCRDR, target->SAVED_DCRDR);
        if (res != ERROR_OK)
                return res;
 
@@ -727,26 +612,33 @@ static int adapter_write_memory(struct target *target, target_addr_t address,
        return adapter->layout->api->write_mem(adapter->handle, address, size, count, buffer);
 }
 
-static const struct command_registration adapter_command_handlers[] = {
+static const struct command_registration hla_command_handlers[] = {
        {
                .chain = arm_command_handlers,
        },
        {
                .chain = armv7m_trace_command_handlers,
        },
+       {
+               .chain = rtt_target_command_handlers,
+       },
+       /* START_DEPRECATED_TPIU */
+       {
+               .chain = arm_tpiu_deprecated_command_handlers,
+       },
+       /* END_DEPRECATED_TPIU */
        COMMAND_REGISTRATION_DONE
 };
 
 struct target_type hla_target = {
        .name = "hla_target",
-       .deprecated_name = "stm32_stlink",
 
        .init_target = adapter_init_target,
        .deinit_target = cortex_m_deinit_target,
        .target_create = adapter_target_create,
        .target_jim_configure = adiv5_jim_configure,
        .examine = cortex_m_examine,
-       .commands = adapter_command_handlers,
+       .commands = hla_command_handlers,
 
        .poll = adapter_poll,
        .arch_state = armv7m_arch_state,