flash/nor/at91samd: Use 32-bit register writes for ST-Link compat
[fw/openocd] / src / target / arm_dpm.h
index 8d2638e2a3b8034ac60f8f0bc36021f77c685963..d35e9f68d6dfd61a01dde4275c281d5ac28969cf 100644 (file)
@@ -1,24 +1,11 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /*
  * Copyright (C) 2009 by David Brownell
- *
- * 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 __ARM_DPM_H
-#define __ARM_DPM_H
+#ifndef OPENOCD_TARGET_ARM_DPM_H
+#define OPENOCD_TARGET_ARM_DPM_H
 
 /**
  * @file
@@ -61,37 +48,56 @@ struct arm_dpm {
        struct arm *arm;
 
        /** Cache of DIDR */
-       uint32_t didr;
+       uint64_t didr;
 
        /** Invoke before a series of instruction operations */
-       int (*prepare)(struct arm_dpm *);
+       int (*prepare)(struct arm_dpm *dpm);
 
        /** Invoke after a series of instruction operations */
-       int (*finish)(struct arm_dpm *);
+       int (*finish)(struct arm_dpm *dpm);
+
+       /** Runs one instruction. */
+       int (*instr_execute)(struct arm_dpm *dpm, uint32_t opcode);
 
        /* WRITE TO CPU */
 
        /** Runs one instruction, writing data to DCC before execution. */
