1 /***************************************************************************
2 * Copyright (C) 2006 by Magnus Lundin *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
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. *
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. *
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 ***************************************************************************/
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.
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
44 /* A[3:0] for DP registers (for JTAG, stored in DPACC) */
46 #define DP_CTRL_STAT 0x4
50 /* Fields of the DP's CTRL/STAT register */
51 #define CORUNDETECT (1 << 0)
52 #define SSTICKYORUN (1 << 1)
53 /* 3:2 - transaction mode (e.g. pushed compare) */
54 #define SSTICKYERR (1 << 5)
55 #define READOK (1 << 6)
56 #define WDATAERR (1 << 7)
57 /* 11:8 - mask lanes for pushed compare or verify ops */
58 /* 21:12 - transaction counter */
59 #define CDBGRSTREQ (1 << 26)
60 #define CDBGRSTACK (1 << 27)
61 #define CDBGPWRUPREQ (1 << 28)
62 #define CDBGPWRUPACK (1 << 29)
63 #define CSYSPWRUPREQ (1 << 30)
64 #define CSYSPWRUPACK (1 << 31)
66 /* MEM-AP register addresses */
67 /* TODO: rename as MEM_AP_REG_* */
68 #define AP_REG_CSW 0x00
69 #define AP_REG_TAR 0x04
70 #define AP_REG_DRW 0x0C
71 #define AP_REG_BD0 0x10
72 #define AP_REG_BD1 0x14
73 #define AP_REG_BD2 0x18
74 #define AP_REG_BD3 0x1C
75 #define AP_REG_CFG 0xF4 /* big endian? */
76 #define AP_REG_BASE 0xF8
78 /* Generic AP register address */
79 #define AP_REG_IDR 0xFC
81 /* Fields of the MEM-AP's CSW register */
85 #define CSW_ADDRINC_MASK (3 << 4)
86 #define CSW_ADDRINC_OFF 0
87 #define CSW_ADDRINC_SINGLE (1 << 4)
88 #define CSW_ADDRINC_PACKED (2 << 4)
89 #define CSW_DEVICE_EN (1 << 6)
90 #define CSW_TRIN_PROG (1 << 7)
91 #define CSW_SPIDEN (1 << 23)
92 /* 30:24 - implementation-defined! */
93 #define CSW_HPROT (1 << 25) /* ? */
94 #define CSW_MASTER_DEBUG (1 << 29) /* ? */
95 #define CSW_DBGSWENABLE (1 << 31)
97 /* transaction mode */
98 #define TRANS_MODE_NONE 0
99 /* Transaction waits for previous to complete */
100 #define TRANS_MODE_ATOMIC 1
101 /* Freerunning transactions with delays and overrun checking */
102 #define TRANS_MODE_COMPOSITE 2
105 * This represents an ARM Debug Interface (v5) Debug Access Port (DAP).
106 * A DAP has two types of component: one Debug Port (DP), which is a
107 * transport agent; and at least one Access Port (AP), controlling
108 * resource access. Most common is a MEM-AP, for memory access.
110 * @todo Rename "swjdp_common" as "dap". Use of SWJ-DP is optional!
114 struct arm_jtag *jtag_info;
116 uint32_t dp_ctrl_stat;
117 /* Support for several AP's in one DAP */
119 /* Register select cache */
120 uint32_t dp_select_value;
121 uint32_t ap_csw_value;
122 uint32_t ap_tar_value;
123 /* information about current pending SWjDP-AHBAP transaction */
127 /* extra tck clocks for memory bus access */
128 uint32_t memaccess_tck;
129 /* Size of TAR autoincrement block, ARM ADI Specification requires at least 10 bits */
130 uint32_t tar_autoincr_block;
134 /* Accessor function for currently selected DAP-AP number */
135 static inline uint8_t dap_ap_get_select(struct swjdp_common *swjdp)
137 return (uint8_t)(swjdp ->apsel >> 24);
140 /* Queued transactions -- use with care */
141 int dap_setup_accessport(struct swjdp_common *swjdp,
142 uint32_t csw, uint32_t tar);
143 int dap_ap_select(struct swjdp_common *swjdp,uint8_t apsel);
144 int dap_ap_write_reg_u32(struct swjdp_common *swjdp,
145 uint32_t addr, uint32_t value);
146 int dap_ap_read_reg_u32(struct swjdp_common *swjdp,
147 uint32_t addr, uint32_t *value);
149 /* Queued transactions must be completed with swjdp_transaction_endcheck() */
150 int swjdp_transaction_endcheck(struct swjdp_common *swjdp);
152 /* MEM-AP memory mapped bus single uint32_t register transfers, without endcheck */
153 int mem_ap_read_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t *value);
154 int mem_ap_write_u32(struct swjdp_common *swjdp, uint32_t address, uint32_t value);
156 /* MEM-AP memory mapped bus transfers, single registers, complete transactions */
157 int mem_ap_read_atomic_u32(struct swjdp_common *swjdp,
158 uint32_t address, uint32_t *value);
159 int mem_ap_write_atomic_u32(struct swjdp_common *swjdp,
160 uint32_t address, uint32_t value);
162 /* MEM-AP memory mapped bus block transfers */
163 int mem_ap_read_buf_u8(struct swjdp_common *swjdp,
164 uint8_t *buffer, int count, uint32_t address);
165 int mem_ap_read_buf_u16(struct swjdp_common *swjdp,
166 uint8_t *buffer, int count, uint32_t address);
167 int mem_ap_read_buf_u32(struct swjdp_common *swjdp,
168 uint8_t *buffer, int count, uint32_t address);
170 int mem_ap_write_buf_u8(struct swjdp_common *swjdp,
171 uint8_t *buffer, int count, uint32_t address);
172 int mem_ap_write_buf_u16(struct swjdp_common *swjdp,
173 uint8_t *buffer, int count, uint32_t address);
174 int mem_ap_write_buf_u32(struct swjdp_common *swjdp,
175 uint8_t *buffer, int count, uint32_t address);
177 /* Initialisation of the debug system, power domains and registers */
178 int ahbap_debugport_init(struct swjdp_common *swjdp);
181 /* Commands for user dap access */
182 int dap_info_command(struct command_context *cmd_ctx,
183 struct swjdp_common *swjdp, int apsel);
185 #define DAP_COMMAND_HANDLER(name) \
186 COMMAND_HELPER(name, struct swjdp_common *swjdp)
187 DAP_COMMAND_HANDLER(dap_baseaddr_command);
188 DAP_COMMAND_HANDLER(dap_memaccess_command);
189 DAP_COMMAND_HANDLER(dap_apsel_command);
190 DAP_COMMAND_HANDLER(dap_apid_command);