Tcl commands: Fix improper return status in flash commands and load_image.
[fw/openocd] / src / target / arm_adi_v5.h
index 63d7f286e8c916727112edc3eff23c1df614289a..3220d8b6d27e12c260b43a6a80cd8a9d426a6241 100644 (file)
  *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
-#ifndef ARM_ADI_V5_H
-#define ARM_ADI_V5_H
+#ifndef OPENOCD_TARGET_ARM_ADI_V5_H
+#define OPENOCD_TARGET_ARM_ADI_V5_H
 
 /**
  * @file
  * resources accessed through a MEM-AP.
  */
 
+#include <helper/list.h>
 #include "arm_jtag.h"
 
-/* FIXME remove these JTAG-specific decls when mem_ap_read_buf_u32()
- * is no longer JTAG-specific
- */
-#define JTAG_DP_DPACC          0xA
-#define JTAG_DP_APACC          0xB
-
 /* three-bit ACK values for SWD access (sent LSB first) */
 #define SWD_ACK_OK    0x1
 #define SWD_ACK_WAIT  0x2
 /* A[3:0] for DP registers; A[1:0] are always zero.
  * - JTAG accesses all of these via JTAG_DP_DPACC, except for
  *   IDCODE (JTAG_DP_IDCODE) and ABORT (JTAG_DP_ABORT).
- * - SWD accesses these directly, sometimes needing SELECT.CTRLSEL
+ * - SWD accesses these directly, sometimes needing SELECT.DPBANKSEL
  */
-#define DP_IDCODE              BANK_REG(0x0, 0x0)      /* SWD: read */
-#define DP_ABORT               BANK_REG(0x0, 0x0)      /* SWD: write */
-#define DP_CTRL_STAT           BANK_REG(0x0, 0x4)      /* r/w */
-#define DP_RESEND              BANK_REG(0x0, 0x8)      /* SWD: read */
-#define DP_SELECT              BANK_REG(0x0, 0x8)      /* JTAG: r/w; SWD: write */
-#define DP_RDBUFF              BANK_REG(0x0, 0xC)      /* read-only */
-#define DP_WCR                 BANK_REG(0x1, 0x4)      /* SWD: r/w */
-
-#define WCR_TO_TRN(wcr) ((uint32_t)(1 + (3 & ((wcr)) >> 8)))   /* 1..4 clocks */
-#define WCR_TO_PRESCALE(wcr) ((uint32_t)(7 & ((wcr))))         /* impl defined */
+#define DP_DPIDR        BANK_REG(0x0, 0x0) /* DPv1+: ro */
+#define DP_ABORT        BANK_REG(0x0, 0x0) /* DPv1+: SWD: wo */
+#define DP_CTRL_STAT    BANK_REG(0x0, 0x4) /* DPv0+: rw */
+#define DP_DLCR         BANK_REG(0x1, 0x4) /* DPv1+: SWD: rw */
+#define DP_TARGETID     BANK_REG(0x2, 0x4) /* DPv2: ro */
+#define DP_DLPIDR       BANK_REG(0x3, 0x4) /* DPv2: ro */
+#define DP_EVENTSTAT    BANK_REG(0x4, 0x4) /* DPv2: ro */
+#define DP_RESEND       BANK_REG(0x0, 0x8) /* DPv1+: SWD: ro */
+#define DP_SELECT       BANK_REG(0x0, 0x8) /* DPv0+: JTAG: rw; SWD: wo */
+#define DP_RDBUFF       BANK_REG(0x0, 0xC) /* DPv0+: ro */
+#define DP_TARGETSEL    BANK_REG(0x0, 0xC) /* DPv2: SWD: wo */
+
+#define DLCR_TO_TRN(dlcr) ((uint32_t)(1 + ((3 & (dlcr)) >> 8))) /* 1..4 clocks */
 
 /* Fields of the DP's AP ABORT register */
 #define DAPABORT        (1UL << 0)
 
 #define IDR_JEP106_ARM 0x04760000
 
+#define DP_SELECT_APSEL 0xFF000000
+#define DP_SELECT_APBANK 0x000000F0
+#define DP_SELECT_DPBANK 0x0000000F
+#define DP_SELECT_INVALID 0x00FFFF00 /* Reserved bits one */
+
 /**
  * This represents an ARM Debug Interface (v5) Access Port (AP).
  * Most common is a MEM-AP, for memory access.
@@ -201,6 +202,9 @@ struct adiv5_ap {
 struct adiv5_dap {
        const struct dap_ops *ops;
 
+       /* dap transaction list for WAIT support */
+       struct list_head cmd_journal;
+
        struct jtag_tap *tap;
        /* Control config */
        uint32_t dp_ctrl_stat;
