3d3128a8f5
Make messages reference "DAP" if they're actually transport-agnostic, or "JTAG-DP" when they're JTAG-specific. Saying SWJ-DP is often wrong (on most Cortex-A8 chips) and is confusing even if correct (since we don't yet support SWD). Rename a JTAG-specific routine to jtagdp_transaction_endcheck() to highlight that it's JTAG-specific, and that identify DAP clients undesirably depending on JTAG. (They will all need to change for SWD support.) Shrink a few overlong lines of code. Copy a comment from code removed in a previous patch (for the ARMv7-M "dap baseaddr" command). Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
217 lines
8.0 KiB
C
217 lines
8.0 KiB
C
/***************************************************************************
|
|
* Copyright (C) 2006 by Magnus Lundin *
|
|
* lundin@mlu.mine.nu *
|
|
* *
|
|
* Copyright (C) 2008 by Spencer Oliver *
|
|
* spen@spen-soft.co.uk *
|
|
* *
|
|
* 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_ADI_V5_H
|
|
#define ARM_ADI_V5_H
|
|
|
|
/**
|
|
* @file
|
|
* This defines formats and data structures used to talk to ADIv5 entities.
|
|
* Those include a DAP, different types of Debug Port (DP), and memory mapped
|
|
* resources accessed through a MEM-AP.
|
|
*/
|
|
|
|
#include "arm_jtag.h"
|
|
|
|
/* JTAG instructions/registers for JTAG-DP and SWJ-DP */
|
|
#define JTAG_DP_ABORT 0x8
|
|
#define JTAG_DP_DPACC 0xA
|
|
#define JTAG_DP_APACC 0xB
|
|
#define JTAG_DP_IDCODE 0xE
|
|
|
|
/* three-bit ACK values for DPACC and APACC reads */
|
|
#define JTAG_ACK_OK_FAULT 0x2
|
|
#define JTAG_ACK_WAIT 0x1
|
|
|
|
/* three-bit ACK values for SWD access (sent LSB first) */
|
|
#define SWD_ACK_OK 0x4
|
|
#define SWD_ACK_WAIT 0x2
|
|
#define SWD_ACK_FAULT 0x1
|
|
|
|
#define DPAP_WRITE 0
|
|
#define DPAP_READ 1
|
|
|
|
/* 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
|
|
*/
|
|
#define DP_IDCODE 0 /* SWD: read */
|
|
#define DP_ABORT 0 /* SWD: write */
|
|
#define DP_CTRL_STAT 0x4 /* r/w */
|
|
#define DP_WCR 0x4 /* SWD: r/w (mux CTRLSEL) */
|
|
#define DP_RESEND 0x8 /* SWD: read */
|
|
#define DP_SELECT 0x8 /* JTAG: r/w; SWD: write */
|
|
#define DP_RDBUFF 0xC /* read-only */
|
|
|
|
/* Fields of the DP's AP ABORT register */
|
|
#define DAPABORT (1 << 0)
|
|
#define STKCMPCLR (1 << 1) /* SWD-only */
|
|
#define STKERRCLR (1 << 2) /* SWD-only */
|
|
#define WDERRCLR (1 << 3) /* SWD-only */
|
|
#define ORUNERRCLR (1 << 4) /* SWD-only */
|
|
|
|
/* Fields of the DP's CTRL/STAT register */
|
|
#define CORUNDETECT (1 << 0)
|
|
#define SSTICKYORUN (1 << 1)
|
|
/* 3:2 - transaction mode (e.g. pushed compare) */
|
|
#define SSTICKYCMP (1 << 4)
|
|
#define SSTICKYERR (1 << 5)
|
|
#define READOK (1 << 6) /* SWD-only */
|
|
#define WDATAERR (1 << 7) /* SWD-only */
|
|
/* 11:8 - mask lanes for pushed compare or verify ops */
|
|
/* 21:12 - transaction counter */
|
|
#define CDBGRSTREQ (1 << 26)
|
|
#define CDBGRSTACK (1 << 27)
|
|
#define CDBGPWRUPREQ (1 << 28)
|
|
#define CDBGPWRUPACK (1 << 29)
|
|
#define CSYSPWRUPREQ (1 << 30)
|
|
#define CSYSPWRUPACK (1 << 31)
|
|
|
|
/* MEM-AP register addresses */
|
|
/* TODO: rename as MEM_AP_REG_* */
|
|
#define AP_REG_CSW 0x00
|
|
#define AP_REG_TAR 0x04
|
|
#define AP_REG_DRW 0x0C
|
|
#define AP_REG_BD0 0x10
|
|
#define AP_REG_BD1 0x14
|
|
#define AP_REG_BD2 0x18
|
|
#define AP_REG_BD3 0x1C
|
|
#define AP_REG_CFG 0xF4 /* big endian? */
|
|
#define AP_REG_BASE 0xF8
|
|
|
|
/* Generic AP register address */
|
|
#define AP_REG_IDR 0xFC
|
|
|
|
/* Fields of the MEM-AP's CSW register */
|
|
#define CSW_8BIT 0
|
|
#define CSW_16BIT 1
|
|
#define CSW_32BIT 2
|
|
#define CSW_ADDRINC_MASK (3 << 4)
|
|
#define CSW_ADDRINC_OFF 0
|
|
#define CSW_ADDRINC_SINGLE (1 << 4)
|
|
#define CSW_ADDRINC_PACKED (2 << 4)
|
|
#define CSW_DEVICE_EN (1 << 6)
|
|
#define CSW_TRIN_PROG (1 << 7)
|
|
#define CSW_SPIDEN (1 << 23)
|
|
/* 30:24 - implementation-defined! */
|
|
#define CSW_HPROT (1 << 25) /* ? */
|
|
#define CSW_MASTER_DEBUG (1 << 29) /* ? */
|
|
#define CSW_DBGSWENABLE (1 << 31)
|
|
|
|
/* transaction mode */
|
|
#define TRANS_MODE_NONE 0
|
|
/* Transaction waits for previous to complete */
|
|
#define TRANS_MODE_ATOMIC 1
|
|
/* Freerunning transactions with delays and overrun checking */
|
|
#define TRANS_MODE_COMPOSITE 2
|
|
|
|
/**
|
|
* This represents an ARM Debug Interface (v5) Debug Access Port (DAP).
|
|
* A DAP has two types of component: one Debug Port (DP), which is a
|
|
* transport agent; and at least one Access Port (AP), controlling
|
|
* resource access. Most common is a MEM-AP, for memory access.
|
|
*
|
|
* @todo Rename "swjdp_common" as "dap". Use of SWJ-DP is optional!
|
|
*/
|
|
struct swjdp_common
|
|
{
|
|
struct arm_jtag *jtag_info;
|
|
/* Control config */
|
|
uint32_t dp_ctrl_stat;
|
|
/* Support for several AP's in one DAP */
|
|
uint32_t apsel;
|
|
/* Register select cache */
|
|
uint32_t dp_select_value;
|
|
uint32_t ap_csw_value;
|
|
uint32_t ap_tar_value;
|
|
/* information about current pending SWjDP-AHBAP transaction */
|
|
uint8_t trans_mode;
|
|
uint8_t trans_rw;
|
|
uint8_t ack;
|
|
/* extra tck clocks for memory bus access */
|
|
uint32_t memaccess_tck;
|
|
/* Size of TAR autoincrement block, ARM ADI Specification requires at least 10 bits */
|
|
uint32_t tar_autoincr_block;
|
|
|
|
};
|
|
|
|
/* Accessor function for currently selected DAP-AP number */
|
|
static inline uint8_t dap_ap_get_select(struct swjdp_common *swjdp)
|
|
{
|
|
return (uint8_t)(swjdp ->apsel >> 24);
|
|
}
|
|
|
|
/* Queued transactions -- use with care */
|
|
int dap_setup_accessport(struct swjdp_common *swjdp,
|
|
uint32_t csw, uint32_t tar);
|
|
int dap_ap_select(struct swjdp_common *swjdp,uint8_t apsel);
|
|
int dap_ap_write_reg_u32(struct swjdp_common *swjdp,
|
|
uint32_t addr, uint32_t value);
|
|
int dap_ap_read_reg_u32(struct swjdp_common *swjdp,
|
|
uint32_t addr, uint32_t *value);
|
|
|
|
/* Queued JTAG ops must be completed with jtagdp_transaction_endcheck() */
|
|
int jtagdp_transaction_endcheck(struct swjdp_common *swjdp);
|
|
|
|
/* MEM-AP memory mapped bus single uint32_t register transfers, without endcheck */
|
|
int mem_ap_read_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t *value);
|
|
int mem_ap_write_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t value);
|
|
|
|
/* MEM-AP memory mapped bus transfers, single registers, complete transactions */
|
|
int mem_ap_read_atomic_u32(struct swjdp_common *swjdp,
|
|
uint32_t address, uint32_t *value);
|
|
int mem_ap_write_atomic_u32(struct swjdp_common *swjdp,
|
|
uint32_t address, uint32_t value);
|
|
|
|
/* MEM-AP memory mapped bus block transfers */
|
|
int mem_ap_read_buf_u8(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
int mem_ap_read_buf_u16(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
int mem_ap_read_buf_u32(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
|
|
int mem_ap_write_buf_u8(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
int mem_ap_write_buf_u16(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
int mem_ap_write_buf_u32(struct swjdp_common *swjdp,
|
|
uint8_t *buffer, int count, uint32_t address);
|
|
|
|
/* Initialisation of the debug system, power domains and registers */
|
|
int ahbap_debugport_init(struct swjdp_common *swjdp);
|
|
|
|
|
|
/* Commands for user dap access */
|
|
int dap_info_command(struct command_context *cmd_ctx,
|
|
struct swjdp_common *swjdp, int apsel);
|
|
|
|
#define DAP_COMMAND_HANDLER(name) \
|
|
COMMAND_HELPER(name, struct swjdp_common *swjdp)
|
|
DAP_COMMAND_HANDLER(dap_baseaddr_command);
|
|
DAP_COMMAND_HANDLER(dap_memaccess_command);
|
|
DAP_COMMAND_HANDLER(dap_apsel_command);
|
|
DAP_COMMAND_HANDLER(dap_apid_command);
|
|
|
|
#endif
|