git.gag.com Git - fw/openocd/blob - src/target/arm_adi_v5.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Magnus Lundin                                   *
   3  *   lundin@mlu.mine.nu                                                    *
   4  *                                                                         *
   5  *   Copyright (C) 2008 by Spencer Oliver                                  *
   6  *   spen@spen-soft.co.uk                                                  *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23 #ifndef ARM_ADI_V5_H
  24 #define ARM_ADI_V5_H
  25
  26 /**
  27  * @file
  28  * This defines formats and data structures used to talk to ADIv5 entities.
  29  * Those include a DAP, different types of Debug Port (DP), and memory mapped
  30  * resources accessed through a MEM-AP.
  31  */
  32
  33 #include "arm_jtag.h"
  34
  35 /* JTAG instructions/registers for JTAG-DP and SWJ-DP */
  36 #define JTAG_DP_ABORT           0x8
  37 #define JTAG_DP_DPACC           0xA
  38 #define JTAG_DP_APACC           0xB
  39 #define JTAG_DP_IDCODE          0xE
  40
  41 /* three-bit ACK values for DPACC and APACC reads */
  42 #define JTAG_ACK_OK_FAULT       0x2
  43 #define JTAG_ACK_WAIT           0x1
  44
  45 /* three-bit ACK values for SWD access (sent LSB first) */
  46 #define SWD_ACK_OK              0x4
  47 #define SWD_ACK_WAIT            0x2
  48 #define SWD_ACK_FAULT           0x1
  49
  50 #define DPAP_WRITE              0
  51 #define DPAP_READ               1
  52
  53 /* A[3:0] for DP registers; A[1:0] are always zero.
  54  * - JTAG accesses all of these via JTAG_DP_DPACC, except for
  55  *   IDCODE (JTAG_DP_IDCODE) and ABORT (JTAG_DP_ABORT).
  56  * - SWD accesses these directly, sometimes needing SELECT.CTRLSEL
  57  */
  58 #define DP_IDCODE               0               /* SWD: read */
  59 #define DP_ABORT                0               /* SWD: write */
  60 #define DP_CTRL_STAT            0x4             /* r/w */
  61 #define DP_WCR                  0x4             /* SWD: r/w (mux CTRLSEL) */
  62 #define DP_RESEND               0x8             /* SWD: read */
  63 #define DP_SELECT               0x8             /* JTAG: r/w; SWD: write */
  64 #define DP_RDBUFF               0xC             /* read-only */
  65
  66 /* Fields of the DP's AP ABORT register */
  67 #define DAPABORT                (1 << 0)
  68 #define STKCMPCLR               (1 << 1)        /* SWD-only */
  69 #define STKERRCLR               (1 << 2)        /* SWD-only */
  70 #define WDERRCLR                (1 << 3)        /* SWD-only */
  71 #define ORUNERRCLR              (1 << 4)        /* SWD-only */
  72
  73 /* Fields of the DP's CTRL/STAT register */
  74 #define CORUNDETECT             (1 << 0)
  75 #define SSTICKYORUN             (1 << 1)
  76 /* 3:2 - transaction mode (e.g. pushed compare) */
  77 #define SSTICKYCMP              (1 << 4)
  78 #define SSTICKYERR              (1 << 5)
  79 #define READOK                  (1 << 6)        /* SWD-only */
  80 #define WDATAERR                (1 << 7)        /* SWD-only */
  81 /* 11:8 - mask lanes for pushed compare or verify ops */
  82 /* 21:12 - transaction counter */
  83 #define CDBGRSTREQ              (1 << 26)
  84 #define CDBGRSTACK              (1 << 27)
  85 #define CDBGPWRUPREQ    (1 << 28)
  86 #define CDBGPWRUPACK    (1 << 29)
  87 #define CSYSPWRUPREQ    (1 << 30)
  88 #define CSYSPWRUPACK    (1 << 31)
  89
  90 /* MEM-AP register addresses */
  91 /* TODO: rename as MEM_AP_REG_* */
  92 #define AP_REG_CSW              0x00
  93 #define AP_REG_TAR              0x04
  94 #define AP_REG_DRW              0x0C
  95 #define AP_REG_BD0              0x10
  96 #define AP_REG_BD1              0x14
  97 #define AP_REG_BD2              0x18
  98 #define AP_REG_BD3              0x1C
  99 #define AP_REG_CFG              0xF4            /* big endian? */
 100 #define AP_REG_BASE             0xF8
 101
 102 /* Generic AP register address */
 103 #define AP_REG_IDR              0xFC
 104
 105 /* Fields of the MEM-AP's CSW register */
 106 #define CSW_8BIT                0
 107 #define CSW_16BIT               1
 108 #define CSW_32BIT               2
 109 #define CSW_ADDRINC_MASK        (3 << 4)
 110 #define CSW_ADDRINC_OFF         0
 111 #define CSW_ADDRINC_SINGLE      (1 << 4)
 112 #define CSW_ADDRINC_PACKED      (2 << 4)
 113 #define CSW_DEVICE_EN           (1 << 6)
 114 #define CSW_TRIN_PROG           (1 << 7)
 115 #define CSW_SPIDEN                      (1 << 23)
 116 /* 30:24 - implementation-defined! */
 117 #define CSW_HPROT                       (1 << 25)               /* ? */
 118 #define CSW_MASTER_DEBUG        (1 << 29)               /* ? */
 119 #define CSW_DBGSWENABLE         (1 << 31)
 120
 121 /**
 122  * This represents an ARM Debug Interface (v5) Debug Access Port (DAP).
 123  * A DAP has two types of component:  one Debug Port (DP), which is a
 124  * transport agent; and at least one Access Port (AP), controlling
 125  * resource access.  Most common is a MEM-AP, for memory access.
 126  *
 127  * There are two basic DP transports: JTAG, and ARM's low pin-count SWD.
 128  * Accordingly, this interface is responsible for hiding the transport
 129  * differences so upper layer code can largely ignore them.
 130  *
 131  * When the chip is implemented with JTAG-DP or SW-DP, the transport is
 132  * fixed as JTAG or SWD, respectively.  Chips incorporating SWJ-DP permit
 133  * a choice made at board design time (by only using the SWD pins), or
 134  * as part of setting up a debug session (if all the dual-role JTAG/SWD
 135  * signals are available).
 136  *
 137  * @todo Rename "swjdp_common" as "dap".  Use of SWJ-DP is optional!
 138  */
 139 struct swjdp_common
 140 {
 141         const struct dap_ops *ops;
 142
 143         struct arm_jtag *jtag_info;
 144         /* Control config */
 145         uint32_t dp_ctrl_stat;
 146
 147         /**
 148          * Cache for DP_SELECT bits identifying the current AP.  A DAP may
 149          * connect to multiple APs, such as one MEM-AP for general access,
 150          * another reserved for accessing debug modules, and a JTAG-DP.
 151          * "-1" indicates no cached value.
 152          */
 153         uint32_t apsel;
 154
 155         /**
 156          * Cache for DP_SELECT bits identifying the current four-word AP
 157          * register bank.  This caches AP register addresss bits 7:4; JTAG
 158          * and SWD access primitves pass address bits 3:2; bits 1:0 are zero.
 159          * "-1" indicates no cached value.
 160          */
 161         uint32_t ap_bank_value;
 162
 163         /**
 164          * Cache for (MEM-AP) AP_REG_CSW register value.  This is written to
 165          * configure an access mode, such as autoincrementing AP_REG_TAR during
 166          * word access.  "-1" indicates no cached value.
 167          */
 168         uint32_t ap_csw_value;
 169
 170         /**
 171          * Cache for (MEM-AP) AP_REG_TAR register value This is written to
 172          * configure the address being read or written
 173          * "-1" indicates no cached value.
 174          */
 175         uint32_t ap_tar_value;
 176
 177         /* information about current pending SWjDP-AHBAP transaction */
 178         uint8_t  ack;
 179
 180         /**
 181          * Configures how many extra tck clocks are added after starting a
 182          * MEM-AP access before we try to read its status (and/or result).
 183          */
 184         uint32_t        memaccess_tck;
 185         /* Size of TAR autoincrement block, ARM ADI Specification requires at least 10 bits */
 186         uint32_t tar_autoincr_block;
 187
 188 };
 189
 190 /**
 191  * Transport-neutral representation of queued DAP transactions, supporting
 192  * both JTAG and SWD transports.  All submitted transactions are logically
 193  * queued, until the queue is executed by run().  Some implementations might
 194  * execute transactions as soon as they're submitted, but no status is made
 195  * availablue until run().
 196  */
 197 struct dap_ops {
 198         /** If the DAP transport isn't SWD, it must be JTAG.  Upper level
 199          * code may need to care about the difference in some cases.
 200          */
 201         bool    is_swd;
 202
 203         /** Reads the DAP's IDCODe register. */
 204         int (*queue_idcode_read)(struct swjdp_common *dap,
 205                         uint8_t *ack, uint32_t *data);
 206
 207         /** DP register read. */
 208         int (*queue_dp_read)(struct swjdp_common *dap, unsigned reg,
 209                         uint32_t *data);
 210         /** DP register write. */
 211         int (*queue_dp_write)(struct swjdp_common *dap, unsigned reg,
 212                         uint32_t data);
 213
 214         /** AP register read. */
 215         int (*queue_ap_read)(struct swjdp_common *dap, unsigned reg,
 216                         uint32_t *data);
 217         /** AP register write. */
 218         int (*queue_ap_write)(struct swjdp_common *dap, unsigned reg,
 219                         uint32_t data);
 220         /** AP operation abort. */
 221         int (*queue_ap_abort)(struct swjdp_common *dap, uint8_t *ack);
 222
 223         /** Executes all queued DAP operations. */
 224         int (*run)(struct swjdp_common *dap);
 225 };
 226
 227 /**
 228  * Queue an IDCODE register read.  This is primarily useful for SWD
 229  * transports, where it is required as part of link initialization.
 230  * (For JTAG, this register is read as part of scan chain setup.)
 231  *
 232  * @param dap The DAP used for reading.
 233  * @param ack Pointer to where transaction status will be stored.
 234  * @param data Pointer saying where to store the IDCODE value.
 235  *
 236  * @return ERROR_OK for success, else a fault code.
 237  */
 238 static inline int dap_queue_idcode_read(struct swjdp_common *dap,
 239                 uint8_t *ack, uint32_t *data)
 240 {
 241         return dap->ops->queue_idcode_read(dap, ack, data);
 242 }
 243
 244 /**
 245  * Queue a DP register read.
 246  * Note that not all DP registers are readable; also, that JTAG and SWD
 247  * have slight differences in DP register support.
 248  *
 249  * @param dap The DAP used for reading.
 250  * @param reg The two-bit number of the DP register being read.
 251  * @param data Pointer saying where to store the register's value
 252  *      (in host endianness).
 253  *
 254  * @return ERROR_OK for success, else a fault code.
 255  */
 256 static inline int dap_queue_dp_read(struct swjdp_common *dap,
 257                 unsigned reg, uint32_t *data)
 258 {
 259         return dap->ops->queue_dp_read(dap, reg, data);
 260 }
 261
 262 /**
 263  * Queue a DP register write.
 264  * Note that not all DP registers are writable; also, that JTAG and SWD
 265  * have slight differences in DP register support.
 266  *
 267  * @param dap The DAP used for writing.
 268  * @param reg The two-bit number of the DP register being written.
 269  * @param data Value being written (host endianness)
 270  *
 271  * @return ERROR_OK for success, else a fault code.
 272  */
 273 static inline int dap_queue_dp_write(struct swjdp_common *dap,
 274                 unsigned reg, uint32_t data)
 275 {
 276         return dap->ops->queue_dp_write(dap, reg, data);
 277 }
 278
 279 /**
 280  * Queue an AP register read.
 281  *
 282  * @param dap The DAP used for reading.
 283  * @param reg The number of the AP register being read.
 284  * @param data Pointer saying where to store the register's value
 285  *      (in host endianness).
 286  *
 287  * @return ERROR_OK for success, else a fault code.
 288  */
 289 static inline int dap_queue_ap_read(struct swjdp_common *dap,
 290                 unsigned reg, uint32_t *data)
 291 {
 292         return dap->ops->queue_ap_read(dap, reg, data);
 293 }
 294
 295 /**
 296  * Queue an AP register write.
 297  *
 298  * @param dap The DAP used for writing.
 299  * @param reg The number of the AP register being written.
 300  * @param data Value being written (host endianness)
 301  *
 302  * @return ERROR_OK for success, else a fault code.
 303  */
 304 static inline int dap_queue_ap_write(struct swjdp_common *dap,
 305                 unsigned reg, uint32_t data)
 306 {
 307         return dap->ops->queue_ap_write(dap, reg, data);
 308 }
 309
 310 /**
 311  * Queue an AP abort operation.  The current AP transaction is aborted,
 312  * including any update of the transaction counter.  The AP is left in
 313  * an unknown state (so it must be re-initialized).  For use only after
 314  * the AP has reported WAIT status for an extended period.
 315  *
 316  * @param dap The DAP used for writing.
 317  * @param ack Pointer to where transaction status will be stored.
 318  *
 319  * @return ERROR_OK for success, else a fault code.
 320  */
 321 static inline int dap_queue_ap_abort(struct swjdp_common *dap, uint8_t *ack)
 322 {
 323         return dap->ops->queue_ap_abort(dap, ack);
 324 }
 325
 326 /**
 327  * Perform all queued DAP operations, and clear any errors posted in the
 328  * CTRL_STAT register when they are done.  Note that if more than one AP
 329  * operation will be queued, one of the first operations in the queue
 330  * should probably enable CORUNDETECT in the CTRL/STAT register.
 331  *
 332  * @param dap The DAP used.
 333  *
 334  * @return ERROR_OK for success, else a fault code.
 335  */
 336 static inline int dap_run(struct swjdp_common *dap)
 337 {
 338         return dap->ops->run(dap);
 339 }
 340
 341 /** Accessor for currently selected DAP-AP number (0..255) */
 342 static inline uint8_t dap_ap_get_select(struct swjdp_common *swjdp)
 343 {
 344         return (uint8_t)(swjdp ->apsel >> 24);
 345 }
 346
 347 /* AP selection applies to future AP transactions */
 348 void dap_ap_select(struct swjdp_common *dap,uint8_t apsel);
 349
 350 /* Queued AP transactions */
 351 int dap_setup_accessport(struct swjdp_common *swjdp,
 352                 uint32_t csw, uint32_t tar);
 353
 354 /* Queued MEM-AP memory mapped single word transfers */
 355 int mem_ap_read_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t *value);
 356 int mem_ap_write_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t value);
 357
 358 /* Synchronous MEM-AP memory mapped single word transfers */
 359 int mem_ap_read_atomic_u32(struct swjdp_common *swjdp,
 360                 uint32_t address, uint32_t *value);
 361 int mem_ap_write_atomic_u32(struct swjdp_common *swjdp,
 362                 uint32_t address, uint32_t value);
 363
 364 /* MEM-AP memory mapped bus block transfers */
 365 int mem_ap_read_buf_u8(struct swjdp_common *swjdp,
 366                 uint8_t *buffer, int count, uint32_t address);
 367 int mem_ap_read_buf_u16(struct swjdp_common *swjdp,
 368                 uint8_t *buffer, int count, uint32_t address);
 369 int mem_ap_read_buf_u32(struct swjdp_common *swjdp,
 370                 uint8_t *buffer, int count, uint32_t address);
 371
 372 int mem_ap_write_buf_u8(struct swjdp_common *swjdp,
 373                 uint8_t *buffer, int count, uint32_t address);
 374 int mem_ap_write_buf_u16(struct swjdp_common *swjdp,
 375                 uint8_t *buffer, int count, uint32_t address);
 376 int mem_ap_write_buf_u32(struct swjdp_common *swjdp,
 377                 uint8_t *buffer, int count, uint32_t address);
 378
 379 /* Initialisation of the debug system, power domains and registers */
 380 int ahbap_debugport_init(struct swjdp_common *swjdp);
 381
 382
 383 /* Commands for user dap access */
 384 int dap_info_command(struct command_context *cmd_ctx,
 385                 struct swjdp_common *swjdp, int apsel);
 386
 387 #define DAP_COMMAND_HANDLER(name) \
 388                 COMMAND_HELPER(name, struct swjdp_common *swjdp)
 389 DAP_COMMAND_HANDLER(dap_baseaddr_command);
 390 DAP_COMMAND_HANDLER(dap_memaccess_command);
 391 DAP_COMMAND_HANDLER(dap_apsel_command);
 392 DAP_COMMAND_HANDLER(dap_apid_command);
 393
 394 struct target;
 395
 396 /* Put debug link into SWD mode */
 397 int dap_to_swd(struct target *target);
 398
 399 /* Put debug link into JTAG mode */
 400 int dap_to_jtag(struct target *target);
 401
 402 #endif