target/riscv: Add null pointer check before right shift for bscan tunneling.

[openocd.git] / src / target / arm_adi_v5.h

diff --git a/src/target/arm_adi_v5.h b/src/target/arm_adi_v5.h
index 4eab35d6ead684240cabe897fa0dc46f7f70de7c..90d28bcf235457190cfe43a0d76819f37785d6f5 100644 (file)
--- a/src/target/arm_adi_v5.h
+++ b/src/target/arm_adi_v5.h
@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
 /***************************************************************************
  *   Copyright (C) 2006 by Magnus Lundin                                   *
  *   lundin@mlu.mine.nu                                                    *
@@ -6,19 +8,6 @@
  *   spen@spen-soft.co.uk                                                  *
  *                                                                         *
  *   Copyright (C) 2019-2021, Ampere Computing LLC                         *
- *                                                                         *
- *   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_ARM_ADI_V5_H
@@ -86,6 +75,9 @@
 #define DP_DPIDR1_ASIZE_MASK    (0x7F)
 #define DP_DPIDR1_ERRMODE       BIT(7)
 
+/* Fields of register DP_BASEPTR0 */
+#define DP_BASEPTR0_VALID       BIT(0)
+
 /* Fields of the DP's CTRL/STAT register */
 #define CORUNDETECT     (1UL << 0)
 #define SSTICKYORUN     (1UL << 1)
@@ -110,8 +102,8 @@
 #define DP_SELECT_DPBANK 0x0000000F
 #define DP_SELECT_INVALID 0x00FFFF00 /* Reserved bits one */
 
-#define DP_APSEL_MAX        (255)
-#define DP_APSEL_INVALID    (-1)
+#define DP_APSEL_MAX        (255) /* for ADIv5 only */
+#define DP_APSEL_INVALID    0xF00 /* more than DP_APSEL_MAX and not ADIv6 aligned 4k */
 
 #define DP_TARGETSEL_INVALID 0xFFFFFFFFU
 #define DP_TARGETSEL_DPID_MASK 0x0FFFFFFFU
@@ -255,9 +247,11 @@ struct adiv5_ap {
        struct adiv5_dap *dap;
 
        /**
-        * Number of this AP.
+        * ADIv5: Number of this AP (0~255)
+        * ADIv6: Base address of this AP (4k aligned)
+        * TODO: to be more coherent, it should be renamed apsel
         */
-       uint8_t ap_num;
+       uint64_t ap_num;
 
        /**
         * Default value for (MEM-AP) AP_REG_CSW register.
@@ -342,7 +336,7 @@ struct adiv5_dap {
        struct adiv5_ap ap[DP_APSEL_MAX + 1];
 
        /* The current manually selected AP by the "dap apsel" command */
-       uint32_t apsel;
+       uint64_t apsel;
 
        /**
         * Cache for DP_SELECT register. A value of DP_SELECT_INVALID
@@ -365,6 +359,10 @@ struct adiv5_dap {
         * swizzle appropriately. */
        bool ti_be_32_quirks;
 
+       /* The Nuvoton NPCX M4 has an issue with writing to non-4-byte-aligned mmios.
+        * The work around is to repeat the data in all 4 bytes of DRW */
+       bool nu_npcx_quirks;
+
        /**
         * STLINK adapter need to know if last AP operation was read or write, and
         * in case of write has to flush it with a dummy read from DP_RDBUFF
@@ -457,6 +455,9 @@ enum ap_type {
        AP_TYPE_AHB5H_AP = AP_REG_IDR_VALUE(ARM_ID, AP_REG_IDR_CLASS_MEM_AP, 8),  /* AHB5 with enhanced HPROT Memory-AP */
 };
 
+extern const struct dap_ops jtag_dp_ops;
+extern const struct dap_ops swd_dap_ops;
+
 /* Check the ap->cfg_reg Long Address field (bit 1)
  *
  * 0b0: The AP only supports physical addresses 32 bits or smaller
@@ -551,7 +552,7 @@ static inline int dap_queue_ap_read(struct adiv5_ap *ap,
        assert(ap->dap->ops);
        if (ap->refcount == 0) {
                ap->refcount = 1;
-               LOG_ERROR("BUG: refcount AP#%" PRIu8 " used without get", ap->ap_num);
+               LOG_ERROR("BUG: refcount AP#0x%" PRIx64 " used without get", ap->ap_num);
        }
        return ap->dap->ops->queue_ap_read(ap, reg, data);
 }
@@ -571,7 +572,7 @@ static inline int dap_queue_ap_write(struct adiv5_ap *ap,
        assert(ap->dap->ops);
        if (ap->refcount == 0) {
                ap->refcount = 1;
-               LOG_ERROR("BUG: refcount AP#%" PRIu8 " used without get", ap->ap_num);
+               LOG_ERROR("BUG: refcount AP#0x%" PRIx64 " used without get", ap->ap_num);
        }
        return ap->dap->ops->queue_ap_write(ap, reg, data);
 }
@@ -690,16 +691,22 @@ int mem_ap_init(struct adiv5_ap *ap);
 /* Invalidate cached DP select and cached TAR and CSW of all APs */
 void dap_invalidate_cache(struct adiv5_dap *dap);
 
+/* read ADIv6 baseptr register */
+int adiv6_dap_read_baseptr(struct command_invocation *cmd, struct adiv5_dap *dap, target_addr_t *baseptr);
+
+/* test if ap_num is valid, based on current knowledge of dap */
+bool is_ap_num_valid(struct adiv5_dap *dap, uint64_t ap_num);
+
 /* Probe Access Ports to find a particular type. Increment AP refcount */
 int dap_find_get_ap(struct adiv5_dap *dap,
                        enum ap_type type_to_find,
                        struct adiv5_ap **ap_out);
 
 /* Return AP with specified ap_num. Increment AP refcount */
-struct adiv5_ap *dap_get_ap(struct adiv5_dap *dap, unsigned int ap_num);
+struct adiv5_ap *dap_get_ap(struct adiv5_dap *dap, uint64_t ap_num);
 
 /* Return AP with specified ap_num. Increment AP refcount and keep it non-zero */
-struct adiv5_ap *dap_get_config_ap(struct adiv5_dap *dap, unsigned int ap_num);
+struct adiv5_ap *dap_get_config_ap(struct adiv5_dap *dap, uint64_t ap_num);
 
 /* Decrement AP refcount and release the AP when refcount reaches zero */
 int dap_put_ap(struct adiv5_ap *ap);
@@ -735,7 +742,7 @@ extern const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self);
 extern int dap_cleanup_all(void);
 
 struct adiv5_private_config {
-       int ap_num;
+       uint64_t ap_num;
        struct adiv5_dap *dap;
 };
 
@@ -744,7 +751,7 @@ extern int adiv5_jim_configure(struct target *target, struct jim_getopt_info *go
 
 struct adiv5_mem_ap_spot {
        struct adiv5_dap *dap;
-       int ap_num;
+       uint64_t ap_num;
        uint32_t base;
 };