-       int (*instr_write_data_dcc)(struct arm_dpm *,
+       int (*instr_write_data_dcc)(struct arm_dpm *dpm,
                        uint32_t opcode, uint32_t data);
 
+       int (*instr_write_data_dcc_64)(struct arm_dpm *dpm,
+                       uint32_t opcode, uint64_t data);
+
        /** Runs one instruction, writing data to R0 before execution. */
-       int (*instr_write_data_r0)(struct arm_dpm *,
+       int (*instr_write_data_r0)(struct arm_dpm *dpm,
                        uint32_t opcode, uint32_t data);
 
+       /** Runs one instruction, writing data to R0 before execution. */
+       int (*instr_write_data_r0_64)(struct arm_dpm *dpm,
+                       uint32_t opcode, uint64_t data);
+
        /** Optional core-specific operation invoked after CPSR writes. */
        int (*instr_cpsr_sync)(struct arm_dpm *dpm);
 
        /* READ FROM CPU */
 
        /** Runs one instruction, reading data from dcc after execution. */
-       int (*instr_read_data_dcc)(struct arm_dpm *,
+       int (*instr_read_data_dcc)(struct arm_dpm *dpm,
                        uint32_t opcode, uint32_t *data);
 
+       int (*instr_read_data_dcc_64)(struct arm_dpm *dpm,
+                       uint32_t opcode, uint64_t *data);
+
        /** Runs one instruction, reading data from r0 after execution. */
-       int (*instr_read_data_r0)(struct arm_dpm *,
+       int (*instr_read_data_r0)(struct arm_dpm *dpm,
                        uint32_t opcode, uint32_t *data);
 
+       int (*instr_read_data_r0_64)(struct arm_dpm *dpm,
+                       uint32_t opcode, uint64_t *data);
+
+       struct reg *(*arm_reg_current)(struct arm *arm,
+                       unsigned regnum);
+
        /* BREAKPOINT/WATCHPOINT SUPPORT */
 
        /**
@@ -100,7 +106,7 @@ struct arm_dpm {
         * must currently be disabled.  Indices 0..15 are used for
         * breakpoints; indices 16..31 are for watchpoints.
         */
-       int (*bpwp_enable)(struct arm_dpm *, unsigned index_value,
+       int (*bpwp_enable)(struct arm_dpm *dpm, unsigned index_value,
                        uint32_t addr, uint32_t control);
 
        /**
@@ -108,7 +114,7 @@ struct arm_dpm {
         * hardware control registers.  Indices are the same ones
         * accepted by bpwp_enable().
         */
-       int (*bpwp_disable)(struct arm_dpm *, unsigned index_value);
+       int (*bpwp_disable)(struct arm_dpm *dpm, unsigned index_value);
 
        /* The breakpoint and watchpoint arrays are private to the
         * DPM infrastructure.  There are nbp indices in the dbp
@@ -120,25 +126,32 @@ struct arm_dpm {
        struct dpm_bp *dbp;
        struct dpm_wp *dwp;
 
-       /** Address of the instruction which triggered a watchpoint. */
-       uint32_t wp_pc;
+       /**
+        * Target dependent watchpoint address.
+        * Either the address of the instruction which triggered a watchpoint
+        * or the memory address whose access triggered a watchpoint.
+        */
+       target_addr_t wp_addr;
 
        /** Recent value of DSCR. */
        uint32_t dscr;
 
+       /** Recent exception level on armv8 */
+       unsigned int last_el;
+
        /* FIXME -- read/write DCSR methods and symbols */
 };
 
 int arm_dpm_setup(struct arm_dpm *dpm);
 int arm_dpm_initialize(struct arm_dpm *dpm);
 
-int arm_dpm_read_current_registers(struct arm_dpm *);
-int dpm_modeswitch(struct arm_dpm *dpm, enum arm_mode mode);
-
+int arm_dpm_read_reg(struct arm_dpm *dpm, struct reg *r, unsigned regnum);
+int arm_dpm_read_current_registers(struct arm_dpm *dpm);
+int arm_dpm_modeswitch(struct arm_dpm *dpm, enum arm_mode mode);
 
-int arm_dpm_write_dirty_registers(struct arm_dpm *, bool bpwp);
+int arm_dpm_write_dirty_registers(struct arm_dpm *dpm, bool bpwp);
 
-void arm_dpm_report_wfar(struct arm_dpm *, uint32_t wfar);
+void arm_dpm_report_wfar(struct arm_dpm *dpm, uint32_t wfar);
 
 /* DSCR bits; see ARMv7a arch spec section C10.3.1.
  * Not all v7 bits are valid in v6.
@@ -168,21 +181,21 @@ void arm_dpm_report_wfar(struct arm_dpm *, uint32_t wfar);
 #define DSCR_DTR_TX_FULL            (0x1 << 29)
 #define DSCR_DTR_RX_FULL            (0x1 << 30) /* bit 31 is reserved */
 
-#define DSCR_ENTRY(dscr)            (((dscr) >> 2) & 0xf)
-#define DSCR_RUN_MODE(dscr)         ((dscr) & (DSCR_CORE_HALTED | DSCR_CORE_RESTARTED))
+#define DSCR_ENTRY(dscr)            ((dscr) & 0x3f)
+#define DSCR_RUN_MODE(dscr)         ((dscr) & 0x03)
 
 
 /* Methods of entry into debug mode */
-#define DSCR_ENTRY_HALT_REQ           (0x0 << 2)
-#define DSCR_ENTRY_BREAKPOINT         (0x1 << 2)
-#define DSCR_ENTRY_IMPRECISE_WATCHPT  (0x2 << 2)
-#define DSCR_ENTRY_BKPT_INSTR         (0x3 << 2)
-#define DSCR_ENTRY_EXT_DBG_REQ        (0x4 << 2)
-#define DSCR_ENTRY_VECT_CATCH         (0x5 << 2)
-#define DSCR_ENTRY_D_SIDE_ABORT       (0x6 << 2)  /* v6 only */
-#define DSCR_ENTRY_I_SIDE_ABORT       (0x7 << 2)  /* v6 only */
-#define DSCR_ENTRY_OS_UNLOCK          (0x8 << 2)
-#define DSCR_ENTRY_PRECISE_WATCHPT    (0xA << 2)
+#define DSCR_ENTRY_HALT_REQ           (0x03)
+#define DSCR_ENTRY_BREAKPOINT         (0x07)
+#define DSCR_ENTRY_IMPRECISE_WATCHPT  (0x0B)
+#define DSCR_ENTRY_BKPT_INSTR         (0x0F)
+#define DSCR_ENTRY_EXT_DBG_REQ        (0x13)
+#define DSCR_ENTRY_VECT_CATCH         (0x17)
+#define DSCR_ENTRY_D_SIDE_ABORT       (0x1B)  /* v6 only */
+#define DSCR_ENTRY_I_SIDE_ABORT       (0x1F)  /* v6 only */
+#define DSCR_ENTRY_OS_UNLOCK          (0x23)
+#define DSCR_ENTRY_PRECISE_WATCHPT    (0x2B)
 
 /* DTR modes */
 #define DSCR_EXT_DCC_NON_BLOCKING     (0x0 << 20)
@@ -200,4 +213,25 @@ void arm_dpm_report_wfar(struct arm_dpm *, uint32_t wfar);
 
 void arm_dpm_report_dscr(struct arm_dpm *dpm, uint32_t dcsr);
 
-#endif /* __ARM_DPM_H */
+/* PRCR (Device Power-down and Reset Control Register) bits */
+#define PRCR_DEBUG_NO_POWER_DOWN         (1 << 0)
+#define PRCR_WARM_RESET                  (1 << 1)
+#define PRCR_HOLD_NON_DEBUG_RESET        (1 << 2)
+
+/* PRSR (Device Power-down and Reset Status Register) bits */
+#define PRSR_POWERUP_STATUS              (1 << 0)
+#define PRSR_STICKY_POWERDOWN_STATUS     (1 << 1)
+#define PRSR_RESET_STATUS                (1 << 2)
+#define PRSR_STICKY_RESET_STATUS         (1 << 3)
+#define PRSR_HALTED                      (1 << 4)  /* v7.1 Debug only */
+#define PRSR_OSLK                        (1 << 5)  /* v7.1 Debug only */
+#define PRSR_DLK                         (1 << 6)  /* v7.1 Debug only */
+
+/* OSLSR (OS Lock Status Register) bits */
+#define OSLSR_OSLM0                      (1 << 0)
+#define OSLSR_OSLK                       (1 << 1)
+#define OSLSR_NTT                        (1 << 2)
+#define OSLSR_OSLM1                      (1 << 3)
+#define OSLSR_OSLM                       (OSLSR_OSLM0|OSLSR_OSLM1)
+
+#endif /* OPENOCD_TARGET_ARM_DPM_H */