1 /***************************************************************************
2 * Copyright (C) 2008 digenius technology GmbH. *
5 * Copyright (C) 2008,2009 Oyvind Harboe oyvind.harboe@zylin.com *
7 * Copyright (C) 2008 Georg Acher <acher@in.tum.de> *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
14 * This program is distributed in the hope that it will be useful, *
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
17 * GNU General Public License for more details. *
19 * You should have received a copy of the GNU General Public License *
20 * along with this program; if not, write to the *
21 * Free Software Foundation, Inc., *
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
23 ***************************************************************************/
30 #include "breakpoints.h"
31 #include "arm11_dbgtap.h"
32 #include "arm_simulator.h"
33 #include "time_support.h"
34 #include "target_type.h"
35 #include "algorithm.h"
40 #define _DEBUG_INSTRUCTION_EXECUTION_
43 static bool arm11_config_memwrite_burst
= true;
44 static bool arm11_config_memwrite_error_fatal
= true;
45 static uint32_t arm11_vcr
= 0;
46 static bool arm11_config_step_irq_enable
= false;
47 static bool arm11_config_hardware_step
= false;
63 enum arm11_regtype type
;
66 /* update arm11_regcache_ids when changing this */
67 static const struct arm11_reg_defs arm11_reg_defs
[] =
70 {"dscr", 0, -1, ARM11_REGISTER_DSCR
},
71 {"wdtr", 0, -1, ARM11_REGISTER_WDTR
},
72 {"rdtr", 0, -1, ARM11_REGISTER_RDTR
},
75 enum arm11_regcache_ids
84 static int arm11_on_enter_debug_state(struct arm11_common
*arm11
);
85 static int arm11_step(struct target
*target
, int current
,
86 uint32_t address
, int handle_breakpoints
);
88 static int arm11_build_reg_cache(struct target
*target
);
89 static int arm11_set_reg(struct reg
*reg
, uint8_t *buf
);
90 static int arm11_get_reg(struct reg
*reg
);
93 /** Check and if necessary take control of the system
95 * \param arm11 Target state variable.
96 * \param dscr If the current DSCR content is
97 * available a pointer to a word holding the
98 * DSCR can be passed. Otherwise use NULL.
100 static int arm11_check_init(struct arm11_common
*arm11
, uint32_t *dscr
)
102 uint32_t dscr_local_tmp_copy
;
106 dscr
= &dscr_local_tmp_copy
;
108 CHECK_RETVAL(arm11_read_DSCR(arm11
, dscr
));
111 if (!(*dscr
& ARM11_DSCR_MODE_SELECT
))
113 LOG_DEBUG("Bringing target into debug mode");
115 *dscr
|= ARM11_DSCR_MODE_SELECT
; /* Halt debug-mode */
116 arm11_write_DSCR(arm11
, *dscr
);
118 /* add further reset initialization here */
120 arm11
->simulate_reset_on_next_halt
= true;
122 if (*dscr
& ARM11_DSCR_CORE_HALTED
)
124 /** \todo TODO: this needs further scrutiny because
125 * arm11_on_enter_debug_state() never gets properly called.
126 * As a result we don't read the actual register states from
130 arm11
->target
->state
= TARGET_HALTED
;
131 arm11
->target
->debug_reason
= arm11_get_DSCR_debug_reason(*dscr
);
135 arm11
->target
->state
= TARGET_RUNNING
;
136 arm11
->target
->debug_reason
= DBG_REASON_NOTHALTED
;
139 arm11_sc7_clear_vbw(arm11
);
148 (arm11->reg_values[ARM11_RC_##x])
150 /** Save processor state.
152 * This is called when the HALT instruction has succeeded
153 * or on other occasions that stop the processor.
156 static int arm11_on_enter_debug_state(struct arm11_common
*arm11
)
160 /* REVISIT entire cache should already be invalid !!! */
161 register_cache_invalidate(arm11
->arm
.core_cache
);
163 for (size_t i
= 0; i
< ARRAY_SIZE(arm11
->reg_values
); i
++)
165 arm11
->reg_list
[i
].valid
= 1;
166 arm11
->reg_list
[i
].dirty
= 0;
169 /* See e.g. ARM1136 TRM, "14.8.4 Entering Debug state" */
172 CHECK_RETVAL(arm11_read_DSCR(arm11
, &R(DSCR
)));
176 if (R(DSCR
) & ARM11_DSCR_WDTR_FULL
)
178 arm11_add_debug_SCAN_N(arm11
, 0x05, ARM11_TAP_DEFAULT
);
180 arm11_add_IR(arm11
, ARM11_INTEST
, ARM11_TAP_DEFAULT
);
182 struct scan_field chain5_fields
[3];
184 arm11_setup_field(arm11
, 32, NULL
, &R(WDTR
), chain5_fields
+ 0);
185 arm11_setup_field(arm11
, 1, NULL
, NULL
, chain5_fields
+ 1);
186 arm11_setup_field(arm11
, 1, NULL
, NULL
, chain5_fields
+ 2);
188 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields
), chain5_fields
, TAP_DRPAUSE
);
192 arm11
->reg_list
[ARM11_RC_WDTR
].valid
= 0;
196 /* DSCR: set ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE
198 * ARM1176 spec says this is needed only for wDTR/rDTR's "ITR mode",
199 * but not to issue ITRs. ARM1136 seems to require this to issue
202 uint32_t new_dscr
= R(DSCR
) | ARM11_DSCR_EXECUTE_ARM_INSTRUCTION_ENABLE
;
204 /* this executes JTAG queue: */
206 arm11_write_DSCR(arm11
, new_dscr
);
210 Before executing any instruction in debug state you have to drain the write buffer.
211 This ensures that no imprecise Data Aborts can return at a later point:*/
213 /** \todo TODO: Test drain write buffer. */
218 /* MRC p14,0,R0,c5,c10,0 */
219 // arm11_run_instr_no_data1(arm11, /*0xee150e1a*/0xe320f000);
221 /* mcr 15, 0, r0, cr7, cr10, {4} */
222 arm11_run_instr_no_data1(arm11
, 0xee070f9a);
224 uint32_t dscr
= arm11_read_DSCR(arm11
);
226 LOG_DEBUG("DRAIN, DSCR %08x", dscr
);
228 if (dscr
& ARM11_DSCR_STICKY_IMPRECISE_DATA_ABORT
)
230 arm11_run_instr_no_data1(arm11
, 0xe320f000);
232 dscr
= arm11_read_DSCR(arm11
);
234 LOG_DEBUG("DRAIN, DSCR %08x (DONE)", dscr
);
243 * NOTE: ARM1136 TRM suggests saving just R0 here now, then
244 * CPSR and PC after the rDTR stuff. We do it all at once.
246 retval
= arm_dpm_read_current_registers(&arm11
->dpm
);
247 if (retval
!= ERROR_OK
)
248 LOG_ERROR("DPM REG READ -- fail %d", retval
);
250 retval
= arm11_run_instr_data_prepare(arm11
);
251 if (retval
!= ERROR_OK
)
254 /* maybe save rDTR */
256 /* check rDTRfull in DSCR */
258 if (R(DSCR
) & ARM11_DSCR_RDTR_FULL
)
260 /* MRC p14,0,R0,c0,c5,0 (move rDTR -> r0 (-> wDTR -> local var)) */
261 retval
= arm11_run_instr_data_from_core_via_r0(arm11
, 0xEE100E15, &R(RDTR
));
262 if (retval
!= ERROR_OK
)
267 arm11
->reg_list
[ARM11_RC_RDTR
].valid
= 0;
270 /* REVISIT Now that we've saved core state, there's may also
271 * be MMU and cache state to care about ...
274 if (arm11
->simulate_reset_on_next_halt
)
276 arm11
->simulate_reset_on_next_halt
= false;
278 LOG_DEBUG("Reset c1 Control Register");
280 /* Write 0 (reset value) to Control register 0 to disable MMU/Cache etc. */
282 /* MCR p15,0,R0,c1,c0,0 */
283 retval
= arm11_run_instr_data_to_core_via_r0(arm11
, 0xee010f10, 0);
284 if (retval
!= ERROR_OK
)
289 retval
= arm11_run_instr_data_finish(arm11
);
290 if (retval
!= ERROR_OK
)
296 /** Restore processor state
298 * This is called in preparation for the RESTART function.
301 static int arm11_leave_debug_state(struct arm11_common
*arm11
)
305 /* See e.g. ARM1136 TRM, "14.8.5 Leaving Debug state" */
307 /* NOTE: the ARM1136 TRM suggests restoring all registers
308 * except R0/PC/CPSR right now. Instead, we do them all
309 * at once, just a bit later on.
312 /* REVISIT once we start caring about MMU and cache state,
313 * address it here ...
316 /* spec says clear wDTR and rDTR; we assume they are clear as
317 otherwise our programming would be sloppy */
321 CHECK_RETVAL(arm11_read_DSCR(arm11
, &DSCR
));
323 if (DSCR
& (ARM11_DSCR_RDTR_FULL
| ARM11_DSCR_WDTR_FULL
))
326 The wDTR/rDTR two registers that are used to send/receive data to/from
327 the core in tandem with corresponding instruction codes that are
328 written into the core. The RDTR FULL/WDTR FULL flag indicates that the
329 registers hold data that was written by one side (CPU or JTAG) and not
330 read out by the other side.
332 LOG_ERROR("wDTR/rDTR inconsistent (DSCR %08" PRIx32
")", DSCR
);
337 /* maybe restore original wDTR */
338 if ((R(DSCR
) & ARM11_DSCR_WDTR_FULL
) || arm11
->reg_list
[ARM11_RC_WDTR
].dirty
)
340 retval
= arm11_run_instr_data_prepare(arm11
);
341 if (retval
!= ERROR_OK
)
344 /* MCR p14,0,R0,c0,c5,0 */
345 retval
= arm11_run_instr_data_to_core_via_r0(arm11
, 0xee000e15, R(WDTR
));
346 if (retval
!= ERROR_OK
)
349 retval
= arm11_run_instr_data_finish(arm11
);
350 if (retval
!= ERROR_OK
)
354 /* restore CPSR, PC, and R0 ... after flushing any modified
357 retval
= arm_dpm_write_dirty_registers(&arm11
->dpm
);
359 register_cache_invalidate(arm11
->arm
.core_cache
);
363 arm11_write_DSCR(arm11
, R(DSCR
));
365 /* maybe restore rDTR */
367 if (R(DSCR
) & ARM11_DSCR_RDTR_FULL
|| arm11
->reg_list
[ARM11_RC_RDTR
].dirty
)
369 arm11_add_debug_SCAN_N(arm11
, 0x05, ARM11_TAP_DEFAULT
);
371 arm11_add_IR(arm11
, ARM11_EXTEST
, ARM11_TAP_DEFAULT
);
373 struct scan_field chain5_fields
[3];
375 uint8_t Ready
= 0; /* ignored */
376 uint8_t Valid
= 0; /* ignored */
378 arm11_setup_field(arm11
, 32, &R(RDTR
), NULL
, chain5_fields
+ 0);
379 arm11_setup_field(arm11
, 1, &Ready
, NULL
, chain5_fields
+ 1);
380 arm11_setup_field(arm11
, 1, &Valid
, NULL
, chain5_fields
+ 2);
382 arm11_add_dr_scan_vc(ARRAY_SIZE(chain5_fields
), chain5_fields
, TAP_DRPAUSE
);
385 /* now processor is ready to RESTART */
390 /* poll current target status */
391 static int arm11_poll(struct target
*target
)
394 struct arm11_common
*arm11
= target_to_arm11(target
);
397 CHECK_RETVAL(arm11_read_DSCR(arm11
, &dscr
));
399 LOG_DEBUG("DSCR %08" PRIx32
"", dscr
);
401 CHECK_RETVAL(arm11_check_init(arm11
, &dscr
));
403 if (dscr
& ARM11_DSCR_CORE_HALTED
)
405 if (target
->state
!= TARGET_HALTED
)
407 enum target_state old_state
= target
->state
;
409 LOG_DEBUG("enter TARGET_HALTED");
410 target
->state
= TARGET_HALTED
;
411 target
->debug_reason
= arm11_get_DSCR_debug_reason(dscr
);
412 retval
= arm11_on_enter_debug_state(arm11
);
413 if (retval
!= ERROR_OK
)
416 target_call_event_callbacks(target
,
417 old_state
== TARGET_DEBUG_RUNNING
? TARGET_EVENT_DEBUG_HALTED
: TARGET_EVENT_HALTED
);
422 if (target
->state
!= TARGET_RUNNING
&& target
->state
!= TARGET_DEBUG_RUNNING
)
424 LOG_DEBUG("enter TARGET_RUNNING");
425 target
->state
= TARGET_RUNNING
;
426 target
->debug_reason
= DBG_REASON_NOTHALTED
;
432 /* architecture specific status reply */
433 static int arm11_arch_state(struct target
*target
)
437 retval
= armv4_5_arch_state(target
);
439 /* REVISIT also display ARM11-specific MMU and cache status ... */
444 /* target request support */
445 static int arm11_target_request_data(struct target
*target
,
446 uint32_t size
, uint8_t *buffer
)
448 LOG_WARNING("Not implemented: %s", __func__
);
453 /* target execution control */
454 static int arm11_halt(struct target
*target
)
456 struct arm11_common
*arm11
= target_to_arm11(target
);
458 LOG_DEBUG("target->state: %s",
459 target_state_name(target
));
461 if (target
->state
== TARGET_UNKNOWN
)
463 arm11
->simulate_reset_on_next_halt
= true;
466 if (target
->state
== TARGET_HALTED
)
468 LOG_DEBUG("target was already halted");
472 arm11_add_IR(arm11
, ARM11_HALT
, TAP_IDLE
);
474 CHECK_RETVAL(jtag_execute_queue());
481 CHECK_RETVAL(arm11_read_DSCR(arm11
, &dscr
));
483 if (dscr
& ARM11_DSCR_CORE_HALTED
)
494 if ((timeval_ms()-then
) > 1000)
496 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
503 arm11_on_enter_debug_state(arm11
);
505 enum target_state old_state
= target
->state
;
507 target
->state
= TARGET_HALTED
;
508 target
->debug_reason
= arm11_get_DSCR_debug_reason(dscr
);
511 target_call_event_callbacks(target
,
512 old_state
== TARGET_DEBUG_RUNNING
? TARGET_EVENT_DEBUG_HALTED
: TARGET_EVENT_HALTED
));
518 arm11_nextpc(struct arm11_common
*arm11
, int current
, uint32_t address
)
520 void *value
= arm11
->arm
.core_cache
->reg_list
[15].value
;
523 buf_set_u32(value
, 0, 32, address
);
525 address
= buf_get_u32(value
, 0, 32);
530 static int arm11_resume(struct target
*target
, int current
,
531 uint32_t address
, int handle_breakpoints
, int debug_execution
)
533 // LOG_DEBUG("current %d address %08x handle_breakpoints %d debug_execution %d",
534 // current, address, handle_breakpoints, debug_execution);
536 struct arm11_common
*arm11
= target_to_arm11(target
);
538 LOG_DEBUG("target->state: %s",
539 target_state_name(target
));
542 if (target
->state
!= TARGET_HALTED
)
544 LOG_ERROR("Target not halted");
545 return ERROR_TARGET_NOT_HALTED
;
548 address
= arm11_nextpc(arm11
, current
, address
);
550 LOG_DEBUG("RESUME PC %08" PRIx32
"%s", address
, !current
? "!" : "");
552 /* clear breakpoints/watchpoints and VCR*/
553 arm11_sc7_clear_vbw(arm11
);
555 if (!debug_execution
)
556 target_free_all_working_areas(target
);
558 /* Set up breakpoints */
559 if (handle_breakpoints
)
561 /* check if one matches PC and step over it if necessary */
563 struct breakpoint
* bp
;
565 for (bp
= target
->breakpoints
; bp
; bp
= bp
->next
)
567 if (bp
->address
== address
)
569 LOG_DEBUG("must step over %08" PRIx32
"", bp
->address
);
570 arm11_step(target
, 1, 0, 0);
575 /* set all breakpoints */
577 unsigned brp_num
= 0;
579 for (bp
= target
->breakpoints
; bp
; bp
= bp
->next
)
581 struct arm11_sc7_action brp
[2];
584 brp
[0].address
= ARM11_SC7_BVR0
+ brp_num
;
585 brp
[0].value
= bp
->address
;
587 brp
[1].address
= ARM11_SC7_BCR0
+ brp_num
;
588 brp
[1].value
= 0x1 | (3 << 1) | (0x0F << 5) | (0 << 14) | (0 << 16) | (0 << 20) | (0 << 21);
590 arm11_sc7_run(arm11
, brp
, ARRAY_SIZE(brp
));
592 LOG_DEBUG("Add BP %d at %08" PRIx32
, brp_num
,
598 arm11_sc7_set_vcr(arm11
, arm11_vcr
);
601 arm11_leave_debug_state(arm11
);
603 arm11_add_IR(arm11
, ARM11_RESTART
, TAP_IDLE
);
605 CHECK_RETVAL(jtag_execute_queue());
612 CHECK_RETVAL(arm11_read_DSCR(arm11
, &dscr
));
614 LOG_DEBUG("DSCR %08" PRIx32
"", dscr
);
616 if (dscr
& ARM11_DSCR_CORE_RESTARTED
)
627 if ((timeval_ms()-then
) > 1000)
629 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
636 if (!debug_execution
)
638 target
->state
= TARGET_RUNNING
;
639 target
->debug_reason
= DBG_REASON_NOTHALTED
;
641 CHECK_RETVAL(target_call_event_callbacks(target
, TARGET_EVENT_RESUMED
));
645 target
->state
= TARGET_DEBUG_RUNNING
;
646 target
->debug_reason
= DBG_REASON_NOTHALTED
;
648 CHECK_RETVAL(target_call_event_callbacks(target
, TARGET_EVENT_RESUMED
));
654 static int arm11_step(struct target
*target
, int current
,
655 uint32_t address
, int handle_breakpoints
)
657 LOG_DEBUG("target->state: %s",
658 target_state_name(target
));
660 if (target
->state
!= TARGET_HALTED
)
662 LOG_WARNING("target was not halted");
663 return ERROR_TARGET_NOT_HALTED
;
666 struct arm11_common
*arm11
= target_to_arm11(target
);
668 address
= arm11_nextpc(arm11
, current
, address
);
670 LOG_DEBUG("STEP PC %08" PRIx32
"%s", address
, !current
? "!" : "");
673 /** \todo TODO: Thumb not supported here */
675 uint32_t next_instruction
;
677 CHECK_RETVAL(arm11_read_memory_word(arm11
, address
, &next_instruction
));
680 if ((next_instruction
& 0xFFF00070) == 0xe1200070)
682 address
= arm11_nextpc(arm11
, 0, address
+ 4);
683 LOG_DEBUG("Skipping BKPT");
685 /* skip over Wait for interrupt / Standby */
686 /* mcr 15, 0, r?, cr7, cr0, {4} */
687 else if ((next_instruction
& 0xFFFF0FFF) == 0xee070f90)
689 address
= arm11_nextpc(arm11
, 0, address
+ 4);
690 LOG_DEBUG("Skipping WFI");
692 /* ignore B to self */
693 else if ((next_instruction
& 0xFEFFFFFF) == 0xeafffffe)
695 LOG_DEBUG("Not stepping jump to self");
699 /** \todo TODO: check if break-/watchpoints make any sense at all in combination
702 /** \todo TODO: check if disabling IRQs might be a good idea here. Alternatively
703 * the VCR might be something worth looking into. */
706 /* Set up breakpoint for stepping */
708 struct arm11_sc7_action brp
[2];
711 brp
[0].address
= ARM11_SC7_BVR0
;
713 brp
[1].address
= ARM11_SC7_BCR0
;
715 if (arm11_config_hardware_step
)
717 /* Hardware single stepping ("instruction address
718 * mismatch") is used if enabled. It's not quite
719 * exactly "run one instruction"; "branch to here"
720 * loops won't break, neither will some other cases,
721 * but it's probably the best default.
723 * Hardware single stepping isn't supported on v6
724 * debug modules. ARM1176 and v7 can support it...
726 * FIXME Thumb stepping likely needs to use 0x03
727 * or 0xc0 byte masks, not 0x0f.
729 brp
[0].value
= address
;
730 brp
[1].value
= 0x1 | (3 << 1) | (0x0F << 5)
731 | (0 << 14) | (0 << 16) | (0 << 20)
735 /* Sets a breakpoint on the next PC, as calculated
736 * by instruction set simulation.
738 * REVISIT stepping Thumb on ARM1156 requires Thumb2
739 * support from the simulator.
744 retval
= arm_simulate_step(target
, &next_pc
);
745 if (retval
!= ERROR_OK
)
748 brp
[0].value
= next_pc
;
749 brp
[1].value
= 0x1 | (3 << 1) | (0x0F << 5)
750 | (0 << 14) | (0 << 16) | (0 << 20)
754 CHECK_RETVAL(arm11_sc7_run(arm11
, brp
, ARRAY_SIZE(brp
)));
759 if (arm11_config_step_irq_enable
)
760 R(DSCR
) &= ~ARM11_DSCR_INTERRUPTS_DISABLE
; /* should be redundant */
762 R(DSCR
) |= ARM11_DSCR_INTERRUPTS_DISABLE
;
765 CHECK_RETVAL(arm11_leave_debug_state(arm11
));
767 arm11_add_IR(arm11
, ARM11_RESTART
, TAP_IDLE
);
769 CHECK_RETVAL(jtag_execute_queue());
777 CHECK_RETVAL(arm11_read_DSCR(arm11
, &dscr
));
779 LOG_DEBUG("DSCR %08" PRIx32
"e", dscr
);
781 if ((dscr
& (ARM11_DSCR_CORE_RESTARTED
| ARM11_DSCR_CORE_HALTED
)) ==
782 (ARM11_DSCR_CORE_RESTARTED
| ARM11_DSCR_CORE_HALTED
))
792 if ((timeval_ms()-then
) > 1000)
794 LOG_WARNING("Timeout (1000ms) waiting for instructions to complete");
801 /* clear breakpoint */
802 arm11_sc7_clear_vbw(arm11
);
805 CHECK_RETVAL(arm11_on_enter_debug_state(arm11
));
807 /* restore default state */
808 R(DSCR
) &= ~ARM11_DSCR_INTERRUPTS_DISABLE
;
812 // target->state = TARGET_HALTED;
813 target
->debug_reason
= DBG_REASON_SINGLESTEP
;
815 CHECK_RETVAL(target_call_event_callbacks(target
, TARGET_EVENT_HALTED
));
820 static int arm11_assert_reset(struct target
*target
)
823 struct arm11_common
*arm11
= target_to_arm11(target
);
825 retval
= arm11_check_init(arm11
, NULL
);
826 if (retval
!= ERROR_OK
)
829 target
->state
= TARGET_UNKNOWN
;
831 /* we would very much like to reset into the halted, state,
832 * but resetting and halting is second best... */
833 if (target
->reset_halt
)
835 CHECK_RETVAL(target_halt(target
));
839 /* srst is funny. We can not do *anything* else while it's asserted
840 * and it has unkonwn side effects. Make sure no other code runs
843 * Code below assumes srst:
845 * - Causes power-on-reset (but of what parts of the system?). Bug
848 * - Messes us TAP state without asserting trst.
850 * - There is another bug in the arm11 core. When you generate an access to
851 * external logic (for example ddr controller via AHB bus) and that block
852 * is not configured (perhaps it is still held in reset), that transaction
853 * will never complete. This will hang arm11 core but it will also hang
854 * JTAG controller. Nothing, short of srst assertion will bring it out of
859 * - What should the PC be after an srst reset when starting in the halted
863 jtag_add_reset(0, 1);
864 jtag_add_reset(0, 0);
866 /* How long do we have to wait? */
867 jtag_add_sleep(5000);
869 /* un-mess up TAP state */
872 retval
= jtag_execute_queue();
873 if (retval
!= ERROR_OK
)
881 static int arm11_deassert_reset(struct target
*target
)
886 static int arm11_soft_reset_halt(struct target
*target
)
888 LOG_WARNING("Not implemented: %s", __func__
);
893 /* target memory access
894 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
895 * count: number of items of <size>
897 * arm11_config_memrw_no_increment - in the future we may want to be able
898 * to read/write a range of data to a "port". a "port" is an action on
899 * read memory address for some peripheral.
901 static int arm11_read_memory_inner(struct target
*target
,
902 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
,
903 bool arm11_config_memrw_no_increment
)
905 /** \todo TODO: check if buffer cast to uint32_t* and uint16_t* might cause alignment problems */
908 if (target
->state
!= TARGET_HALTED
)
910 LOG_WARNING("target was not halted");
911 return ERROR_TARGET_NOT_HALTED
;
914 LOG_DEBUG("ADDR %08" PRIx32
" SIZE %08" PRIx32
" COUNT %08" PRIx32
"", address
, size
, count
);
916 struct arm11_common
*arm11
= target_to_arm11(target
);
918 retval
= arm11_run_instr_data_prepare(arm11
);
919 if (retval
!= ERROR_OK
)
922 /* MRC p14,0,r0,c0,c5,0 */
923 retval
= arm11_run_instr_data_to_core1(arm11
, 0xee100e15, address
);
924 if (retval
!= ERROR_OK
)
930 arm11
->arm
.core_cache
->reg_list
[1].dirty
= true;
932 for (size_t i
= 0; i
< count
; i
++)
934 /* ldrb r1, [r0], #1 */
936 arm11_run_instr_no_data1(arm11
,
937 !arm11_config_memrw_no_increment
? 0xe4d01001 : 0xe5d01000);
940 /* MCR p14,0,R1,c0,c5,0 */
941 arm11_run_instr_data_from_core(arm11
, 0xEE001E15, &res
, 1);
950 arm11
->arm
.core_cache
->reg_list
[1].dirty
= true;
952 for (size_t i
= 0; i
< count
; i
++)
954 /* ldrh r1, [r0], #2 */
955 arm11_run_instr_no_data1(arm11
,
956 !arm11_config_memrw_no_increment
? 0xe0d010b2 : 0xe1d010b0);
960 /* MCR p14,0,R1,c0,c5,0 */
961 arm11_run_instr_data_from_core(arm11
, 0xEE001E15, &res
, 1);
963 uint16_t svalue
= res
;
964 memcpy(buffer
+ i
* sizeof(uint16_t), &svalue
, sizeof(uint16_t));
972 uint32_t instr
= !arm11_config_memrw_no_increment
? 0xecb05e01 : 0xed905e00;
973 /** \todo TODO: buffer cast to uint32_t* causes alignment warnings */
974 uint32_t *words
= (uint32_t *)buffer
;
976 /* LDC p14,c5,[R0],#4 */
977 /* LDC p14,c5,[R0] */
978 arm11_run_instr_data_from_core(arm11
, instr
, words
, count
);
983 return arm11_run_instr_data_finish(arm11
);
986 static int arm11_read_memory(struct target
*target
, uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
988 return arm11_read_memory_inner(target
, address
, size
, count
, buffer
, false);
992 * arm11_config_memrw_no_increment - in the future we may want to be able
993 * to read/write a range of data to a "port". a "port" is an action on
994 * read memory address for some peripheral.
996 static int arm11_write_memory_inner(struct target
*target
,
997 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
,
998 bool arm11_config_memrw_no_increment
)
1002 if (target
->state
!= TARGET_HALTED
)
1004 LOG_WARNING("target was not halted");
1005 return ERROR_TARGET_NOT_HALTED
;
1008 LOG_DEBUG("ADDR %08" PRIx32
" SIZE %08" PRIx32
" COUNT %08" PRIx32
"", address
, size
, count
);
1010 struct arm11_common
*arm11
= target_to_arm11(target
);
1012 retval
= arm11_run_instr_data_prepare(arm11
);
1013 if (retval
!= ERROR_OK
)
1016 /* MRC p14,0,r0,c0,c5,0 */
1017 retval
= arm11_run_instr_data_to_core1(arm11
, 0xee100e15, address
);
1018 if (retval
!= ERROR_OK
)
1021 /* burst writes are not used for single words as those may well be
1022 * reset init script writes.
1024 * The other advantage is that as burst writes are default, we'll
1025 * now exercise both burst and non-burst code paths with the
1026 * default settings, increasing code coverage.
1028 bool burst
= arm11_config_memwrite_burst
&& (count
> 1);
1034 arm11
->arm
.core_cache
->reg_list
[1].dirty
= true;
1036 for (size_t i
= 0; i
< count
; i
++)
1038 /* MRC p14,0,r1,c0,c5,0 */
1039 retval
= arm11_run_instr_data_to_core1(arm11
, 0xee101e15, *buffer
++);
1040 if (retval
!= ERROR_OK
)
1043 /* strb r1, [r0], #1 */
1045 retval
= arm11_run_instr_no_data1(arm11
,
1046 !arm11_config_memrw_no_increment
? 0xe4c01001 : 0xe5c01000);
1047 if (retval
!= ERROR_OK
)
1056 arm11
->arm
.core_cache
->reg_list
[1].dirty
= true;
1058 for (size_t i
= 0; i
< count
; i
++)
1061 memcpy(&value
, buffer
+ i
* sizeof(uint16_t), sizeof(uint16_t));
1063 /* MRC p14,0,r1,c0,c5,0 */
1064 retval
= arm11_run_instr_data_to_core1(arm11
, 0xee101e15, value
);
1065 if (retval
!= ERROR_OK
)
1068 /* strh r1, [r0], #2 */
1070 retval
= arm11_run_instr_no_data1(arm11
,
1071 !arm11_config_memrw_no_increment
? 0xe0c010b2 : 0xe1c010b0);
1072 if (retval
!= ERROR_OK
)
1080 uint32_t instr
= !arm11_config_memrw_no_increment
? 0xeca05e01 : 0xed805e00;
1082 /** \todo TODO: buffer cast to uint32_t* causes alignment warnings */
1083 uint32_t *words
= (uint32_t*)buffer
;
1087 /* STC p14,c5,[R0],#4 */
1088 /* STC p14,c5,[R0]*/
1089 retval
= arm11_run_instr_data_to_core(arm11
, instr
, words
, count
);
1090 if (retval
!= ERROR_OK
)
1095 /* STC p14,c5,[R0],#4 */
1096 /* STC p14,c5,[R0]*/
1097 retval
= arm11_run_instr_data_to_core_noack(arm11
, instr
, words
, count
);
1098 if (retval
!= ERROR_OK
)
1106 /* r0 verification */
1107 if (!arm11_config_memrw_no_increment
)
1111 /* MCR p14,0,R0,c0,c5,0 */
1112 retval
= arm11_run_instr_data_from_core(arm11
, 0xEE000E15, &r0
, 1);
1113 if (retval
!= ERROR_OK
)
1116 if (address
+ size
* count
!= r0
)
1118 LOG_ERROR("Data transfer failed. Expected end "
1119 "address 0x%08x, got 0x%08x",
1120 (unsigned) (address
+ size
* count
),
1124 LOG_ERROR("use 'arm11 memwrite burst disable' to disable fast burst mode");
1126 if (arm11_config_memwrite_error_fatal
)
1131 return arm11_run_instr_data_finish(arm11
);
1134 static int arm11_write_memory(struct target
*target
,
1135 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1137 return arm11_write_memory_inner(target
, address
, size
, count
, buffer
, false);
1140 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
1141 static int arm11_bulk_write_memory(struct target
*target
,
1142 uint32_t address
, uint32_t count
, uint8_t *buffer
)
1144 if (target
->state
!= TARGET_HALTED
)
1146 LOG_WARNING("target was not halted");
1147 return ERROR_TARGET_NOT_HALTED
;
1150 return arm11_write_memory(target
, address
, 4, count
, buffer
);
1153 /* target break-/watchpoint control
1154 * rw: 0 = write, 1 = read, 2 = access
1156 static int arm11_add_breakpoint(struct target
*target
,
1157 struct breakpoint
*breakpoint
)
1159 struct arm11_common
*arm11
= target_to_arm11(target
);
1162 if (breakpoint
->type
== BKPT_SOFT
)
1164 LOG_INFO("sw breakpoint requested, but software breakpoints not enabled");
1165 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1169 if (!arm11
->free_brps
)
1171 LOG_DEBUG("no breakpoint unit available for hardware breakpoint");
1172 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1175 if (breakpoint
->length
!= 4)
1177 LOG_DEBUG("only breakpoints of four bytes length supported");
1178 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1186 static int arm11_remove_breakpoint(struct target
*target
,
1187 struct breakpoint
*breakpoint
)
1189 struct arm11_common
*arm11
= target_to_arm11(target
);
1196 static int arm11_add_watchpoint(struct target
*target
,
1197 struct watchpoint
*watchpoint
)
1199 LOG_WARNING("Not implemented: %s", __func__
);
1204 static int arm11_remove_watchpoint(struct target
*target
,
1205 struct watchpoint
*watchpoint
)
1207 LOG_WARNING("Not implemented: %s", __func__
);
1212 static int arm11_target_create(struct target
*target
, Jim_Interp
*interp
)
1214 struct arm11_common
*arm11
;
1216 if (target
->tap
== NULL
)
1219 if (target
->tap
->ir_length
!= 5)
1221 LOG_ERROR("'target arm11' expects IR LENGTH = 5");
1222 return ERROR_COMMAND_SYNTAX_ERROR
;
1225 arm11
= calloc(1, sizeof *arm11
);
1229 armv4_5_init_arch_info(target
, &arm11
->arm
);
1231 arm11
->target
= target
;
1233 arm11
->jtag_info
.tap
= target
->tap
;
1234 arm11
->jtag_info
.scann_size
= 5;
1235 arm11
->jtag_info
.scann_instr
= ARM11_SCAN_N
;
1236 /* cur_scan_chain == 0 */
1237 arm11
->jtag_info
.intest_instr
= ARM11_INTEST
;
1242 static int arm11_init_target(struct command_context
*cmd_ctx
,
1243 struct target
*target
)
1245 /* Initialize anything we can set up without talking to the target */
1247 /* REVISIT do we really want such a debug-registers-only cache?
1248 * If we do, it should probably be handled purely by the DPM code,
1249 * so it works identically on the v7a/v7r cores.
1251 return arm11_build_reg_cache(target
);
1254 /* talk to the target and set things up */
1255 static int arm11_examine(struct target
*target
)
1259 struct arm11_common
*arm11
= target_to_arm11(target
);
1260 uint32_t didr
, device_id
;
1261 uint8_t implementor
;
1263 /* FIXME split into do-first-time and do-every-time logic ... */
1267 arm11_add_IR(arm11
, ARM11_IDCODE
, ARM11_TAP_DEFAULT
);
1269 struct scan_field idcode_field
;
1271 arm11_setup_field(arm11
, 32, NULL
, &device_id
, &idcode_field
);
1273 arm11_add_dr_scan_vc(1, &idcode_field
, TAP_DRPAUSE
);
1277 arm11_add_debug_SCAN_N(arm11
, 0x00, ARM11_TAP_DEFAULT
);
1279 arm11_add_IR(arm11
, ARM11_INTEST
, ARM11_TAP_DEFAULT
);
1281 struct scan_field chain0_fields
[2];
1283 arm11_setup_field(arm11
, 32, NULL
, &didr
, chain0_fields
+ 0);
1284 arm11_setup_field(arm11
, 8, NULL
, &implementor
, chain0_fields
+ 1);
1286 arm11_add_dr_scan_vc(ARRAY_SIZE(chain0_fields
), chain0_fields
, TAP_IDLE
);
1288 CHECK_RETVAL(jtag_execute_queue());
1290 switch (device_id
& 0x0FFFF000)
1299 arm11
->arm
.core_type
= ARM_MODE_MON
;
1303 LOG_ERROR("'target arm11' expects IDCODE 0x*7B*7****");
1306 LOG_INFO("found %s", type
);
1308 /* unlikely this could ever fail, but ... */
1309 switch ((didr
>> 16) & 0x0F) {
1310 case ARM11_DEBUG_V6
:
1311 case ARM11_DEBUG_V61
: /* supports security extensions */
1314 LOG_ERROR("Only ARM v6 and v6.1 debug supported.");
1318 arm11
->brp
= ((didr
>> 24) & 0x0F) + 1;
1319 arm11
->wrp
= ((didr
>> 28) & 0x0F) + 1;
1321 /** \todo TODO: reserve one brp slot if we allow breakpoints during step */
1322 arm11
->free_brps
= arm11
->brp
;
1323 arm11
->free_wrps
= arm11
->wrp
;
1325 LOG_DEBUG("IDCODE %08" PRIx32
" IMPLEMENTOR %02x DIDR %08" PRIx32
,
1326 device_id
, implementor
, didr
);
1328 /* as a side-effect this reads DSCR and thus
1329 * clears the ARM11_DSCR_STICKY_PRECISE_DATA_ABORT / Sticky Precise Data Abort Flag
1330 * as suggested by the spec.
1333 retval
= arm11_check_init(arm11
, NULL
);
1334 if (retval
!= ERROR_OK
)
1337 /* Build register cache "late", after target_init(), since we
1338 * want to know if this core supports Secure Monitor mode.
1340 if (!target_was_examined(target
)) {
1341 arm11_dpm_init(arm11
, didr
);
1342 retval
= arm_dpm_setup(&arm11
->dpm
);
1345 /* ETM on ARM11 still uses original scanchain 6 access mode */
1346 if (arm11
->arm
.etm
&& !target_was_examined(target
)) {
1347 *register_get_last_cache_p(&target
->reg_cache
) =
1348 etm_build_reg_cache(target
, &arm11
->jtag_info
,
1350 retval
= etm_setup(target
);
1353 target_set_examined(target
);
1359 /** Load a register that is marked !valid in the register cache */
1360 static int arm11_get_reg(struct reg
*reg
)
1362 struct target
* target
= ((struct arm11_reg_state
*)reg
->arch_info
)->target
;
1364 if (target
->state
!= TARGET_HALTED
)
1366 LOG_WARNING("target was not halted");
1367 return ERROR_TARGET_NOT_HALTED
;
1370 /** \todo TODO: Check this. We assume that all registers are fetched at debug entry. */
1373 struct arm11_common
*arm11
= target_to_arm11(target
);
1374 const struct arm11_reg_defs
*arm11_reg_info
= arm11_reg_defs
+ ((struct arm11_reg_state
*)reg
->arch_info
)->def_index
;
1380 /** Change a value in the register cache */
1381 static int arm11_set_reg(struct reg
*reg
, uint8_t *buf
)
1383 struct target
*target
= ((struct arm11_reg_state
*)reg
->arch_info
)->target
;
1384 struct arm11_common
*arm11
= target_to_arm11(target
);
1385 // const struct arm11_reg_defs *arm11_reg_info = arm11_reg_defs + ((struct arm11_reg_state *)reg->arch_info)->def_index;
1387 arm11
->reg_values
[((struct arm11_reg_state
*)reg
->arch_info
)->def_index
] = buf_get_u32(buf
, 0, 32);
1394 static const struct reg_arch_type arm11_reg_type
= {
1395 .get
= arm11_get_reg
,
1396 .set
= arm11_set_reg
,
1399 static int arm11_build_reg_cache(struct target
*target
)
1401 struct arm11_common
*arm11
= target_to_arm11(target
);
1402 struct reg_cache
*cache
;
1403 struct reg
*reg_list
;
1404 struct arm11_reg_state
*arm11_reg_states
;
1406 cache
= calloc(1, sizeof *cache
);
1407 reg_list
= calloc(ARM11_REGCACHE_COUNT
, sizeof *reg_list
);
1408 arm11_reg_states
= calloc(ARM11_REGCACHE_COUNT
,
1409 sizeof *arm11_reg_states
);
1410 if (!cache
|| !reg_list
|| !arm11_reg_states
) {
1413 free(arm11_reg_states
);
1417 arm11
->reg_list
= reg_list
;
1419 /* build cache for some of the debug registers */
1420 cache
->name
= "arm11 debug registers";
1421 cache
->reg_list
= reg_list
;
1422 cache
->num_regs
= ARM11_REGCACHE_COUNT
;
1424 struct reg_cache
**cache_p
= register_get_last_cache_p(&target
->reg_cache
);
1427 arm11
->core_cache
= cache
;
1431 /* Not very elegant assertion */
1432 if (ARM11_REGCACHE_COUNT
!= ARRAY_SIZE(arm11
->reg_values
) ||
1433 ARM11_REGCACHE_COUNT
!= ARRAY_SIZE(arm11_reg_defs
) ||
1434 ARM11_REGCACHE_COUNT
!= ARM11_RC_MAX
)
1436 LOG_ERROR("BUG: arm11->reg_values inconsistent (%d %u %u %d)",
1437 ARM11_REGCACHE_COUNT
,
1438 (unsigned) ARRAY_SIZE(arm11
->reg_values
),
1439 (unsigned) ARRAY_SIZE(arm11_reg_defs
),
1441 /* FIXME minimally, use a build_bug_on(X) mechanism;
1442 * runtime exit() here is bad!
1447 for (i
= 0; i
< ARM11_REGCACHE_COUNT
; i
++)
1449 struct reg
* r
= reg_list
+ i
;
1450 const struct arm11_reg_defs
* rd
= arm11_reg_defs
+ i
;
1451 struct arm11_reg_state
* rs
= arm11_reg_states
+ i
;
1455 r
->value
= (uint8_t *)(arm11
->reg_values
+ i
);
1458 r
->type
= &arm11_reg_type
;
1462 rs
->target
= target
;
1468 /* FIXME all these BOOL_WRAPPER things should be modifying
1469 * per-instance state, not shared state; ditto the vector
1470 * catch register support. Scan chains with multiple cores
1471 * should be able to say "work with this core like this,
1472 * that core like that". Example, ARM11 MPCore ...
1475 #define ARM11_BOOL_WRAPPER(name, print_name) \
1476 COMMAND_HANDLER(arm11_handle_bool_##name) \
1478 return CALL_COMMAND_HANDLER(handle_command_parse_bool, \
1479 &arm11_config_##name, print_name); \
1482 ARM11_BOOL_WRAPPER(memwrite_burst
, "memory write burst mode")
1483 ARM11_BOOL_WRAPPER(memwrite_error_fatal
, "fatal error mode for memory writes")
1484 ARM11_BOOL_WRAPPER(step_irq_enable
, "IRQs while stepping")
1485 ARM11_BOOL_WRAPPER(hardware_step
, "hardware single step")
1487 COMMAND_HANDLER(arm11_handle_vcr
)
1493 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], arm11_vcr
);
1496 return ERROR_COMMAND_SYNTAX_ERROR
;
1499 LOG_INFO("VCR 0x%08" PRIx32
"", arm11_vcr
);
1503 static const uint32_t arm11_coproc_instruction_limits
[] =
1505 15, /* coprocessor */
1510 0xFFFFFFFF, /* value */
1513 static int arm11_mrc_inner(struct target
*target
, int cpnum
,
1514 uint32_t op1
, uint32_t op2
, uint32_t CRn
, uint32_t CRm
,
1515 uint32_t *value
, bool read
)
1518 struct arm11_common
*arm11
= target_to_arm11(target
);
1520 if (target
->state
!= TARGET_HALTED
)
1522 LOG_ERROR("Target not halted");
1526 uint32_t instr
= 0xEE000010 |
1534 instr
|= 0x00100000;
1536 retval
= arm11_run_instr_data_prepare(arm11
);
1537 if (retval
!= ERROR_OK
)
1542 retval
= arm11_run_instr_data_from_core_via_r0(arm11
, instr
, value
);
1543 if (retval
!= ERROR_OK
)
1548 retval
= arm11_run_instr_data_to_core_via_r0(arm11
, instr
, *value
);
1549 if (retval
!= ERROR_OK
)
1553 return arm11_run_instr_data_finish(arm11
);
1556 static int arm11_mrc(struct target
*target
, int cpnum
,
1557 uint32_t op1
, uint32_t op2
, uint32_t CRn
, uint32_t CRm
, uint32_t *value
)
1559 return arm11_mrc_inner(target
, cpnum
, op1
, op2
, CRn
, CRm
, value
, true);
1562 static int arm11_mcr(struct target
*target
, int cpnum
,
1563 uint32_t op1
, uint32_t op2
, uint32_t CRn
, uint32_t CRm
, uint32_t value
)
1565 return arm11_mrc_inner(target
, cpnum
, op1
, op2
, CRn
, CRm
, &value
, false);
1568 static int arm11_register_commands(struct command_context
*cmd_ctx
)
1570 struct command
*top_cmd
, *mw_cmd
;
1572 armv4_5_register_commands(cmd_ctx
);
1574 top_cmd
= register_command(cmd_ctx
, NULL
, "arm11",
1575 NULL
, COMMAND_ANY
, NULL
);
1577 /* "hardware_step" is only here to check if the default
1578 * simulate + breakpoint implementation is broken.
1579 * TEMPORARY! NOT DOCUMENTED!
1581 register_command(cmd_ctx
, top_cmd
, "hardware_step",
1582 arm11_handle_bool_hardware_step
, COMMAND_ANY
,
1583 "DEBUG ONLY - Hardware single stepping"
1584 " (default: disabled)");
1586 mw_cmd
= register_command(cmd_ctx
, top_cmd
, "memwrite",
1587 NULL
, COMMAND_ANY
, NULL
);
1588 register_command(cmd_ctx
, mw_cmd
, "burst",
1589 arm11_handle_bool_memwrite_burst
, COMMAND_ANY
,
1590 "Enable/Disable non-standard but fast burst mode"
1591 " (default: enabled)");
1592 register_command(cmd_ctx
, mw_cmd
, "error_fatal",
1593 arm11_handle_bool_memwrite_error_fatal
, COMMAND_ANY
,
1594 "Terminate program if transfer error was found"
1595 " (default: enabled)");
1597 register_command(cmd_ctx
, top_cmd
, "step_irq_enable",
1598 arm11_handle_bool_step_irq_enable
, COMMAND_ANY
,
1599 "Enable interrupts while stepping"
1600 " (default: disabled)");
1601 register_command(cmd_ctx
, top_cmd
, "vcr",
1602 arm11_handle_vcr
, COMMAND_ANY
,
1603 "Control (Interrupt) Vector Catch Register");
1605 return etm_register_commands(cmd_ctx
);
1608 /** Holds methods for ARM11xx targets. */
1609 struct target_type arm11_target
= {
1613 .arch_state
= arm11_arch_state
,
1615 .target_request_data
= arm11_target_request_data
,
1618 .resume
= arm11_resume
,
1621 .assert_reset
= arm11_assert_reset
,
1622 .deassert_reset
= arm11_deassert_reset
,
1623 .soft_reset_halt
= arm11_soft_reset_halt
,
1625 .get_gdb_reg_list
= armv4_5_get_gdb_reg_list
,
1627 .read_memory
= arm11_read_memory
,
1628 .write_memory
= arm11_write_memory
,
1630 .bulk_write_memory
= arm11_bulk_write_memory
,
1632 .checksum_memory
= arm_checksum_memory
,
1633 .blank_check_memory
= arm_blank_check_memory
,
1635 .add_breakpoint
= arm11_add_breakpoint
,
1636 .remove_breakpoint
= arm11_remove_breakpoint
,
1637 .add_watchpoint
= arm11_add_watchpoint
,
1638 .remove_watchpoint
= arm11_remove_watchpoint
,
1640 .run_algorithm
= armv4_5_run_algorithm
,
1642 .register_commands
= arm11_register_commands
,
1643 .target_create
= arm11_target_create
,
1644 .init_target
= arm11_init_target
,
1645 .examine
= arm11_examine
,