openocd: src/target: replace the GPL-2.0-or-later license tag
[fw/openocd] / src / target / arm_semihosting.c
index 57f3139c2bae1b4b8a84ac17499df86582974870..853e20fa3f54e9462166a39704552493f625d1af 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2009 by Marvell Technology Group Ltd.                   *
  *   Written by Nicolas Pitre <nico@marvell.com>                           *
  *                                                                         *
  *   Copyright (C) 2018 by Liviu Ionescu                                   *
  *   <ilg@livius.net>                                                      *
- *                                                                         *
- *   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/>. *
  ***************************************************************************/
 
 /**
@@ -46,6 +35,7 @@
 #include "arm7_9_common.h"
 #include "armv7m.h"
 #include "armv7a.h"
+#include "armv8.h"
 #include "cortex_m.h"
 #include "register.h"
 #include "arm_opcodes.h"
 #include <helper/log.h>
 #include <sys/stat.h>
 
+static int arm_semihosting_resume(struct target *target, int *retval)
+{
+       if (is_armv8(target_to_armv8(target))) {
+               struct armv8_common *armv8 = target_to_armv8(target);
+               if (armv8->last_run_control_op == ARMV8_RUNCONTROL_RESUME) {
+                       *retval = target_resume(target, 1, 0, 0, 0);
+                       if (*retval != ERROR_OK) {
+                               LOG_ERROR("Failed to resume target");
+                               return 0;
+                       }
+               } else if (armv8->last_run_control_op == ARMV8_RUNCONTROL_STEP)
+                       target->debug_reason = DBG_REASON_SINGLESTEP;
+       } else {
+               *retval = target_resume(target, 1, 0, 0, 0);
+               if (*retval != ERROR_OK) {
+                       LOG_ERROR("Failed to resume target");
+                       return 0;
+               }
+       }
+       return 1;
+}
+
 static int post_result(struct target *target)
 {
        struct arm *arm = target_to_arm(target);
 
+       if (!target->semihosting)
+               return ERROR_FAIL;
+
        /* REVISIT this looks wrong ... ARM11 and Cortex-A8
         * should work this way at least sometimes.
         */
@@ -68,12 +83,12 @@ static int post_result(struct target *target)
 
                /* return value in R0 */
                buf_set_u32(arm->core_cache->reg_list[0].value, 0, 32, target->semihosting->result);
-               arm->core_cache->reg_list[0].dirty = 1;
+               arm->core_cache->reg_list[0].dirty = true;
 
                /* LR --> PC */
                buf_set_u32(arm->core_cache->reg_list[15].value, 0, 32,
                        buf_get_u32(arm_reg_current(arm, 14)->value, 0, 32));
-               arm->core_cache->reg_list[15].dirty = 1;
+               arm->core_cache->reg_list[15].dirty = true;
 
                /* saved PSR --> current PSR */
                spsr = buf_get_u32(arm->spsr->value, 0, 32);
@@ -83,18 +98,44 @@ static int post_result(struct target *target)
                 */
 
                buf_set_u32(arm->cpsr->value, 0, 32, spsr);
-               arm->cpsr->dirty = 1;
+               arm->cpsr->dirty = true;
                arm->core_mode = spsr & 0x1f;
                if (spsr & 0x20)
                        arm->core_state = ARM_STATE_THUMB;
 
+       } else if (is_armv8(target_to_armv8(target))) {
+               if (arm->core_state == ARM_STATE_AARCH64) {
+                       /* return value in R0 */
+                       buf_set_u64(arm->core_cache->reg_list[0].value, 0, 64, target->semihosting->result);
+                       arm->core_cache->reg_list[0].dirty = true;
+
+                       uint64_t pc = buf_get_u64(arm->core_cache->reg_list[32].value, 0, 64);
+                       buf_set_u64(arm->pc->value, 0, 64, pc + 4);
+                       arm->pc->dirty = true;
+               }  else if (arm->core_state == ARM_STATE_ARM) {
+                       /* return value in R0 */
+                       buf_set_u32(arm->core_cache->reg_list[0].value, 0, 32, target->semihosting->result);
+                       arm->core_cache->reg_list[0].dirty = true;
+
+                       uint32_t pc = buf_get_u32(arm->core_cache->reg_list[32].value, 0, 32);
+                       buf_set_u32(arm->pc->value, 0, 32, pc + 4);
+                       arm->pc->dirty = true;
+               } else if (arm->core_state == ARM_STATE_THUMB) {
+                       /* return value in R0 */
+                       buf_set_u32(arm->core_cache->reg_list[0].value, 0, 32, target->semihosting->result);
+                       arm->core_cache->reg_list[0].dirty = true;
+
+                       uint32_t pc = buf_get_u32(arm->core_cache->reg_list[32].value, 0, 32);
+                       buf_set_u32(arm->pc->value, 0, 32, pc + 2);
+                       arm->pc->dirty = true;
+               }
        } else {
                /* resume execution, this will be pc+2 to skip over the
                 * bkpt instruction */
 
                /* return result in R0 */
                buf_set_u32(arm->core_cache->reg_list[0].value, 0, 32, target->semihosting->result);
-               arm->core_cache->reg_list[0].dirty = 1;
+               arm->core_cache->reg_list[0].dirty = true;
        }
 
        return ERROR_OK;
