openocd: remove CamelCase symbols *xPSR*
[fw/openocd] / src / target / armv8.h
index 07e3b419a715fc65671f4164680406f277d0a47c..2ed3a65acd9e8fb3f015f99b690a71090d3a9d2a 100644 (file)
@@ -1,19 +1,7 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2015 by David Ung                                       *
- *                                                                         *
- *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
  ***************************************************************************/
 
 #ifndef OPENOCD_TARGET_ARMV8_H
 #include "armv4_5_mmu.h"
 #include "armv4_5_cache.h"
 #include "armv8_dpm.h"
+#include "arm_cti.h"
 
 enum {
-       ARMV8_R0,
+       ARMV8_R0 = 0,
        ARMV8_R1,
        ARMV8_R2,
        ARMV8_R3,
@@ -57,16 +46,69 @@ enum {
        ARMV8_R28,
        ARMV8_R29,
        ARMV8_R30,
-       ARMV8_R31,
 
+       ARMV8_SP = 31,
        ARMV8_PC = 32,
-       ARMV8_xPSR = 33,
+       ARMV8_XPSR = 33,
+
+       ARMV8_V0 = 34,
+       ARMV8_V1,
+       ARMV8_V2,
+       ARMV8_V3,
+       ARMV8_V4,
+       ARMV8_V5,
+       ARMV8_V6,
+       ARMV8_V7,
+       ARMV8_V8,
+       ARMV8_V9,
+       ARMV8_V10,
+       ARMV8_V11,
+       ARMV8_V12,
+       ARMV8_V13,
+       ARMV8_V14,
+       ARMV8_V15,
+       ARMV8_V16,
+       ARMV8_V17,
+       ARMV8_V18,
+       ARMV8_V19,
+       ARMV8_V20,
+       ARMV8_V21,
+       ARMV8_V22,
+       ARMV8_V23,
+       ARMV8_V24,
+       ARMV8_V25,
+       ARMV8_V26,
+       ARMV8_V27,
+       ARMV8_V28,
+       ARMV8_V29,
+       ARMV8_V30,
+       ARMV8_V31,
+       ARMV8_FPSR,
+       ARMV8_FPCR,
+
+       ARMV8_ELR_EL1 = 68,
+       ARMV8_ESR_EL1 = 69,
+       ARMV8_SPSR_EL1 = 70,
+
+       ARMV8_ELR_EL2 = 71,
+       ARMV8_ESR_EL2 = 72,
+       ARMV8_SPSR_EL2 = 73,
+
+       ARMV8_ELR_EL3 = 74,
+       ARMV8_ESR_EL3 = 75,
+       ARMV8_SPSR_EL3 = 76,
 
        ARMV8_LAST_REG,
 };
 
+enum run_control_op {
+       ARMV8_RUNCONTROL_UNKNOWN = 0,
+       ARMV8_RUNCONTROL_RESUME = 1,
+       ARMV8_RUNCONTROL_HALT = 2,
+       ARMV8_RUNCONTROL_STEP = 3,
+};
 
-#define ARMV8_COMMON_MAGIC 0x0A450AAA
+#define ARMV8_COMMON_MAGIC 0x0A450AAAU
 
 /* VA to PA translation operations opc2 values*/
 #define V2PCWPR  0
@@ -85,7 +127,7 @@ struct armv8_l2x_cache {
 
 struct armv8_cachesize {
        uint32_t level_num;
-       /*  cache dimensionning */
+       /*  cache dimensioning */
        uint32_t linelen;
        uint32_t associativity;
        uint32_t nsets;
@@ -116,7 +158,7 @@ struct armv8_cache_common {
        /* l2 external unified cache if some */
        void *l2_cache;
        int (*flush_all_data_cache)(struct target *target);
-       int (*display_cache_info)(struct command_context *cmd_ctx,
+       int (*display_cache_info)(struct command_invocation *cmd,
                        struct armv8_cache_common *armv8_cache);
 };
 
@@ -136,14 +178,14 @@ struct armv8_mmu_common {
 };
 
 struct armv8_common {
+       unsigned int common_magic;
+
        struct arm arm;
-       int common_magic;
        struct reg_cache *core_cache;
 
        /* Core Debug Unit */
        struct arm_dpm dpm;
-       uint32_t debug_base;
-       uint32_t cti_base;
+       target_addr_t debug_base;
        struct adiv5_ap *debug_ap;
 
        const uint32_t *opcodes;
@@ -161,9 +203,20 @@ struct armv8_common {
 
        struct armv8_mmu_common armv8_mmu;
 
+       struct arm_cti *cti;
+
+       /* last run-control command issued to this target (resume, halt, step) */
+       enum run_control_op last_run_control_op;
+
        /* Direct processor core register read and writes */
-       int (*load_core_reg_u64)(struct target *target, uint32_t num, uint64_t *value);
-       int (*store_core_reg_u64)(struct target *target, uint32_t num, uint64_t value);
+       int (*read_reg_u64)(struct armv8_common *armv8, int num, uint64_t *value);
+       int (*write_reg_u64)(struct armv8_common *armv8, int num, uint64_t value);
+
+       /* SIMD/FPU registers read/write interface */
+       int (*read_reg_u128)(struct armv8_common *armv8, int num,
+                       uint64_t *lvalue, uint64_t *hvalue);
+       int (*write_reg_u128)(struct armv8_common *armv8, int num,
+                       uint64_t lvalue, uint64_t hvalue);
 
        int (*examine_debug_reason)(struct target *target);
        int (*post_debug_entry)(struct target *target);
@@ -177,6 +230,11 @@ target_to_armv8(struct target *target)
        return container_of(target->arch_info, struct armv8_common, arm);
 }
 
+static inline bool is_armv8(struct armv8_common *armv8)
+{
+       return armv8->common_magic == ARMV8_COMMON_MAGIC;
+}
+
 /* register offsets from armv8.debug_base */
 #define CPUV8_DBG_MAINID0              0xD00
 #define CPUV8_DBG_CPUFEATURE0  0xD20
@@ -188,10 +246,11 @@ target_to_armv8(struct target *target)
 
 #define CPUV8_DBG_EDESR                0x20
 #define CPUV8_DBG_EDECR                0x24
-#define CPUV8_DBG_WFAR0                0x30
-#define CPUV8_DBG_WFAR1                0x34
+#define CPUV8_DBG_EDWAR0       0x30
+#define CPUV8_DBG_EDWAR1       0x34
 #define CPUV8_DBG_DSCR         0x088
 #define CPUV8_DBG_DRCR         0x090
+#define CPUV8_DBG_ECCR         0x098
 #define CPUV8_DBG_PRCR         0x310
 #define CPUV8_DBG_PRSR         0x314
 
@@ -210,40 +269,6 @@ target_to_armv8(struct target *target)
 
 #define CPUV8_DBG_AUTHSTATUS   0xFB8
 
-/*define CTI(cross trigger interface)*/
-#define CTI_CTR                                0x0
-#define CTI_INACK                      0x10
-#define CTI_APPSET                     0x14
-#define CTI_APPCLEAR           0x18
-#define CTI_APPPULSE           0x1C
-#define CTI_INEN0                      0x20
-#define CTI_INEN1                      0x24
-#define CTI_INEN2                      0x28
-#define CTI_INEN3                      0x2C
-#define CTI_INEN4                      0x30
-#define CTI_INEN5                      0x34
-#define CTI_INEN6                      0x38
-#define CTI_INEN7                      0x3C
-#define CTI_OUTEN0                     0xA0
-#define CTI_OUTEN1                     0xA4
-#define CTI_OUTEN2                     0xA8
-#define CTI_OUTEN3                     0xAC
-#define CTI_OUTEN4                     0xB0
-#define CTI_OUTEN5                     0xB4
-#define CTI_OUTEN6                     0xB8
-#define CTI_OUTEN7                     0xBC
-#define CTI_TRIN_STATUS                0x130
-#define CTI_TROUT_STATUS       0x134
-#define CTI_CHIN_STATUS                0x138
-#define CTI_CHOU_STATUS                0x13C
-#define CTI_GATE                       0x140
-#define CTI_UNLOCK                     0xFB0
-
-#define CTI_CHNL(x)                    (1 << x)
-#define CTI_TRIG_HALT          0
-#define CTI_TRIG_RESUME                1
-#define CTI_TRIG(n)                    (1 << CTI_TRIG_##n)
-
 #define PAGE_SIZE_4KB                          0x1000
 #define PAGE_SIZE_4KB_LEVEL0_BITS      39
 #define PAGE_SIZE_4KB_LEVEL1_BITS      30
@@ -265,11 +290,41 @@ int armv8_mmu_translate_va_pa(struct target *target, target_addr_t va,
                target_addr_t *val, int meminfo);
 int armv8_mmu_translate_va(struct target *target,  target_addr_t va, target_addr_t *val);
 
-int armv8_handle_cache_info_command(struct command_context *cmd_ctx,
+int armv8_handle_cache_info_command(struct command_invocation *cmd,
                struct armv8_cache_common *armv8_cache);
 
 void armv8_set_cpsr(struct arm *arm, uint32_t cpsr);
 
+static inline unsigned int armv8_curel_from_core_mode(enum arm_mode core_mode)
+{
+       switch (core_mode) {
+       /* Aarch32 modes */
+       case ARM_MODE_USR:
+               return 0;
+       case ARM_MODE_SVC:
+       case ARM_MODE_ABT: /* FIXME: EL3? */
+       case ARM_MODE_IRQ: /* FIXME: EL3? */
+       case ARM_MODE_FIQ: /* FIXME: EL3? */
+       case ARM_MODE_UND: /* FIXME: EL3? */
+       case ARM_MODE_SYS: /* FIXME: EL3? */
+               return 1;
+       /* case ARM_MODE_HYP:
+        *     return 2;
+        */
+       case ARM_MODE_MON:
+               return 3;
+       /* all Aarch64 modes */
+       default:
+               return (core_mode >> 2) & 3;
+       }
+}
+
+const char *armv8_mode_name(unsigned psr_mode);
+void armv8_select_reg_access(struct armv8_common *armv8, bool is_aarch64);
+int armv8_set_dbgreg_bits(struct armv8_common *armv8, unsigned int reg, unsigned long mask, unsigned long value);
+
+extern void armv8_free_reg_cache(struct target *target);
+
 extern const struct command_registration armv8_command_handlers[];
 
-#endif
+#endif /* OPENOCD_TARGET_ARMV8_H */