@@ -211,27 +215,10 @@ struct adiv5_dap {
        uint32_t apsel;
 
        /**
-        * Cache for DP_SELECT bits identifying the current AP.  A DAP may
-        * connect to multiple APs, such as one MEM-AP for general access,
-        * another reserved for accessing debug modules, and a JTAG-DP.
-        * "-1" indicates no cached value.
-        */
-       uint32_t ap_current;
-
-       /**
-        * Cache for DP_SELECT bits identifying the current four-word AP
-        * register bank.  This caches AP register addresss bits 7:4; JTAG
-        * and SWD access primitves pass address bits 3:2; bits 1:0 are zero.
-        * "-1" indicates no cached value.
-        */
-       uint32_t ap_bank_value;
-
-       /**
-        * Cache for DP_SELECT bits identifying the current four-word DP
-        * register bank.  This caches DP register addresss bits 7:4; JTAG
-        * and SWD access primitves pass address bits 3:2; bits 1:0 are zero.
+        * Cache for DP_SELECT register. A value of DP_SELECT_INVALID
+        * indicates no cached value and forces rewrite of the register.
         */
-       uint32_t dp_bank_value;
+       uint32_t select;
 
        /* information about current pending SWjDP-AHBAP transaction */
        uint8_t  ack;
@@ -271,10 +258,10 @@ struct dap_ops {
                        uint32_t data);
 
        /** AP register read. */
-       int (*queue_ap_read)(struct adiv5_dap *dap, unsigned reg,
+       int (*queue_ap_read)(struct adiv5_ap *ap, unsigned reg,
                        uint32_t *data);
        /** AP register write. */
-       int (*queue_ap_write)(struct adiv5_dap *dap, unsigned reg,
+       int (*queue_ap_write)(struct adiv5_ap *ap, unsigned reg,
                        uint32_t data);
 
        /** AP operation abort. */
@@ -282,6 +269,10 @@ struct dap_ops {
 
        /** Executes all queued DAP operations. */
        int (*run)(struct adiv5_dap *dap);
+
+       /** Executes all queued DAP operations but doesn't check
+        * sticky error conditions */
+       int (*sync)(struct adiv5_dap *dap);
 };
 
 /*
@@ -302,9 +293,6 @@ enum ap_type {
        AP_TYPE_AXI_AP  = 0x4,  /* AXI Memory-AP */
 };
 
-/* AP selection applies to future AP transactions */
-void dap_ap_select(struct adiv5_dap *dap, uint8_t ap);
-
 /**
  * Queue a DP register read.
  * Note that not all DP registers are readable; also, that JTAG and SWD
@@ -356,8 +344,7 @@ static inline int dap_queue_ap_read(struct adiv5_ap *ap,
                unsigned reg, uint32_t *data)
 {
        assert(ap->dap->ops != NULL);
-       dap_ap_select(ap->dap, ap->ap_num);
-       return ap->dap->ops->queue_ap_read(ap->dap, reg, data);
+       return ap->dap->ops->queue_ap_read(ap, reg, data);
 }
 
 /**
@@ -373,8 +360,7 @@ static inline int dap_queue_ap_write(struct adiv5_ap *ap,
                unsigned reg, uint32_t data)
 {
        assert(ap->dap->ops != NULL);
-       dap_ap_select(ap->dap, ap->ap_num);
-       return ap->dap->ops->queue_ap_write(ap->dap, reg, data);
+       return ap->dap->ops->queue_ap_write(ap, reg, data);
 }
 
 /**
@@ -410,6 +396,14 @@ static inline int dap_run(struct adiv5_dap *dap)
        return dap->ops->run(dap);
 }
 
+static inline int dap_sync(struct adiv5_dap *dap)
+{
+       assert(dap->ops != NULL);
+       if (dap->ops->sync)
+               return dap->ops->sync(dap);
+       return ERROR_OK;
+}
+
 static inline int dap_dp_read_atomic(struct adiv5_dap *dap, unsigned reg,
                                     uint32_t *value)
 {
@@ -451,12 +445,6 @@ static inline int dap_dp_poll_register(struct adiv5_dap *dap, unsigned reg,
        }
 }
 
-/** Accessor for currently selected DAP-AP number (0..255) */
-static inline uint8_t dap_ap_get_select(struct adiv5_dap *swjdp)
-{
-       return (uint8_t)(swjdp->ap_current >> 24);
-}
-
 /* Queued MEM-AP memory mapped single word transfers. */
 int mem_ap_read_u32(struct adiv5_ap *ap,
                uint32_t address, uint32_t *value);
@@ -516,4 +504,4 @@ int dap_to_jtag(struct target *target);
 
 extern const struct command_registration dap_command_handlers[];
 
-#endif
+#endif /* OPENOCD_TARGET_ARM_ADI_V5_H */