@@ -235,6 +276,63 @@ int arm_semihosting(struct target *target, int *retval)
                /* bkpt 0xAB */
                if (insn != 0xBEAB)
                        return 0;
+       } else if (is_armv8(target_to_armv8(target))) {
+               if (target->debug_reason != DBG_REASON_BREAKPOINT)
+                       return 0;
+
+               /* According to ARM Semihosting for AArch32 and AArch64:
+                * The HLT encodings are new in version 2.0 of the semihosting specification.
+                * Where possible, have semihosting callers continue to use the previously
+                * existing trap instructions to ensure compatibility with legacy semihosting
+                * implementations.
+                * These trap instructions are HLT for A64, SVC on A+R profile A32 or T32,
+                * and BKPT on M profile.
+                * However, it is necessary to change from SVC to HLT instructions to support
+                * AArch32 semihosting properly in a mixed AArch32/AArch64 system. */
+
+               if (arm->core_state == ARM_STATE_AARCH64) {
+                       uint32_t insn = 0;
+                       r = arm->pc;
+                       uint64_t pc64 = buf_get_u64(r->value, 0, 64);
+                       *retval = target_read_u32(target, pc64, &insn);
+
+                       if (*retval != ERROR_OK)
+                               return 1;
+
+                       /* HLT 0xF000 */
+                       if (insn != 0xD45E0000)
+                               return 0;
+               } else if (arm->core_state == ARM_STATE_ARM) {
+                       r = arm->pc;
+                       pc = buf_get_u32(r->value, 0, 32);
+
+                       /* A32 instruction => check for HLT 0xF000 (0xE10F0070) */
+                       uint32_t insn = 0;
+
+                       *retval = target_read_u32(target, pc, &insn);
+
+                       if (*retval != ERROR_OK)
+                               return 1;
+
+                       /* HLT 0xF000*/
+                       if (insn != 0xE10F0070)
+                               return 0;
+               } else if (arm->core_state == ARM_STATE_THUMB) {
+                       r = arm->pc;
+                       pc = buf_get_u32(r->value, 0, 32);
+
+                       /* T32 instruction => check for HLT 0x3C (0xBABC) */
+                       uint16_t insn = 0;
+                       *retval = target_read_u16(target, pc, &insn);
+
+                       if (*retval != ERROR_OK)
+                               return 1;
+
+                       /* HLT 0x3C*/
+                       if (insn != 0xBABC)
+                               return 0;
+               } else
+                       return 1;
        } else {
                LOG_ERROR("Unsupported semi-hosting Target");
                return 0;
@@ -244,19 +342,27 @@ int arm_semihosting(struct target *target, int *retval)
         * operation to complete.
         */
        if (!semihosting->hit_fileio) {
-               /* TODO: update for 64-bits */
-               uint32_t r0 = buf_get_u32(arm->core_cache->reg_list[0].value, 0, 32);
-               uint32_t r1 = buf_get_u32(arm->core_cache->reg_list[1].value, 0, 32);
-
-               semihosting->op = r0;
-               semihosting->param = r1;
-               semihosting->word_size_bytes = 4;
+               if (is_armv8(target_to_armv8(target)) &&
+                               arm->core_state == ARM_STATE_AARCH64) {
+                       /* Read op and param from register x0 and x1 respectively. */
+                       semihosting->op = buf_get_u64(arm->core_cache->reg_list[0].value, 0, 64);
+                       semihosting->param = buf_get_u64(arm->core_cache->reg_list[1].value, 0, 64);
+                       semihosting->word_size_bytes = 8;
+               } else {
+                       /* Read op and param from register r0 and r1 respectively. */
+                       semihosting->op = buf_get_u32(arm->core_cache->reg_list[0].value, 0, 32);
+                       semihosting->param = buf_get_u32(arm->core_cache->reg_list[1].value, 0, 32);
+                       semihosting->word_size_bytes = 4;
+               }
 
                /* Check for ARM operation numbers. */
-               if (0 <= semihosting->op && semihosting->op <= 0x31) {
+               if ((semihosting->op >= 0 && semihosting->op <= 0x31) ||
+                       (semihosting->op >= 0x100 && semihosting->op <= 0x107)) {
+
                        *retval = semihosting_common(target);
                        if (*retval != ERROR_OK) {
-                               LOG_ERROR("Failed semihosting operation");
+                               LOG_ERROR("Failed semihosting operation (0x%02X)",
+                                               semihosting->op);
                                return 0;
                        }
                } else {
@@ -265,19 +371,11 @@ int arm_semihosting(struct target *target, int *retval)
                }
        }
 
-       /* Post result to target if we are not waiting on a fileio
+       /* Resume if target it is resumable and we are not waiting on a fileio
         * operation to complete:
         */
-       if (semihosting->is_resumable && !semihosting->hit_fileio) {
-               /* Resume right after the BRK instruction. */
-               *retval = target_resume(target, 1, 0, 0, 0);
-               if (*retval != ERROR_OK) {
-                       LOG_ERROR("Failed to resume target");
-                       return 0;
-               }
-
-               return 1;
-       }
+       if (semihosting->is_resumable && !semihosting->hit_fileio)
+               return arm_semihosting_resume(target, retval);
 
        return 0;
 }