2 * Copyright (C) 2009 by David Brownell
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
22 #include "armv8_dpm.h"
23 #include <jtag/jtag.h>
25 #include "breakpoints.h"
26 #include "target_type.h"
27 #include "armv8_opcodes.h"
29 #include "helper/time_support.h"
32 #define T32_FMTITR(instr) (((instr & 0x0000FFFF) << 16) | ((instr & 0xFFFF0000) >> 16))
36 * Implements various ARM DPM operations using architectural debug registers.
37 * These routines layer over core-specific communication methods to cope with
38 * implementation differences between cores like ARM1136 and Cortex-A8.
40 * The "Debug Programmers' Model" (DPM) for ARMv6 and ARMv7 is defined by
41 * Part C (Debug Architecture) of the ARM Architecture Reference Manual,
42 * ARMv7-A and ARMv7-R edition (ARM DDI 0406B). In OpenOCD, DPM operations
43 * are abstracted through internal programming interfaces to share code and
44 * to minimize needless differences in debug behavior between cores.
48 * Get core state from EDSCR, without necessity to retrieve CPSR
50 enum arm_state
armv8_dpm_get_core_state(struct arm_dpm
*dpm
)
52 int el
= (dpm
->dscr
>> 8) & 0x3;
53 int rw
= (dpm
->dscr
>> 10) & 0xF;
57 /* In Debug state, each bit gives the current Execution state of each EL */
59 return ARM_STATE_AARCH64
;
64 /*----------------------------------------------------------------------*/
66 static int dpmv8_write_dcc(struct armv8_common
*armv8
, uint32_t data
)
68 return mem_ap_write_u32(armv8
->debug_ap
,
69 armv8
->debug_base
+ CPUV8_DBG_DTRRX
, data
);
72 static int dpmv8_write_dcc_64(struct armv8_common
*armv8
, uint64_t data
)
75 ret
= mem_ap_write_u32(armv8
->debug_ap
,
76 armv8
->debug_base
+ CPUV8_DBG_DTRRX
, data
);
78 ret
= mem_ap_write_u32(armv8
->debug_ap
,
79 armv8
->debug_base
+ CPUV8_DBG_DTRTX
, data
>> 32);
83 static int dpmv8_read_dcc(struct armv8_common
*armv8
, uint32_t *data
,
86 uint32_t dscr
= DSCR_ITE
;
92 /* Wait for DTRRXfull */
93 long long then
= timeval_ms();
94 while ((dscr
& DSCR_DTR_TX_FULL
) == 0) {
95 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
96 armv8
->debug_base
+ CPUV8_DBG_DSCR
,
98 if (retval
!= ERROR_OK
)
100 if (timeval_ms() > then
+ 1000) {
101 LOG_ERROR("Timeout waiting for read dcc");
106 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
107 armv8
->debug_base
+ CPUV8_DBG_DTRTX
,
109 if (retval
!= ERROR_OK
)
118 static int dpmv8_read_dcc_64(struct armv8_common
*armv8
, uint64_t *data
,
121 uint32_t dscr
= DSCR_ITE
;
128 /* Wait for DTRRXfull */
129 long long then
= timeval_ms();
130 while ((dscr
& DSCR_DTR_TX_FULL
) == 0) {
131 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
132 armv8
->debug_base
+ CPUV8_DBG_DSCR
,
134 if (retval
!= ERROR_OK
)
136 if (timeval_ms() > then
+ 1000) {
137 LOG_ERROR("Timeout waiting for DTR_TX_FULL, dscr = 0x%08" PRIx32
, dscr
);
142 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
143 armv8
->debug_base
+ CPUV8_DBG_DTRTX
,
145 if (retval
!= ERROR_OK
)
148 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
149 armv8
->debug_base
+ CPUV8_DBG_DTRRX
,
151 if (retval
!= ERROR_OK
)
154 *data
= *(uint32_t *)data
| (uint64_t)higher
<< 32;
162 static int dpmv8_dpm_prepare(struct arm_dpm
*dpm
)
164 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
168 /* set up invariant: ITE is set after ever DPM operation */
169 long long then
= timeval_ms();
171 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
172 armv8
->debug_base
+ CPUV8_DBG_DSCR
,
174 if (retval
!= ERROR_OK
)
176 if ((dscr
& DSCR_ITE
) != 0)
178 if (timeval_ms() > then
+ 1000) {
179 LOG_ERROR("Timeout waiting for dpm prepare");
184 /* update the stored copy of dscr */
187 /* this "should never happen" ... */
188 if (dscr
& DSCR_DTR_RX_FULL
) {
189 LOG_ERROR("DSCR_DTR_RX_FULL, dscr 0x%08" PRIx32
, dscr
);
191 retval
= mem_ap_read_u32(armv8
->debug_ap
,
192 armv8
->debug_base
+ CPUV8_DBG_DTRRX
, &dscr
);
193 if (retval
!= ERROR_OK
)
200 static int dpmv8_dpm_finish(struct arm_dpm
*dpm
)
202 /* REVISIT what could be done here? */
206 static int dpmv8_exec_opcode(struct arm_dpm
*dpm
,
207 uint32_t opcode
, uint32_t *p_dscr
)
209 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
210 uint32_t dscr
= dpm
->dscr
;
216 /* Wait for InstrCompl bit to be set */
217 long long then
= timeval_ms();
218 while ((dscr
& DSCR_ITE
) == 0) {
219 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
220 armv8
->debug_base
+ CPUV8_DBG_DSCR
, &dscr
);
221 if (retval
!= ERROR_OK
) {
222 LOG_ERROR("Could not read DSCR register, opcode = 0x%08" PRIx32
, opcode
);
225 if (timeval_ms() > then
+ 1000) {
226 LOG_ERROR("Timeout waiting for aarch64_exec_opcode");
231 if (armv8_dpm_get_core_state(dpm
) != ARM_STATE_AARCH64
)
232 opcode
= T32_FMTITR(opcode
);
234 retval
= mem_ap_write_u32(armv8
->debug_ap
,
235 armv8
->debug_base
+ CPUV8_DBG_ITR
, opcode
);
236 if (retval
!= ERROR_OK
)
241 retval
= mem_ap_read_atomic_u32(armv8
->debug_ap
,
242 armv8
->debug_base
+ CPUV8_DBG_DSCR
, &dscr
);
243 if (retval
!= ERROR_OK
) {
244 LOG_ERROR("Could not read DSCR register");
247 if (timeval_ms() > then
+ 1000) {
248 LOG_ERROR("Timeout waiting for aarch64_exec_opcode");
251 } while ((dscr
& DSCR_ITE
) == 0); /* Wait for InstrCompl bit to be set */
253 /* update dscr and el after each command execution */
255 if (dpm
->last_el
!= ((dscr
>> 8) & 3))
256 LOG_DEBUG("EL %i -> %i", dpm
->last_el
, (dscr
>> 8) & 3);
257 dpm
->last_el
= (dscr
>> 8) & 3;
259 if (dscr
& DSCR_ERR
) {
260 LOG_ERROR("Opcode 0x%08"PRIx32
", DSCR.ERR=1, DSCR.EL=%i", opcode
, dpm
->last_el
);
261 armv8_dpm_handle_exception(dpm
);
271 static int dpmv8_instr_execute(struct arm_dpm
*dpm
, uint32_t opcode
)
273 return dpmv8_exec_opcode(dpm
, opcode
, NULL
);
276 static int dpmv8_instr_write_data_dcc(struct arm_dpm
*dpm
,
277 uint32_t opcode
, uint32_t data
)
279 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
282 retval
= dpmv8_write_dcc(armv8
, data
);
283 if (retval
!= ERROR_OK
)
286 return dpmv8_exec_opcode(dpm
, opcode
, 0);
289 static int dpmv8_instr_write_data_dcc_64(struct arm_dpm
*dpm
,
290 uint32_t opcode
, uint64_t data
)
292 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
295 retval
= dpmv8_write_dcc_64(armv8
, data
);
296 if (retval
!= ERROR_OK
)
299 return dpmv8_exec_opcode(dpm
, opcode
, 0);
302 static int dpmv8_instr_write_data_r0(struct arm_dpm
*dpm
,
303 uint32_t opcode
, uint32_t data
)
305 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
306 uint32_t dscr
= DSCR_ITE
;
309 retval
= dpmv8_write_dcc(armv8
, data
);
310 if (retval
!= ERROR_OK
)
313 retval
= dpmv8_exec_opcode(dpm
, armv8_opcode(armv8
, READ_REG_DTRRX
), &dscr
);
314 if (retval
!= ERROR_OK
)
317 /* then the opcode, taking data from R0 */
318 return dpmv8_exec_opcode(dpm
, opcode
, &dscr
);
321 static int dpmv8_instr_write_data_r0_64(struct arm_dpm
*dpm
,
322 uint32_t opcode
, uint64_t data
)
324 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
327 if (dpm
->arm
->core_state
!= ARM_STATE_AARCH64
)
328 return dpmv8_instr_write_data_r0(dpm
, opcode
, data
);
330 /* transfer data from DCC to R0 */
331 retval
= dpmv8_write_dcc_64(armv8
, data
);
332 if (retval
== ERROR_OK
)
333 retval
= dpmv8_exec_opcode(dpm
, ARMV8_MRS(SYSTEM_DBG_DBGDTR_EL0
, 0), &dpm
->dscr
);
335 /* then the opcode, taking data from R0 */
336 if (retval
== ERROR_OK
)
337 retval
= dpmv8_exec_opcode(dpm
, opcode
, &dpm
->dscr
);
342 static int dpmv8_instr_cpsr_sync(struct arm_dpm
*dpm
)
345 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
347 /* "Prefetch flush" after modifying execution status in CPSR */
348 retval
= dpmv8_exec_opcode(dpm
, armv8_opcode(armv8
, ARMV8_OPC_DSB_SY
), &dpm
->dscr
);
349 if (retval
== ERROR_OK
)
350 dpmv8_exec_opcode(dpm
, armv8_opcode(armv8
, ARMV8_OPC_ISB_SY
), &dpm
->dscr
);
354 static int dpmv8_instr_read_data_dcc(struct arm_dpm
*dpm
,
355 uint32_t opcode
, uint32_t *data
)
357 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
360 /* the opcode, writing data to DCC */
361 retval
= dpmv8_exec_opcode(dpm
, opcode
, &dpm
->dscr
);
362 if (retval
!= ERROR_OK
)
365 return dpmv8_read_dcc(armv8
, data
, &dpm
->dscr
);
368 static int dpmv8_instr_read_data_dcc_64(struct arm_dpm
*dpm
,
369 uint32_t opcode
, uint64_t *data
)
371 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
374 /* the opcode, writing data to DCC */
375 retval
= dpmv8_exec_opcode(dpm
, opcode
, &dpm
->dscr
);
376 if (retval
!= ERROR_OK
)
379 return dpmv8_read_dcc_64(armv8
, data
, &dpm
->dscr
);
382 static int dpmv8_instr_read_data_r0(struct arm_dpm
*dpm
,
383 uint32_t opcode
, uint32_t *data
)
385 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
388 /* the opcode, writing data to R0 */
389 retval
= dpmv8_exec_opcode(dpm
, opcode
, &dpm
->dscr
);
390 if (retval
!= ERROR_OK
)
393 /* write R0 to DCC */
394 retval
= dpmv8_exec_opcode(dpm
, armv8_opcode(armv8
, WRITE_REG_DTRTX
), &dpm
->dscr
);
395 if (retval
!= ERROR_OK
)
398 return dpmv8_read_dcc(armv8
, data
, &dpm
->dscr
);
401 static int dpmv8_instr_read_data_r0_64(struct arm_dpm
*dpm
,
402 uint32_t opcode
, uint64_t *data
)
404 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
407 if (dpm
->arm
->core_state
!= ARM_STATE_AARCH64
) {
409 retval
= dpmv8_instr_read_data_r0(dpm
, opcode
, &tmp
);
410 if (retval
== ERROR_OK
)
415 /* the opcode, writing data to R0 */
416 retval
= dpmv8_exec_opcode(dpm
, opcode
, &dpm
->dscr
);
417 if (retval
!= ERROR_OK
)
420 /* write R0 to DCC */
421 retval
= dpmv8_exec_opcode(dpm
, ARMV8_MSR_GP(SYSTEM_DBG_DBGDTR_EL0
, 0), &dpm
->dscr
);
422 if (retval
!= ERROR_OK
)
425 return dpmv8_read_dcc_64(armv8
, data
, &dpm
->dscr
);
429 static int dpmv8_bpwp_enable(struct arm_dpm
*dpm
, unsigned index_t
,
430 target_addr_t addr
, uint32_t control
)
432 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
433 uint32_t vr
= armv8
->debug_base
;
434 uint32_t cr
= armv8
->debug_base
;
438 case 0 ... 15: /* breakpoints */
439 vr
+= CPUV8_DBG_BVR_BASE
;
440 cr
+= CPUV8_DBG_BCR_BASE
;
442 case 16 ... 31: /* watchpoints */
443 vr
+= CPUV8_DBG_WVR_BASE
;
444 cr
+= CPUV8_DBG_WCR_BASE
;
453 LOG_DEBUG("A8: bpwp enable, vr %08x cr %08x",
454 (unsigned) vr
, (unsigned) cr
);
456 retval
= mem_ap_write_atomic_u32(armv8
->debug_ap
, vr
, addr
);
457 if (retval
!= ERROR_OK
)
459 return mem_ap_write_atomic_u32(armv8
->debug_ap
, cr
, control
);
463 static int dpmv8_bpwp_disable(struct arm_dpm
*dpm
, unsigned index_t
)
465 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
470 cr
= armv8
->debug_base
+ CPUV8_DBG_BCR_BASE
;
473 cr
= armv8
->debug_base
+ CPUV8_DBG_WCR_BASE
;
481 LOG_DEBUG("A: bpwp disable, cr %08x", (unsigned) cr
);
483 /* clear control register */
484 return mem_ap_write_atomic_u32(armv8
->debug_ap
, cr
, 0);
488 * Coprocessor support
491 /* Read coprocessor */
492 static int dpmv8_mrc(struct target
*target
, int cpnum
,
493 uint32_t op1
, uint32_t op2
, uint32_t CRn
, uint32_t CRm
,
496 struct arm
*arm
= target_to_arm(target
);
497 struct arm_dpm
*dpm
= arm
->dpm
;
500 retval
= dpm
->prepare(dpm
);
501 if (retval
!= ERROR_OK
)
504 LOG_DEBUG("MRC p%d, %d, r0, c%d, c%d, %d", cpnum
,
505 (int) op1
, (int) CRn
,
506 (int) CRm
, (int) op2
);
508 /* read coprocessor register into R0; return via DCC */
509 retval
= dpm
->instr_read_data_r0(dpm
,
510 ARMV4_5_MRC(cpnum
, op1
, 0, CRn
, CRm
, op2
),
513 /* (void) */ dpm
->finish(dpm
);
517 static int dpmv8_mcr(struct target
*target
, int cpnum
,
518 uint32_t op1
, uint32_t op2
, uint32_t CRn
, uint32_t CRm
,
521 struct arm
*arm
= target_to_arm(target
);
522 struct arm_dpm
*dpm
= arm
->dpm
;
525 retval
= dpm
->prepare(dpm
);
526 if (retval
!= ERROR_OK
)
529 LOG_DEBUG("MCR p%d, %d, r0, c%d, c%d, %d", cpnum
,
530 (int) op1
, (int) CRn
,
531 (int) CRm
, (int) op2
);
533 /* read DCC into r0; then write coprocessor register from R0 */
534 retval
= dpm
->instr_write_data_r0(dpm
,
535 ARMV4_5_MCR(cpnum
, op1
, 0, CRn
, CRm
, op2
),
538 /* (void) */ dpm
->finish(dpm
);
542 /*----------------------------------------------------------------------*/
545 * Register access utilities
548 int armv8_dpm_modeswitch(struct arm_dpm
*dpm
, enum arm_mode mode
)
550 struct armv8_common
*armv8
= (struct armv8_common
*)dpm
->arm
->arch_info
;
551 int retval
= ERROR_OK
;
552 unsigned int target_el
;
553 enum arm_state core_state
;
556 /* restore previous mode */
557 if (mode
== ARM_MODE_ANY
) {
558 cpsr
= buf_get_u32(dpm
->arm
->cpsr
->value
, 0, 32);
560 LOG_DEBUG("restoring mode, cpsr = 0x%08"PRIx32
, cpsr
);
563 LOG_DEBUG("setting mode 0x%"PRIx32
, mode
);
565 /* else force to the specified mode */
566 if (is_arm_mode(mode
))
572 switch (cpsr
& 0x1f) {
584 * TODO: handle ARM_MODE_HYP
594 target_el
= (cpsr
>> 2) & 3;
597 if (target_el
> SYSTEM_CUREL_EL3
) {
598 LOG_ERROR("%s: Invalid target exception level %i", __func__
, target_el
);
602 LOG_DEBUG("target_el = %i, last_el = %i", target_el
, dpm
->last_el
);
603 if (target_el
> dpm
->last_el
) {
604 retval
= dpm
->instr_execute(dpm
,
605 armv8_opcode(armv8
, ARMV8_OPC_DCPS
) | target_el
);
607 /* DCPS clobbers registers just like an exception taken */
608 armv8_dpm_handle_exception(dpm
);
610 core_state
= armv8_dpm_get_core_state(dpm
);
611 if (core_state
!= ARM_STATE_AARCH64
) {
612 /* cannot do DRPS/ERET when already in EL0 */
613 if (dpm
->last_el
!= 0) {
614 /* load SPSR with the desired mode and execute DRPS */
615 LOG_DEBUG("SPSR = 0x%08"PRIx32
, cpsr
);
616 retval
= dpm
->instr_write_data_r0(dpm
,
617 ARMV8_MSR_GP_xPSR_T1(1, 0, 15), cpsr
);
618 if (retval
== ERROR_OK
)
619 retval
= dpm
->instr_execute(dpm
, armv8_opcode(armv8
, ARMV8_OPC_DRPS
));
623 * need to execute multiple DRPS instructions until target_el
626 while (retval
== ERROR_OK
&& dpm
->last_el
!= target_el
) {
627 unsigned int cur_el
= dpm
->last_el
;
628 retval
= dpm
->instr_execute(dpm
, armv8_opcode(armv8
, ARMV8_OPC_DRPS
));
629 if (cur_el
== dpm
->last_el
) {
630 LOG_INFO("Cannot reach EL %i, SPSR corrupted?", target_el
);
636 /* On executing DRPS, DSPSR and DLR become UNKNOWN, mark them as dirty */
637 dpm
->arm
->cpsr
->dirty
= true;
638 dpm
->arm
->pc
->dirty
= true;
641 * re-evaluate the core state, we might be in Aarch32 state now
642 * we rely on dpm->dscr being up-to-date
644 core_state
= armv8_dpm_get_core_state(dpm
);
645 armv8_select_opcodes(armv8
, core_state
== ARM_STATE_AARCH64
);
646 armv8_select_reg_access(armv8
, core_state
== ARM_STATE_AARCH64
);
653 * Common register read, relies on armv8_select_reg_access() having been called.
655 static int dpmv8_read_reg(struct arm_dpm
*dpm
, struct reg
*r
, unsigned regnum
)
657 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
661 retval
= armv8
->read_reg_u64(armv8
, regnum
, &value_64
);
663 if (retval
== ERROR_OK
) {
666 buf_set_u64(r
->value
, 0, r
->size
, value_64
);
668 LOG_DEBUG("READ: %s, %16.8llx", r
->name
, (unsigned long long) value_64
);
670 LOG_DEBUG("READ: %s, %8.8x", r
->name
, (unsigned int) value_64
);
676 * Common register write, relies on armv8_select_reg_access() having been called.
678 static int dpmv8_write_reg(struct arm_dpm
*dpm
, struct reg
*r
, unsigned regnum
)
680 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
681 int retval
= ERROR_FAIL
;
684 value_64
= buf_get_u64(r
->value
, 0, r
->size
);
686 retval
= armv8
->write_reg_u64(armv8
, regnum
, value_64
);
687 if (retval
== ERROR_OK
) {
690 LOG_DEBUG("WRITE: %s, %16.8llx", r
->name
, (unsigned long long)value_64
);
692 LOG_DEBUG("WRITE: %s, %8.8x", r
->name
, (unsigned int)value_64
);
699 * Read basic registers of the the current context: R0 to R15, and CPSR;
700 * sets the core mode (such as USR or IRQ) and state (such as ARM or Thumb).
701 * In normal operation this is called on entry to halting debug state,
702 * possibly after some other operations supporting restore of debug state
703 * or making sure the CPU is fully idle (drain write buffer, etc).
705 int armv8_dpm_read_current_registers(struct arm_dpm
*dpm
)
707 struct arm
*arm
= dpm
->arm
;
708 struct armv8_common
*armv8
= (struct armv8_common
*)arm
->arch_info
;
709 struct reg_cache
*cache
;
714 retval
= dpm
->prepare(dpm
);
715 if (retval
!= ERROR_OK
)
718 cache
= arm
->core_cache
;
720 /* read R0 first (it's used for scratch), then CPSR */
721 r
= cache
->reg_list
+ ARMV8_R0
;
723 retval
= dpmv8_read_reg(dpm
, r
, ARMV8_R0
);
724 if (retval
!= ERROR_OK
)
729 /* read R1, too, it will be clobbered during memory access */
730 r
= cache
->reg_list
+ ARMV8_R1
;
732 retval
= dpmv8_read_reg(dpm
, r
, ARMV8_R1
);
733 if (retval
!= ERROR_OK
)
737 /* read cpsr to r0 and get it back */
738 retval
= dpm
->instr_read_data_r0(dpm
,
739 armv8_opcode(armv8
, READ_REG_DSPSR
), &cpsr
);
740 if (retval
!= ERROR_OK
)
743 /* update core mode and state */
744 armv8_set_cpsr(arm
, cpsr
);
746 for (unsigned int i
= ARMV8_PC
; i
< cache
->num_regs
; i
++) {
747 struct arm_reg
*arm_reg
;
749 r
= armv8_reg_current(arm
, i
);
754 * Only read registers that are available from the
755 * current EL (or core mode).
757 arm_reg
= r
->arch_info
;
758 if (arm_reg
->mode
!= ARM_MODE_ANY
&&
759 dpm
->last_el
!= armv8_curel_from_core_mode(arm_reg
->mode
))
762 retval
= dpmv8_read_reg(dpm
, r
, i
);
763 if (retval
!= ERROR_OK
)
773 /* Avoid needless I/O ... leave breakpoints and watchpoints alone
774 * unless they're removed, or need updating because of single-stepping
775 * or running debugger code.
777 static int dpmv8_maybe_update_bpwp(struct arm_dpm
*dpm
, bool bpwp
,
778 struct dpm_bpwp
*xp
, int *set_p
)
780 int retval
= ERROR_OK
;
787 /* removed or startup; we must disable it */
792 /* disabled, but we must set it */
793 xp
->dirty
= disable
= false;
798 /* set, but we must temporarily disable it */
799 xp
->dirty
= disable
= true;
804 retval
= dpm
->bpwp_disable(dpm
, xp
->number
);
806 retval
= dpm
->bpwp_enable(dpm
, xp
->number
,
807 xp
->address
, xp
->control
);
809 if (retval
!= ERROR_OK
)
810 LOG_ERROR("%s: can't %s HW %spoint %d",
811 disable
? "disable" : "enable",
812 target_name(dpm
->arm
->target
),
813 (xp
->number
< 16) ? "break" : "watch",
819 static int dpmv8_add_breakpoint(struct target
*target
, struct breakpoint
*bp
);
822 * Writes all modified core registers for all processor modes. In normal
823 * operation this is called on exit from halting debug state.
825 * @param dpm: represents the processor
826 * @param bpwp: true ensures breakpoints and watchpoints are set,
827 * false ensures they are cleared
829 int armv8_dpm_write_dirty_registers(struct arm_dpm
*dpm
, bool bpwp
)
831 struct arm
*arm
= dpm
->arm
;
832 struct reg_cache
*cache
= arm
->core_cache
;
835 retval
= dpm
->prepare(dpm
);
836 if (retval
!= ERROR_OK
)
839 /* If we're managing hardware breakpoints for this core, enable
840 * or disable them as requested.
842 * REVISIT We don't yet manage them for ANY cores. Eventually
843 * we should be able to assume we handle them; but until then,
844 * cope with the hand-crafted breakpoint code.
846 if (arm
->target
->type
->add_breakpoint
== dpmv8_add_breakpoint
) {
847 for (unsigned i
= 0; i
< dpm
->nbp
; i
++) {
848 struct dpm_bp
*dbp
= dpm
->dbp
+ i
;
849 struct breakpoint
*bp
= dbp
->bp
;
851 retval
= dpmv8_maybe_update_bpwp(dpm
, bpwp
, &dbp
->bpwp
,
852 bp
? &bp
->set
: NULL
);
853 if (retval
!= ERROR_OK
)
858 /* enable/disable watchpoints */
859 for (unsigned i
= 0; i
< dpm
->nwp
; i
++) {
860 struct dpm_wp
*dwp
= dpm
->dwp
+ i
;
861 struct watchpoint
*wp
= dwp
->wp
;
863 retval
= dpmv8_maybe_update_bpwp(dpm
, bpwp
, &dwp
->bpwp
,
864 wp
? &wp
->set
: NULL
);
865 if (retval
!= ERROR_OK
)
869 /* NOTE: writes to breakpoint and watchpoint registers might
870 * be queued, and need (efficient/batched) flushing later.
873 /* Restore original core mode and state */
874 retval
= armv8_dpm_modeswitch(dpm
, ARM_MODE_ANY
);
875 if (retval
!= ERROR_OK
)
878 /* check everything except our scratch register R0 */
879 for (unsigned i
= 1; i
< cache
->num_regs
; i
++) {
882 /* skip PC and CPSR */
883 if (i
== ARMV8_PC
|| i
== ARMV8_xPSR
)
886 if (!cache
->reg_list
[i
].valid
)
889 if (!cache
->reg_list
[i
].dirty
)
892 /* skip all registers not on the current EL */
893 r
= cache
->reg_list
[i
].arch_info
;
894 if (r
->mode
!= ARM_MODE_ANY
&&
895 dpm
->last_el
!= armv8_curel_from_core_mode(r
->mode
))
898 retval
= dpmv8_write_reg(dpm
, &cache
->reg_list
[i
], i
);
899 if (retval
!= ERROR_OK
)
903 /* flush CPSR and PC */
904 if (retval
== ERROR_OK
)
905 retval
= dpmv8_write_reg(dpm
, &cache
->reg_list
[ARMV8_xPSR
], ARMV8_xPSR
);
906 if (retval
== ERROR_OK
)
907 retval
= dpmv8_write_reg(dpm
, &cache
->reg_list
[ARMV8_PC
], ARMV8_PC
);
908 /* flush R0 -- it's *very* dirty by now */
909 if (retval
== ERROR_OK
)
910 retval
= dpmv8_write_reg(dpm
, &cache
->reg_list
[0], 0);
911 if (retval
== ERROR_OK
)
912 dpm
->instr_cpsr_sync(dpm
);
919 * Standard ARM register accessors ... there are three methods
920 * in "struct arm", to support individual read/write and bulk read
924 static int armv8_dpm_read_core_reg(struct target
*target
, struct reg
*r
,
925 int regnum
, enum arm_mode mode
)
927 struct arm
*arm
= target_to_arm(target
);
928 struct arm_dpm
*dpm
= target_to_arm(target
)->dpm
;
930 int max
= arm
->core_cache
->num_regs
;
932 if (regnum
< 0 || regnum
>= max
)
933 return ERROR_COMMAND_SYNTAX_ERROR
;
936 * REVISIT what happens if we try to read SPSR in a core mode
937 * which has no such register?
939 retval
= dpm
->prepare(dpm
);
940 if (retval
!= ERROR_OK
)
943 retval
= dpmv8_read_reg(dpm
, r
, regnum
);
944 if (retval
!= ERROR_OK
)
948 /* (void) */ dpm
->finish(dpm
);
952 static int armv8_dpm_write_core_reg(struct target
*target
, struct reg
*r
,
953 int regnum
, enum arm_mode mode
, uint8_t *value
)
955 struct arm
*arm
= target_to_arm(target
);
956 struct arm_dpm
*dpm
= target_to_arm(target
)->dpm
;
958 int max
= arm
->core_cache
->num_regs
;
960 if (regnum
< 0 || regnum
> max
)
961 return ERROR_COMMAND_SYNTAX_ERROR
;
963 /* REVISIT what happens if we try to write SPSR in a core mode
964 * which has no such register?
967 retval
= dpm
->prepare(dpm
);
968 if (retval
!= ERROR_OK
)
971 retval
= dpmv8_write_reg(dpm
, r
, regnum
);
973 /* always clean up, regardless of error */
979 static int armv8_dpm_full_context(struct target
*target
)
981 struct arm
*arm
= target_to_arm(target
);
982 struct arm_dpm
*dpm
= arm
->dpm
;
983 struct reg_cache
*cache
= arm
->core_cache
;
987 retval
= dpm
->prepare(dpm
);
988 if (retval
!= ERROR_OK
)
992 enum arm_mode mode
= ARM_MODE_ANY
;
996 /* We "know" arm_dpm_read_current_registers() was called so
997 * the unmapped registers (R0..R7, PC, AND CPSR) and some
998 * view of R8..R14 are current. We also "know" oddities of
999 * register mapping: special cases for R8..R12 and SPSR.
1001 * Pick some mode with unread registers and read them all.
1002 * Repeat until done.
1004 for (unsigned i
= 0; i
< cache
->num_regs
; i
++) {
1007 if (cache
->reg_list
[i
].valid
)
1009 r
= cache
->reg_list
[i
].arch_info
;
1011 /* may need to pick a mode and set CPSR */
1016 /* For regular (ARM_MODE_ANY) R8..R12
1017 * in case we've entered debug state
1018 * in FIQ mode we need to patch mode.
1020 if (mode
!= ARM_MODE_ANY
)
1021 retval
= armv8_dpm_modeswitch(dpm
, mode
);
1023 retval
= armv8_dpm_modeswitch(dpm
, ARM_MODE_USR
);
1025 if (retval
!= ERROR_OK
)
1028 if (r
->mode
!= mode
)
1031 /* CPSR was read, so "R16" must mean SPSR */
1032 retval
= dpmv8_read_reg(dpm
,
1033 &cache
->reg_list
[i
],
1034 (r
->num
== 16) ? 17 : r
->num
);
1035 if (retval
!= ERROR_OK
)
1041 retval
= armv8_dpm_modeswitch(dpm
, ARM_MODE_ANY
);
1042 /* (void) */ dpm
->finish(dpm
);
1048 /*----------------------------------------------------------------------*/
1051 * Breakpoint and Watchpoint support.
1053 * Hardware {break,watch}points are usually left active, to minimize
1054 * debug entry/exit costs. When they are set or cleared, it's done in
1055 * batches. Also, DPM-conformant hardware can update debug registers
1056 * regardless of whether the CPU is running or halted ... though that
1057 * fact isn't currently leveraged.
1060 static int dpmv8_bpwp_setup(struct arm_dpm
*dpm
, struct dpm_bpwp
*xp
,
1061 uint32_t addr
, uint32_t length
)
1065 control
= (1 << 0) /* enable */
1066 | (3 << 1); /* both user and privileged access */
1068 /* Match 1, 2, or all 4 byte addresses in this word.
1070 * FIXME: v7 hardware allows lengths up to 2 GB for BP and WP.
1071 * Support larger length, when addr is suitably aligned. In
1072 * particular, allow watchpoints on 8 byte "double" values.
1074 * REVISIT allow watchpoints on unaligned 2-bit values; and on
1075 * v7 hardware, unaligned 4-byte ones too.
1079 control
|= (1 << (addr
& 3)) << 5;
1082 /* require 2-byte alignment */
1084 control
|= (3 << (addr
& 2)) << 5;
1089 /* require 4-byte alignment */
1091 control
|= 0xf << 5;
1096 LOG_ERROR("unsupported {break,watch}point length/alignment");
1097 return ERROR_COMMAND_SYNTAX_ERROR
;
1100 /* other shared control bits:
1101 * bits 15:14 == 0 ... both secure and nonsecure states (v6.1+ only)
1102 * bit 20 == 0 ... not linked to a context ID
1103 * bit 28:24 == 0 ... not ignoring N LSBs (v7 only)
1106 xp
->address
= addr
& ~3;
1107 xp
->control
= control
;
1110 LOG_DEBUG("BPWP: addr %8.8" PRIx32
", control %" PRIx32
", number %d",
1111 xp
->address
, control
, xp
->number
);
1113 /* hardware is updated in write_dirty_registers() */
1117 static int dpmv8_add_breakpoint(struct target
*target
, struct breakpoint
*bp
)
1119 struct arm
*arm
= target_to_arm(target
);
1120 struct arm_dpm
*dpm
= arm
->dpm
;
1121 int retval
= ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1124 return ERROR_COMMAND_SYNTAX_ERROR
;
1125 if (!dpm
->bpwp_enable
)
1128 /* FIXME we need a generic solution for software breakpoints. */
1129 if (bp
->type
== BKPT_SOFT
)
1130 LOG_DEBUG("using HW bkpt, not SW...");
1132 for (unsigned i
= 0; i
< dpm
->nbp
; i
++) {
1133 if (!dpm
->dbp
[i
].bp
) {
1134 retval
= dpmv8_bpwp_setup(dpm
, &dpm
->dbp
[i
].bpwp
,
1135 bp
->address
, bp
->length
);
1136 if (retval
== ERROR_OK
)
1137 dpm
->dbp
[i
].bp
= bp
;
1145 static int dpmv8_remove_breakpoint(struct target
*target
, struct breakpoint
*bp
)
1147 struct arm
*arm
= target_to_arm(target
);
1148 struct arm_dpm
*dpm
= arm
->dpm
;
1149 int retval
= ERROR_COMMAND_SYNTAX_ERROR
;
1151 for (unsigned i
= 0; i
< dpm
->nbp
; i
++) {
1152 if (dpm
->dbp
[i
].bp
== bp
) {
1153 dpm
->dbp
[i
].bp
= NULL
;
1154 dpm
->dbp
[i
].bpwp
.dirty
= true;
1156 /* hardware is updated in write_dirty_registers() */
1165 static int dpmv8_watchpoint_setup(struct arm_dpm
*dpm
, unsigned index_t
,
1166 struct watchpoint
*wp
)
1169 struct dpm_wp
*dwp
= dpm
->dwp
+ index_t
;
1172 /* this hardware doesn't support data value matching or masking */
1173 if (wp
->value
|| wp
->mask
!= ~(uint32_t)0) {
1174 LOG_DEBUG("watchpoint values and masking not supported");
1175 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1178 retval
= dpmv8_bpwp_setup(dpm
, &dwp
->bpwp
, wp
->address
, wp
->length
);
1179 if (retval
!= ERROR_OK
)
1182 control
= dwp
->bpwp
.control
;
1194 dwp
->bpwp
.control
= control
;
1196 dpm
->dwp
[index_t
].wp
= wp
;
1201 static int dpmv8_add_watchpoint(struct target
*target
, struct watchpoint
*wp
)
1203 struct arm
*arm
= target_to_arm(target
);
1204 struct arm_dpm
*dpm
= arm
->dpm
;
1205 int retval
= ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1207 if (dpm
->bpwp_enable
) {
1208 for (unsigned i
= 0; i
< dpm
->nwp
; i
++) {
1209 if (!dpm
->dwp
[i
].wp
) {
1210 retval
= dpmv8_watchpoint_setup(dpm
, i
, wp
);
1219 static int dpmv8_remove_watchpoint(struct target
*target
, struct watchpoint
*wp
)
1221 struct arm
*arm
= target_to_arm(target
);
1222 struct arm_dpm
*dpm
= arm
->dpm
;
1223 int retval
= ERROR_COMMAND_SYNTAX_ERROR
;
1225 for (unsigned i
= 0; i
< dpm
->nwp
; i
++) {
1226 if (dpm
->dwp
[i
].wp
== wp
) {
1227 dpm
->dwp
[i
].wp
= NULL
;
1228 dpm
->dwp
[i
].bpwp
.dirty
= true;
1230 /* hardware is updated in write_dirty_registers() */
1239 void armv8_dpm_report_wfar(struct arm_dpm
*dpm
, uint64_t addr
)
1241 switch (dpm
->arm
->core_state
) {
1243 case ARM_STATE_AARCH64
:
1246 case ARM_STATE_THUMB
:
1247 case ARM_STATE_THUMB_EE
:
1250 case ARM_STATE_JAZELLE
:
1254 LOG_DEBUG("Unknown core_state");
1261 * Handle exceptions taken in debug state. This happens mostly for memory
1262 * accesses that violated a MMU policy. Taking an exception while in debug
1263 * state clobbers certain state registers on the target exception level.
1264 * Just mark those registers dirty so that they get restored on resume.
1265 * This works both for Aarch32 and Aarch64 states.
1267 * This function must not perform any actions that trigger another exception
1268 * or a recursion will happen.
1270 void armv8_dpm_handle_exception(struct arm_dpm
*dpm
)
1272 struct armv8_common
*armv8
= dpm
->arm
->arch_info
;
1273 struct reg_cache
*cache
= dpm
->arm
->core_cache
;
1274 enum arm_state core_state
;
1279 static const int clobbered_regs_by_el
[3][5] = {
1280 { ARMV8_PC
, ARMV8_xPSR
, ARMV8_ELR_EL1
, ARMV8_ESR_EL1
, ARMV8_SPSR_EL1
},
1281 { ARMV8_PC
, ARMV8_xPSR
, ARMV8_ELR_EL2
, ARMV8_ESR_EL2
, ARMV8_SPSR_EL2
},
1282 { ARMV8_PC
, ARMV8_xPSR
, ARMV8_ELR_EL3
, ARMV8_ESR_EL3
, ARMV8_SPSR_EL3
},
1285 el
= (dpm
->dscr
>> 8) & 3;
1287 /* safety check, must not happen since EL0 cannot be a target for an exception */
1288 if (el
< SYSTEM_CUREL_EL1
|| el
> SYSTEM_CUREL_EL3
) {
1289 LOG_ERROR("%s: EL %i is invalid, DSCR corrupted?", __func__
, el
);
1293 /* Clear sticky error */
1294 mem_ap_write_u32(armv8
->debug_ap
,
1295 armv8
->debug_base
+ CPUV8_DBG_DRCR
, DRCR_CSE
);
1297 armv8
->read_reg_u64(armv8
, ARMV8_xPSR
, &dlr
);
1299 armv8
->read_reg_u64(armv8
, ARMV8_PC
, &dlr
);
1301 LOG_DEBUG("Exception taken to EL %i, DLR=0x%016"PRIx64
" DSPSR=0x%08"PRIx32
,
1304 /* mark all clobbered registers as dirty */
1305 for (int i
= 0; i
< 5; i
++)
1306 cache
->reg_list
[clobbered_regs_by_el
[el
-1][i
]].dirty
= true;
1309 * re-evaluate the core state, we might be in Aarch64 state now
1310 * we rely on dpm->dscr being up-to-date
1312 core_state
= armv8_dpm_get_core_state(dpm
);
1313 armv8_select_opcodes(armv8
, core_state
== ARM_STATE_AARCH64
);
1314 armv8_select_reg_access(armv8
, core_state
== ARM_STATE_AARCH64
);
1316 armv8_dpm_modeswitch(dpm
, ARM_MODE_ANY
);
1319 /*----------------------------------------------------------------------*/
1322 * Other debug and support utilities
1325 void armv8_dpm_report_dscr(struct arm_dpm
*dpm
, uint32_t dscr
)
1327 struct target
*target
= dpm
->arm
->target
;
1330 dpm
->last_el
= (dscr
>> 8) & 3;
1332 /* Examine debug reason */
1333 switch (DSCR_ENTRY(dscr
)) {
1334 /* FALL THROUGH -- assume a v6 core in abort mode */
1335 case DSCRV8_ENTRY_EXT_DEBUG
: /* EDBGRQ */
1336 target
->debug_reason
= DBG_REASON_DBGRQ
;
1338 case DSCRV8_ENTRY_HALT_STEP_EXECLU
: /* HALT step */
1339 case DSCRV8_ENTRY_HALT_STEP_NORMAL
: /* Halt step*/
1340 case DSCRV8_ENTRY_HALT_STEP
:
1341 target
->debug_reason
= DBG_REASON_SINGLESTEP
;
1343 case DSCRV8_ENTRY_HLT
: /* HLT instruction (software breakpoint) */
1344 case DSCRV8_ENTRY_BKPT
: /* SW BKPT (?) */
1345 case DSCRV8_ENTRY_RESET_CATCH
: /* Reset catch */
1346 case DSCRV8_ENTRY_OS_UNLOCK
: /*OS unlock catch*/
1347 case DSCRV8_ENTRY_EXCEPTION_CATCH
: /*exception catch*/
1348 case DSCRV8_ENTRY_SW_ACCESS_DBG
: /*SW access dbg register*/
1349 target
->debug_reason
= DBG_REASON_BREAKPOINT
;
1351 case DSCRV8_ENTRY_WATCHPOINT
: /* asynch watchpoint */
1352 target
->debug_reason
= DBG_REASON_WATCHPOINT
;
1355 target
->debug_reason
= DBG_REASON_UNDEFINED
;
1361 /*----------------------------------------------------------------------*/
1364 * Setup and management support.
1368 * Hooks up this DPM to its associated target; call only once.
1369 * Initially this only covers the register cache.
1371 * Oh, and watchpoints. Yeah.
1373 int armv8_dpm_setup(struct arm_dpm
*dpm
)
1375 struct arm
*arm
= dpm
->arm
;
1376 struct target
*target
= arm
->target
;
1377 struct reg_cache
*cache
;
1380 /* register access setup */
1381 arm
->full_context
= armv8_dpm_full_context
;
1382 arm
->read_core_reg
= armv8_dpm_read_core_reg
;
1383 arm
->write_core_reg
= armv8_dpm_write_core_reg
;
1385 if (arm
->core_cache
== NULL
) {
1386 cache
= armv8_build_reg_cache(target
);
1391 /* coprocessor access setup */
1392 arm
->mrc
= dpmv8_mrc
;
1393 arm
->mcr
= dpmv8_mcr
;
1395 dpm
->prepare
= dpmv8_dpm_prepare
;
1396 dpm
->finish
= dpmv8_dpm_finish
;
1398 dpm
->instr_execute
= dpmv8_instr_execute
;
1399 dpm
->instr_write_data_dcc
= dpmv8_instr_write_data_dcc
;
1400 dpm
->instr_write_data_dcc_64
= dpmv8_instr_write_data_dcc_64
;
1401 dpm
->instr_write_data_r0
= dpmv8_instr_write_data_r0
;
1402 dpm
->instr_write_data_r0_64
= dpmv8_instr_write_data_r0_64
;
1403 dpm
->instr_cpsr_sync
= dpmv8_instr_cpsr_sync
;
1405 dpm
->instr_read_data_dcc
= dpmv8_instr_read_data_dcc
;
1406 dpm
->instr_read_data_dcc_64
= dpmv8_instr_read_data_dcc_64
;
1407 dpm
->instr_read_data_r0
= dpmv8_instr_read_data_r0
;
1408 dpm
->instr_read_data_r0_64
= dpmv8_instr_read_data_r0_64
;
1410 dpm
->arm_reg_current
= armv8_reg_current
;
1412 /* dpm->bpwp_enable = dpmv8_bpwp_enable; */
1413 dpm
->bpwp_disable
= dpmv8_bpwp_disable
;
1415 /* breakpoint setup -- optional until it works everywhere */
1416 if (!target
->type
->add_breakpoint
) {
1417 target
->type
->add_breakpoint
= dpmv8_add_breakpoint
;
1418 target
->type
->remove_breakpoint
= dpmv8_remove_breakpoint
;
1421 /* watchpoint setup */
1422 target
->type
->add_watchpoint
= dpmv8_add_watchpoint
;
1423 target
->type
->remove_watchpoint
= dpmv8_remove_watchpoint
;
1425 /* FIXME add vector catch support */
1427 dpm
->nbp
= 1 + ((dpm
->didr
>> 12) & 0xf);
1428 dpm
->dbp
= calloc(dpm
->nbp
, sizeof *dpm
->dbp
);
1430 dpm
->nwp
= 1 + ((dpm
->didr
>> 20) & 0xf);
1431 dpm
->dwp
= calloc(dpm
->nwp
, sizeof *dpm
->dwp
);
1433 if (!dpm
->dbp
|| !dpm
->dwp
) {
1439 LOG_INFO("%s: hardware has %d breakpoints, %d watchpoints",
1440 target_name(target
), dpm
->nbp
, dpm
->nwp
);
1442 /* REVISIT ... and some of those breakpoints could match
1443 * execution context IDs...
1450 * Reinitializes DPM state at the beginning of a new debug session
1451 * or after a reset which may have affected the debug module.
1453 int armv8_dpm_initialize(struct arm_dpm
*dpm
)
1455 /* Disable all breakpoints and watchpoints at startup. */
1456 if (dpm
->bpwp_disable
) {
1459 for (i
= 0; i
< dpm
->nbp
; i
++) {
1460 dpm
->dbp
[i
].bpwp
.number
= i
;
1461 (void) dpm
->bpwp_disable(dpm
, i
);
1463 for (i
= 0; i
< dpm
->nwp
; i
++) {
1464 dpm
->dwp
[i
].bpwp
.number
= 16 + i
;
1465 (void) dpm
->bpwp_disable(dpm
, 16 + i
);
1468 LOG_WARNING("%s: can't disable breakpoints and watchpoints",
1469 target_name(dpm
->arm
->target
));
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)