openocd: remove CamelCase symbols *xPSR*

[fw/openocd] / src / target / armv7m.h

diff --git a/src/target/armv7m.h b/src/target/armv7m.h
index f3eb90f248616cfc784f80e67c5beca73e4f1d54..188bd5652eb502a8828d4169ee1aac8e84089a02 100644 (file)
--- a/src/target/armv7m.h
+++ b/src/target/armv7m.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,28 +9,16 @@
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   spen@spen-soft.co.uk                                                  *
- *                                                                         *
- *   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/>. *
  ***************************************************************************/
 
 #ifndef OPENOCD_TARGET_ARMV7M_H
 #define OPENOCD_TARGET_ARMV7M_H
 
-#include "arm_adi_v5.h"
 #include "arm.h"
 #include "armv7m_trace.h"
 
+struct adiv5_ap;
+
 extern const int armv7m_psp_reg_map[];
 extern const int armv7m_msp_reg_map[];
 
@@ -56,7 +46,7 @@ enum {
        ARMV7M_REGSEL_R14,
        ARMV7M_REGSEL_PC = 15,
 
-       ARMV7M_REGSEL_xPSR = 16,
+       ARMV7M_REGSEL_XPSR = 16,
        ARMV7M_REGSEL_MSP,
        ARMV7M_REGSEL_PSP,
 
@@ -134,7 +124,7 @@ enum {
        ARMV7M_R14 = ARMV7M_REGSEL_R14,
        ARMV7M_PC = ARMV7M_REGSEL_PC,
 
-       ARMV7M_xPSR = ARMV7M_REGSEL_xPSR,
+       ARMV7M_XPSR = ARMV7M_REGSEL_XPSR,
        ARMV7M_MSP = ARMV7M_REGSEL_MSP,
        ARMV7M_PSP = ARMV7M_REGSEL_PSP,
 
@@ -209,7 +199,7 @@ enum {
        /* for convenience add registers' block delimiters */
        ARMV7M_LAST_REG,
        ARMV7M_CORE_FIRST_REG = ARMV7M_R0,
-       ARMV7M_CORE_LAST_REG = ARMV7M_xPSR,
+       ARMV7M_CORE_LAST_REG = ARMV7M_XPSR,
        ARMV7M_FPU_FIRST_REG = ARMV7M_D0,
        ARMV7M_FPU_LAST_REG = ARMV7M_FPSCR,
        ARMV8M_FIRST_REG = ARMV8M_MSP_NS,
@@ -225,12 +215,13 @@ enum {
 
 #define ARMV7M_NUM_CORE_REGS (ARMV7M_CORE_LAST_REG - ARMV7M_CORE_FIRST_REG + 1)
 
-#define ARMV7M_COMMON_MAGIC 0x2A452A45
+#define ARMV7M_COMMON_MAGIC 0x2A452A45U
 
 struct armv7m_common {
+       unsigned int common_magic;
+
        struct arm arm;
 
-       int common_magic;
        int exception_number;
 
        /* AP this processor is connected to in the DAP */
@@ -254,19 +245,52 @@ struct armv7m_common {
        void (*pre_restore_context)(struct target *target);
 };
 
+static inline bool is_armv7m(const struct armv7m_common *armv7m)
+{
+       return armv7m->common_magic == ARMV7M_COMMON_MAGIC;
+}
+
+/**
+ * @returns the pointer to the target specific struct
+ * without matching a magic number.
+ * Use in target specific service routines, where the correct
+ * type of arch_info is certain.
+ */
 static inline struct armv7m_common *
 target_to_armv7m(struct target *target)
 {
        return container_of(target->arch_info, struct armv7m_common, arm);
 }
 
-static inline bool is_armv7m(const struct armv7m_common *armv7m)
+/**
+ * @returns the pointer to the target specific struct
+ * or NULL if the magic number does not match.
+ * Use in a flash driver or any place where mismatch of the arch_info
+ * type can happen.
+ */
+static inline struct armv7m_common *
+target_to_armv7m_safe(struct target *target)
 {
-       return armv7m->common_magic == ARMV7M_COMMON_MAGIC;
+       if (!target)
+               return NULL;
+
+       if (!target->arch_info)
+               return NULL;
+
+       /* Check the parent type first to prevent peeking memory too far
+        * from arch_info pointer */
+       if (!is_arm(target_to_arm(target)))
+               return NULL;
+
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       if (!is_armv7m(armv7m))
+               return NULL;
+
+       return armv7m;
 }
 
 struct armv7m_algorithm {
-       int common_magic;
+       unsigned int common_magic;
 
        enum arm_mode core_mode;
 
@@ -308,6 +332,11 @@ int armv7m_invalidate_core_regs(struct target *target);
 
 int armv7m_restore_context(struct target *target);
 
+uint32_t armv7m_map_id_to_regsel(unsigned int arm_reg_id);
+
+bool armv7m_map_reg_packing(unsigned int arm_reg_id,
+               unsigned int *reg32_id, uint32_t *offset);
+
 int armv7m_checksum_memory(struct target *target,
                target_addr_t address, uint32_t count, uint32_t *checksum);
 int armv7m_blank_check_memory(struct target *target,