target/arm_adiv5: Add type for AHB5-AP
[fw/openocd] / 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, see <http://www.gnu.org/licenses/>. *
20  ***************************************************************************/
21
22 #ifndef OPENOCD_TARGET_ARM_ADI_V5_H
23 #define OPENOCD_TARGET_ARM_ADI_V5_H
24
25 /**
26  * @file
27  * This defines formats and data structures used to talk to ADIv5 entities.
28  * Those include a DAP, different types of Debug Port (DP), and memory mapped
29  * resources accessed through a MEM-AP.
30  */
31
32 #include <helper/list.h>
33 #include "arm_jtag.h"
34
35 /* three-bit ACK values for SWD access (sent LSB first) */
36 #define SWD_ACK_OK    0x1
37 #define SWD_ACK_WAIT  0x2
38 #define SWD_ACK_FAULT 0x4
39
40 #define DPAP_WRITE              0
41 #define DPAP_READ               1
42
43 #define BANK_REG(bank, reg)     (((bank) << 4) | (reg))
44
45 /* A[3:0] for DP registers; A[1:0] are always zero.
46  * - JTAG accesses all of these via JTAG_DP_DPACC, except for
47  *   IDCODE (JTAG_DP_IDCODE) and ABORT (JTAG_DP_ABORT).
48  * - SWD accesses these directly, sometimes needing SELECT.DPBANKSEL
49  */
50 #define DP_DPIDR        BANK_REG(0x0, 0x0) /* DPv1+: ro */
51 #define DP_ABORT        BANK_REG(0x0, 0x0) /* DPv1+: SWD: wo */
52 #define DP_CTRL_STAT    BANK_REG(0x0, 0x4) /* DPv0+: rw */
53 #define DP_DLCR         BANK_REG(0x1, 0x4) /* DPv1+: SWD: rw */
54 #define DP_TARGETID     BANK_REG(0x2, 0x4) /* DPv2: ro */
55 #define DP_DLPIDR       BANK_REG(0x3, 0x4) /* DPv2: ro */
56 #define DP_EVENTSTAT    BANK_REG(0x4, 0x4) /* DPv2: ro */
57 #define DP_RESEND       BANK_REG(0x0, 0x8) /* DPv1+: SWD: ro */
58 #define DP_SELECT       BANK_REG(0x0, 0x8) /* DPv0+: JTAG: rw; SWD: wo */
59 #define DP_RDBUFF       BANK_REG(0x0, 0xC) /* DPv0+: ro */
60 #define DP_TARGETSEL    BANK_REG(0x0, 0xC) /* DPv2: SWD: wo */
61
62 #define DLCR_TO_TRN(dlcr) ((uint32_t)(1 + ((3 & (dlcr)) >> 8))) /* 1..4 clocks */
63
64 /* Fields of the DP's AP ABORT register */
65 #define DAPABORT        (1UL << 0)
66 #define STKCMPCLR       (1UL << 1) /* SWD-only */
67 #define STKERRCLR       (1UL << 2) /* SWD-only */
68 #define WDERRCLR        (1UL << 3) /* SWD-only */
69 #define ORUNERRCLR      (1UL << 4) /* SWD-only */
70
71 /* Fields of the DP's CTRL/STAT register */
72 #define CORUNDETECT     (1UL << 0)
73 #define SSTICKYORUN     (1UL << 1)
74 /* 3:2 - transaction mode (e.g. pushed compare) */
75 #define SSTICKYCMP      (1UL << 4)
76 #define SSTICKYERR      (1UL << 5)
77 #define READOK          (1UL << 6) /* SWD-only */
78 #define WDATAERR        (1UL << 7) /* SWD-only */
79 /* 11:8 - mask lanes for pushed compare or verify ops */
80 /* 21:12 - transaction counter */
81 #define CDBGRSTREQ      (1UL << 26)
82 #define CDBGRSTACK      (1UL << 27)
83 #define CDBGPWRUPREQ    (1UL << 28)
84 #define CDBGPWRUPACK    (1UL << 29)
85 #define CSYSPWRUPREQ    (1UL << 30)
86 #define CSYSPWRUPACK    (1UL << 31)
87
88 /* MEM-AP register addresses */
89 #define MEM_AP_REG_CSW          0x00
90 #define MEM_AP_REG_TAR          0x04
91 #define MEM_AP_REG_TAR64        0x08            /* RW: Large Physical Address Extension */
92 #define MEM_AP_REG_DRW          0x0C            /* RW: Data Read/Write register */
93 #define MEM_AP_REG_BD0          0x10            /* RW: Banked Data register 0-3 */
94 #define MEM_AP_REG_BD1          0x14
95 #define MEM_AP_REG_BD2          0x18
96 #define MEM_AP_REG_BD3          0x1C
97 #define MEM_AP_REG_MBT          0x20            /* --: Memory Barrier Transfer register */
98 #define MEM_AP_REG_BASE64       0xF0            /* RO: Debug Base Address (LA) register */
99 #define MEM_AP_REG_CFG          0xF4            /* RO: Configuration register */
100 #define MEM_AP_REG_BASE         0xF8            /* RO: Debug Base Address register */
101 /* Generic AP register address */
102 #define AP_REG_IDR                      0xFC            /* RO: Identification Register */
103
104 /* Fields of the MEM-AP's CSW register */
105 #define CSW_SIZE_MASK           7
106 #define CSW_8BIT                0
107 #define CSW_16BIT               1
108 #define CSW_32BIT               2
109 #define CSW_ADDRINC_MASK    (3UL << 4)
110 #define CSW_ADDRINC_OFF     0UL
111 #define CSW_ADDRINC_SINGLE  (1UL << 4)
112 #define CSW_ADDRINC_PACKED  (2UL << 4)
113 #define CSW_DEVICE_EN       (1UL << 6)
114 #define CSW_TRIN_PROG       (1UL << 7)
115
116 /* All fields in bits 12 and above are implementation-defined
117  * Defaults for AHB/AXI in "Standard Memory Access Port Definitions" from ADI
118  * Some bits are shared between buses
119  */
120 #define CSW_SPIDEN          (1UL << 23)
121 #define CSW_DBGSWENABLE     (1UL << 31)
122
123 /* AHB: Privileged */
124 #define CSW_AHB_HPROT1          (1UL << 25)
125 /* AHB: set HMASTER signals to AHB-AP ID */
126 #define CSW_AHB_MASTER_DEBUG    (1UL << 29)
127 /* AHB5: non-secure access via HNONSEC
128  * AHB3: SBO, UNPREDICTABLE if zero */
129 #define CSW_AHB_SPROT           (1UL << 30)
130 /* AHB: initial value of csw_default */
131 #define CSW_AHB_DEFAULT         (CSW_AHB_HPROT1 | CSW_AHB_MASTER_DEBUG | CSW_DBGSWENABLE)
132
133 /* AXI: Privileged */
134 #define CSW_AXI_ARPROT0_PRIV    (1UL << 28)
135 /* AXI: Non-secure */
136 #define CSW_AXI_ARPROT1_NONSEC  (1UL << 29)
137 /* AXI: initial value of csw_default */
138 #define CSW_AXI_DEFAULT         (CSW_AXI_ARPROT0_PRIV | CSW_AXI_ARPROT1_NONSEC | CSW_DBGSWENABLE)
139
140 /* APB: initial value of csw_default */
141 #define CSW_APB_DEFAULT         (CSW_DBGSWENABLE)
142
143
144 /* Fields of the MEM-AP's IDR register */
145 #define IDR_REV     (0xFUL << 28)
146 #define IDR_JEP106  (0x7FFUL << 17)
147 #define IDR_CLASS   (0xFUL << 13)
148 #define IDR_VARIANT (0xFUL << 4)
149 #define IDR_TYPE    (0xFUL << 0)
150
151 #define IDR_JEP106_ARM 0x04760000
152
153 #define DP_SELECT_APSEL 0xFF000000
154 #define DP_SELECT_APBANK 0x000000F0
155 #define DP_SELECT_DPBANK 0x0000000F
156 #define DP_SELECT_INVALID 0x00FFFF00 /* Reserved bits one */
157
158 #define DP_APSEL_MAX        (255)
159 #define DP_APSEL_INVALID    (-1)
160
161 /**
162  * This represents an ARM Debug Interface (v5) Access Port (AP).
163  * Most common is a MEM-AP, for memory access.
164  */
165 struct adiv5_ap {
166         /**
167          * DAP this AP belongs to.
168          */
169         struct adiv5_dap *dap;
170
171         /**
172          * Number of this AP.
173          */
174         uint8_t ap_num;
175
176         /**
177          * Default value for (MEM-AP) AP_REG_CSW register.
178          */
179         uint32_t csw_default;
180
181         /**
182          * Cache for (MEM-AP) AP_REG_CSW register value.  This is written to
183          * configure an access mode, such as autoincrementing AP_REG_TAR during
184          * word access.  "-1" indicates no cached value.
185          */
186         uint32_t csw_value;
187
188         /**
189          * Cache for (MEM-AP) AP_REG_TAR register value This is written to
190          * configure the address being read or written
191          * "-1" indicates no cached value.
192          */
193         uint32_t tar_value;
194
195         /**
196          * Configures how many extra tck clocks are added after starting a
197          * MEM-AP access before we try to read its status (and/or result).
198          */
199         uint32_t memaccess_tck;
200
201         /* Size of TAR autoincrement block, ARM ADI Specification requires at least 10 bits */
202         uint32_t tar_autoincr_block;
203
204         /* true if packed transfers are supported by the MEM-AP */
205         bool packed_transfers;
206
207         /* true if unaligned memory access is not supported by the MEM-AP */
208         bool unaligned_access_bad;
209
210         /* true if tar_value is in sync with TAR register */
211         bool tar_valid;
212 };
213
214
215 /**
216  * This represents an ARM Debug Interface (v5) Debug Access Port (DAP).
217  * A DAP has two types of component:  one Debug Port (DP), which is a
218  * transport agent; and at least one Access Port (AP), controlling
219  * resource access.
220  *
221  * There are two basic DP transports: JTAG, and ARM's low pin-count SWD.
222  * Accordingly, this interface is responsible for hiding the transport
223  * differences so upper layer code can largely ignore them.
224  *
225  * When the chip is implemented with JTAG-DP or SW-DP, the transport is
226  * fixed as JTAG or SWD, respectively.  Chips incorporating SWJ-DP permit
227  * a choice made at board design time (by only using the SWD pins), or
228  * as part of setting up a debug session (if all the dual-role JTAG/SWD
229  * signals are available).
230  */
231 struct adiv5_dap {
232         const struct dap_ops *ops;
233
234         /* dap transaction list for WAIT support */
235         struct list_head cmd_journal;
236
237         struct jtag_tap *tap;
238         /* Control config */
239         uint32_t dp_ctrl_stat;
240
241         struct adiv5_ap ap[256];
242
243         /* The current manually selected AP by the "dap apsel" command */
244         uint32_t apsel;
245
246         /**
247          * Cache for DP_SELECT register. A value of DP_SELECT_INVALID
248          * indicates no cached value and forces rewrite of the register.
249          */
250         uint32_t select;
251
252         /* information about current pending SWjDP-AHBAP transaction */
253         uint8_t  ack;
254
255         /**
256          * Holds the pointer to the destination word for the last queued read,
257          * for use with posted AP read sequence optimization.
258          */
259         uint32_t *last_read;
260
261         /* The TI TMS470 and TMS570 series processors use a BE-32 memory ordering
262          * despite lack of support in the ARMv7 architecture. Memory access through
263          * the AHB-AP has strange byte ordering these processors, and we need to
264          * swizzle appropriately. */
265         bool ti_be_32_quirks;
266
267         /**
268          * Signals that an attempt to reestablish communication afresh
269          * should be performed before the next access.
270          */
271         bool do_reconnect;
272
273         /** Flag saying whether to ignore the syspwrupack flag in DAP. Some devices
274          *  do not set this bit until later in the bringup sequence */
275         bool ignore_syspwrupack;
276 };
277
278 /**
279  * Transport-neutral representation of queued DAP transactions, supporting
280  * both JTAG and SWD transports.  All submitted transactions are logically
281  * queued, until the queue is executed by run().  Some implementations might
282  * execute transactions as soon as they're submitted, but no status is made
283  * available until run().
284  */
285 struct dap_ops {
286         /** connect operation for SWD */
287         int (*connect)(struct adiv5_dap *dap);
288         /** DP register read. */
289         int (*queue_dp_read)(struct adiv5_dap *dap, unsigned reg,
290                         uint32_t *data);
291         /** DP register write. */
292         int (*queue_dp_write)(struct adiv5_dap *dap, unsigned reg,
293                         uint32_t data);
294
295         /** AP register read. */
296         int (*queue_ap_read)(struct adiv5_ap *ap, unsigned reg,
297                         uint32_t *data);
298         /** AP register write. */
299         int (*queue_ap_write)(struct adiv5_ap *ap, unsigned reg,
300                         uint32_t data);
301
302         /** AP operation abort. */
303         int (*queue_ap_abort)(struct adiv5_dap *dap, uint8_t *ack);
304
305         /** Executes all queued DAP operations. */
306         int (*run)(struct adiv5_dap *dap);
307
308         /** Executes all queued DAP operations but doesn't check
309          * sticky error conditions */
310         int (*sync)(struct adiv5_dap *dap);
311
312         /** Optional; called at OpenOCD exit */
313         void (*quit)(struct adiv5_dap *dap);
314 };
315
316 /*
317  * Access Port classes
318  */
319 enum ap_class {
320         AP_CLASS_NONE   = 0x00000,  /* No class defined */
321         AP_CLASS_MEM_AP = 0x10000,  /* MEM-AP */
322 };
323
324 /*
325  * Access Port types
326  */
327 enum ap_type {
328         AP_TYPE_JTAG_AP = 0x0,  /* JTAG-AP - JTAG master for controlling other JTAG devices */
329         AP_TYPE_AHB3_AP = 0x1,  /* AHB3 Memory-AP */
330         AP_TYPE_APB_AP  = 0x2,  /* APB Memory-AP */
331         AP_TYPE_AXI_AP  = 0x4,  /* AXI Memory-AP */
332         AP_TYPE_AHB5_AP = 0x5,  /* AHB5 Memory-AP. */
333 };
334
335 /**
336  * Queue a DP register read.
337  * Note that not all DP registers are readable; also, that JTAG and SWD
338  * have slight differences in DP register support.
339  *
340  * @param dap The DAP used for reading.
341  * @param reg The two-bit number of the DP register being read.
342  * @param data Pointer saying where to store the register's value
343  * (in host endianness).
344  *
345  * @return ERROR_OK for success, else a fault code.
346  */
347 static inline int dap_queue_dp_read(struct adiv5_dap *dap,
348                 unsigned reg, uint32_t *data)
349 {
350         assert(dap->ops != NULL);
351         return dap->ops->queue_dp_read(dap, reg, data);
352 }
353
354 /**
355  * Queue a DP register write.
356  * Note that not all DP registers are writable; also, that JTAG and SWD
357  * have slight differences in DP register support.
358  *
359  * @param dap The DAP used for writing.
360  * @param reg The two-bit number of the DP register being written.
361  * @param data Value being written (host endianness)
362  *
363  * @return ERROR_OK for success, else a fault code.
364  */
365 static inline int dap_queue_dp_write(struct adiv5_dap *dap,
366                 unsigned reg, uint32_t data)
367 {
368         assert(dap->ops != NULL);
369         return dap->ops->queue_dp_write(dap, reg, data);
370 }
371
372 /**
373  * Queue an AP register read.
374  *
375  * @param ap The AP used for reading.
376  * @param reg The number of the AP register being read.
377  * @param data Pointer saying where to store the register's value
378  * (in host endianness).
379  *
380  * @return ERROR_OK for success, else a fault code.
381  */
382 static inline int dap_queue_ap_read(struct adiv5_ap *ap,
383                 unsigned reg, uint32_t *data)
384 {
385         assert(ap->dap->ops != NULL);
386         return ap->dap->ops->queue_ap_read(ap, reg, data);
387 }
388
389 /**
390  * Queue an AP register write.
391  *
392  * @param ap The AP used for writing.
393  * @param reg The number of the AP register being written.
394  * @param data Value being written (host endianness)
395  *
396  * @return ERROR_OK for success, else a fault code.
397  */
398 static inline int dap_queue_ap_write(struct adiv5_ap *ap,
399                 unsigned reg, uint32_t data)
400 {
401         assert(ap->dap->ops != NULL);
402         return ap->dap->ops->queue_ap_write(ap, reg, data);
403 }
404
405 /**
406  * Queue an AP abort operation.  The current AP transaction is aborted,
407  * including any update of the transaction counter.  The AP is left in
408  * an unknown state (so it must be re-initialized).  For use only after
409  * the AP has reported WAIT status for an extended period.
410  *
411  * @param dap The DAP used for writing.
412  * @param ack Pointer to where transaction status will be stored.
413  *
414  * @return ERROR_OK for success, else a fault code.
415  */
416 static inline int dap_queue_ap_abort(struct adiv5_dap *dap, uint8_t *ack)
417 {
418         assert(dap->ops != NULL);
419         return dap->ops->queue_ap_abort(dap, ack);
420 }
421
422 /**
423  * Perform all queued DAP operations, and clear any errors posted in the
424  * CTRL_STAT register when they are done.  Note that if more than one AP
425  * operation will be queued, one of the first operations in the queue
426  * should probably enable CORUNDETECT in the CTRL/STAT register.
427  *
428  * @param dap The DAP used.
429  *
430  * @return ERROR_OK for success, else a fault code.
431  */
432 static inline int dap_run(struct adiv5_dap *dap)
433 {
434         assert(dap->ops != NULL);
435         return dap->ops->run(dap);
436 }
437
438 static inline int dap_sync(struct adiv5_dap *dap)
439 {
440         assert(dap->ops != NULL);
441         if (dap->ops->sync)
442                 return dap->ops->sync(dap);
443         return ERROR_OK;
444 }
445
446 static inline int dap_dp_read_atomic(struct adiv5_dap *dap, unsigned reg,
447                                      uint32_t *value)
448 {
449         int retval;
450
451         retval = dap_queue_dp_read(dap, reg, value);
452         if (retval != ERROR_OK)
453                 return retval;
454
455         return dap_run(dap);
456 }
457
458 static inline int dap_dp_poll_register(struct adiv5_dap *dap, unsigned reg,
459                                        uint32_t mask, uint32_t value, int timeout)
460 {
461         assert(timeout > 0);
462         assert((value & mask) == value);
463
464         int ret;
465         uint32_t regval;
466         LOG_DEBUG("DAP: poll %x, mask 0x%08" PRIx32 ", value 0x%08" PRIx32,
467                   reg, mask, value);
468         do {
469                 ret = dap_dp_read_atomic(dap, reg, &regval);
470                 if (ret != ERROR_OK)
471                         return ret;
472
473                 if ((regval & mask) == value)
474                         break;
475
476                 alive_sleep(10);
477         } while (--timeout);
478
479         if (!timeout) {
480                 LOG_DEBUG("DAP: poll %x timeout", reg);
481                 return ERROR_WAIT;
482         } else {
483                 return ERROR_OK;
484         }
485 }
486
487 /* Queued MEM-AP memory mapped single word transfers. */
488 int mem_ap_read_u32(struct adiv5_ap *ap,
489                 uint32_t address, uint32_t *value);
490 int mem_ap_write_u32(struct adiv5_ap *ap,
491                 uint32_t address, uint32_t value);
492
493 /* Synchronous MEM-AP memory mapped single word transfers. */
494 int mem_ap_read_atomic_u32(struct adiv5_ap *ap,
495                 uint32_t address, uint32_t *value);
496 int mem_ap_write_atomic_u32(struct adiv5_ap *ap,
497                 uint32_t address, uint32_t value);
498
499 /* Synchronous MEM-AP memory mapped bus block transfers. */
500 int mem_ap_read_buf(struct adiv5_ap *ap,
501                 uint8_t *buffer, uint32_t size, uint32_t count, uint32_t address);
502 int mem_ap_write_buf(struct adiv5_ap *ap,
503                 const uint8_t *buffer, uint32_t size, uint32_t count, uint32_t address);
504
505 /* Synchronous, non-incrementing buffer functions for accessing fifos. */
506 int mem_ap_read_buf_noincr(struct adiv5_ap *ap,
507                 uint8_t *buffer, uint32_t size, uint32_t count, uint32_t address);
508 int mem_ap_write_buf_noincr(struct adiv5_ap *ap,
509                 const uint8_t *buffer, uint32_t size, uint32_t count, uint32_t address);
510
511 /* Initialisation of the debug system, power domains and registers */
512 int dap_dp_init(struct adiv5_dap *dap);
513 int mem_ap_init(struct adiv5_ap *ap);
514
515 /* Invalidate cached DP select and cached TAR and CSW of all APs */
516 void dap_invalidate_cache(struct adiv5_dap *dap);
517
518 /* Probe the AP for ROM Table location */
519 int dap_get_debugbase(struct adiv5_ap *ap,
520                         uint32_t *dbgbase, uint32_t *apid);
521
522 /* Probe Access Ports to find a particular type */
523 int dap_find_ap(struct adiv5_dap *dap,
524                         enum ap_type type_to_find,
525                         struct adiv5_ap **ap_out);
526
527 static inline struct adiv5_ap *dap_ap(struct adiv5_dap *dap, uint8_t ap_num)
528 {
529         return &dap->ap[ap_num];
530 }
531
532 /* Lookup CoreSight component */
533 int dap_lookup_cs_component(struct adiv5_ap *ap,
534                         uint32_t dbgbase, uint8_t type, uint32_t *addr, int32_t *idx);
535
536 struct target;
537
538 /* Put debug link into SWD mode */
539 int dap_to_swd(struct adiv5_dap *dap);
540
541 /* Put debug link into JTAG mode */
542 int dap_to_jtag(struct adiv5_dap *dap);
543
544 extern const struct command_registration dap_instance_commands[];
545
546 struct arm_dap_object;
547 extern struct adiv5_dap *dap_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o);
548 extern struct adiv5_dap *adiv5_get_dap(struct arm_dap_object *obj);
549 extern int dap_info_command(struct command_invocation *cmd,
550                                          struct adiv5_ap *ap);
551 extern int dap_register_commands(struct command_context *cmd_ctx);
552 extern const char *adiv5_dap_name(struct adiv5_dap *self);
553 extern const struct swd_driver *adiv5_dap_swd_driver(struct adiv5_dap *self);
554 extern int dap_cleanup_all(void);
555
556 struct adiv5_private_config {
557         int ap_num;
558         struct adiv5_dap *dap;
559 };
560
561 extern int adiv5_verify_config(struct adiv5_private_config *pc);
562 extern int adiv5_jim_configure(struct target *target, Jim_GetOptInfo *goi);
563
564 #endif /* OPENOCD_TARGET_ARM_ADI_V5_H */