Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
armv7m: Fix memory leak in register caching.
[openocd.git] / src / target / cortex_m.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2006 by Magnus Lundin *
6 * lundin@mlu.mine.nu *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 * *
26 * *
27 * Cortex-M3(tm) TRM, ARM DDI 0337E (r1p1) and 0337G (r2p0) *
28 * *
29 ***************************************************************************/
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 #include "jtag/interface.h"
35 #include "breakpoints.h"
36 #include "cortex_m.h"
37 #include "target_request.h"
38 #include "target_type.h"
39 #include "arm_disassembler.h"
40 #include "register.h"
41 #include "arm_opcodes.h"
42 #include "arm_semihosting.h"
43 #include <helper/time_support.h>
44
45 /* NOTE: most of this should work fine for the Cortex-M1 and
46 * Cortex-M0 cores too, although they're ARMv6-M not ARMv7-M.
47 * Some differences: M0/M1 doesn't have FBP remapping or the
48 * DWT tracing/profiling support. (So the cycle counter will
49 * not be usable; the other stuff isn't currently used here.)
50 *
51 * Although there are some workarounds for errata seen only in r0p0
52 * silicon, such old parts are hard to find and thus not much tested
53 * any longer.
54 */
55
56 /**
57 * Returns the type of a break point required by address location
58 */
59 #define BKPT_TYPE_BY_ADDR(addr) ((addr) < 0x20000000 ? BKPT_HARD : BKPT_SOFT)
60
61 /* forward declarations */
62 static int cortex_m_store_core_reg_u32(struct target *target,
63 uint32_t num, uint32_t value);
64 static void cortex_m_dwt_free(struct target *target);
65
66 static int cortexm_dap_read_coreregister_u32(struct target *target,
67 uint32_t *value, int regnum)
68 {
69 struct armv7m_common *armv7m = target_to_armv7m(target);
70 struct adiv5_dap *swjdp = armv7m->arm.dap;
71 int retval;
72 uint32_t dcrdr;
73
74 /* because the DCB_DCRDR is used for the emulated dcc channel
75 * we have to save/restore the DCB_DCRDR when used */
76 if (target->dbg_msg_enabled) {
77 retval = mem_ap_read_u32(swjdp, DCB_DCRDR, &dcrdr);
78 if (retval != ERROR_OK)
79 return retval;
80 }
81
82 retval = mem_ap_write_u32(swjdp, DCB_DCRSR, regnum);
83 if (retval != ERROR_OK)
84 return retval;
85
86 retval = mem_ap_read_atomic_u32(swjdp, DCB_DCRDR, value);
87 if (retval != ERROR_OK)
88 return retval;
89
90 if (target->dbg_msg_enabled) {
91 /* restore DCB_DCRDR - this needs to be in a separate
92 * transaction otherwise the emulated DCC channel breaks */
93 if (retval == ERROR_OK)
94 retval = mem_ap_write_atomic_u32(swjdp, DCB_DCRDR, dcrdr);
95 }
96
97 return retval;
98 }
99
100 static int cortexm_dap_write_coreregister_u32(struct target *target,
101 uint32_t value, int regnum)
102 {
103 struct armv7m_common *armv7m = target_to_armv7m(target);
104 struct adiv5_dap *swjdp = armv7m->arm.dap;
105 int retval;
106 uint32_t dcrdr;
107
108 /* because the DCB_DCRDR is used for the emulated dcc channel
109 * we have to save/restore the DCB_DCRDR when used */
110 if (target->dbg_msg_enabled) {
111 retval = mem_ap_read_u32(swjdp, DCB_DCRDR, &dcrdr);
112 if (retval != ERROR_OK)
113 return retval;
114 }
115
116 retval = mem_ap_write_u32(swjdp, DCB_DCRDR, value);
117 if (retval != ERROR_OK)
118 return retval;
119
120 retval = mem_ap_write_atomic_u32(swjdp, DCB_DCRSR, regnum | DCRSR_WnR);
121 if (retval != ERROR_OK)
122 return retval;
123
124 if (target->dbg_msg_enabled) {
125 /* restore DCB_DCRDR - this needs to be in a seperate
126 * transaction otherwise the emulated DCC channel breaks */
127 if (retval == ERROR_OK)
128 retval = mem_ap_write_atomic_u32(swjdp, DCB_DCRDR, dcrdr);
129 }
130
131 return retval;
132 }
133
134 static int cortex_m_write_debug_halt_mask(struct target *target,
135 uint32_t mask_on, uint32_t mask_off)
136 {
137 struct cortex_m_common *cortex_m = target_to_cm(target);
138 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
139
140 /* mask off status bits */
141 cortex_m->dcb_dhcsr &= ~((0xFFFF << 16) | mask_off);
142 /* create new register mask */
143 cortex_m->dcb_dhcsr |= DBGKEY | C_DEBUGEN | mask_on;
144
145 return mem_ap_write_atomic_u32(swjdp, DCB_DHCSR, cortex_m->dcb_dhcsr);
146 }
147
148 static int cortex_m_clear_halt(struct target *target)
149 {
150 struct cortex_m_common *cortex_m = target_to_cm(target);
151 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
152 int retval;
153
154 /* clear step if any */
155 cortex_m_write_debug_halt_mask(target, C_HALT, C_STEP);
156
157 /* Read Debug Fault Status Register */
158 retval = mem_ap_read_atomic_u32(swjdp, NVIC_DFSR, &cortex_m->nvic_dfsr);
159 if (retval != ERROR_OK)
160 return retval;
161
162 /* Clear Debug Fault Status */
163 retval = mem_ap_write_atomic_u32(swjdp, NVIC_DFSR, cortex_m->nvic_dfsr);
164 if (retval != ERROR_OK)
165 return retval;
166 LOG_DEBUG(" NVIC_DFSR 0x%" PRIx32 "", cortex_m->nvic_dfsr);
167
168 return ERROR_OK;
169 }
170
171 static int cortex_m_single_step_core(struct target *target)
172 {
173 struct cortex_m_common *cortex_m = target_to_cm(target);
174 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
175 uint32_t dhcsr_save;
176 int retval;
177
178 /* backup dhcsr reg */
179 dhcsr_save = cortex_m->dcb_dhcsr;
180
181 /* Mask interrupts before clearing halt, if done already. This avoids
182 * Erratum 377497 (fixed in r1p0) where setting MASKINTS while clearing
183 * HALT can put the core into an unknown state.
184 */
185 if (!(cortex_m->dcb_dhcsr & C_MASKINTS)) {
186 retval = mem_ap_write_atomic_u32(swjdp, DCB_DHCSR,
187 DBGKEY | C_MASKINTS | C_HALT | C_DEBUGEN);
188 if (retval != ERROR_OK)
189 return retval;
190 }
191 retval = mem_ap_write_atomic_u32(swjdp, DCB_DHCSR,
192 DBGKEY | C_MASKINTS | C_STEP | C_DEBUGEN);
193 if (retval != ERROR_OK)
194 return retval;
195 LOG_DEBUG(" ");
196
197 /* restore dhcsr reg */
198 cortex_m->dcb_dhcsr = dhcsr_save;
199 cortex_m_clear_halt(target);
200
201 return ERROR_OK;
202 }
203
204 static int cortex_m_enable_fpb(struct target *target)
205 {
206 int retval = target_write_u32(target, FP_CTRL, 3);
207 if (retval != ERROR_OK)
208 return retval;
209
210 /* check the fpb is actually enabled */
211 uint32_t fpctrl;
212 retval = target_read_u32(target, FP_CTRL, &fpctrl);
213 if (retval != ERROR_OK)
214 return retval;
215
216 if (fpctrl & 1)
217 return ERROR_OK;
218
219 return ERROR_FAIL;
220 }
221
222 static int cortex_m_endreset_event(struct target *target)
223 {
224 int i;
225 int retval;
226 uint32_t dcb_demcr;
227 struct cortex_m_common *cortex_m = target_to_cm(target);
228 struct armv7m_common *armv7m = &cortex_m->armv7m;
229 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
230 struct cortex_m_fp_comparator *fp_list = cortex_m->fp_comparator_list;
231 struct cortex_m_dwt_comparator *dwt_list = cortex_m->dwt_comparator_list;
232
233 /* REVISIT The four debug monitor bits are currently ignored... */
234 retval = mem_ap_read_atomic_u32(swjdp, DCB_DEMCR, &dcb_demcr);
235 if (retval != ERROR_OK)
236 return retval;
237 LOG_DEBUG("DCB_DEMCR = 0x%8.8" PRIx32 "", dcb_demcr);
238
239 /* this register is used for emulated dcc channel */
240 retval = mem_ap_write_u32(swjdp, DCB_DCRDR, 0);
241 if (retval != ERROR_OK)
242 return retval;
243
244 /* Enable debug requests */
245 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
246 if (retval != ERROR_OK)
247 return retval;
248 if (!(cortex_m->dcb_dhcsr & C_DEBUGEN)) {
249 retval = mem_ap_write_u32(swjdp, DCB_DHCSR, DBGKEY | C_DEBUGEN);
250 if (retval != ERROR_OK)
251 return retval;
252 }
253
254 /* clear any interrupt masking */
255 cortex_m_write_debug_halt_mask(target, 0, C_MASKINTS);
256
257 /* Enable features controlled by ITM and DWT blocks, and catch only
258 * the vectors we were told to pay attention to.
259 *
260 * Target firmware is responsible for all fault handling policy
261 * choices *EXCEPT* explicitly scripted overrides like "vector_catch"
262 * or manual updates to the NVIC SHCSR and CCR registers.
263 */
264 retval = mem_ap_write_u32(swjdp, DCB_DEMCR, TRCENA | armv7m->demcr);
265 if (retval != ERROR_OK)
266 return retval;
267
268 /* Paranoia: evidently some (early?) chips don't preserve all the
269 * debug state (including FBP, DWT, etc) across reset...
270 */
271
272 /* Enable FPB */
273 retval = cortex_m_enable_fpb(target);
274 if (retval != ERROR_OK) {
275 LOG_ERROR("Failed to enable the FPB");
276 return retval;
277 }
278
279 cortex_m->fpb_enabled = 1;
280
281 /* Restore FPB registers */
282 for (i = 0; i < cortex_m->fp_num_code + cortex_m->fp_num_lit; i++) {
283 retval = target_write_u32(target, fp_list[i].fpcr_address, fp_list[i].fpcr_value);
284 if (retval != ERROR_OK)
285 return retval;
286 }
287
288 /* Restore DWT registers */
289 for (i = 0; i < cortex_m->dwt_num_comp; i++) {
290 retval = target_write_u32(target, dwt_list[i].dwt_comparator_address + 0,
291 dwt_list[i].comp);
292 if (retval != ERROR_OK)
293 return retval;
294 retval = target_write_u32(target, dwt_list[i].dwt_comparator_address + 4,
295 dwt_list[i].mask);
296 if (retval != ERROR_OK)
297 return retval;
298 retval = target_write_u32(target, dwt_list[i].dwt_comparator_address + 8,
299 dwt_list[i].function);
300 if (retval != ERROR_OK)
301 return retval;
302 }
303 retval = dap_run(swjdp);
304 if (retval != ERROR_OK)
305 return retval;
306
307 register_cache_invalidate(armv7m->arm.core_cache);
308
309 /* make sure we have latest dhcsr flags */
310 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
311
312 return retval;
313 }
314
315 static int cortex_m_examine_debug_reason(struct target *target)
316 {
317 struct cortex_m_common *cortex_m = target_to_cm(target);
318
319 /* THIS IS NOT GOOD, TODO - better logic for detection of debug state reason
320 * only check the debug reason if we don't know it already */
321
322 if ((target->debug_reason != DBG_REASON_DBGRQ)
323 && (target->debug_reason != DBG_REASON_SINGLESTEP)) {
324 if (cortex_m->nvic_dfsr & DFSR_BKPT) {
325 target->debug_reason = DBG_REASON_BREAKPOINT;
326 if (cortex_m->nvic_dfsr & DFSR_DWTTRAP)
327 target->debug_reason = DBG_REASON_WPTANDBKPT;
328 } else if (cortex_m->nvic_dfsr & DFSR_DWTTRAP)
329 target->debug_reason = DBG_REASON_WATCHPOINT;
330 else if (cortex_m->nvic_dfsr & DFSR_VCATCH)
331 target->debug_reason = DBG_REASON_BREAKPOINT;
332 else /* EXTERNAL, HALTED */
333 target->debug_reason = DBG_REASON_UNDEFINED;
334 }
335
336 return ERROR_OK;
337 }
338
339 static int cortex_m_examine_exception_reason(struct target *target)
340 {
341 uint32_t shcsr = 0, except_sr = 0, cfsr = -1, except_ar = -1;
342 struct armv7m_common *armv7m = target_to_armv7m(target);
343 struct adiv5_dap *swjdp = armv7m->arm.dap;
344 int retval;
345
346 retval = mem_ap_read_u32(swjdp, NVIC_SHCSR, &shcsr);
347 if (retval != ERROR_OK)
348 return retval;
349 switch (armv7m->exception_number) {
350 case 2: /* NMI */
351 break;
352 case 3: /* Hard Fault */
353 retval = mem_ap_read_atomic_u32(swjdp, NVIC_HFSR, &except_sr);
354 if (retval != ERROR_OK)
355 return retval;
356 if (except_sr & 0x40000000) {
357 retval = mem_ap_read_u32(swjdp, NVIC_CFSR, &cfsr);
358 if (retval != ERROR_OK)
359 return retval;
360 }
361 break;
362 case 4: /* Memory Management */
363 retval = mem_ap_read_u32(swjdp, NVIC_CFSR, &except_sr);
364 if (retval != ERROR_OK)
365 return retval;
366 retval = mem_ap_read_u32(swjdp, NVIC_MMFAR, &except_ar);
367 if (retval != ERROR_OK)
368 return retval;
369 break;
370 case 5: /* Bus Fault */
371 retval = mem_ap_read_u32(swjdp, NVIC_CFSR, &except_sr);
372 if (retval != ERROR_OK)
373 return retval;
374 retval = mem_ap_read_u32(swjdp, NVIC_BFAR, &except_ar);
375 if (retval != ERROR_OK)
376 return retval;
377 break;
378 case 6: /* Usage Fault */
379 retval = mem_ap_read_u32(swjdp, NVIC_CFSR, &except_sr);
380 if (retval != ERROR_OK)
381 return retval;
382 break;
383 case 11: /* SVCall */
384 break;
385 case 12: /* Debug Monitor */
386 retval = mem_ap_read_u32(swjdp, NVIC_DFSR, &except_sr);
387 if (retval != ERROR_OK)
388 return retval;
389 break;
390 case 14: /* PendSV */
391 break;
392 case 15: /* SysTick */
393 break;
394 default:
395 except_sr = 0;
396 break;
397 }
398 retval = dap_run(swjdp);
399 if (retval == ERROR_OK)
400 LOG_DEBUG("%s SHCSR 0x%" PRIx32 ", SR 0x%" PRIx32
401 ", CFSR 0x%" PRIx32 ", AR 0x%" PRIx32,
402 armv7m_exception_string(armv7m->exception_number),
403 shcsr, except_sr, cfsr, except_ar);
404 return retval;
405 }
406
407 static int cortex_m_debug_entry(struct target *target)
408 {
409 int i;
410 uint32_t xPSR;
411 int retval;
412 struct cortex_m_common *cortex_m = target_to_cm(target);
413 struct armv7m_common *armv7m = &cortex_m->armv7m;
414 struct arm *arm = &armv7m->arm;
415 struct adiv5_dap *swjdp = armv7m->arm.dap;
416 struct reg *r;
417
418 LOG_DEBUG(" ");
419
420 cortex_m_clear_halt(target);
421 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
422 if (retval != ERROR_OK)
423 return retval;
424
425 retval = armv7m->examine_debug_reason(target);
426 if (retval != ERROR_OK)
427 return retval;
428
429 /* Examine target state and mode
430 * First load register accessible through core debug port */
431 int num_regs = arm->core_cache->num_regs;
432
433 for (i = 0; i < num_regs; i++) {
434 r = &armv7m->arm.core_cache->reg_list[i];
435 if (!r->valid)
436 arm->read_core_reg(target, r, i, ARM_MODE_ANY);
437 }
438
439 r = arm->cpsr;
440 xPSR = buf_get_u32(r->value, 0, 32);
441
442 /* For IT instructions xPSR must be reloaded on resume and clear on debug exec */
443 if (xPSR & 0xf00) {
444 r->dirty = r->valid;
445 cortex_m_store_core_reg_u32(target, 16, xPSR & ~0xff);
446 }
447
448 /* Are we in an exception handler */
449 if (xPSR & 0x1FF) {
450 armv7m->exception_number = (xPSR & 0x1FF);
451
452 arm->core_mode = ARM_MODE_HANDLER;
453 arm->map = armv7m_msp_reg_map;
454 } else {
455 unsigned control = buf_get_u32(arm->core_cache
456 ->reg_list[ARMV7M_CONTROL].value, 0, 2);
457
458 /* is this thread privileged? */
459 arm->core_mode = control & 1
460 ? ARM_MODE_USER_THREAD
461 : ARM_MODE_THREAD;
462
463 /* which stack is it using? */
464 if (control & 2)
465 arm->map = armv7m_psp_reg_map;
466 else
467 arm->map = armv7m_msp_reg_map;
468
469 armv7m->exception_number = 0;
470 }
471
472 if (armv7m->exception_number)
473 cortex_m_examine_exception_reason(target);
474
475 LOG_DEBUG("entered debug state in core mode: %s at PC 0x%" PRIx32 ", target->state: %s",
476 arm_mode_name(arm->core_mode),
477 buf_get_u32(arm->pc->value, 0, 32),
478 target_state_name(target));
479
480 if (armv7m->post_debug_entry) {
481 retval = armv7m->post_debug_entry(target);
482 if (retval != ERROR_OK)
483 return retval;
484 }
485
486 return ERROR_OK;
487 }
488
489 static int cortex_m_poll(struct target *target)
490 {
491 int detected_failure = ERROR_OK;
492 int retval = ERROR_OK;
493 enum target_state prev_target_state = target->state;
494 struct cortex_m_common *cortex_m = target_to_cm(target);
495 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
496
497 /* Read from Debug Halting Control and Status Register */
498 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
499 if (retval != ERROR_OK) {
500 target->state = TARGET_UNKNOWN;
501 return retval;
502 }
503
504 /* Recover from lockup. See ARMv7-M architecture spec,
505 * section B1.5.15 "Unrecoverable exception cases".
506 */
507 if (cortex_m->dcb_dhcsr & S_LOCKUP) {
508 LOG_ERROR("%s -- clearing lockup after double fault",
509 target_name(target));
510 cortex_m_write_debug_halt_mask(target, C_HALT, 0);
511 target->debug_reason = DBG_REASON_DBGRQ;
512
513 /* We have to execute the rest (the "finally" equivalent, but
514 * still throw this exception again).
515 */
516 detected_failure = ERROR_FAIL;
517
518 /* refresh status bits */
519 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
520 if (retval != ERROR_OK)
521 return retval;
522 }
523
524 if (cortex_m->dcb_dhcsr & S_RESET_ST) {
525 target->state = TARGET_RESET;
526 return ERROR_OK;
527 }
528
529 if (target->state == TARGET_RESET) {
530 /* Cannot switch context while running so endreset is
531 * called with target->state == TARGET_RESET
532 */
533 LOG_DEBUG("Exit from reset with dcb_dhcsr 0x%" PRIx32,
534 cortex_m->dcb_dhcsr);
535 retval = cortex_m_endreset_event(target);
536 if (retval != ERROR_OK) {
537 target->state = TARGET_UNKNOWN;
538 return retval;
539 }
540 target->state = TARGET_RUNNING;
541 prev_target_state = TARGET_RUNNING;
542 }
543
544 if (cortex_m->dcb_dhcsr & S_HALT) {
545 target->state = TARGET_HALTED;
546
547 if ((prev_target_state == TARGET_RUNNING) || (prev_target_state == TARGET_RESET)) {
548 retval = cortex_m_debug_entry(target);
549 if (retval != ERROR_OK)
550 return retval;
551
552 if (arm_semihosting(target, &retval) != 0)
553 return retval;
554
555 target_call_event_callbacks(target, TARGET_EVENT_HALTED);
556 }
557 if (prev_target_state == TARGET_DEBUG_RUNNING) {
558 LOG_DEBUG(" ");
559 retval = cortex_m_debug_entry(target);
560 if (retval != ERROR_OK)
561 return retval;
562
563 target_call_event_callbacks(target, TARGET_EVENT_DEBUG_HALTED);
564 }
565 }
566
567 /* REVISIT when S_SLEEP is set, it's in a Sleep or DeepSleep state.
568 * How best to model low power modes?
569 */
570
571 if (target->state == TARGET_UNKNOWN) {
572 /* check if processor is retiring instructions */
573 if (cortex_m->dcb_dhcsr & S_RETIRE_ST) {
574 target->state = TARGET_RUNNING;
575 retval = ERROR_OK;
576 }
577 }
578
579 /* Did we detect a failure condition that we cleared? */
580 if (detected_failure != ERROR_OK)
581 retval = detected_failure;
582 return retval;
583 }
584
585 static int cortex_m_halt(struct target *target)
586 {
587 LOG_DEBUG("target->state: %s",
588 target_state_name(target));
589
590 if (target->state == TARGET_HALTED) {
591 LOG_DEBUG("target was already halted");
592 return ERROR_OK;
593 }
594
595 if (target->state == TARGET_UNKNOWN)
596 LOG_WARNING("target was in unknown state when halt was requested");
597
598 if (target->state == TARGET_RESET) {
599 if ((jtag_get_reset_config() & RESET_SRST_PULLS_TRST) && jtag_get_srst()) {
600 LOG_ERROR("can't request a halt while in reset if nSRST pulls nTRST");
601 return ERROR_TARGET_FAILURE;
602 } else {
603 /* we came here in a reset_halt or reset_init sequence
604 * debug entry was already prepared in cortex_m3_assert_reset()
605 */
606 target->debug_reason = DBG_REASON_DBGRQ;
607
608 return ERROR_OK;
609 }
610 }
611
612 /* Write to Debug Halting Control and Status Register */
613 cortex_m_write_debug_halt_mask(target, C_HALT, 0);
614
615 target->debug_reason = DBG_REASON_DBGRQ;
616
617 return ERROR_OK;
618 }
619
620 static int cortex_m_soft_reset_halt(struct target *target)
621 {
622 struct cortex_m_common *cortex_m = target_to_cm(target);
623 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
624 uint32_t dcb_dhcsr = 0;
625 int retval, timeout = 0;
626
627 /* soft_reset_halt is deprecated on cortex_m as the same functionality
628 * can be obtained by using 'reset halt' and 'cortex_m reset_config vectreset'
629 * As this reset only used VC_CORERESET it would only ever reset the cortex_m
630 * core, not the peripherals */
631 LOG_WARNING("soft_reset_halt is deprecated, please use 'reset halt' instead.");
632
633 /* Enter debug state on reset; restore DEMCR in endreset_event() */
634 retval = mem_ap_write_u32(swjdp, DCB_DEMCR,
635 TRCENA | VC_HARDERR | VC_BUSERR | VC_CORERESET);
636 if (retval != ERROR_OK)
637 return retval;
638
639 /* Request a core-only reset */
640 retval = mem_ap_write_atomic_u32(swjdp, NVIC_AIRCR,
641 AIRCR_VECTKEY | AIRCR_VECTRESET);
642 if (retval != ERROR_OK)
643 return retval;
644 target->state = TARGET_RESET;
645
646 /* registers are now invalid */
647 register_cache_invalidate(cortex_m->armv7m.arm.core_cache);
648
649 while (timeout < 100) {
650 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &dcb_dhcsr);
651 if (retval == ERROR_OK) {
652 retval = mem_ap_read_atomic_u32(swjdp, NVIC_DFSR,
653 &cortex_m->nvic_dfsr);
654 if (retval != ERROR_OK)
655 return retval;
656 if ((dcb_dhcsr & S_HALT)
657 && (cortex_m->nvic_dfsr & DFSR_VCATCH)) {
658 LOG_DEBUG("system reset-halted, DHCSR 0x%08x, "
659 "DFSR 0x%08x",
660 (unsigned) dcb_dhcsr,
661 (unsigned) cortex_m->nvic_dfsr);
662 cortex_m_poll(target);
663 /* FIXME restore user's vector catch config */
664 return ERROR_OK;
665 } else
666 LOG_DEBUG("waiting for system reset-halt, "
667 "DHCSR 0x%08x, %d ms",
668 (unsigned) dcb_dhcsr, timeout);
669 }
670 timeout++;
671 alive_sleep(1);
672 }
673
674 return ERROR_OK;
675 }
676
677 void cortex_m_enable_breakpoints(struct target *target)
678 {
679 struct breakpoint *breakpoint = target->breakpoints;
680
681 /* set any pending breakpoints */
682 while (breakpoint) {
683 if (!breakpoint->set)
684 cortex_m_set_breakpoint(target, breakpoint);
685 breakpoint = breakpoint->next;
686 }
687 }
688
689 static int cortex_m_resume(struct target *target, int current,
690 uint32_t address, int handle_breakpoints, int debug_execution)
691 {
692 struct armv7m_common *armv7m = target_to_armv7m(target);
693 struct breakpoint *breakpoint = NULL;
694 uint32_t resume_pc;
695 struct reg *r;
696
697 if (target->state != TARGET_HALTED) {
698 LOG_WARNING("target not halted");
699 return ERROR_TARGET_NOT_HALTED;
700 }
701
702 if (!debug_execution) {
703 target_free_all_working_areas(target);
704 cortex_m_enable_breakpoints(target);
705 cortex_m_enable_watchpoints(target);
706 }
707
708 if (debug_execution) {
709 r = armv7m->arm.core_cache->reg_list + ARMV7M_PRIMASK;
710
711 /* Disable interrupts */
712 /* We disable interrupts in the PRIMASK register instead of
713 * masking with C_MASKINTS. This is probably the same issue
714 * as Cortex-M3 Erratum 377493 (fixed in r1p0): C_MASKINTS
715 * in parallel with disabled interrupts can cause local faults
716 * to not be taken.
717 *
718 * REVISIT this clearly breaks non-debug execution, since the
719 * PRIMASK register state isn't saved/restored... workaround
720 * by never resuming app code after debug execution.
721 */
722 buf_set_u32(r->value, 0, 1, 1);
723 r->dirty = true;
724 r->valid = true;
725
726 /* Make sure we are in Thumb mode */
727 r = armv7m->arm.cpsr;
728 buf_set_u32(r->value, 24, 1, 1);
729 r->dirty = true;
730 r->valid = true;
731 }
732
733 /* current = 1: continue on current pc, otherwise continue at <address> */
734 r = armv7m->arm.pc;
735 if (!current) {
736 buf_set_u32(r->value, 0, 32, address);
737 r->dirty = true;
738 r->valid = true;
739 }
740
741 /* if we halted last time due to a bkpt instruction
742 * then we have to manually step over it, otherwise
743 * the core will break again */
744
745 if (!breakpoint_find(target, buf_get_u32(r->value, 0, 32))
746 && !debug_execution)
747 armv7m_maybe_skip_bkpt_inst(target, NULL);
748
749 resume_pc = buf_get_u32(r->value, 0, 32);
750
751 armv7m_restore_context(target);
752
753 /* the front-end may request us not to handle breakpoints */
754 if (handle_breakpoints) {
755 /* Single step past breakpoint at current address */
756 breakpoint = breakpoint_find(target, resume_pc);
757 if (breakpoint) {
758 LOG_DEBUG("unset breakpoint at 0x%8.8" PRIx32 " (ID: %" PRIu32 ")",
759 breakpoint->address,
760 breakpoint->unique_id);
761 cortex_m_unset_breakpoint(target, breakpoint);
762 cortex_m_single_step_core(target);
763 cortex_m_set_breakpoint(target, breakpoint);
764 }
765 }
766
767 /* Restart core */
768 cortex_m_write_debug_halt_mask(target, 0, C_HALT);
769
770 target->debug_reason = DBG_REASON_NOTHALTED;
771
772 /* registers are now invalid */
773 register_cache_invalidate(armv7m->arm.core_cache);
774
775 if (!debug_execution) {
776 target->state = TARGET_RUNNING;
777 target_call_event_callbacks(target, TARGET_EVENT_RESUMED);
778 LOG_DEBUG("target resumed at 0x%" PRIx32 "", resume_pc);
779 } else {
780 target->state = TARGET_DEBUG_RUNNING;
781 target_call_event_callbacks(target, TARGET_EVENT_DEBUG_RESUMED);
782 LOG_DEBUG("target debug resumed at 0x%" PRIx32 "", resume_pc);
783 }
784
785 return ERROR_OK;
786 }
787
788 /* int irqstepcount = 0; */
789 static int cortex_m_step(struct target *target, int current,
790 uint32_t address, int handle_breakpoints)
791 {
792 struct cortex_m_common *cortex_m = target_to_cm(target);
793 struct armv7m_common *armv7m = &cortex_m->armv7m;
794 struct adiv5_dap *swjdp = armv7m->arm.dap;
795 struct breakpoint *breakpoint = NULL;
796 struct reg *pc = armv7m->arm.pc;
797 bool bkpt_inst_found = false;
798 int retval;
799 bool isr_timed_out = false;
800
801 if (target->state != TARGET_HALTED) {
802 LOG_WARNING("target not halted");
803 return ERROR_TARGET_NOT_HALTED;
804 }
805
806 /* current = 1: continue on current pc, otherwise continue at <address> */
807 if (!current)
808 buf_set_u32(pc->value, 0, 32, address);
809
810 uint32_t pc_value = buf_get_u32(pc->value, 0, 32);
811
812 /* the front-end may request us not to handle breakpoints */
813 if (handle_breakpoints) {
814 breakpoint = breakpoint_find(target, pc_value);
815 if (breakpoint)
816 cortex_m_unset_breakpoint(target, breakpoint);
817 }
818
819 armv7m_maybe_skip_bkpt_inst(target, &bkpt_inst_found);
820
821 target->debug_reason = DBG_REASON_SINGLESTEP;
822
823 armv7m_restore_context(target);
824
825 target_call_event_callbacks(target, TARGET_EVENT_RESUMED);
826
827 /* if no bkpt instruction is found at pc then we can perform
828 * a normal step, otherwise we have to manually step over the bkpt
829 * instruction - as such simulate a step */
830 if (bkpt_inst_found == false) {
831 /* Automatic ISR masking mode off: Just step over the next instruction */
832 if ((cortex_m->isrmasking_mode != CORTEX_M_ISRMASK_AUTO))
833 cortex_m_write_debug_halt_mask(target, C_STEP, C_HALT);
834 else {
835 /* Process interrupts during stepping in a way they don't interfere
836 * debugging.
837 *
838 * Principle:
839 *
840 * Set a temporary break point at the current pc and let the core run
841 * with interrupts enabled. Pending interrupts get served and we run
842 * into the breakpoint again afterwards. Then we step over the next
843 * instruction with interrupts disabled.
844 *
845 * If the pending interrupts don't complete within time, we leave the
846 * core running. This may happen if the interrupts trigger faster
847 * than the core can process them or the handler doesn't return.
848 *
849 * If no more breakpoints are available we simply do a step with
850 * interrupts enabled.
851 *
852 */
853
854 /* 2012-09-29 ph
855 *
856 * If a break point is already set on the lower half word then a break point on
857 * the upper half word will not break again when the core is restarted. So we
858 * just step over the instruction with interrupts disabled.
859 *
860 * The documentation has no information about this, it was found by observation
861 * on STM32F1 and STM32F2. Proper explanation welcome. STM32F0 dosen't seem to
862 * suffer from this problem.
863 *
864 * To add some confusion: pc_value has bit 0 always set, while the breakpoint
865 * address has it always cleared. The former is done to indicate thumb mode
866 * to gdb.
867 *
868 */
869 if ((pc_value & 0x02) && breakpoint_find(target, pc_value & ~0x03)) {
870 LOG_DEBUG("Stepping over next instruction with interrupts disabled");
871 cortex_m_write_debug_halt_mask(target, C_HALT | C_MASKINTS, 0);
872 cortex_m_write_debug_halt_mask(target, C_STEP, C_HALT);
873 /* Re-enable interrupts */
874 cortex_m_write_debug_halt_mask(target, C_HALT, C_MASKINTS);
875 }
876 else {
877
878 /* Set a temporary break point */
879 if (breakpoint)
880 retval = cortex_m_set_breakpoint(target, breakpoint);
881 else
882 retval = breakpoint_add(target, pc_value, 2, BKPT_TYPE_BY_ADDR(pc_value));
883 bool tmp_bp_set = (retval == ERROR_OK);
884
885 /* No more breakpoints left, just do a step */
886 if (!tmp_bp_set)
887 cortex_m_write_debug_halt_mask(target, C_STEP, C_HALT);
888 else {
889 /* Start the core */
890 LOG_DEBUG("Starting core to serve pending interrupts");
891 int64_t t_start = timeval_ms();
892 cortex_m_write_debug_halt_mask(target, 0, C_HALT | C_STEP);
893
894 /* Wait for pending handlers to complete or timeout */
895 do {
896 retval = mem_ap_read_atomic_u32(swjdp,
897 DCB_DHCSR,
898 &cortex_m->dcb_dhcsr);
899 if (retval != ERROR_OK) {
900 target->state = TARGET_UNKNOWN;
901 return retval;
902 }
903 isr_timed_out = ((timeval_ms() - t_start) > 500);
904 } while (!((cortex_m->dcb_dhcsr & S_HALT) || isr_timed_out));
905
906 /* only remove breakpoint if we created it */
907 if (breakpoint)
908 cortex_m_unset_breakpoint(target, breakpoint);
909 else {
910 /* Remove the temporary breakpoint */
911 breakpoint_remove(target, pc_value);
912 }
913
914 if (isr_timed_out) {
915 LOG_DEBUG("Interrupt handlers didn't complete within time, "
916 "leaving target running");
917 } else {
918 /* Step over next instruction with interrupts disabled */
919 cortex_m_write_debug_halt_mask(target,
920 C_HALT | C_MASKINTS,
921 0);
922 cortex_m_write_debug_halt_mask(target, C_STEP, C_HALT);
923 /* Re-enable interrupts */
924 cortex_m_write_debug_halt_mask(target, C_HALT, C_MASKINTS);
925 }
926 }
927 }
928 }
929 }
930
931 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
932 if (retval != ERROR_OK)
933 return retval;
934
935 /* registers are now invalid */
936 register_cache_invalidate(armv7m->arm.core_cache);
937
938 if (breakpoint)
939 cortex_m_set_breakpoint(target, breakpoint);
940
941 if (isr_timed_out) {
942 /* Leave the core running. The user has to stop execution manually. */
943 target->debug_reason = DBG_REASON_NOTHALTED;
944 target->state = TARGET_RUNNING;
945 return ERROR_OK;
946 }
947
948 LOG_DEBUG("target stepped dcb_dhcsr = 0x%" PRIx32
949 " nvic_icsr = 0x%" PRIx32,
950 cortex_m->dcb_dhcsr, cortex_m->nvic_icsr);
951
952 retval = cortex_m_debug_entry(target);
953 if (retval != ERROR_OK)
954 return retval;
955 target_call_event_callbacks(target, TARGET_EVENT_HALTED);
956
957 LOG_DEBUG("target stepped dcb_dhcsr = 0x%" PRIx32
958 " nvic_icsr = 0x%" PRIx32,
959 cortex_m->dcb_dhcsr, cortex_m->nvic_icsr);
960
961 return ERROR_OK;
962 }
963
964 static int cortex_m_assert_reset(struct target *target)
965 {
966 struct cortex_m_common *cortex_m = target_to_cm(target);
967 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
968 enum cortex_m_soft_reset_config reset_config = cortex_m->soft_reset_config;
969
970 LOG_DEBUG("target->state: %s",
971 target_state_name(target));
972
973 enum reset_types jtag_reset_config = jtag_get_reset_config();
974
975 if (target_has_event_action(target, TARGET_EVENT_RESET_ASSERT)) {
976 /* allow scripts to override the reset event */
977
978 target_handle_event(target, TARGET_EVENT_RESET_ASSERT);
979 register_cache_invalidate(cortex_m->armv7m.arm.core_cache);
980 target->state = TARGET_RESET;
981
982 return ERROR_OK;
983 }
984
985 /* some cores support connecting while srst is asserted
986 * use that mode is it has been configured */
987
988 bool srst_asserted = false;
989
990 if ((jtag_reset_config & RESET_HAS_SRST) &&
991 (jtag_reset_config & RESET_SRST_NO_GATING)) {
992 adapter_assert_reset();
993 srst_asserted = true;
994 }
995
996 /* Enable debug requests */
997 int retval;
998 retval = mem_ap_read_atomic_u32(swjdp, DCB_DHCSR, &cortex_m->dcb_dhcsr);
999 if (retval != ERROR_OK)
1000 return retval;
1001 if (!(cortex_m->dcb_dhcsr & C_DEBUGEN)) {
1002 retval = mem_ap_write_u32(swjdp, DCB_DHCSR, DBGKEY | C_DEBUGEN);
1003 if (retval != ERROR_OK)
1004 return retval;
1005 }
1006
1007 /* If the processor is sleeping in a WFI or WFE instruction, the
1008 * C_HALT bit must be asserted to regain control */
1009 if (cortex_m->dcb_dhcsr & S_SLEEP) {
1010 retval = mem_ap_write_u32(swjdp, DCB_DHCSR, DBGKEY | C_HALT | C_DEBUGEN);
1011 if (retval != ERROR_OK)
1012 return retval;
1013 }
1014
1015 retval = mem_ap_write_u32(swjdp, DCB_DCRDR, 0);
1016 if (retval != ERROR_OK)
1017 return retval;
1018
1019 if (!target->reset_halt) {
1020 /* Set/Clear C_MASKINTS in a separate operation */
1021 if (cortex_m->dcb_dhcsr & C_MASKINTS) {
1022 retval = mem_ap_write_atomic_u32(swjdp, DCB_DHCSR,
1023 DBGKEY | C_DEBUGEN | C_HALT);
1024 if (retval != ERROR_OK)
1025 return retval;
1026 }
1027
1028 /* clear any debug flags before resuming */
1029 cortex_m_clear_halt(target);
1030
1031 /* clear C_HALT in dhcsr reg */
1032 cortex_m_write_debug_halt_mask(target, 0, C_HALT);
1033 } else {
1034 /* Halt in debug on reset; endreset_event() restores DEMCR.
1035 *
1036 * REVISIT catching BUSERR presumably helps to defend against
1037 * bad vector table entries. Should this include MMERR or
1038 * other flags too?
1039 */
1040 retval = mem_ap_write_atomic_u32(swjdp, DCB_DEMCR,
1041 TRCENA | VC_HARDERR | VC_BUSERR | VC_CORERESET);
1042 if (retval != ERROR_OK)
1043 return retval;
1044 }
1045
1046 if (jtag_reset_config & RESET_HAS_SRST) {
1047 /* default to asserting srst */
1048 if (!srst_asserted)
1049 adapter_assert_reset();
1050 } else {
1051 /* Use a standard Cortex-M3 software reset mechanism.
1052 * We default to using VECRESET as it is supported on all current cores.
1053 * This has the disadvantage of not resetting the peripherals, so a
1054 * reset-init event handler is needed to perform any peripheral resets.
1055 */
1056 LOG_DEBUG("Using Cortex-M %s", (reset_config == CORTEX_M_RESET_SYSRESETREQ)
1057 ? "SYSRESETREQ" : "VECTRESET");
1058
1059 if (reset_config == CORTEX_M_RESET_VECTRESET) {
1060 LOG_WARNING("Only resetting the Cortex-M core, use a reset-init event "
1061 "handler to reset any peripherals or configure hardware srst support.");
1062 }
1063
1064 retval = mem_ap_write_atomic_u32(swjdp, NVIC_AIRCR,
1065 AIRCR_VECTKEY | ((reset_config == CORTEX_M_RESET_SYSRESETREQ)
1066 ? AIRCR_SYSRESETREQ : AIRCR_VECTRESET));
1067 if (retval != ERROR_OK)
1068 LOG_DEBUG("Ignoring AP write error right after reset");
1069
1070 retval = ahbap_debugport_init(swjdp);
1071 if (retval != ERROR_OK) {
1072 LOG_ERROR("DP initialisation failed");
1073 return retval;
1074 }
1075
1076 {
1077 /* I do not know why this is necessary, but it
1078 * fixes strange effects (step/resume cause NMI
1079 * after reset) on LM3S6918 -- Michael Schwingen
1080 */
1081 uint32_t tmp;
1082 retval = mem_ap_read_atomic_u32(swjdp, NVIC_AIRCR, &tmp);
1083 if (retval != ERROR_OK)
1084 return retval;
1085 }
1086 }
1087
1088 target->state = TARGET_RESET;
1089 jtag_add_sleep(50000);
1090
1091 register_cache_invalidate(cortex_m->armv7m.arm.core_cache);
1092
1093 if (target->reset_halt) {
1094 retval = target_halt(target);
1095 if (retval != ERROR_OK)
1096 return retval;
1097 }
1098
1099 return ERROR_OK;
1100 }
1101
1102 static int cortex_m_deassert_reset(struct target *target)
1103 {
1104 LOG_DEBUG("target->state: %s",
1105 target_state_name(target));
1106
1107 /* deassert reset lines */
1108 adapter_deassert_reset();
1109
1110 enum reset_types jtag_reset_config = jtag_get_reset_config();
1111
1112 if ((jtag_reset_config & RESET_HAS_SRST) &&
1113 !(jtag_reset_config & RESET_SRST_NO_GATING)) {
1114 int retval = ahbap_debugport_init(target_to_cm(target)->armv7m.arm.dap);
1115 if (retval != ERROR_OK) {
1116 LOG_ERROR("DP initialisation failed");
1117 return retval;
1118 }
1119 }
1120
1121 return ERROR_OK;
1122 }
1123
1124 int cortex_m_set_breakpoint(struct target *target, struct breakpoint *breakpoint)
1125 {
1126 int retval;
1127 int fp_num = 0;
1128 uint32_t hilo;
1129 struct cortex_m_common *cortex_m = target_to_cm(target);
1130 struct cortex_m_fp_comparator *comparator_list = cortex_m->fp_comparator_list;
1131
1132 if (breakpoint->set) {
1133 LOG_WARNING("breakpoint (BPID: %" PRIu32 ") already set", breakpoint->unique_id);
1134 return ERROR_OK;
1135 }
1136
1137 if (cortex_m->auto_bp_type)
1138 breakpoint->type = BKPT_TYPE_BY_ADDR(breakpoint->address);
1139
1140 if (breakpoint->type == BKPT_HARD) {
1141 while (comparator_list[fp_num].used && (fp_num < cortex_m->fp_num_code))
1142 fp_num++;
1143 if (fp_num >= cortex_m->fp_num_code) {
1144 LOG_ERROR("Can not find free FPB Comparator!");
1145 return ERROR_FAIL;
1146 }
1147 breakpoint->set = fp_num + 1;
1148 hilo = (breakpoint->address & 0x2) ? FPCR_REPLACE_BKPT_HIGH : FPCR_REPLACE_BKPT_LOW;
1149 comparator_list[fp_num].used = 1;
1150 comparator_list[fp_num].fpcr_value = (breakpoint->address & 0x1FFFFFFC) | hilo | 1;
1151 target_write_u32(target, comparator_list[fp_num].fpcr_address,
1152 comparator_list[fp_num].fpcr_value);
1153 LOG_DEBUG("fpc_num %i fpcr_value 0x%" PRIx32 "",
1154 fp_num,
1155 comparator_list[fp_num].fpcr_value);
1156 if (!cortex_m->fpb_enabled) {
1157 LOG_DEBUG("FPB wasn't enabled, do it now");
1158 retval = cortex_m_enable_fpb(target);
1159 if (retval != ERROR_OK) {
1160 LOG_ERROR("Failed to enable the FPB");
1161 return retval;
1162 }
1163
1164 cortex_m->fpb_enabled = 1;
1165 }
1166 } else if (breakpoint->type == BKPT_SOFT) {
1167 uint8_t code[4];
1168
1169 /* NOTE: on ARMv6-M and ARMv7-M, BKPT(0xab) is used for
1170 * semihosting; don't use that. Otherwise the BKPT
1171 * parameter is arbitrary.
1172 */
1173 buf_set_u32(code, 0, 32, ARMV5_T_BKPT(0x11));
1174 retval = target_read_memory(target,
1175 breakpoint->address & 0xFFFFFFFE,
1176 breakpoint->length, 1,
1177 breakpoint->orig_instr);
1178 if (retval != ERROR_OK)
1179 return retval;
1180 retval = target_write_memory(target,
1181 breakpoint->address & 0xFFFFFFFE,
1182 breakpoint->length, 1,
1183 code);
1184 if (retval != ERROR_OK)
1185 return retval;
1186 breakpoint->set = true;
1187 }
1188
1189 LOG_DEBUG("BPID: %" PRIu32 ", Type: %d, Address: 0x%08" PRIx32 " Length: %d (set=%d)",
1190 breakpoint->unique_id,
1191 (int)(breakpoint->type),
1192 breakpoint->address,
1193 breakpoint->length,
1194 breakpoint->set);
1195
1196 return ERROR_OK;
1197 }
1198
1199 int cortex_m_unset_breakpoint(struct target *target, struct breakpoint *breakpoint)
1200 {
1201 int retval;
1202 struct cortex_m_common *cortex_m = target_to_cm(target);
1203 struct cortex_m_fp_comparator *comparator_list = cortex_m->fp_comparator_list;
1204
1205 if (!breakpoint->set) {
1206 LOG_WARNING("breakpoint not set");
1207 return ERROR_OK;
1208 }
1209
1210 LOG_DEBUG("BPID: %" PRIu32 ", Type: %d, Address: 0x%08" PRIx32 " Length: %d (set=%d)",
1211 breakpoint->unique_id,
1212 (int)(breakpoint->type),
1213 breakpoint->address,
1214 breakpoint->length,
1215 breakpoint->set);
1216
1217 if (breakpoint->type == BKPT_HARD) {
1218 int fp_num = breakpoint->set - 1;
1219 if ((fp_num < 0) || (fp_num >= cortex_m->fp_num_code)) {
1220 LOG_DEBUG("Invalid FP Comparator number in breakpoint");
1221 return ERROR_OK;
1222 }
1223 comparator_list[fp_num].used = 0;
1224 comparator_list[fp_num].fpcr_value = 0;
1225 target_write_u32(target, comparator_list[fp_num].fpcr_address,
1226 comparator_list[fp_num].fpcr_value);
1227 } else {
1228 /* restore original instruction (kept in target endianness) */
1229 if (breakpoint->length == 4) {
1230 retval = target_write_memory(target, breakpoint->address & 0xFFFFFFFE, 4, 1,
1231 breakpoint->orig_instr);
1232 if (retval != ERROR_OK)
1233 return retval;
1234 } else {
1235 retval = target_write_memory(target, breakpoint->address & 0xFFFFFFFE, 2, 1,
1236 breakpoint->orig_instr);
1237 if (retval != ERROR_OK)
1238 return retval;
1239 }
1240 }
1241 breakpoint->set = false;
1242
1243 return ERROR_OK;
1244 }
1245
1246 int cortex_m_add_breakpoint(struct target *target, struct breakpoint *breakpoint)
1247 {
1248 struct cortex_m_common *cortex_m = target_to_cm(target);
1249
1250 if (cortex_m->auto_bp_type)
1251 breakpoint->type = BKPT_TYPE_BY_ADDR(breakpoint->address);
1252
1253 if (breakpoint->type != BKPT_TYPE_BY_ADDR(breakpoint->address)) {
1254 if (breakpoint->type == BKPT_HARD) {
1255 LOG_INFO("flash patch comparator requested outside code memory region");
1256 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1257 }
1258
1259 if (breakpoint->type == BKPT_SOFT) {
1260 LOG_INFO("soft breakpoint requested in code (flash) memory region");
1261 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1262 }
1263 }
1264
1265 if ((breakpoint->type == BKPT_HARD) && (cortex_m->fp_code_available < 1)) {
1266 LOG_INFO("no flash patch comparator unit available for hardware breakpoint");
1267 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1268 }
1269
1270 if (breakpoint->length == 3) {
1271 LOG_DEBUG("Using a two byte breakpoint for 32bit Thumb-2 request");
1272 breakpoint->length = 2;
1273 }
1274
1275 if ((breakpoint->length != 2)) {
1276 LOG_INFO("only breakpoints of two bytes length supported");
1277 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1278 }
1279
1280 if (breakpoint->type == BKPT_HARD)
1281 cortex_m->fp_code_available--;
1282
1283 return cortex_m_set_breakpoint(target, breakpoint);
1284 }
1285
1286 int cortex_m_remove_breakpoint(struct target *target, struct breakpoint *breakpoint)
1287 {
1288 struct cortex_m_common *cortex_m = target_to_cm(target);
1289
1290 /* REVISIT why check? FBP can be updated with core running ... */
1291 if (target->state != TARGET_HALTED) {
1292 LOG_WARNING("target not halted");
1293 return ERROR_TARGET_NOT_HALTED;
1294 }
1295
1296 if (cortex_m->auto_bp_type)
1297 breakpoint->type = BKPT_TYPE_BY_ADDR(breakpoint->address);
1298
1299 if (breakpoint->set)
1300 cortex_m_unset_breakpoint(target, breakpoint);
1301
1302 if (breakpoint->type == BKPT_HARD)
1303 cortex_m->fp_code_available++;
1304
1305 return ERROR_OK;
1306 }
1307
1308 int cortex_m_set_watchpoint(struct target *target, struct watchpoint *watchpoint)
1309 {
1310 int dwt_num = 0;
1311 uint32_t mask, temp;
1312 struct cortex_m_common *cortex_m = target_to_cm(target);
1313
1314 /* watchpoint params were validated earlier */
1315 mask = 0;
1316 temp = watchpoint->length;
1317 while (temp) {
1318 temp >>= 1;
1319 mask++;
1320 }
1321 mask--;
1322
1323 /* REVISIT Don't fully trust these "not used" records ... users
1324 * may set up breakpoints by hand, e.g. dual-address data value
1325 * watchpoint using comparator #1; comparator #0 matching cycle
1326 * count; send data trace info through ITM and TPIU; etc
1327 */
1328 struct cortex_m_dwt_comparator *comparator;
1329
1330 for (comparator = cortex_m->dwt_comparator_list;
1331 comparator->used && dwt_num < cortex_m->dwt_num_comp;
1332 comparator++, dwt_num++)
1333 continue;
1334 if (dwt_num >= cortex_m->dwt_num_comp) {
1335 LOG_ERROR("Can not find free DWT Comparator");
1336 return ERROR_FAIL;
1337 }
1338 comparator->used = 1;
1339 watchpoint->set = dwt_num + 1;
1340
1341 comparator->comp = watchpoint->address;
1342 target_write_u32(target, comparator->dwt_comparator_address + 0,
1343 comparator->comp);
1344
1345 comparator->mask = mask;
1346 target_write_u32(target, comparator->dwt_comparator_address + 4,
1347 comparator->mask);
1348
1349 switch (watchpoint->rw) {
1350 case WPT_READ:
1351 comparator->function = 5;
1352 break;
1353 case WPT_WRITE:
1354 comparator->function = 6;
1355 break;
1356 case WPT_ACCESS:
1357 comparator->function = 7;
1358 break;
1359 }
1360 target_write_u32(target, comparator->dwt_comparator_address + 8,
1361 comparator->function);
1362
1363 LOG_DEBUG("Watchpoint (ID %d) DWT%d 0x%08x 0x%x 0x%05x",
1364 watchpoint->unique_id, dwt_num,
1365 (unsigned) comparator->comp,
1366 (unsigned) comparator->mask,
1367 (unsigned) comparator->function);
1368 return ERROR_OK;
1369 }
1370
1371 int cortex_m_unset_watchpoint(struct target *target, struct watchpoint *watchpoint)
1372 {
1373 struct cortex_m_common *cortex_m = target_to_cm(target);
1374 struct cortex_m_dwt_comparator *comparator;
1375 int dwt_num;
1376
1377 if (!watchpoint->set) {
1378 LOG_WARNING("watchpoint (wpid: %d) not set",
1379 watchpoint->unique_id);
1380 return ERROR_OK;
1381 }
1382
1383 dwt_num = watchpoint->set - 1;
1384
1385 LOG_DEBUG("Watchpoint (ID %d) DWT%d address: 0x%08x clear",
1386 watchpoint->unique_id, dwt_num,
1387 (unsigned) watchpoint->address);
1388
1389 if ((dwt_num < 0) || (dwt_num >= cortex_m->dwt_num_comp)) {
1390 LOG_DEBUG("Invalid DWT Comparator number in watchpoint");
1391 return ERROR_OK;
1392 }
1393
1394 comparator = cortex_m->dwt_comparator_list + dwt_num;
1395 comparator->used = 0;
1396 comparator->function = 0;
1397 target_write_u32(target, comparator->dwt_comparator_address + 8,
1398 comparator->function);
1399
1400 watchpoint->set = false;
1401
1402 return ERROR_OK;
1403 }
1404
1405 int cortex_m_add_watchpoint(struct target *target, struct watchpoint *watchpoint)
1406 {
1407 struct cortex_m_common *cortex_m = target_to_cm(target);
1408
1409 if (cortex_m->dwt_comp_available < 1) {
1410 LOG_DEBUG("no comparators?");
1411 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1412 }
1413
1414 /* hardware doesn't support data value masking */
1415 if (watchpoint->mask != ~(uint32_t)0) {
1416 LOG_DEBUG("watchpoint value masks not supported");
1417 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1418 }
1419
1420 /* hardware allows address masks of up to 32K */
1421 unsigned mask;
1422
1423 for (mask = 0; mask < 16; mask++) {
1424 if ((1u << mask) == watchpoint->length)
1425 break;
1426 }
1427 if (mask == 16) {
1428 LOG_DEBUG("unsupported watchpoint length");
1429 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1430 }
1431 if (watchpoint->address & ((1 << mask) - 1)) {
1432 LOG_DEBUG("watchpoint address is unaligned");
1433 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1434 }
1435
1436 /* Caller doesn't seem to be able to describe watching for data
1437 * values of zero; that flags "no value".
1438 *
1439 * REVISIT This DWT may well be able to watch for specific data
1440 * values. Requires comparator #1 to set DATAVMATCH and match
1441 * the data, and another comparator (DATAVADDR0) matching addr.
1442 */
1443 if (watchpoint->value) {
1444 LOG_DEBUG("data value watchpoint not YET supported");
1445 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1446 }
1447
1448 cortex_m->dwt_comp_available--;
1449 LOG_DEBUG("dwt_comp_available: %d", cortex_m->dwt_comp_available);
1450
1451 return ERROR_OK;
1452 }
1453
1454 int cortex_m_remove_watchpoint(struct target *target, struct watchpoint *watchpoint)
1455 {
1456 struct cortex_m_common *cortex_m = target_to_cm(target);
1457
1458 /* REVISIT why check? DWT can be updated with core running ... */
1459 if (target->state != TARGET_HALTED) {
1460 LOG_WARNING("target not halted");
1461 return ERROR_TARGET_NOT_HALTED;
1462 }
1463
1464 if (watchpoint->set)
1465 cortex_m_unset_watchpoint(target, watchpoint);
1466
1467 cortex_m->dwt_comp_available++;
1468 LOG_DEBUG("dwt_comp_available: %d", cortex_m->dwt_comp_available);
1469
1470 return ERROR_OK;
1471 }
1472
1473 void cortex_m_enable_watchpoints(struct target *target)
1474 {
1475 struct watchpoint *watchpoint = target->watchpoints;
1476
1477 /* set any pending watchpoints */
1478 while (watchpoint) {
1479 if (!watchpoint->set)
1480 cortex_m_set_watchpoint(target, watchpoint);
1481 watchpoint = watchpoint->next;
1482 }
1483 }
1484
1485 static int cortex_m_load_core_reg_u32(struct target *target,
1486 uint32_t num, uint32_t *value)
1487 {
1488 int retval;
1489
1490 /* NOTE: we "know" here that the register identifiers used
1491 * in the v7m header match the Cortex-M3 Debug Core Register
1492 * Selector values for R0..R15, xPSR, MSP, and PSP.
1493 */
1494 switch (num) {
1495 case 0 ... 18:
1496 /* read a normal core register */
1497 retval = cortexm_dap_read_coreregister_u32(target, value, num);
1498
1499 if (retval != ERROR_OK) {
1500 LOG_ERROR("JTAG failure %i", retval);
1501 return ERROR_JTAG_DEVICE_ERROR;
1502 }
1503 LOG_DEBUG("load from core reg %i value 0x%" PRIx32 "", (int)num, *value);
1504 break;
1505
1506 case ARMV7M_FPSCR:
1507 /* Floating-point Status and Registers */
1508 retval = target_write_u32(target, DCB_DCRSR, 0x21);
1509 if (retval != ERROR_OK)
1510 return retval;
1511 retval = target_read_u32(target, DCB_DCRDR, value);
1512 if (retval != ERROR_OK)
1513 return retval;
1514 LOG_DEBUG("load from FPSCR value 0x%" PRIx32, *value);
1515 break;
1516
1517 case ARMV7M_S0 ... ARMV7M_S31:
1518 /* Floating-point Status and Registers */
1519 retval = target_write_u32(target, DCB_DCRSR, num - ARMV7M_S0 + 0x40);
1520 if (retval != ERROR_OK)
1521 return retval;
1522 retval = target_read_u32(target, DCB_DCRDR, value);
1523 if (retval != ERROR_OK)
1524 return retval;
1525 LOG_DEBUG("load from FPU reg S%d value 0x%" PRIx32,
1526 (int)(num - ARMV7M_S0), *value);
1527 break;
1528
1529 case ARMV7M_PRIMASK:
1530 case ARMV7M_BASEPRI:
1531 case ARMV7M_FAULTMASK:
1532 case ARMV7M_CONTROL:
1533 /* Cortex-M3 packages these four registers as bitfields
1534 * in one Debug Core register. So say r0 and r2 docs;
1535 * it was removed from r1 docs, but still works.
1536 */
1537 cortexm_dap_read_coreregister_u32(target, value, 20);
1538
1539 switch (num) {
1540 case ARMV7M_PRIMASK:
1541 *value = buf_get_u32((uint8_t *)value, 0, 1);
1542 break;
1543
1544 case ARMV7M_BASEPRI:
1545 *value = buf_get_u32((uint8_t *)value, 8, 8);
1546 break;
1547
1548 case ARMV7M_FAULTMASK:
1549 *value = buf_get_u32((uint8_t *)value, 16, 1);
1550 break;
1551
1552 case ARMV7M_CONTROL:
1553 *value = buf_get_u32((uint8_t *)value, 24, 2);
1554 break;
1555 }
1556
1557 LOG_DEBUG("load from special reg %i value 0x%" PRIx32 "", (int)num, *value);
1558 break;
1559
1560 default:
1561 return ERROR_COMMAND_SYNTAX_ERROR;
1562 }
1563
1564 return ERROR_OK;
1565 }
1566
1567 static int cortex_m_store_core_reg_u32(struct target *target,
1568 uint32_t num, uint32_t value)
1569 {
1570 int retval;
1571 uint32_t reg;
1572 struct armv7m_common *armv7m = target_to_armv7m(target);
1573
1574 /* NOTE: we "know" here that the register identifiers used
1575 * in the v7m header match the Cortex-M3 Debug Core Register
1576 * Selector values for R0..R15, xPSR, MSP, and PSP.
1577 */
1578 switch (num) {
1579 case 0 ... 18:
1580 retval = cortexm_dap_write_coreregister_u32(target, value, num);
1581 if (retval != ERROR_OK) {
1582 struct reg *r;
1583
1584 LOG_ERROR("JTAG failure");
1585 r = armv7m->arm.core_cache->reg_list + num;
1586 r->dirty = r->valid;
1587 return ERROR_JTAG_DEVICE_ERROR;
1588 }
1589 LOG_DEBUG("write core reg %i value 0x%" PRIx32 "", (int)num, value);
1590 break;
1591
1592 case ARMV7M_FPSCR:
1593 /* Floating-point Status and Registers */
1594 retval = target_write_u32(target, DCB_DCRDR, value);
1595 if (retval != ERROR_OK)
1596 return retval;
1597 retval = target_write_u32(target, DCB_DCRSR, 0x21 | (1<<16));
1598 if (retval != ERROR_OK)
1599 return retval;
1600 LOG_DEBUG("write FPSCR value 0x%" PRIx32, value);
1601 break;
1602
1603 case ARMV7M_S0 ... ARMV7M_S31:
1604 /* Floating-point Status and Registers */
1605 retval = target_write_u32(target, DCB_DCRDR, value);
1606 if (retval != ERROR_OK)
1607 return retval;
1608 retval = target_write_u32(target, DCB_DCRSR, (num - ARMV7M_S0 + 0x40) | (1<<16));
1609 if (retval != ERROR_OK)
1610 return retval;
1611 LOG_DEBUG("write FPU reg S%d value 0x%" PRIx32,
1612 (int)(num - ARMV7M_S0), value);
1613 break;
1614
1615 case ARMV7M_PRIMASK:
1616 case ARMV7M_BASEPRI:
1617 case ARMV7M_FAULTMASK:
1618 case ARMV7M_CONTROL:
1619 /* Cortex-M3 packages these four registers as bitfields
1620 * in one Debug Core register. So say r0 and r2 docs;
1621 * it was removed from r1 docs, but still works.
1622 */
1623 cortexm_dap_read_coreregister_u32(target, &reg, 20);
1624
1625 switch (num) {
1626 case ARMV7M_PRIMASK:
1627 buf_set_u32((uint8_t *)&reg, 0, 1, value);
1628 break;
1629
1630 case ARMV7M_BASEPRI:
1631 buf_set_u32((uint8_t *)&reg, 8, 8, value);
1632 break;
1633
1634 case ARMV7M_FAULTMASK:
1635 buf_set_u32((uint8_t *)&reg, 16, 1, value);
1636 break;
1637
1638 case ARMV7M_CONTROL:
1639 buf_set_u32((uint8_t *)&reg, 24, 2, value);
1640 break;
1641 }
1642
1643 cortexm_dap_write_coreregister_u32(target, reg, 20);
1644
1645 LOG_DEBUG("write special reg %i value 0x%" PRIx32 " ", (int)num, value);
1646 break;
1647
1648 default:
1649 return ERROR_COMMAND_SYNTAX_ERROR;
1650 }
1651
1652 return ERROR_OK;
1653 }
1654
1655 static int cortex_m_read_memory(struct target *target, uint32_t address,
1656 uint32_t size, uint32_t count, uint8_t *buffer)
1657 {
1658 struct armv7m_common *armv7m = target_to_armv7m(target);
1659 struct adiv5_dap *swjdp = armv7m->arm.dap;
1660
1661 if (armv7m->arm.is_armv6m) {
1662 /* armv6m does not handle unaligned memory access */
1663 if (((size == 4) && (address & 0x3u)) || ((size == 2) && (address & 0x1u)))
1664 return ERROR_TARGET_UNALIGNED_ACCESS;
1665 }
1666
1667 return mem_ap_read(swjdp, buffer, size, count, address, true);
1668 }
1669
1670 static int cortex_m_write_memory(struct target *target, uint32_t address,
1671 uint32_t size, uint32_t count, const uint8_t *buffer)
1672 {
1673 struct armv7m_common *armv7m = target_to_armv7m(target);
1674 struct adiv5_dap *swjdp = armv7m->arm.dap;
1675
1676 if (armv7m->arm.is_armv6m) {
1677 /* armv6m does not handle unaligned memory access */
1678 if (((size == 4) && (address & 0x3u)) || ((size == 2) && (address & 0x1u)))
1679 return ERROR_TARGET_UNALIGNED_ACCESS;
1680 }
1681
1682 return mem_ap_write(swjdp, buffer, size, count, address, true);
1683 }
1684
1685 static int cortex_m_init_target(struct command_context *cmd_ctx,
1686 struct target *target)
1687 {
1688 armv7m_build_reg_cache(target);
1689 return ERROR_OK;
1690 }
1691
1692 void cortex_m_deinit_target(struct target *target)
1693 {
1694 struct cortex_m_common *cortex_m = target_to_cm(target);
1695
1696 free(cortex_m->fp_comparator_list);
1697
1698 cortex_m_dwt_free(target);
1699 armv7m_free_reg_cache(target);
1700
1701 free(cortex_m);
1702 }
1703
1704 /* REVISIT cache valid/dirty bits are unmaintained. We could set "valid"
1705 * on r/w if the core is not running, and clear on resume or reset ... or
1706 * at least, in a post_restore_context() method.
1707 */
1708
1709 struct dwt_reg_state {
1710 struct target *target;
1711 uint32_t addr;
1712 uint8_t value[4]; /* scratch/cache */
1713 };
1714
1715 static int cortex_m_dwt_get_reg(struct reg *reg)
1716 {
1717 struct dwt_reg_state *state = reg->arch_info;
1718
1719 uint32_t tmp;
1720 int retval = target_read_u32(state->target, state->addr, &tmp);
1721 if (retval != ERROR_OK)
1722 return retval;
1723
1724 buf_set_u32(state->value, 0, 32, tmp);
1725 return ERROR_OK;
1726 }
1727
1728 static int cortex_m_dwt_set_reg(struct reg *reg, uint8_t *buf)
1729 {
1730 struct dwt_reg_state *state = reg->arch_info;
1731
1732 return target_write_u32(state->target, state->addr,
1733 buf_get_u32(buf, 0, reg->size));
1734 }
1735
1736 struct dwt_reg {
1737 uint32_t addr;
1738 char *name;
1739 unsigned size;
1740 };
1741
1742 static struct dwt_reg dwt_base_regs[] = {
1743 { DWT_CTRL, "dwt_ctrl", 32, },
1744 /* NOTE that Erratum 532314 (fixed r2p0) affects CYCCNT: it wrongly
1745 * increments while the core is asleep.
1746 */
1747 { DWT_CYCCNT, "dwt_cyccnt", 32, },
1748 /* plus some 8 bit counters, useful for profiling with TPIU */
1749 };
1750
1751 static struct dwt_reg dwt_comp[] = {
1752 #define DWT_COMPARATOR(i) \
1753 { DWT_COMP0 + 0x10 * (i), "dwt_" #i "_comp", 32, }, \
1754 { DWT_MASK0 + 0x10 * (i), "dwt_" #i "_mask", 4, }, \
1755 { DWT_FUNCTION0 + 0x10 * (i), "dwt_" #i "_function", 32, }
1756 DWT_COMPARATOR(0),
1757 DWT_COMPARATOR(1),
1758 DWT_COMPARATOR(2),
1759 DWT_COMPARATOR(3),
1760 #undef DWT_COMPARATOR
1761 };
1762
1763 static const struct reg_arch_type dwt_reg_type = {
1764 .get = cortex_m_dwt_get_reg,
1765 .set = cortex_m_dwt_set_reg,
1766 };
1767
1768 static void cortex_m_dwt_addreg(struct target *t, struct reg *r, struct dwt_reg *d)
1769 {
1770 struct dwt_reg_state *state;
1771
1772 state = calloc(1, sizeof *state);
1773 if (!state)
1774 return;
1775 state->addr = d->addr;
1776 state->target = t;
1777
1778 r->name = d->name;
1779 r->size = d->size;
1780 r->value = state->value;
1781 r->arch_info = state;
1782 r->type = &dwt_reg_type;
1783 }
1784
1785 void cortex_m_dwt_setup(struct cortex_m_common *cm, struct target *target)
1786 {
1787 uint32_t dwtcr;
1788 struct reg_cache *cache;
1789 struct cortex_m_dwt_comparator *comparator;
1790 int reg, i;
1791
1792 target_read_u32(target, DWT_CTRL, &dwtcr);
1793 if (!dwtcr) {
1794 LOG_DEBUG("no DWT");
1795 return;
1796 }
1797
1798 cm->dwt_num_comp = (dwtcr >> 28) & 0xF;
1799 cm->dwt_comp_available = cm->dwt_num_comp;
1800 cm->dwt_comparator_list = calloc(cm->dwt_num_comp,
1801 sizeof(struct cortex_m_dwt_comparator));
1802 if (!cm->dwt_comparator_list) {
1803 fail0:
1804 cm->dwt_num_comp = 0;
1805 LOG_ERROR("out of mem");
1806 return;
1807 }
1808
1809 cache = calloc(1, sizeof *cache);
1810 if (!cache) {
1811 fail1:
1812 free(cm->dwt_comparator_list);
1813 goto fail0;
1814 }
1815 cache->name = "Cortex-M DWT registers";
1816 cache->num_regs = 2 + cm->dwt_num_comp * 3;
1817 cache->reg_list = calloc(cache->num_regs, sizeof *cache->reg_list);
1818 if (!cache->reg_list) {
1819 free(cache);
1820 goto fail1;
1821 }
1822
1823 for (reg = 0; reg < 2; reg++)
1824 cortex_m_dwt_addreg(target, cache->reg_list + reg,
1825 dwt_base_regs + reg);
1826
1827 comparator = cm->dwt_comparator_list;
1828 for (i = 0; i < cm->dwt_num_comp; i++, comparator++) {
1829 int j;
1830
1831 comparator->dwt_comparator_address = DWT_COMP0 + 0x10 * i;
1832 for (j = 0; j < 3; j++, reg++)
1833 cortex_m_dwt_addreg(target, cache->reg_list + reg,
1834 dwt_comp + 3 * i + j);
1835
1836 /* make sure we clear any watchpoints enabled on the target */
1837 target_write_u32(target, comparator->dwt_comparator_address + 8, 0);
1838 }
1839
1840 *register_get_last_cache_p(&target->reg_cache) = cache;
1841 cm->dwt_cache = cache;
1842
1843 LOG_DEBUG("DWT dwtcr 0x%" PRIx32 ", comp %d, watch%s",
1844 dwtcr, cm->dwt_num_comp,
1845 (dwtcr & (0xf << 24)) ? " only" : "/trigger");
1846
1847 /* REVISIT: if num_comp > 1, check whether comparator #1 can
1848 * implement single-address data value watchpoints ... so we
1849 * won't need to check it later, when asked to set one up.
1850 */
1851 }
1852
1853 static void cortex_m_dwt_free(struct target *target)
1854 {
1855 struct cortex_m_common *cm = target_to_cm(target);
1856 struct reg_cache *cache = cm->dwt_cache;
1857
1858 free(cm->dwt_comparator_list);
1859 cm->dwt_comparator_list = NULL;
1860
1861 if (cache) {
1862 register_unlink_cache(&target->reg_cache, cache);
1863
1864 if (cache->reg_list) {
1865 for (size_t i = 0; i < cache->num_regs; i++)
1866 free(cache->reg_list[i].arch_info);
1867 free(cache->reg_list);
1868 }
1869 free(cache);
1870 }
1871 cm->dwt_cache = NULL;
1872 }
1873
1874 #define MVFR0 0xe000ef40
1875 #define MVFR1 0xe000ef44
1876
1877 #define MVFR0_DEFAULT_M4 0x10110021
1878 #define MVFR1_DEFAULT_M4 0x11000011
1879
1880 int cortex_m_examine(struct target *target)
1881 {
1882 int retval;
1883 uint32_t cpuid, fpcr, mvfr0, mvfr1;
1884 int i;
1885 struct cortex_m_common *cortex_m = target_to_cm(target);
1886 struct adiv5_dap *swjdp = cortex_m->armv7m.arm.dap;
1887 struct armv7m_common *armv7m = target_to_armv7m(target);
1888
1889 /* stlink shares the examine handler but does not support
1890 * all its calls */
1891 if (!armv7m->stlink) {
1892 retval = ahbap_debugport_init(swjdp);
1893 if (retval != ERROR_OK)
1894 return retval;
1895 }
1896
1897 if (!target_was_examined(target)) {
1898 target_set_examined(target);
1899
1900 /* Read from Device Identification Registers */
1901 retval = target_read_u32(target, CPUID, &cpuid);
1902 if (retval != ERROR_OK)
1903 return retval;
1904
1905 /* Get CPU Type */
1906 i = (cpuid >> 4) & 0xf;
1907
1908 LOG_DEBUG("Cortex-M%d r%" PRId8 "p%" PRId8 " processor detected",
1909 i, (uint8_t)((cpuid >> 20) & 0xf), (uint8_t)((cpuid >> 0) & 0xf));
1910 LOG_DEBUG("cpuid: 0x%8.8" PRIx32 "", cpuid);
1911
1912 /* test for floating point feature on cortex-m4 */
1913 if (i == 4) {
1914 target_read_u32(target, MVFR0, &mvfr0);
1915 target_read_u32(target, MVFR1, &mvfr1);
1916
1917 if ((mvfr0 == MVFR0_DEFAULT_M4) && (mvfr1 == MVFR1_DEFAULT_M4)) {
1918 LOG_DEBUG("Cortex-M%d floating point feature FPv4_SP found", i);
1919 armv7m->fp_feature = FPv4_SP;
1920 }
1921 } else if (i == 0) {
1922 /* Cortex-M0 does not support unaligned memory access */
1923 armv7m->arm.is_armv6m = true;
1924 }
1925
1926 if (armv7m->fp_feature != FPv4_SP &&
1927 armv7m->arm.core_cache->num_regs > ARMV7M_NUM_CORE_REGS_NOFP) {
1928 /* free unavailable FPU registers */
1929 size_t idx;
1930
1931 for (idx = ARMV7M_NUM_CORE_REGS_NOFP;
1932 idx < armv7m->arm.core_cache->num_regs;
1933 idx++) {
1934 free(armv7m->arm.core_cache->reg_list[idx].value);
1935 free(armv7m->arm.core_cache->reg_list[idx].feature);
1936 free(armv7m->arm.core_cache->reg_list[idx].reg_data_type);
1937 }
1938 armv7m->arm.core_cache->num_regs = ARMV7M_NUM_CORE_REGS_NOFP;
1939 }
1940
1941 if (i == 4 || i == 3) {
1942 /* Cortex-M3/M4 has 4096 bytes autoincrement range */
1943 armv7m->dap.tar_autoincr_block = (1 << 12);
1944 }
1945
1946 /* Configure trace modules */
1947 retval = target_write_u32(target, DCB_DEMCR, TRCENA | armv7m->demcr);
1948 if (retval != ERROR_OK)
1949 return retval;
1950
1951 if (armv7m->trace_config.config_type != DISABLED) {
1952 armv7m_trace_tpiu_config(target);
1953 armv7m_trace_itm_config(target);
1954 }
1955
1956 /* NOTE: FPB and DWT are both optional. */
1957
1958 /* Setup FPB */
1959 target_read_u32(target, FP_CTRL, &fpcr);
1960 cortex_m->auto_bp_type = 1;
1961 /* bits [14:12] and [7:4] */
1962 cortex_m->fp_num_code = ((fpcr >> 8) & 0x70) | ((fpcr >> 4) & 0xF);
1963 cortex_m->fp_num_lit = (fpcr >> 8) & 0xF;
1964 cortex_m->fp_code_available = cortex_m->fp_num_code;
1965 free(cortex_m->fp_comparator_list);
1966 cortex_m->fp_comparator_list = calloc(
1967 cortex_m->fp_num_code + cortex_m->fp_num_lit,
1968 sizeof(struct cortex_m_fp_comparator));
1969 cortex_m->fpb_enabled = fpcr & 1;
1970 for (i = 0; i < cortex_m->fp_num_code + cortex_m->fp_num_lit; i++) {
1971 cortex_m->fp_comparator_list[i].type =
1972 (i < cortex_m->fp_num_code) ? FPCR_CODE : FPCR_LITERAL;
1973 cortex_m->fp_comparator_list[i].fpcr_address = FP_COMP0 + 4 * i;
1974
1975 /* make sure we clear any breakpoints enabled on the target */
1976 target_write_u32(target, cortex_m->fp_comparator_list[i].fpcr_address, 0);
1977 }
1978 LOG_DEBUG("FPB fpcr 0x%" PRIx32 ", numcode %i, numlit %i",
1979 fpcr,
1980 cortex_m->fp_num_code,
1981 cortex_m->fp_num_lit);
1982
1983 /* Setup DWT */
1984 cortex_m_dwt_free(target);
1985 cortex_m_dwt_setup(cortex_m, target);
1986
1987 /* These hardware breakpoints only work for code in flash! */
1988 LOG_INFO("%s: hardware has %d breakpoints, %d watchpoints",
1989 target_name(target),
1990 cortex_m->fp_num_code,
1991 cortex_m->dwt_num_comp);
1992 }
1993
1994 return ERROR_OK;
1995 }
1996
1997 static int cortex_m_dcc_read(struct target *target, uint8_t *value, uint8_t *ctrl)
1998 {
1999 struct armv7m_common *armv7m = target_to_armv7m(target);
2000 struct adiv5_dap *swjdp = armv7m->arm.dap;
2001 uint16_t dcrdr;
2002 uint8_t buf[2];
2003 int retval;
2004
2005 retval = mem_ap_read(swjdp, buf, 2, 1, DCB_DCRDR, false);
2006 if (retval != ERROR_OK)
2007 return retval;
2008
2009 dcrdr = target_buffer_get_u16(target, buf);
2010 *ctrl = (uint8_t)dcrdr;
2011 *value = (uint8_t)(dcrdr >> 8);
2012
2013 LOG_DEBUG("data 0x%x ctrl 0x%x", *value, *ctrl);
2014
2015 /* write ack back to software dcc register
2016 * signify we have read data */
2017 if (dcrdr & (1 << 0)) {
2018 target_buffer_set_u16(target, buf, 0);
2019 retval = mem_ap_write(swjdp, buf, 2, 1, DCB_DCRDR, false);
2020 if (retval != ERROR_OK)
2021 return retval;
2022 }
2023
2024 return ERROR_OK;
2025 }
2026
2027 static int cortex_m_target_request_data(struct target *target,
2028 uint32_t size, uint8_t *buffer)
2029 {
2030 uint8_t data;
2031 uint8_t ctrl;
2032 uint32_t i;
2033
2034 for (i = 0; i < (size * 4); i++) {
2035 int retval = cortex_m_dcc_read(target, &data, &ctrl);
2036 if (retval != ERROR_OK)
2037 return retval;
2038 buffer[i] = data;
2039 }
2040
2041 return ERROR_OK;
2042 }
2043
2044 static int cortex_m_handle_target_request(void *priv)
2045 {
2046 struct target *target = priv;
2047 if (!target_was_examined(target))
2048 return ERROR_OK;
2049
2050 if (!target->dbg_msg_enabled)
2051 return ERROR_OK;
2052
2053 if (target->state == TARGET_RUNNING) {
2054 uint8_t data;
2055 uint8_t ctrl;
2056 int retval;
2057
2058 retval = cortex_m_dcc_read(target, &data, &ctrl);
2059 if (retval != ERROR_OK)
2060 return retval;
2061
2062 /* check if we have data */
2063 if (ctrl & (1 << 0)) {
2064 uint32_t request;
2065
2066 /* we assume target is quick enough */
2067 request = data;
2068 for (int i = 1; i <= 3; i++) {
2069 retval = cortex_m_dcc_read(target, &data, &ctrl);
2070 if (retval != ERROR_OK)
2071 return retval;
2072 request |= ((uint32_t)data << (i * 8));
2073 }
2074 target_request(target, request);
2075 }
2076 }
2077
2078 return ERROR_OK;
2079 }
2080
2081 static int cortex_m_init_arch_info(struct target *target,
2082 struct cortex_m_common *cortex_m, struct jtag_tap *tap)
2083 {
2084 int retval;
2085 struct armv7m_common *armv7m = &cortex_m->armv7m;
2086
2087 armv7m_init_arch_info(target, armv7m);
2088
2089 /* prepare JTAG information for the new target */
2090 cortex_m->jtag_info.tap = tap;
2091 cortex_m->jtag_info.scann_size = 4;
2092
2093 /* default reset mode is to use srst if fitted
2094 * if not it will use CORTEX_M3_RESET_VECTRESET */
2095 cortex_m->soft_reset_config = CORTEX_M_RESET_VECTRESET;
2096
2097 armv7m->arm.dap = &armv7m->dap;
2098
2099 /* Leave (only) generic DAP stuff for debugport_init(); */
2100 armv7m->dap.jtag_info = &cortex_m->jtag_info;
2101 armv7m->dap.memaccess_tck = 8;
2102
2103 /* Cortex-M3/M4 has 4096 bytes autoincrement range
2104 * but set a safe default to 1024 to support Cortex-M0
2105 * this will be changed in cortex_m3_examine if a M3/M4 is detected */
2106 armv7m->dap.tar_autoincr_block = (1 << 10);
2107
2108 /* register arch-specific functions */
2109 armv7m->examine_debug_reason = cortex_m_examine_debug_reason;
2110
2111 armv7m->post_debug_entry = NULL;
2112
2113 armv7m->pre_restore_context = NULL;
2114
2115 armv7m->load_core_reg_u32 = cortex_m_load_core_reg_u32;
2116 armv7m->store_core_reg_u32 = cortex_m_store_core_reg_u32;
2117
2118 target_register_timer_callback(cortex_m_handle_target_request, 1, 1, target);
2119
2120 retval = arm_jtag_setup_connection(&cortex_m->jtag_info);
2121 if (retval != ERROR_OK)
2122 return retval;
2123
2124 return ERROR_OK;
2125 }
2126
2127 static int cortex_m_target_create(struct target *target, Jim_Interp *interp)
2128 {
2129 struct cortex_m_common *cortex_m = calloc(1, sizeof(struct cortex_m_common));
2130
2131 cortex_m->common_magic = CORTEX_M_COMMON_MAGIC;
2132 cortex_m_init_arch_info(target, cortex_m, target->tap);
2133
2134 return ERROR_OK;
2135 }
2136
2137 /*--------------------------------------------------------------------------*/
2138
2139 static int cortex_m_verify_pointer(struct command_context *cmd_ctx,
2140 struct cortex_m_common *cm)
2141 {
2142 if (cm->common_magic != CORTEX_M_COMMON_MAGIC) {
2143 command_print(cmd_ctx, "target is not a Cortex-M");
2144 return ERROR_TARGET_INVALID;
2145 }
2146 return ERROR_OK;
2147 }
2148
2149 /*
2150 * Only stuff below this line should need to verify that its target
2151 * is a Cortex-M3. Everything else should have indirected through the
2152 * cortexm3_target structure, which is only used with CM3 targets.
2153 */
2154
2155 static const struct {
2156 char name[10];
2157 unsigned mask;
2158 } vec_ids[] = {
2159 { "hard_err", VC_HARDERR, },
2160 { "int_err", VC_INTERR, },
2161 { "bus_err", VC_BUSERR, },
2162 { "state_err", VC_STATERR, },
2163 { "chk_err", VC_CHKERR, },
2164 { "nocp_err", VC_NOCPERR, },
2165 { "mm_err", VC_MMERR, },
2166 { "reset", VC_CORERESET, },
2167 };
2168
2169 COMMAND_HANDLER(handle_cortex_m_vector_catch_command)
2170 {
2171 struct target *target = get_current_target(CMD_CTX);
2172 struct cortex_m_common *cortex_m = target_to_cm(target);
2173 struct armv7m_common *armv7m = &cortex_m->armv7m;
2174 struct adiv5_dap *swjdp = armv7m->arm.dap;
2175 uint32_t demcr = 0;
2176 int retval;
2177
2178 retval = cortex_m_verify_pointer(CMD_CTX, cortex_m);
2179 if (retval != ERROR_OK)
2180 return retval;
2181
2182 retval = mem_ap_read_atomic_u32(swjdp, DCB_DEMCR, &demcr);
2183 if (retval != ERROR_OK)
2184 return retval;
2185
2186 if (CMD_ARGC > 0) {
2187 unsigned catch = 0;
2188
2189 if (CMD_ARGC == 1) {
2190 if (strcmp(CMD_ARGV[0], "all") == 0) {
2191 catch = VC_HARDERR | VC_INTERR | VC_BUSERR
2192 | VC_STATERR | VC_CHKERR | VC_NOCPERR
2193 | VC_MMERR | VC_CORERESET;
2194 goto write;
2195 } else if (strcmp(CMD_ARGV[0], "none") == 0)
2196 goto write;
2197 }
2198 while (CMD_ARGC-- > 0) {
2199 unsigned i;
2200 for (i = 0; i < ARRAY_SIZE(vec_ids); i++) {
2201 if (strcmp(CMD_ARGV[CMD_ARGC], vec_ids[i].name) != 0)
2202 continue;
2203 catch |= vec_ids[i].mask;
2204 break;
2205 }
2206 if (i == ARRAY_SIZE(vec_ids)) {
2207 LOG_ERROR("No CM3 vector '%s'", CMD_ARGV[CMD_ARGC]);
2208 return ERROR_COMMAND_SYNTAX_ERROR;
2209 }
2210 }
2211 write:
2212 /* For now, armv7m->demcr only stores vector catch flags. */
2213 armv7m->demcr = catch;
2214
2215 demcr &= ~0xffff;
2216 demcr |= catch;
2217
2218 /* write, but don't assume it stuck (why not??) */
2219 retval = mem_ap_write_u32(swjdp, DCB_DEMCR, demcr);
2220 if (retval != ERROR_OK)
2221 return retval;
2222 retval = mem_ap_read_atomic_u32(swjdp, DCB_DEMCR, &demcr);
2223 if (retval != ERROR_OK)
2224 return retval;
2225
2226 /* FIXME be sure to clear DEMCR on clean server shutdown.
2227 * Otherwise the vector catch hardware could fire when there's
2228 * no debugger hooked up, causing much confusion...
2229 */
2230 }
2231
2232 for (unsigned i = 0; i < ARRAY_SIZE(vec_ids); i++) {
2233 command_print(CMD_CTX, "%9s: %s", vec_ids[i].name,
2234 (demcr & vec_ids[i].mask) ? "catch" : "ignore");
2235 }
2236
2237 return ERROR_OK;
2238 }
2239
2240 COMMAND_HANDLER(handle_cortex_m_mask_interrupts_command)
2241 {
2242 struct target *target = get_current_target(CMD_CTX);
2243 struct cortex_m_common *cortex_m = target_to_cm(target);
2244 int retval;
2245
2246 static const Jim_Nvp nvp_maskisr_modes[] = {
2247 { .name = "auto", .value = CORTEX_M_ISRMASK_AUTO },
2248 { .name = "off", .value = CORTEX_M_ISRMASK_OFF },
2249 { .name = "on", .value = CORTEX_M_ISRMASK_ON },
2250 { .name = NULL, .value = -1 },
2251 };
2252 const Jim_Nvp *n;
2253
2254
2255 retval = cortex_m_verify_pointer(CMD_CTX, cortex_m);
2256 if (retval != ERROR_OK)
2257 return retval;
2258
2259 if (target->state != TARGET_HALTED) {
2260 command_print(CMD_CTX, "target must be stopped for \"%s\" command", CMD_NAME);
2261 return ERROR_OK;
2262 }
2263
2264 if (CMD_ARGC > 0) {
2265 n = Jim_Nvp_name2value_simple(nvp_maskisr_modes, CMD_ARGV[0]);
2266 if (n->name == NULL)
2267 return ERROR_COMMAND_SYNTAX_ERROR;
2268 cortex_m->isrmasking_mode = n->value;
2269
2270
2271 if (cortex_m->isrmasking_mode == CORTEX_M_ISRMASK_ON)
2272 cortex_m_write_debug_halt_mask(target, C_HALT | C_MASKINTS, 0);
2273 else
2274 cortex_m_write_debug_halt_mask(target, C_HALT, C_MASKINTS);
2275 }
2276
2277 n = Jim_Nvp_value2name_simple(nvp_maskisr_modes, cortex_m->isrmasking_mode);
2278 command_print(CMD_CTX, "cortex_m interrupt mask %s", n->name);
2279
2280 return ERROR_OK;
2281 }
2282
2283 COMMAND_HANDLER(handle_cortex_m_reset_config_command)
2284 {
2285 struct target *target = get_current_target(CMD_CTX);
2286 struct cortex_m_common *cortex_m = target_to_cm(target);
2287 int retval;
2288 char *reset_config;
2289
2290 retval = cortex_m_verify_pointer(CMD_CTX, cortex_m);
2291 if (retval != ERROR_OK)
2292 return retval;
2293
2294 if (CMD_ARGC > 0) {
2295 if (strcmp(*CMD_ARGV, "sysresetreq") == 0)
2296 cortex_m->soft_reset_config = CORTEX_M_RESET_SYSRESETREQ;
2297 else if (strcmp(*CMD_ARGV, "vectreset") == 0)
2298 cortex_m->soft_reset_config = CORTEX_M_RESET_VECTRESET;
2299 }
2300
2301 switch (cortex_m->soft_reset_config) {
2302 case CORTEX_M_RESET_SYSRESETREQ:
2303 reset_config = "sysresetreq";
2304 break;
2305
2306 case CORTEX_M_RESET_VECTRESET:
2307 reset_config = "vectreset";
2308 break;
2309
2310 default:
2311 reset_config = "unknown";
2312 break;
2313 }
2314
2315 command_print(CMD_CTX, "cortex_m reset_config %s", reset_config);
2316
2317 return ERROR_OK;
2318 }
2319
2320 static const struct command_registration cortex_m_exec_command_handlers[] = {
2321 {
2322 .name = "maskisr",
2323 .handler = handle_cortex_m_mask_interrupts_command,
2324 .mode = COMMAND_EXEC,
2325 .help = "mask cortex_m interrupts",
2326 .usage = "['auto'|'on'|'off']",
2327 },
2328 {
2329 .name = "vector_catch",
2330 .handler = handle_cortex_m_vector_catch_command,
2331 .mode = COMMAND_EXEC,
2332 .help = "configure hardware vectors to trigger debug entry",
2333 .usage = "['all'|'none'|('bus_err'|'chk_err'|...)*]",
2334 },
2335 {
2336 .name = "reset_config",
2337 .handler = handle_cortex_m_reset_config_command,
2338 .mode = COMMAND_ANY,
2339 .help = "configure software reset handling",
2340 .usage = "['srst'|'sysresetreq'|'vectreset']",
2341 },
2342 COMMAND_REGISTRATION_DONE
2343 };
2344 static const struct command_registration cortex_m_command_handlers[] = {
2345 {
2346 .chain = armv7m_command_handlers,
2347 },
2348 {
2349 .chain = armv7m_trace_command_handlers,
2350 },
2351 {
2352 .name = "cortex_m",
2353 .mode = COMMAND_EXEC,
2354 .help = "Cortex-M command group",
2355 .usage = "",
2356 .chain = cortex_m_exec_command_handlers,
2357 },
2358 COMMAND_REGISTRATION_DONE
2359 };
2360
2361 struct target_type cortexm_target = {
2362 .name = "cortex_m",
2363 .deprecated_name = "cortex_m3",
2364
2365 .poll = cortex_m_poll,
2366 .arch_state = armv7m_arch_state,
2367
2368 .target_request_data = cortex_m_target_request_data,
2369
2370 .halt = cortex_m_halt,
2371 .resume = cortex_m_resume,
2372 .step = cortex_m_step,
2373
2374 .assert_reset = cortex_m_assert_reset,
2375 .deassert_reset = cortex_m_deassert_reset,
2376 .soft_reset_halt = cortex_m_soft_reset_halt,
2377
2378 .get_gdb_reg_list = armv7m_get_gdb_reg_list,
2379
2380 .read_memory = cortex_m_read_memory,
2381 .write_memory = cortex_m_write_memory,
2382 .checksum_memory = armv7m_checksum_memory,
2383 .blank_check_memory = armv7m_blank_check_memory,
2384
2385 .run_algorithm = armv7m_run_algorithm,
2386 .start_algorithm = armv7m_start_algorithm,
2387 .wait_algorithm = armv7m_wait_algorithm,
2388
2389 .add_breakpoint = cortex_m_add_breakpoint,
2390 .remove_breakpoint = cortex_m_remove_breakpoint,
2391 .add_watchpoint = cortex_m_add_watchpoint,
2392 .remove_watchpoint = cortex_m_remove_watchpoint,
2393
2394 .commands = cortex_m_command_handlers,
2395 .target_create = cortex_m_target_create,
2396 .init_target = cortex_m_init_target,
2397 .examine = cortex_m_examine,
2398 .deinit_target = cortex_m_deinit_target,
2399 };
Open On-Chip Debugger

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)