openocd: src/target: replace the GPL-2.0-or-later license tag
[fw/openocd] / src / target / armv4_5.h
index c8882ed75856331c761dc71721226ccff6e33ee4..250fa82fc5a7967d0dd01877b8a7c365a008354b 100644 (file)
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
@@ -7,58 +9,15 @@
  *                                                                         *
  *   Copyright (C) 2009 by Ã˜yvind Harboe                                   *
  *   oyvind.harboe@zylin.com                                               *
- *                                                                         *
- *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
-#ifndef ARMV4_5_H
-#define ARMV4_5_H
-
-#include <target/target.h>
-#include <helper/command.h>
 
+#ifndef OPENOCD_TARGET_ARMV4_5_H
+#define OPENOCD_TARGET_ARMV4_5_H
 
-/**
- * These numbers match the five low bits of the *PSR registers on
- * "classic ARM" processors, which build on the ARMv4 processor
- * modes and register set.
+/* This stuff "knows" that its callers aren't talking
+ * to microcontroller profile (current Cortex-M) parts.
+ * We want to phase it out so core code can be shared.
  */
-enum arm_mode {
-       ARM_MODE_USR = 16,
-       ARM_MODE_FIQ = 17,
-       ARM_MODE_IRQ = 18,
-       ARM_MODE_SVC = 19,
-       ARM_MODE_ABT = 23,
-       ARM_MODE_MON = 26,
-       ARM_MODE_UND = 27,
-       ARM_MODE_SYS = 31,
-       ARM_MODE_ANY = -1
-};
-
-const char *arm_mode_name(unsigned psr_mode);
-bool is_arm_mode(unsigned psr_mode);
-
-/** The PSR "T" and "J" bits define the mode of "classic ARM" cores. */
-enum arm_state {
-       ARM_STATE_ARM,
-       ARM_STATE_THUMB,
-       ARM_STATE_JAZELLE,
-       ARM_STATE_THUMB_EE,
-};
-
-extern const char *arm_state_strings[];
 
 /* OBSOLETE, DO NOT USE IN NEW CODE!  The "number" of an arm_mode is an
  * index into the armv4_5_core_reg_map array.  Its remaining users are
@@ -68,148 +27,12 @@ extern const char *arm_state_strings[];
 int arm_mode_to_number(enum arm_mode mode);
 enum arm_mode armv4_5_number_to_mode(int number);
 
-extern const int armv4_5_core_reg_map[8][17];
+extern const int armv4_5_core_reg_map[9][17];
 
 #define ARMV4_5_CORE_REG_MODE(cache, mode, num) \
-               cache->reg_list[armv4_5_core_reg_map[arm_mode_to_number(mode)][num]]
+               (cache->reg_list[armv4_5_core_reg_map[arm_mode_to_number(mode)][num]])
 
 /* offset into armv4_5 core register cache -- OBSOLETE, DO NOT USE! */
 enum { ARMV4_5_CPSR = 31, };
 
-#define ARM_COMMON_MAGIC 0x0A450A45
-
-/**
- * Represents a generic ARM core, with standard application registers.
- *
- * There are sixteen application registers (including PC, SP, LR) and a PSR.
- * Cortex-M series cores do not support as many core states or shadowed
- * registers as traditional ARM cores, and only support Thumb2 instructions.
- */
-struct arm
-{
-       int common_magic;
-       struct reg_cache *core_cache;
-
-       /** Handle to the CPSR; valid in all core modes. */
-       struct reg *cpsr;
-
-       /** Handle to the SPSR; valid only in core modes with an SPSR. */
-       struct reg *spsr;
-
-       /** Support for arm_reg_current() */
-       const int *map;
-
-       /**
-        * Indicates what registers are in the ARM state core register set.
-        * ARM_MODE_ANY indicates the standard set of 37 registers,
-        * seen on for example ARM7TDMI cores.  ARM_MODE_MON indicates three
-        * more registers are shadowed, for "Secure Monitor" mode.
-        */
-       enum arm_mode core_type;
-
-       /** Record the current core mode: SVC, USR, or some other mode. */
-       enum arm_mode core_mode;
-
-       /** Record the current core state: ARM, Thumb, or otherwise. */
-       enum arm_state core_state;
-
-       /** Flag reporting unavailability of the BKPT instruction. */
-       bool is_armv4;
-
-       /** Flag reporting whether semihosting is active. */
-       bool is_semihosting;
-
-       /** Value to be returned by semihosting SYS_ERRNO request. */
-       int semihosting_errno;
-
-       /** Backpointer to the target. */
-       struct target *target;
-
-       /** Handle for the debug module, if one is present. */
-       struct arm_dpm *dpm;
-
-       /** Handle for the Embedded Trace Module, if one is present. */
-       struct etm_context *etm;
-
-       /* FIXME all these methods should take "struct arm *" not target */
-
-       /** Retrieve all core registers, for display. */
-       int (*full_context)(struct target *target);
-
-       /** Retrieve a single core register. */
-       int (*read_core_reg)(struct target *target, struct reg *reg,
-                       int num, enum arm_mode mode);
-       int (*write_core_reg)(struct target *target, struct reg *reg,
-                       int num, enum arm_mode mode, uint32_t value);
-
-       /** Read coprocessor register.  */
-       int (*mrc)(struct target *target, int cpnum,
-                       uint32_t op1, uint32_t op2,
-                       uint32_t CRn, uint32_t CRm,
-                       uint32_t *value);
-
-       /** Write coprocessor register.  */
-       int (*mcr)(struct target *target, int cpnum,
-                       uint32_t op1, uint32_t op2,
-                       uint32_t CRn, uint32_t CRm,
-                       uint32_t value);
-
-       void *arch_info;
-};
-
-/** Convert target handle to generic ARM target state handle. */
-static inline struct arm *target_to_arm(struct target *target)
-{
-       return target->arch_info;
-}
-
-static inline bool is_arm(struct arm *arm)
-{
-       return arm && arm->common_magic == ARM_COMMON_MAGIC;
-}
-
-struct arm_algorithm
-{
-       int common_magic;
-
-       enum arm_mode core_mode;
-       enum arm_state core_state;
-};
-
-struct arm_reg
-{
-       int num;
-       enum arm_mode mode;
-       struct target *target;
-       struct arm *armv4_5_common;
-       uint32_t value;
-};
-
-struct reg_cache *arm_build_reg_cache(struct target *target, struct arm *arm);
-
-int arm_arch_state(struct target *target);
-int arm_get_gdb_reg_list(struct target *target,
-               struct reg **reg_list[], int *reg_list_size);
-
-extern const struct command_registration arm_command_handlers[];
-
-int arm_init_arch_info(struct target *target, struct arm *arm);
-
-int armv4_5_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);
-
-int arm_checksum_memory(struct target *target,
-               uint32_t address, uint32_t count, uint32_t *checksum);
-int arm_blank_check_memory(struct target *target,
-               uint32_t address, uint32_t count, uint32_t *blank);
-
-void arm_set_cpsr(struct arm *arm, uint32_t cpsr);
-struct reg *arm_reg_current(struct arm *arm, unsigned regnum);
-
-extern struct reg arm_gdb_dummy_fp_reg;
-extern struct reg arm_gdb_dummy_fps_reg;
-
-#endif /* ARMV4_5_H */
+#endif /* OPENOCD_TARGET_ARMV4_5_H */