1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * Copyright (C) 2008 by Spencer Oliver *
12 * spen@spen-soft.co.uk *
14 * Copyright (C) 2008 by Rick Altherr *
15 * kc8apf@kc8apf.net> *
17 * Copyright (C) 2011 by Broadcom Corporation *
18 * Evan Hunter - ehunter@broadcom.com *
20 * Copyright (C) ST-Ericsson SA 2011 *
21 * michel.jaouen@stericsson.com : smp minimum support *
23 * Copyright (C) 2011 Andreas Fritiofson *
24 * andreas.fritiofson@gmail.com *
26 * This program is free software; you can redistribute it and/or modify *
27 * it under the terms of the GNU General Public License as published by *
28 * the Free Software Foundation; either version 2 of the License, or *
29 * (at your option) any later version. *
31 * This program is distributed in the hope that it will be useful, *
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
34 * GNU General Public License for more details. *
36 * You should have received a copy of the GNU General Public License *
37 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
38 ***************************************************************************/
44 #include <helper/time_support.h>
45 #include <jtag/jtag.h>
46 #include <flash/nor/core.h>
49 #include "target_type.h"
50 #include "target_request.h"
51 #include "breakpoints.h"
55 #include "rtos/rtos.h"
56 #include "transport/transport.h"
59 /* default halt wait timeout (ms) */
60 #define DEFAULT_HALT_TIMEOUT 5000
62 static int target_read_buffer_default(struct target
*target
, target_addr_t address
,
63 uint32_t count
, uint8_t *buffer
);
64 static int target_write_buffer_default(struct target
*target
, target_addr_t address
,
65 uint32_t count
, const uint8_t *buffer
);
66 static int target_array2mem(Jim_Interp
*interp
, struct target
*target
,
67 int argc
, Jim_Obj
* const *argv
);
68 static int target_mem2array(Jim_Interp
*interp
, struct target
*target
,
69 int argc
, Jim_Obj
* const *argv
);
70 static int target_register_user_commands(struct command_context
*cmd_ctx
);
71 static int target_get_gdb_fileio_info_default(struct target
*target
,
72 struct gdb_fileio_info
*fileio_info
);
73 static int target_gdb_fileio_end_default(struct target
*target
, int retcode
,
74 int fileio_errno
, bool ctrl_c
);
77 extern struct target_type arm7tdmi_target
;
78 extern struct target_type arm720t_target
;
79 extern struct target_type arm9tdmi_target
;
80 extern struct target_type arm920t_target
;
81 extern struct target_type arm966e_target
;
82 extern struct target_type arm946e_target
;
83 extern struct target_type arm926ejs_target
;
84 extern struct target_type fa526_target
;
85 extern struct target_type feroceon_target
;
86 extern struct target_type dragonite_target
;
87 extern struct target_type xscale_target
;
88 extern struct target_type cortexm_target
;
89 extern struct target_type cortexa_target
;
90 extern struct target_type aarch64_target
;
91 extern struct target_type cortexr4_target
;
92 extern struct target_type arm11_target
;
93 extern struct target_type ls1_sap_target
;
94 extern struct target_type mips_m4k_target
;
95 extern struct target_type mips_mips64_target
;
96 extern struct target_type avr_target
;
97 extern struct target_type dsp563xx_target
;
98 extern struct target_type dsp5680xx_target
;
99 extern struct target_type testee_target
;
100 extern struct target_type avr32_ap7k_target
;
101 extern struct target_type hla_target
;
102 extern struct target_type nds32_v2_target
;
103 extern struct target_type nds32_v3_target
;
104 extern struct target_type nds32_v3m_target
;
105 extern struct target_type or1k_target
;
106 extern struct target_type quark_x10xx_target
;
107 extern struct target_type quark_d20xx_target
;
108 extern struct target_type stm8_target
;
109 extern struct target_type riscv_target
;
110 extern struct target_type mem_ap_target
;
111 extern struct target_type esirisc_target
;
112 extern struct target_type arcv2_target
;
114 static struct target_type
*target_types
[] = {
154 struct target
*all_targets
;
155 static struct target_event_callback
*target_event_callbacks
;
156 static struct target_timer_callback
*target_timer_callbacks
;
157 static LIST_HEAD(target_reset_callback_list
);
158 static LIST_HEAD(target_trace_callback_list
);
159 static const int polling_interval
= 100;
161 static const Jim_Nvp nvp_assert
[] = {
162 { .name
= "assert", NVP_ASSERT
},
163 { .name
= "deassert", NVP_DEASSERT
},
164 { .name
= "T", NVP_ASSERT
},
165 { .name
= "F", NVP_DEASSERT
},
166 { .name
= "t", NVP_ASSERT
},
167 { .name
= "f", NVP_DEASSERT
},
168 { .name
= NULL
, .value
= -1 }
171 static const Jim_Nvp nvp_error_target
[] = {
172 { .value
= ERROR_TARGET_INVALID
, .name
= "err-invalid" },
173 { .value
= ERROR_TARGET_INIT_FAILED
, .name
= "err-init-failed" },
174 { .value
= ERROR_TARGET_TIMEOUT
, .name
= "err-timeout" },
175 { .value
= ERROR_TARGET_NOT_HALTED
, .name
= "err-not-halted" },
176 { .value
= ERROR_TARGET_FAILURE
, .name
= "err-failure" },
177 { .value
= ERROR_TARGET_UNALIGNED_ACCESS
, .name
= "err-unaligned-access" },
178 { .value
= ERROR_TARGET_DATA_ABORT
, .name
= "err-data-abort" },
179 { .value
= ERROR_TARGET_RESOURCE_NOT_AVAILABLE
, .name
= "err-resource-not-available" },
180 { .value
= ERROR_TARGET_TRANSLATION_FAULT
, .name
= "err-translation-fault" },
181 { .value
= ERROR_TARGET_NOT_RUNNING
, .name
= "err-not-running" },
182 { .value
= ERROR_TARGET_NOT_EXAMINED
, .name
= "err-not-examined" },
183 { .value
= -1, .name
= NULL
}
186 static const char *target_strerror_safe(int err
)
190 n
= Jim_Nvp_value2name_simple(nvp_error_target
, err
);
197 static const Jim_Nvp nvp_target_event
[] = {
199 { .value
= TARGET_EVENT_GDB_HALT
, .name
= "gdb-halt" },
200 { .value
= TARGET_EVENT_HALTED
, .name
= "halted" },
201 { .value
= TARGET_EVENT_RESUMED
, .name
= "resumed" },
202 { .value
= TARGET_EVENT_RESUME_START
, .name
= "resume-start" },
203 { .value
= TARGET_EVENT_RESUME_END
, .name
= "resume-end" },
204 { .value
= TARGET_EVENT_STEP_START
, .name
= "step-start" },
205 { .value
= TARGET_EVENT_STEP_END
, .name
= "step-end" },
207 { .name
= "gdb-start", .value
= TARGET_EVENT_GDB_START
},
208 { .name
= "gdb-end", .value
= TARGET_EVENT_GDB_END
},
210 { .value
= TARGET_EVENT_RESET_START
, .name
= "reset-start" },
211 { .value
= TARGET_EVENT_RESET_ASSERT_PRE
, .name
= "reset-assert-pre" },
212 { .value
= TARGET_EVENT_RESET_ASSERT
, .name
= "reset-assert" },
213 { .value
= TARGET_EVENT_RESET_ASSERT_POST
, .name
= "reset-assert-post" },
214 { .value
= TARGET_EVENT_RESET_DEASSERT_PRE
, .name
= "reset-deassert-pre" },
215 { .value
= TARGET_EVENT_RESET_DEASSERT_POST
, .name
= "reset-deassert-post" },
216 { .value
= TARGET_EVENT_RESET_INIT
, .name
= "reset-init" },
217 { .value
= TARGET_EVENT_RESET_END
, .name
= "reset-end" },
219 { .value
= TARGET_EVENT_EXAMINE_START
, .name
= "examine-start" },
220 { .value
= TARGET_EVENT_EXAMINE_FAIL
, .name
= "examine-fail" },
221 { .value
= TARGET_EVENT_EXAMINE_END
, .name
= "examine-end" },
223 { .value
= TARGET_EVENT_DEBUG_HALTED
, .name
= "debug-halted" },
224 { .value
= TARGET_EVENT_DEBUG_RESUMED
, .name
= "debug-resumed" },
226 { .value
= TARGET_EVENT_GDB_ATTACH
, .name
= "gdb-attach" },
227 { .value
= TARGET_EVENT_GDB_DETACH
, .name
= "gdb-detach" },
229 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_START
, .name
= "gdb-flash-write-start" },
230 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_END
, .name
= "gdb-flash-write-end" },
232 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_START
, .name
= "gdb-flash-erase-start" },
233 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_END
, .name
= "gdb-flash-erase-end" },
235 { .value
= TARGET_EVENT_TRACE_CONFIG
, .name
= "trace-config" },
237 { .name
= NULL
, .value
= -1 }
240 static const Jim_Nvp nvp_target_state
[] = {
241 { .name
= "unknown", .value
= TARGET_UNKNOWN
},
242 { .name
= "running", .value
= TARGET_RUNNING
},
243 { .name
= "halted", .value
= TARGET_HALTED
},
244 { .name
= "reset", .value
= TARGET_RESET
},
245 { .name
= "debug-running", .value
= TARGET_DEBUG_RUNNING
},
246 { .name
= NULL
, .value
= -1 },
249 static const Jim_Nvp nvp_target_debug_reason
[] = {
250 { .name
= "debug-request", .value
= DBG_REASON_DBGRQ
},
251 { .name
= "breakpoint", .value
= DBG_REASON_BREAKPOINT
},
252 { .name
= "watchpoint", .value
= DBG_REASON_WATCHPOINT
},
253 { .name
= "watchpoint-and-breakpoint", .value
= DBG_REASON_WPTANDBKPT
},
254 { .name
= "single-step", .value
= DBG_REASON_SINGLESTEP
},
255 { .name
= "target-not-halted", .value
= DBG_REASON_NOTHALTED
},
256 { .name
= "program-exit", .value
= DBG_REASON_EXIT
},
257 { .name
= "exception-catch", .value
= DBG_REASON_EXC_CATCH
},
258 { .name
= "undefined", .value
= DBG_REASON_UNDEFINED
},
259 { .name
= NULL
, .value
= -1 },
262 static const Jim_Nvp nvp_target_endian
[] = {
263 { .name
= "big", .value
= TARGET_BIG_ENDIAN
},
264 { .name
= "little", .value
= TARGET_LITTLE_ENDIAN
},
265 { .name
= "be", .value
= TARGET_BIG_ENDIAN
},
266 { .name
= "le", .value
= TARGET_LITTLE_ENDIAN
},
267 { .name
= NULL
, .value
= -1 },
270 static const Jim_Nvp nvp_reset_modes
[] = {
271 { .name
= "unknown", .value
= RESET_UNKNOWN
},
272 { .name
= "run", .value
= RESET_RUN
},
273 { .name
= "halt", .value
= RESET_HALT
},
274 { .name
= "init", .value
= RESET_INIT
},
275 { .name
= NULL
, .value
= -1 },
278 const char *debug_reason_name(struct target
*t
)
282 cp
= Jim_Nvp_value2name_simple(nvp_target_debug_reason
,
283 t
->debug_reason
)->name
;
285 LOG_ERROR("Invalid debug reason: %d", (int)(t
->debug_reason
));
286 cp
= "(*BUG*unknown*BUG*)";
291 const char *target_state_name(struct target
*t
)
294 cp
= Jim_Nvp_value2name_simple(nvp_target_state
, t
->state
)->name
;
296 LOG_ERROR("Invalid target state: %d", (int)(t
->state
));
297 cp
= "(*BUG*unknown*BUG*)";
300 if (!target_was_examined(t
) && t
->defer_examine
)
301 cp
= "examine deferred";
306 const char *target_event_name(enum target_event event
)
309 cp
= Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
;
311 LOG_ERROR("Invalid target event: %d", (int)(event
));
312 cp
= "(*BUG*unknown*BUG*)";
317 const char *target_reset_mode_name(enum target_reset_mode reset_mode
)
320 cp
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
;
322 LOG_ERROR("Invalid target reset mode: %d", (int)(reset_mode
));
323 cp
= "(*BUG*unknown*BUG*)";
328 /* determine the number of the new target */
329 static int new_target_number(void)
334 /* number is 0 based */
338 if (x
< t
->target_number
)
339 x
= t
->target_number
;
345 static void append_to_list_all_targets(struct target
*target
)
347 struct target
**t
= &all_targets
;
354 /* read a uint64_t from a buffer in target memory endianness */
355 uint64_t target_buffer_get_u64(struct target
*target
, const uint8_t *buffer
)
357 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
358 return le_to_h_u64(buffer
);
360 return be_to_h_u64(buffer
);
363 /* read a uint32_t from a buffer in target memory endianness */
364 uint32_t target_buffer_get_u32(struct target
*target
, const uint8_t *buffer
)
366 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
367 return le_to_h_u32(buffer
);
369 return be_to_h_u32(buffer
);
372 /* read a uint24_t from a buffer in target memory endianness */
373 uint32_t target_buffer_get_u24(struct target
*target
, const uint8_t *buffer
)
375 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
376 return le_to_h_u24(buffer
);
378 return be_to_h_u24(buffer
);
381 /* read a uint16_t from a buffer in target memory endianness */
382 uint16_t target_buffer_get_u16(struct target
*target
, const uint8_t *buffer
)
384 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
385 return le_to_h_u16(buffer
);
387 return be_to_h_u16(buffer
);
390 /* write a uint64_t to a buffer in target memory endianness */
391 void target_buffer_set_u64(struct target
*target
, uint8_t *buffer
, uint64_t value
)
393 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
394 h_u64_to_le(buffer
, value
);
396 h_u64_to_be(buffer
, value
);
399 /* write a uint32_t to a buffer in target memory endianness */
400 void target_buffer_set_u32(struct target
*target
, uint8_t *buffer
, uint32_t value
)
402 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
403 h_u32_to_le(buffer
, value
);
405 h_u32_to_be(buffer
, value
);
408 /* write a uint24_t to a buffer in target memory endianness */
409 void target_buffer_set_u24(struct target
*target
, uint8_t *buffer
, uint32_t value
)
411 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
412 h_u24_to_le(buffer
, value
);
414 h_u24_to_be(buffer
, value
);
417 /* write a uint16_t to a buffer in target memory endianness */
418 void target_buffer_set_u16(struct target
*target
, uint8_t *buffer
, uint16_t value
)
420 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
421 h_u16_to_le(buffer
, value
);
423 h_u16_to_be(buffer
, value
);
426 /* write a uint8_t to a buffer in target memory endianness */
427 static void target_buffer_set_u8(struct target
*target
, uint8_t *buffer
, uint8_t value
)
432 /* write a uint64_t array to a buffer in target memory endianness */
433 void target_buffer_get_u64_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint64_t *dstbuf
)
436 for (i
= 0; i
< count
; i
++)
437 dstbuf
[i
] = target_buffer_get_u64(target
, &buffer
[i
* 8]);
440 /* write a uint32_t array to a buffer in target memory endianness */
441 void target_buffer_get_u32_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint32_t *dstbuf
)
444 for (i
= 0; i
< count
; i
++)
445 dstbuf
[i
] = target_buffer_get_u32(target
, &buffer
[i
* 4]);
448 /* write a uint16_t array to a buffer in target memory endianness */
449 void target_buffer_get_u16_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint16_t *dstbuf
)
452 for (i
= 0; i
< count
; i
++)
453 dstbuf
[i
] = target_buffer_get_u16(target
, &buffer
[i
* 2]);
456 /* write a uint64_t array to a buffer in target memory endianness */
457 void target_buffer_set_u64_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint64_t *srcbuf
)
460 for (i
= 0; i
< count
; i
++)
461 target_buffer_set_u64(target
, &buffer
[i
* 8], srcbuf
[i
]);
464 /* write a uint32_t array to a buffer in target memory endianness */
465 void target_buffer_set_u32_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint32_t *srcbuf
)
468 for (i
= 0; i
< count
; i
++)
469 target_buffer_set_u32(target
, &buffer
[i
* 4], srcbuf
[i
]);
472 /* write a uint16_t array to a buffer in target memory endianness */
473 void target_buffer_set_u16_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint16_t *srcbuf
)
476 for (i
= 0; i
< count
; i
++)
477 target_buffer_set_u16(target
, &buffer
[i
* 2], srcbuf
[i
]);
480 /* return a pointer to a configured target; id is name or number */
481 struct target
*get_target(const char *id
)
483 struct target
*target
;
485 /* try as tcltarget name */
486 for (target
= all_targets
; target
; target
= target
->next
) {
487 if (target_name(target
) == NULL
)
489 if (strcmp(id
, target_name(target
)) == 0)
493 /* It's OK to remove this fallback sometime after August 2010 or so */
495 /* no match, try as number */
497 if (parse_uint(id
, &num
) != ERROR_OK
)
500 for (target
= all_targets
; target
; target
= target
->next
) {
501 if (target
->target_number
== (int)num
) {
502 LOG_WARNING("use '%s' as target identifier, not '%u'",
503 target_name(target
), num
);
511 /* returns a pointer to the n-th configured target */
512 struct target
*get_target_by_num(int num
)
514 struct target
*target
= all_targets
;
517 if (target
->target_number
== num
)
519 target
= target
->next
;
525 struct target
*get_current_target(struct command_context
*cmd_ctx
)
527 struct target
*target
= get_current_target_or_null(cmd_ctx
);
529 if (target
== NULL
) {
530 LOG_ERROR("BUG: current_target out of bounds");
537 struct target
*get_current_target_or_null(struct command_context
*cmd_ctx
)
539 return cmd_ctx
->current_target_override
540 ? cmd_ctx
->current_target_override
541 : cmd_ctx
->current_target
;
544 int target_poll(struct target
*target
)
548 /* We can't poll until after examine */
549 if (!target_was_examined(target
)) {
550 /* Fail silently lest we pollute the log */
554 retval
= target
->type
->poll(target
);
555 if (retval
!= ERROR_OK
)
558 if (target
->halt_issued
) {
559 if (target
->state
== TARGET_HALTED
)
560 target
->halt_issued
= false;
562 int64_t t
= timeval_ms() - target
->halt_issued_time
;
563 if (t
> DEFAULT_HALT_TIMEOUT
) {
564 target
->halt_issued
= false;
565 LOG_INFO("Halt timed out, wake up GDB.");
566 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
574 int target_halt(struct target
*target
)
577 /* We can't poll until after examine */
578 if (!target_was_examined(target
)) {
579 LOG_ERROR("Target not examined yet");
583 retval
= target
->type
->halt(target
);
584 if (retval
!= ERROR_OK
)
587 target
->halt_issued
= true;
588 target
->halt_issued_time
= timeval_ms();
594 * Make the target (re)start executing using its saved execution
595 * context (possibly with some modifications).
597 * @param target Which target should start executing.
598 * @param current True to use the target's saved program counter instead
599 * of the address parameter
600 * @param address Optionally used as the program counter.
601 * @param handle_breakpoints True iff breakpoints at the resumption PC
602 * should be skipped. (For example, maybe execution was stopped by
603 * such a breakpoint, in which case it would be counterproductive to
605 * @param debug_execution False if all working areas allocated by OpenOCD
606 * should be released and/or restored to their original contents.
607 * (This would for example be true to run some downloaded "helper"
608 * algorithm code, which resides in one such working buffer and uses
609 * another for data storage.)
611 * @todo Resolve the ambiguity about what the "debug_execution" flag
612 * signifies. For example, Target implementations don't agree on how
613 * it relates to invalidation of the register cache, or to whether
614 * breakpoints and watchpoints should be enabled. (It would seem wrong
615 * to enable breakpoints when running downloaded "helper" algorithms
616 * (debug_execution true), since the breakpoints would be set to match
617 * target firmware being debugged, not the helper algorithm.... and
618 * enabling them could cause such helpers to malfunction (for example,
619 * by overwriting data with a breakpoint instruction. On the other
620 * hand the infrastructure for running such helpers might use this
621 * procedure but rely on hardware breakpoint to detect termination.)
623 int target_resume(struct target
*target
, int current
, target_addr_t address
,
624 int handle_breakpoints
, int debug_execution
)
628 /* We can't poll until after examine */
629 if (!target_was_examined(target
)) {
630 LOG_ERROR("Target not examined yet");
634 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_START
);
636 /* note that resume *must* be asynchronous. The CPU can halt before
637 * we poll. The CPU can even halt at the current PC as a result of
638 * a software breakpoint being inserted by (a bug?) the application.
640 retval
= target
->type
->resume(target
, current
, address
, handle_breakpoints
, debug_execution
);
641 if (retval
!= ERROR_OK
)
644 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_END
);
649 static int target_process_reset(struct command_invocation
*cmd
, enum target_reset_mode reset_mode
)
654 n
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
);
655 if (n
->name
== NULL
) {
656 LOG_ERROR("invalid reset mode");
660 struct target
*target
;
661 for (target
= all_targets
; target
; target
= target
->next
)
662 target_call_reset_callbacks(target
, reset_mode
);
664 /* disable polling during reset to make reset event scripts
665 * more predictable, i.e. dr/irscan & pathmove in events will
666 * not have JTAG operations injected into the middle of a sequence.
668 bool save_poll
= jtag_poll_get_enabled();
670 jtag_poll_set_enabled(false);
672 sprintf(buf
, "ocd_process_reset %s", n
->name
);
673 retval
= Jim_Eval(cmd
->ctx
->interp
, buf
);
675 jtag_poll_set_enabled(save_poll
);
677 if (retval
!= JIM_OK
) {
678 Jim_MakeErrorMessage(cmd
->ctx
->interp
);
679 command_print(cmd
, "%s", Jim_GetString(Jim_GetResult(cmd
->ctx
->interp
), NULL
));
683 /* We want any events to be processed before the prompt */
684 retval
= target_call_timer_callbacks_now();
686 for (target
= all_targets
; target
; target
= target
->next
) {
687 target
->type
->check_reset(target
);
688 target
->running_alg
= false;
694 static int identity_virt2phys(struct target
*target
,
695 target_addr_t
virtual, target_addr_t
*physical
)
701 static int no_mmu(struct target
*target
, int *enabled
)
707 static int default_examine(struct target
*target
)
709 target_set_examined(target
);
713 /* no check by default */
714 static int default_check_reset(struct target
*target
)
719 /* Equivalent Tcl code arp_examine_one is in src/target/startup.tcl
721 int target_examine_one(struct target
*target
)
723 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_START
);
725 int retval
= target
->type
->examine(target
);
726 if (retval
!= ERROR_OK
) {
727 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_FAIL
);
731 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_END
);
736 static int jtag_enable_callback(enum jtag_event event
, void *priv
)
738 struct target
*target
= priv
;
740 if (event
!= JTAG_TAP_EVENT_ENABLE
|| !target
->tap
->enabled
)
743 jtag_unregister_event_callback(jtag_enable_callback
, target
);
745 return target_examine_one(target
);
748 /* Targets that correctly implement init + examine, i.e.
749 * no communication with target during init:
753 int target_examine(void)
755 int retval
= ERROR_OK
;
756 struct target
*target
;
758 for (target
= all_targets
; target
; target
= target
->next
) {
759 /* defer examination, but don't skip it */
760 if (!target
->tap
->enabled
) {
761 jtag_register_event_callback(jtag_enable_callback
,
766 if (target
->defer_examine
)
769 retval
= target_examine_one(target
);
770 if (retval
!= ERROR_OK
)
776 const char *target_type_name(struct target
*target
)
778 return target
->type
->name
;
781 static int target_soft_reset_halt(struct target
*target
)
783 if (!target_was_examined(target
)) {
784 LOG_ERROR("Target not examined yet");
787 if (!target
->type
->soft_reset_halt
) {
788 LOG_ERROR("Target %s does not support soft_reset_halt",
789 target_name(target
));
792 return target
->type
->soft_reset_halt(target
);
796 * Downloads a target-specific native code algorithm to the target,
797 * and executes it. * Note that some targets may need to set up, enable,
798 * and tear down a breakpoint (hard or * soft) to detect algorithm
799 * termination, while others may support lower overhead schemes where
800 * soft breakpoints embedded in the algorithm automatically terminate the
803 * @param target used to run the algorithm
804 * @param arch_info target-specific description of the algorithm.
806 int target_run_algorithm(struct target
*target
,
807 int num_mem_params
, struct mem_param
*mem_params
,
808 int num_reg_params
, struct reg_param
*reg_param
,
809 uint32_t entry_point
, uint32_t exit_point
,
810 int timeout_ms
, void *arch_info
)
812 int retval
= ERROR_FAIL
;
814 if (!target_was_examined(target
)) {
815 LOG_ERROR("Target not examined yet");
818 if (!target
->type
->run_algorithm
) {
819 LOG_ERROR("Target type '%s' does not support %s",
820 target_type_name(target
), __func__
);
824 target
->running_alg
= true;
825 retval
= target
->type
->run_algorithm(target
,
826 num_mem_params
, mem_params
,
827 num_reg_params
, reg_param
,
828 entry_point
, exit_point
, timeout_ms
, arch_info
);
829 target
->running_alg
= false;
836 * Executes a target-specific native code algorithm and leaves it running.
838 * @param target used to run the algorithm
839 * @param arch_info target-specific description of the algorithm.
841 int target_start_algorithm(struct target
*target
,
842 int num_mem_params
, struct mem_param
*mem_params
,
843 int num_reg_params
, struct reg_param
*reg_params
,
844 uint32_t entry_point
, uint32_t exit_point
,
847 int retval
= ERROR_FAIL
;
849 if (!target_was_examined(target
)) {
850 LOG_ERROR("Target not examined yet");
853 if (!target
->type
->start_algorithm
) {
854 LOG_ERROR("Target type '%s' does not support %s",
855 target_type_name(target
), __func__
);
858 if (target
->running_alg
) {
859 LOG_ERROR("Target is already running an algorithm");
863 target
->running_alg
= true;
864 retval
= target
->type
->start_algorithm(target
,
865 num_mem_params
, mem_params
,
866 num_reg_params
, reg_params
,
867 entry_point
, exit_point
, arch_info
);
874 * Waits for an algorithm started with target_start_algorithm() to complete.
876 * @param target used to run the algorithm
877 * @param arch_info target-specific description of the algorithm.
879 int target_wait_algorithm(struct target
*target
,
880 int num_mem_params
, struct mem_param
*mem_params
,
881 int num_reg_params
, struct reg_param
*reg_params
,
882 uint32_t exit_point
, int timeout_ms
,
885 int retval
= ERROR_FAIL
;
887 if (!target
->type
->wait_algorithm
) {
888 LOG_ERROR("Target type '%s' does not support %s",
889 target_type_name(target
), __func__
);
892 if (!target
->running_alg
) {
893 LOG_ERROR("Target is not running an algorithm");
897 retval
= target
->type
->wait_algorithm(target
,
898 num_mem_params
, mem_params
,
899 num_reg_params
, reg_params
,
900 exit_point
, timeout_ms
, arch_info
);
901 if (retval
!= ERROR_TARGET_TIMEOUT
)
902 target
->running_alg
= false;
909 * Streams data to a circular buffer on target intended for consumption by code
910 * running asynchronously on target.
912 * This is intended for applications where target-specific native code runs
913 * on the target, receives data from the circular buffer, does something with
914 * it (most likely writing it to a flash memory), and advances the circular
917 * This assumes that the helper algorithm has already been loaded to the target,
918 * but has not been started yet. Given memory and register parameters are passed
921 * The buffer is defined by (buffer_start, buffer_size) arguments and has the
924 * [buffer_start + 0, buffer_start + 4):
925 * Write Pointer address (aka head). Written and updated by this
926 * routine when new data is written to the circular buffer.
927 * [buffer_start + 4, buffer_start + 8):
928 * Read Pointer address (aka tail). Updated by code running on the
929 * target after it consumes data.
930 * [buffer_start + 8, buffer_start + buffer_size):
931 * Circular buffer contents.
933 * See contrib/loaders/flash/stm32f1x.S for an example.
935 * @param target used to run the algorithm
936 * @param buffer address on the host where data to be sent is located
937 * @param count number of blocks to send
938 * @param block_size size in bytes of each block
939 * @param num_mem_params count of memory-based params to pass to algorithm
940 * @param mem_params memory-based params to pass to algorithm
941 * @param num_reg_params count of register-based params to pass to algorithm
942 * @param reg_params memory-based params to pass to algorithm
943 * @param buffer_start address on the target of the circular buffer structure
944 * @param buffer_size size of the circular buffer structure
945 * @param entry_point address on the target to execute to start the algorithm
946 * @param exit_point address at which to set a breakpoint to catch the
947 * end of the algorithm; can be 0 if target triggers a breakpoint itself
950 int target_run_flash_async_algorithm(struct target
*target
,
951 const uint8_t *buffer
, uint32_t count
, int block_size
,
952 int num_mem_params
, struct mem_param
*mem_params
,
953 int num_reg_params
, struct reg_param
*reg_params
,
954 uint32_t buffer_start
, uint32_t buffer_size
,
955 uint32_t entry_point
, uint32_t exit_point
, void *arch_info
)
960 const uint8_t *buffer_orig
= buffer
;
962 /* Set up working area. First word is write pointer, second word is read pointer,
963 * rest is fifo data area. */
964 uint32_t wp_addr
= buffer_start
;
965 uint32_t rp_addr
= buffer_start
+ 4;
966 uint32_t fifo_start_addr
= buffer_start
+ 8;
967 uint32_t fifo_end_addr
= buffer_start
+ buffer_size
;
969 uint32_t wp
= fifo_start_addr
;
970 uint32_t rp
= fifo_start_addr
;
972 /* validate block_size is 2^n */
973 assert(!block_size
|| !(block_size
& (block_size
- 1)));
975 retval
= target_write_u32(target
, wp_addr
, wp
);
976 if (retval
!= ERROR_OK
)
978 retval
= target_write_u32(target
, rp_addr
, rp
);
979 if (retval
!= ERROR_OK
)
982 /* Start up algorithm on target and let it idle while writing the first chunk */
983 retval
= target_start_algorithm(target
, num_mem_params
, mem_params
,
984 num_reg_params
, reg_params
,
989 if (retval
!= ERROR_OK
) {
990 LOG_ERROR("error starting target flash write algorithm");
996 retval
= target_read_u32(target
, rp_addr
, &rp
);
997 if (retval
!= ERROR_OK
) {
998 LOG_ERROR("failed to get read pointer");
1002 LOG_DEBUG("offs 0x%zx count 0x%" PRIx32
" wp 0x%" PRIx32
" rp 0x%" PRIx32
,
1003 (size_t) (buffer
- buffer_orig
), count
, wp
, rp
);
1006 LOG_ERROR("flash write algorithm aborted by target");
1007 retval
= ERROR_FLASH_OPERATION_FAILED
;
1011 if (((rp
- fifo_start_addr
) & (block_size
- 1)) || rp
< fifo_start_addr
|| rp
>= fifo_end_addr
) {
1012 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32
, rp
);
1016 /* Count the number of bytes available in the fifo without
1017 * crossing the wrap around. Make sure to not fill it completely,
1018 * because that would make wp == rp and that's the empty condition. */
1019 uint32_t thisrun_bytes
;
1021 thisrun_bytes
= rp
- wp
- block_size
;
1022 else if (rp
> fifo_start_addr
)
1023 thisrun_bytes
= fifo_end_addr
- wp
;
1025 thisrun_bytes
= fifo_end_addr
- wp
- block_size
;
1027 if (thisrun_bytes
== 0) {
1028 /* Throttle polling a bit if transfer is (much) faster than flash
1029 * programming. The exact delay shouldn't matter as long as it's
1030 * less than buffer size / flash speed. This is very unlikely to
1031 * run when using high latency connections such as USB. */
1034 /* to stop an infinite loop on some targets check and increment a timeout
1035 * this issue was observed on a stellaris using the new ICDI interface */
1036 if (timeout
++ >= 500) {
1037 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
1038 return ERROR_FLASH_OPERATION_FAILED
;
1043 /* reset our timeout */
1046 /* Limit to the amount of data we actually want to write */
1047 if (thisrun_bytes
> count
* block_size
)
1048 thisrun_bytes
= count
* block_size
;
1050 /* Write data to fifo */
1051 retval
= target_write_buffer(target
, wp
, thisrun_bytes
, buffer
);
1052 if (retval
!= ERROR_OK
)
1055 /* Update counters and wrap write pointer */
1056 buffer
+= thisrun_bytes
;
1057 count
-= thisrun_bytes
/ block_size
;
1058 wp
+= thisrun_bytes
;
1059 if (wp
>= fifo_end_addr
)
1060 wp
= fifo_start_addr
;
1062 /* Store updated write pointer to target */
1063 retval
= target_write_u32(target
, wp_addr
, wp
);
1064 if (retval
!= ERROR_OK
)
1067 /* Avoid GDB timeouts */
1071 if (retval
!= ERROR_OK
) {
1072 /* abort flash write algorithm on target */
1073 target_write_u32(target
, wp_addr
, 0);
1076 int retval2
= target_wait_algorithm(target
, num_mem_params
, mem_params
,
1077 num_reg_params
, reg_params
,
1082 if (retval2
!= ERROR_OK
) {
1083 LOG_ERROR("error waiting for target flash write algorithm");
1087 if (retval
== ERROR_OK
) {
1088 /* check if algorithm set rp = 0 after fifo writer loop finished */
1089 retval
= target_read_u32(target
, rp_addr
, &rp
);
1090 if (retval
== ERROR_OK
&& rp
== 0) {
1091 LOG_ERROR("flash write algorithm aborted by target");
1092 retval
= ERROR_FLASH_OPERATION_FAILED
;
1099 int target_read_memory(struct target
*target
,
1100 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1102 if (!target_was_examined(target
)) {
1103 LOG_ERROR("Target not examined yet");
1106 if (!target
->type
->read_memory
) {
1107 LOG_ERROR("Target %s doesn't support read_memory", target_name(target
));
1110 return target
->type
->read_memory(target
, address
, size
, count
, buffer
);
1113 int target_read_phys_memory(struct target
*target
,
1114 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1116 if (!target_was_examined(target
)) {
1117 LOG_ERROR("Target not examined yet");
1120 if (!target
->type
->read_phys_memory
) {
1121 LOG_ERROR("Target %s doesn't support read_phys_memory", target_name(target
));
1124 return target
->type
->read_phys_memory(target
, address
, size
, count
, buffer
);
1127 int target_write_memory(struct target
*target
,
1128 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
)
1130 if (!target_was_examined(target
)) {
1131 LOG_ERROR("Target not examined yet");
1134 if (!target
->type
->write_memory
) {
1135 LOG_ERROR("Target %s doesn't support write_memory", target_name(target
));
1138 return target
->type
->write_memory(target
, address
, size
, count
, buffer
);
1141 int target_write_phys_memory(struct target
*target
,
1142 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
)
1144 if (!target_was_examined(target
)) {
1145 LOG_ERROR("Target not examined yet");
1148 if (!target
->type
->write_phys_memory
) {
1149 LOG_ERROR("Target %s doesn't support write_phys_memory", target_name(target
));
1152 return target
->type
->write_phys_memory(target
, address
, size
, count
, buffer
);
1155 int target_add_breakpoint(struct target
*target
,
1156 struct breakpoint
*breakpoint
)
1158 if ((target
->state
!= TARGET_HALTED
) && (breakpoint
->type
!= BKPT_HARD
)) {
1159 LOG_WARNING("target %s is not halted (add breakpoint)", target_name(target
));
1160 return ERROR_TARGET_NOT_HALTED
;
1162 return target
->type
->add_breakpoint(target
, breakpoint
);
1165 int target_add_context_breakpoint(struct target
*target
,
1166 struct breakpoint
*breakpoint
)
1168 if (target
->state
!= TARGET_HALTED
) {
1169 LOG_WARNING("target %s is not halted (add context breakpoint)", target_name(target
));
1170 return ERROR_TARGET_NOT_HALTED
;
1172 return target
->type
->add_context_breakpoint(target
, breakpoint
);
1175 int target_add_hybrid_breakpoint(struct target
*target
,
1176 struct breakpoint
*breakpoint
)
1178 if (target
->state
!= TARGET_HALTED
) {
1179 LOG_WARNING("target %s is not halted (add hybrid breakpoint)", target_name(target
));
1180 return ERROR_TARGET_NOT_HALTED
;
1182 return target
->type
->add_hybrid_breakpoint(target
, breakpoint
);
1185 int target_remove_breakpoint(struct target
*target
,
1186 struct breakpoint
*breakpoint
)
1188 return target
->type
->remove_breakpoint(target
, breakpoint
);
1191 int target_add_watchpoint(struct target
*target
,
1192 struct watchpoint
*watchpoint
)
1194 if (target
->state
!= TARGET_HALTED
) {
1195 LOG_WARNING("target %s is not halted (add watchpoint)", target_name(target
));
1196 return ERROR_TARGET_NOT_HALTED
;
1198 return target
->type
->add_watchpoint(target
, watchpoint
);
1200 int target_remove_watchpoint(struct target
*target
,
1201 struct watchpoint
*watchpoint
)
1203 return target
->type
->remove_watchpoint(target
, watchpoint
);
1205 int target_hit_watchpoint(struct target
*target
,
1206 struct watchpoint
**hit_watchpoint
)
1208 if (target
->state
!= TARGET_HALTED
) {
1209 LOG_WARNING("target %s is not halted (hit watchpoint)", target
->cmd_name
);
1210 return ERROR_TARGET_NOT_HALTED
;
1213 if (target
->type
->hit_watchpoint
== NULL
) {
1214 /* For backward compatible, if hit_watchpoint is not implemented,
1215 * return ERROR_FAIL such that gdb_server will not take the nonsense
1220 return target
->type
->hit_watchpoint(target
, hit_watchpoint
);
1223 const char *target_get_gdb_arch(struct target
*target
)
1225 if (target
->type
->get_gdb_arch
== NULL
)
1227 return target
->type
->get_gdb_arch(target
);
1230 int target_get_gdb_reg_list(struct target
*target
,
1231 struct reg
**reg_list
[], int *reg_list_size
,
1232 enum target_register_class reg_class
)
1234 int result
= ERROR_FAIL
;
1236 if (!target_was_examined(target
)) {
1237 LOG_ERROR("Target not examined yet");
1241 result
= target
->type
->get_gdb_reg_list(target
, reg_list
,
1242 reg_list_size
, reg_class
);
1245 if (result
!= ERROR_OK
) {
1252 int target_get_gdb_reg_list_noread(struct target
*target
,
1253 struct reg
**reg_list
[], int *reg_list_size
,
1254 enum target_register_class reg_class
)
1256 if (target
->type
->get_gdb_reg_list_noread
&&
1257 target
->type
->get_gdb_reg_list_noread(target
, reg_list
,
1258 reg_list_size
, reg_class
) == ERROR_OK
)
1260 return target_get_gdb_reg_list(target
, reg_list
, reg_list_size
, reg_class
);
1263 bool target_supports_gdb_connection(struct target
*target
)
1266 * exclude all the targets that don't provide get_gdb_reg_list
1267 * or that have explicit gdb_max_connection == 0
1269 return !!target
->type
->get_gdb_reg_list
&& !!target
->gdb_max_connections
;
1272 int target_step(struct target
*target
,
1273 int current
, target_addr_t address
, int handle_breakpoints
)
1277 target_call_event_callbacks(target
, TARGET_EVENT_STEP_START
);
1279 retval
= target
->type
->step(target
, current
, address
, handle_breakpoints
);
1280 if (retval
!= ERROR_OK
)
1283 target_call_event_callbacks(target
, TARGET_EVENT_STEP_END
);
1288 int target_get_gdb_fileio_info(struct target
*target
, struct gdb_fileio_info
*fileio_info
)
1290 if (target
->state
!= TARGET_HALTED
) {
1291 LOG_WARNING("target %s is not halted (gdb fileio)", target
->cmd_name
);
1292 return ERROR_TARGET_NOT_HALTED
;
1294 return target
->type
->get_gdb_fileio_info(target
, fileio_info
);
1297 int target_gdb_fileio_end(struct target
*target
, int retcode
, int fileio_errno
, bool ctrl_c
)
1299 if (target
->state
!= TARGET_HALTED
) {
1300 LOG_WARNING("target %s is not halted (gdb fileio end)", target
->cmd_name
);
1301 return ERROR_TARGET_NOT_HALTED
;
1303 return target
->type
->gdb_fileio_end(target
, retcode
, fileio_errno
, ctrl_c
);
1306 target_addr_t
target_address_max(struct target
*target
)
1308 unsigned bits
= target_address_bits(target
);
1309 if (sizeof(target_addr_t
) * 8 == bits
)
1310 return (target_addr_t
) -1;
1312 return (((target_addr_t
) 1) << bits
) - 1;
1315 unsigned target_address_bits(struct target
*target
)
1317 if (target
->type
->address_bits
)
1318 return target
->type
->address_bits(target
);
1322 static int target_profiling(struct target
*target
, uint32_t *samples
,
1323 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
1325 return target
->type
->profiling(target
, samples
, max_num_samples
,
1326 num_samples
, seconds
);
1330 * Reset the @c examined flag for the given target.
1331 * Pure paranoia -- targets are zeroed on allocation.
1333 static void target_reset_examined(struct target
*target
)
1335 target
->examined
= false;
1338 static int handle_target(void *priv
);
1340 static int target_init_one(struct command_context
*cmd_ctx
,
1341 struct target
*target
)
1343 target_reset_examined(target
);
1345 struct target_type
*type
= target
->type
;
1346 if (type
->examine
== NULL
)
1347 type
->examine
= default_examine
;
1349 if (type
->check_reset
== NULL
)
1350 type
->check_reset
= default_check_reset
;
1352 assert(type
->init_target
!= NULL
);
1354 int retval
= type
->init_target(cmd_ctx
, target
);
1355 if (ERROR_OK
!= retval
) {
1356 LOG_ERROR("target '%s' init failed", target_name(target
));
1360 /* Sanity-check MMU support ... stub in what we must, to help
1361 * implement it in stages, but warn if we need to do so.
1364 if (type
->virt2phys
== NULL
) {
1365 LOG_ERROR("type '%s' is missing virt2phys", type
->name
);
1366 type
->virt2phys
= identity_virt2phys
;
1369 /* Make sure no-MMU targets all behave the same: make no
1370 * distinction between physical and virtual addresses, and
1371 * ensure that virt2phys() is always an identity mapping.
1373 if (type
->write_phys_memory
|| type
->read_phys_memory
|| type
->virt2phys
)
1374 LOG_WARNING("type '%s' has bad MMU hooks", type
->name
);
1377 type
->write_phys_memory
= type
->write_memory
;
1378 type
->read_phys_memory
= type
->read_memory
;
1379 type
->virt2phys
= identity_virt2phys
;
1382 if (target
->type
->read_buffer
== NULL
)
1383 target
->type
->read_buffer
= target_read_buffer_default
;
1385 if (target
->type
->write_buffer
== NULL
)
1386 target
->type
->write_buffer
= target_write_buffer_default
;
1388 if (target
->type
->get_gdb_fileio_info
== NULL
)
1389 target
->type
->get_gdb_fileio_info
= target_get_gdb_fileio_info_default
;
1391 if (target
->type
->gdb_fileio_end
== NULL
)
1392 target
->type
->gdb_fileio_end
= target_gdb_fileio_end_default
;
1394 if (target
->type
->profiling
== NULL
)
1395 target
->type
->profiling
= target_profiling_default
;
1400 static int target_init(struct command_context
*cmd_ctx
)
1402 struct target
*target
;
1405 for (target
= all_targets
; target
; target
= target
->next
) {
1406 retval
= target_init_one(cmd_ctx
, target
);
1407 if (ERROR_OK
!= retval
)
1414 retval
= target_register_user_commands(cmd_ctx
);
1415 if (ERROR_OK
!= retval
)
1418 retval
= target_register_timer_callback(&handle_target
,
1419 polling_interval
, TARGET_TIMER_TYPE_PERIODIC
, cmd_ctx
->interp
);
1420 if (ERROR_OK
!= retval
)
1426 COMMAND_HANDLER(handle_target_init_command
)
1431 return ERROR_COMMAND_SYNTAX_ERROR
;
1433 static bool target_initialized
;
1434 if (target_initialized
) {
1435 LOG_INFO("'target init' has already been called");
1438 target_initialized
= true;
1440 retval
= command_run_line(CMD_CTX
, "init_targets");
1441 if (ERROR_OK
!= retval
)
1444 retval
= command_run_line(CMD_CTX
, "init_target_events");
1445 if (ERROR_OK
!= retval
)
1448 retval
= command_run_line(CMD_CTX
, "init_board");
1449 if (ERROR_OK
!= retval
)
1452 LOG_DEBUG("Initializing targets...");
1453 return target_init(CMD_CTX
);
1456 int target_register_event_callback(int (*callback
)(struct target
*target
,
1457 enum target_event event
, void *priv
), void *priv
)
1459 struct target_event_callback
**callbacks_p
= &target_event_callbacks
;
1461 if (callback
== NULL
)
1462 return ERROR_COMMAND_SYNTAX_ERROR
;
1465 while ((*callbacks_p
)->next
)
1466 callbacks_p
= &((*callbacks_p
)->next
);
1467 callbacks_p
= &((*callbacks_p
)->next
);
1470 (*callbacks_p
) = malloc(sizeof(struct target_event_callback
));
1471 (*callbacks_p
)->callback
= callback
;
1472 (*callbacks_p
)->priv
= priv
;
1473 (*callbacks_p
)->next
= NULL
;
1478 int target_register_reset_callback(int (*callback
)(struct target
*target
,
1479 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1481 struct target_reset_callback
*entry
;
1483 if (callback
== NULL
)
1484 return ERROR_COMMAND_SYNTAX_ERROR
;
1486 entry
= malloc(sizeof(struct target_reset_callback
));
1487 if (entry
== NULL
) {
1488 LOG_ERROR("error allocating buffer for reset callback entry");
1489 return ERROR_COMMAND_SYNTAX_ERROR
;
1492 entry
->callback
= callback
;
1494 list_add(&entry
->list
, &target_reset_callback_list
);
1500 int target_register_trace_callback(int (*callback
)(struct target
*target
,
1501 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1503 struct target_trace_callback
*entry
;
1505 if (callback
== NULL
)
1506 return ERROR_COMMAND_SYNTAX_ERROR
;
1508 entry
= malloc(sizeof(struct target_trace_callback
));
1509 if (entry
== NULL
) {
1510 LOG_ERROR("error allocating buffer for trace callback entry");
1511 return ERROR_COMMAND_SYNTAX_ERROR
;
1514 entry
->callback
= callback
;
1516 list_add(&entry
->list
, &target_trace_callback_list
);
1522 int target_register_timer_callback(int (*callback
)(void *priv
),
1523 unsigned int time_ms
, enum target_timer_type type
, void *priv
)
1525 struct target_timer_callback
**callbacks_p
= &target_timer_callbacks
;
1527 if (callback
== NULL
)
1528 return ERROR_COMMAND_SYNTAX_ERROR
;
1531 while ((*callbacks_p
)->next
)
1532 callbacks_p
= &((*callbacks_p
)->next
);
1533 callbacks_p
= &((*callbacks_p
)->next
);
1536 (*callbacks_p
) = malloc(sizeof(struct target_timer_callback
));
1537 (*callbacks_p
)->callback
= callback
;
1538 (*callbacks_p
)->type
= type
;
1539 (*callbacks_p
)->time_ms
= time_ms
;
1540 (*callbacks_p
)->removed
= false;
1542 gettimeofday(&(*callbacks_p
)->when
, NULL
);
1543 timeval_add_time(&(*callbacks_p
)->when
, 0, time_ms
* 1000);
1545 (*callbacks_p
)->priv
= priv
;
1546 (*callbacks_p
)->next
= NULL
;
1551 int target_unregister_event_callback(int (*callback
)(struct target
*target
,
1552 enum target_event event
, void *priv
), void *priv
)
1554 struct target_event_callback
**p
= &target_event_callbacks
;
1555 struct target_event_callback
*c
= target_event_callbacks
;
1557 if (callback
== NULL
)
1558 return ERROR_COMMAND_SYNTAX_ERROR
;
1561 struct target_event_callback
*next
= c
->next
;
1562 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1574 int target_unregister_reset_callback(int (*callback
)(struct target
*target
,
1575 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1577 struct target_reset_callback
*entry
;
1579 if (callback
== NULL
)
1580 return ERROR_COMMAND_SYNTAX_ERROR
;
1582 list_for_each_entry(entry
, &target_reset_callback_list
, list
) {
1583 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1584 list_del(&entry
->list
);
1593 int target_unregister_trace_callback(int (*callback
)(struct target
*target
,
1594 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1596 struct target_trace_callback
*entry
;
1598 if (callback
== NULL
)
1599 return ERROR_COMMAND_SYNTAX_ERROR
;
1601 list_for_each_entry(entry
, &target_trace_callback_list
, list
) {
1602 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1603 list_del(&entry
->list
);
1612 int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
)
1614 if (callback
== NULL
)
1615 return ERROR_COMMAND_SYNTAX_ERROR
;
1617 for (struct target_timer_callback
*c
= target_timer_callbacks
;
1619 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1628 int target_call_event_callbacks(struct target
*target
, enum target_event event
)
1630 struct target_event_callback
*callback
= target_event_callbacks
;
1631 struct target_event_callback
*next_callback
;
1633 if (event
== TARGET_EVENT_HALTED
) {
1634 /* execute early halted first */
1635 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
1638 LOG_DEBUG("target event %i (%s) for core %s", event
,
1639 Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
,
1640 target_name(target
));
1642 target_handle_event(target
, event
);
1645 next_callback
= callback
->next
;
1646 callback
->callback(target
, event
, callback
->priv
);
1647 callback
= next_callback
;
1653 int target_call_reset_callbacks(struct target
*target
, enum target_reset_mode reset_mode
)
1655 struct target_reset_callback
*callback
;
1657 LOG_DEBUG("target reset %i (%s)", reset_mode
,
1658 Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
);
1660 list_for_each_entry(callback
, &target_reset_callback_list
, list
)
1661 callback
->callback(target
, reset_mode
, callback
->priv
);
1666 int target_call_trace_callbacks(struct target
*target
, size_t len
, uint8_t *data
)
1668 struct target_trace_callback
*callback
;
1670 list_for_each_entry(callback
, &target_trace_callback_list
, list
)
1671 callback
->callback(target
, len
, data
, callback
->priv
);
1676 static int target_timer_callback_periodic_restart(
1677 struct target_timer_callback
*cb
, struct timeval
*now
)
1680 timeval_add_time(&cb
->when
, 0, cb
->time_ms
* 1000L);
1684 static int target_call_timer_callback(struct target_timer_callback
*cb
,
1685 struct timeval
*now
)
1687 cb
->callback(cb
->priv
);
1689 if (cb
->type
== TARGET_TIMER_TYPE_PERIODIC
)
1690 return target_timer_callback_periodic_restart(cb
, now
);
1692 return target_unregister_timer_callback(cb
->callback
, cb
->priv
);
1695 static int target_call_timer_callbacks_check_time(int checktime
)
1697 static bool callback_processing
;
1699 /* Do not allow nesting */
1700 if (callback_processing
)
1703 callback_processing
= true;
1708 gettimeofday(&now
, NULL
);
1710 /* Store an address of the place containing a pointer to the
1711 * next item; initially, that's a standalone "root of the
1712 * list" variable. */
1713 struct target_timer_callback
**callback
= &target_timer_callbacks
;
1714 while (callback
&& *callback
) {
1715 if ((*callback
)->removed
) {
1716 struct target_timer_callback
*p
= *callback
;
1717 *callback
= (*callback
)->next
;
1722 bool call_it
= (*callback
)->callback
&&
1723 ((!checktime
&& (*callback
)->type
== TARGET_TIMER_TYPE_PERIODIC
) ||
1724 timeval_compare(&now
, &(*callback
)->when
) >= 0);
1727 target_call_timer_callback(*callback
, &now
);
1729 callback
= &(*callback
)->next
;
1732 callback_processing
= false;
1736 int target_call_timer_callbacks(void)
1738 return target_call_timer_callbacks_check_time(1);
1741 /* invoke periodic callbacks immediately */
1742 int target_call_timer_callbacks_now(void)
1744 return target_call_timer_callbacks_check_time(0);
1747 /* Prints the working area layout for debug purposes */
1748 static void print_wa_layout(struct target
*target
)
1750 struct working_area
*c
= target
->working_areas
;
1753 LOG_DEBUG("%c%c " TARGET_ADDR_FMT
"-" TARGET_ADDR_FMT
" (%" PRIu32
" bytes)",
1754 c
->backup
? 'b' : ' ', c
->free
? ' ' : '*',
1755 c
->address
, c
->address
+ c
->size
- 1, c
->size
);
1760 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1761 static void target_split_working_area(struct working_area
*area
, uint32_t size
)
1763 assert(area
->free
); /* Shouldn't split an allocated area */
1764 assert(size
<= area
->size
); /* Caller should guarantee this */
1766 /* Split only if not already the right size */
1767 if (size
< area
->size
) {
1768 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1773 new_wa
->next
= area
->next
;
1774 new_wa
->size
= area
->size
- size
;
1775 new_wa
->address
= area
->address
+ size
;
1776 new_wa
->backup
= NULL
;
1777 new_wa
->user
= NULL
;
1778 new_wa
->free
= true;
1780 area
->next
= new_wa
;
1783 /* If backup memory was allocated to this area, it has the wrong size
1784 * now so free it and it will be reallocated if/when needed */
1786 area
->backup
= NULL
;
1790 /* Merge all adjacent free areas into one */
1791 static void target_merge_working_areas(struct target
*target
)
1793 struct working_area
*c
= target
->working_areas
;
1795 while (c
&& c
->next
) {
1796 assert(c
->next
->address
== c
->address
+ c
->size
); /* This is an invariant */
1798 /* Find two adjacent free areas */
1799 if (c
->free
&& c
->next
->free
) {
1800 /* Merge the last into the first */
1801 c
->size
+= c
->next
->size
;
1803 /* Remove the last */
1804 struct working_area
*to_be_freed
= c
->next
;
1805 c
->next
= c
->next
->next
;
1806 free(to_be_freed
->backup
);
1809 /* If backup memory was allocated to the remaining area, it's has
1810 * the wrong size now */
1819 int target_alloc_working_area_try(struct target
*target
, uint32_t size
, struct working_area
**area
)
1821 /* Reevaluate working area address based on MMU state*/
1822 if (target
->working_areas
== NULL
) {
1826 retval
= target
->type
->mmu(target
, &enabled
);
1827 if (retval
!= ERROR_OK
)
1831 if (target
->working_area_phys_spec
) {
1832 LOG_DEBUG("MMU disabled, using physical "
1833 "address for working memory " TARGET_ADDR_FMT
,
1834 target
->working_area_phys
);
1835 target
->working_area
= target
->working_area_phys
;
1837 LOG_ERROR("No working memory available. "
1838 "Specify -work-area-phys to target.");
1839 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1842 if (target
->working_area_virt_spec
) {
1843 LOG_DEBUG("MMU enabled, using virtual "
1844 "address for working memory " TARGET_ADDR_FMT
,
1845 target
->working_area_virt
);
1846 target
->working_area
= target
->working_area_virt
;
1848 LOG_ERROR("No working memory available. "
1849 "Specify -work-area-virt to target.");
1850 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1854 /* Set up initial working area on first call */
1855 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1857 new_wa
->next
= NULL
;
1858 new_wa
->size
= target
->working_area_size
& ~3UL; /* 4-byte align */
1859 new_wa
->address
= target
->working_area
;
1860 new_wa
->backup
= NULL
;
1861 new_wa
->user
= NULL
;
1862 new_wa
->free
= true;
1865 target
->working_areas
= new_wa
;
1868 /* only allocate multiples of 4 byte */
1870 size
= (size
+ 3) & (~3UL);
1872 struct working_area
*c
= target
->working_areas
;
1874 /* Find the first large enough working area */
1876 if (c
->free
&& c
->size
>= size
)
1882 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1884 /* Split the working area into the requested size */
1885 target_split_working_area(c
, size
);
1887 LOG_DEBUG("allocated new working area of %" PRIu32
" bytes at address " TARGET_ADDR_FMT
,
1890 if (target
->backup_working_area
) {
1891 if (c
->backup
== NULL
) {
1892 c
->backup
= malloc(c
->size
);
1893 if (c
->backup
== NULL
)
1897 int retval
= target_read_memory(target
, c
->address
, 4, c
->size
/ 4, c
->backup
);
1898 if (retval
!= ERROR_OK
)
1902 /* mark as used, and return the new (reused) area */
1909 print_wa_layout(target
);
1914 int target_alloc_working_area(struct target
*target
, uint32_t size
, struct working_area
**area
)
1918 retval
= target_alloc_working_area_try(target
, size
, area
);
1919 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
)
1920 LOG_WARNING("not enough working area available(requested %"PRIu32
")", size
);
1925 static int target_restore_working_area(struct target
*target
, struct working_area
*area
)
1927 int retval
= ERROR_OK
;
1929 if (target
->backup_working_area
&& area
->backup
!= NULL
) {
1930 retval
= target_write_memory(target
, area
->address
, 4, area
->size
/ 4, area
->backup
);
1931 if (retval
!= ERROR_OK
)
1932 LOG_ERROR("failed to restore %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1933 area
->size
, area
->address
);
1939 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1940 static int target_free_working_area_restore(struct target
*target
, struct working_area
*area
, int restore
)
1942 int retval
= ERROR_OK
;
1948 retval
= target_restore_working_area(target
, area
);
1949 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1950 if (retval
!= ERROR_OK
)
1956 LOG_DEBUG("freed %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1957 area
->size
, area
->address
);
1959 /* mark user pointer invalid */
1960 /* TODO: Is this really safe? It points to some previous caller's memory.
1961 * How could we know that the area pointer is still in that place and not
1962 * some other vital data? What's the purpose of this, anyway? */
1966 target_merge_working_areas(target
);
1968 print_wa_layout(target
);
1973 int target_free_working_area(struct target
*target
, struct working_area
*area
)
1975 return target_free_working_area_restore(target
, area
, 1);
1978 /* free resources and restore memory, if restoring memory fails,
1979 * free up resources anyway
1981 static void target_free_all_working_areas_restore(struct target
*target
, int restore
)
1983 struct working_area
*c
= target
->working_areas
;
1985 LOG_DEBUG("freeing all working areas");
1987 /* Loop through all areas, restoring the allocated ones and marking them as free */
1991 target_restore_working_area(target
, c
);
1993 *c
->user
= NULL
; /* Same as above */
1999 /* Run a merge pass to combine all areas into one */
2000 target_merge_working_areas(target
);
2002 print_wa_layout(target
);
2005 void target_free_all_working_areas(struct target
*target
)
2007 target_free_all_working_areas_restore(target
, 1);
2009 /* Now we have none or only one working area marked as free */
2010 if (target
->working_areas
) {
2011 /* Free the last one to allow on-the-fly moving and resizing */
2012 free(target
->working_areas
->backup
);
2013 free(target
->working_areas
);
2014 target
->working_areas
= NULL
;
2018 /* Find the largest number of bytes that can be allocated */
2019 uint32_t target_get_working_area_avail(struct target
*target
)
2021 struct working_area
*c
= target
->working_areas
;
2022 uint32_t max_size
= 0;
2025 return target
->working_area_size
;
2028 if (c
->free
&& max_size
< c
->size
)
2037 static void target_destroy(struct target
*target
)
2039 if (target
->type
->deinit_target
)
2040 target
->type
->deinit_target(target
);
2042 free(target
->semihosting
);
2044 jtag_unregister_event_callback(jtag_enable_callback
, target
);
2046 struct target_event_action
*teap
= target
->event_action
;
2048 struct target_event_action
*next
= teap
->next
;
2049 Jim_DecrRefCount(teap
->interp
, teap
->body
);
2054 target_free_all_working_areas(target
);
2056 /* release the targets SMP list */
2058 struct target_list
*head
= target
->head
;
2059 while (head
!= NULL
) {
2060 struct target_list
*pos
= head
->next
;
2061 head
->target
->smp
= 0;
2068 rtos_destroy(target
);
2070 free(target
->gdb_port_override
);
2072 free(target
->trace_info
);
2073 free(target
->fileio_info
);
2074 free(target
->cmd_name
);
2078 void target_quit(void)
2080 struct target_event_callback
*pe
= target_event_callbacks
;
2082 struct target_event_callback
*t
= pe
->next
;
2086 target_event_callbacks
= NULL
;
2088 struct target_timer_callback
*pt
= target_timer_callbacks
;
2090 struct target_timer_callback
*t
= pt
->next
;
2094 target_timer_callbacks
= NULL
;
2096 for (struct target
*target
= all_targets
; target
;) {
2100 target_destroy(target
);
2107 int target_arch_state(struct target
*target
)
2110 if (target
== NULL
) {
2111 LOG_WARNING("No target has been configured");
2115 if (target
->state
!= TARGET_HALTED
)
2118 retval
= target
->type
->arch_state(target
);
2122 static int target_get_gdb_fileio_info_default(struct target
*target
,
2123 struct gdb_fileio_info
*fileio_info
)
2125 /* If target does not support semi-hosting function, target
2126 has no need to provide .get_gdb_fileio_info callback.
2127 It just return ERROR_FAIL and gdb_server will return "Txx"
2128 as target halted every time. */
2132 static int target_gdb_fileio_end_default(struct target
*target
,
2133 int retcode
, int fileio_errno
, bool ctrl_c
)
2138 int target_profiling_default(struct target
*target
, uint32_t *samples
,
2139 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
2141 struct timeval timeout
, now
;
2143 gettimeofday(&timeout
, NULL
);
2144 timeval_add_time(&timeout
, seconds
, 0);
2146 LOG_INFO("Starting profiling. Halting and resuming the"
2147 " target as often as we can...");
2149 uint32_t sample_count
= 0;
2150 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
2151 struct reg
*reg
= register_get_by_name(target
->reg_cache
, "pc", 1);
2153 int retval
= ERROR_OK
;
2155 target_poll(target
);
2156 if (target
->state
== TARGET_HALTED
) {
2157 uint32_t t
= buf_get_u32(reg
->value
, 0, 32);
2158 samples
[sample_count
++] = t
;
2159 /* current pc, addr = 0, do not handle breakpoints, not debugging */
2160 retval
= target_resume(target
, 1, 0, 0, 0);
2161 target_poll(target
);
2162 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
2163 } else if (target
->state
== TARGET_RUNNING
) {
2164 /* We want to quickly sample the PC. */
2165 retval
= target_halt(target
);
2167 LOG_INFO("Target not halted or running");
2172 if (retval
!= ERROR_OK
)
2175 gettimeofday(&now
, NULL
);
2176 if ((sample_count
>= max_num_samples
) || timeval_compare(&now
, &timeout
) >= 0) {
2177 LOG_INFO("Profiling completed. %" PRIu32
" samples.", sample_count
);
2182 *num_samples
= sample_count
;
2186 /* Single aligned words are guaranteed to use 16 or 32 bit access
2187 * mode respectively, otherwise data is handled as quickly as
2190 int target_write_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, const uint8_t *buffer
)
2192 LOG_DEBUG("writing buffer of %" PRIu32
" byte at " TARGET_ADDR_FMT
,
2195 if (!target_was_examined(target
)) {
2196 LOG_ERROR("Target not examined yet");
2203 if ((address
+ size
- 1) < address
) {
2204 /* GDB can request this when e.g. PC is 0xfffffffc */
2205 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2211 return target
->type
->write_buffer(target
, address
, size
, buffer
);
2214 static int target_write_buffer_default(struct target
*target
,
2215 target_addr_t address
, uint32_t count
, const uint8_t *buffer
)
2219 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2220 * will have something to do with the size we leave to it. */
2221 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2222 if (address
& size
) {
2223 int retval
= target_write_memory(target
, address
, size
, 1, buffer
);
2224 if (retval
!= ERROR_OK
)
2232 /* Write the data with as large access size as possible. */
2233 for (; size
> 0; size
/= 2) {
2234 uint32_t aligned
= count
- count
% size
;
2236 int retval
= target_write_memory(target
, address
, size
, aligned
/ size
, buffer
);
2237 if (retval
!= ERROR_OK
)
2248 /* Single aligned words are guaranteed to use 16 or 32 bit access
2249 * mode respectively, otherwise data is handled as quickly as
2252 int target_read_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, uint8_t *buffer
)
2254 LOG_DEBUG("reading buffer of %" PRIu32
" byte at " TARGET_ADDR_FMT
,
2257 if (!target_was_examined(target
)) {
2258 LOG_ERROR("Target not examined yet");
2265 if ((address
+ size
- 1) < address
) {
2266 /* GDB can request this when e.g. PC is 0xfffffffc */
2267 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2273 return target
->type
->read_buffer(target
, address
, size
, buffer
);
2276 static int target_read_buffer_default(struct target
*target
, target_addr_t address
, uint32_t count
, uint8_t *buffer
)
2280 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2281 * will have something to do with the size we leave to it. */
2282 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2283 if (address
& size
) {
2284 int retval
= target_read_memory(target
, address
, size
, 1, buffer
);
2285 if (retval
!= ERROR_OK
)
2293 /* Read the data with as large access size as possible. */
2294 for (; size
> 0; size
/= 2) {
2295 uint32_t aligned
= count
- count
% size
;
2297 int retval
= target_read_memory(target
, address
, size
, aligned
/ size
, buffer
);
2298 if (retval
!= ERROR_OK
)
2309 int target_checksum_memory(struct target
*target
, target_addr_t address
, uint32_t size
, uint32_t *crc
)
2314 uint32_t checksum
= 0;
2315 if (!target_was_examined(target
)) {
2316 LOG_ERROR("Target not examined yet");
2320 retval
= target
->type
->checksum_memory(target
, address
, size
, &checksum
);
2321 if (retval
!= ERROR_OK
) {
2322 buffer
= malloc(size
);
2323 if (buffer
== NULL
) {
2324 LOG_ERROR("error allocating buffer for section (%" PRIu32
" bytes)", size
);
2325 return ERROR_COMMAND_SYNTAX_ERROR
;
2327 retval
= target_read_buffer(target
, address
, size
, buffer
);
2328 if (retval
!= ERROR_OK
) {
2333 /* convert to target endianness */
2334 for (i
= 0; i
< (size
/sizeof(uint32_t)); i
++) {
2335 uint32_t target_data
;
2336 target_data
= target_buffer_get_u32(target
, &buffer
[i
*sizeof(uint32_t)]);
2337 target_buffer_set_u32(target
, &buffer
[i
*sizeof(uint32_t)], target_data
);
2340 retval
= image_calculate_checksum(buffer
, size
, &checksum
);
2349 int target_blank_check_memory(struct target
*target
,
2350 struct target_memory_check_block
*blocks
, int num_blocks
,
2351 uint8_t erased_value
)
2353 if (!target_was_examined(target
)) {
2354 LOG_ERROR("Target not examined yet");
2358 if (target
->type
->blank_check_memory
== NULL
)
2359 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
2361 return target
->type
->blank_check_memory(target
, blocks
, num_blocks
, erased_value
);
2364 int target_read_u64(struct target
*target
, target_addr_t address
, uint64_t *value
)
2366 uint8_t value_buf
[8];
2367 if (!target_was_examined(target
)) {
2368 LOG_ERROR("Target not examined yet");
2372 int retval
= target_read_memory(target
, address
, 8, 1, value_buf
);
2374 if (retval
== ERROR_OK
) {
2375 *value
= target_buffer_get_u64(target
, value_buf
);
2376 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2381 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2388 int target_read_u32(struct target
*target
, target_addr_t address
, uint32_t *value
)
2390 uint8_t value_buf
[4];
2391 if (!target_was_examined(target
)) {
2392 LOG_ERROR("Target not examined yet");
2396 int retval
= target_read_memory(target
, address
, 4, 1, value_buf
);
2398 if (retval
== ERROR_OK
) {
2399 *value
= target_buffer_get_u32(target
, value_buf
);
2400 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2405 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2412 int target_read_u16(struct target
*target
, target_addr_t address
, uint16_t *value
)
2414 uint8_t value_buf
[2];
2415 if (!target_was_examined(target
)) {
2416 LOG_ERROR("Target not examined yet");
2420 int retval
= target_read_memory(target
, address
, 2, 1, value_buf
);
2422 if (retval
== ERROR_OK
) {
2423 *value
= target_buffer_get_u16(target
, value_buf
);
2424 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%4.4" PRIx16
,
2429 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2436 int target_read_u8(struct target
*target
, target_addr_t address
, uint8_t *value
)
2438 if (!target_was_examined(target
)) {
2439 LOG_ERROR("Target not examined yet");
2443 int retval
= target_read_memory(target
, address
, 1, 1, value
);
2445 if (retval
== ERROR_OK
) {
2446 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2451 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2458 int target_write_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2461 uint8_t value_buf
[8];
2462 if (!target_was_examined(target
)) {
2463 LOG_ERROR("Target not examined yet");
2467 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2471 target_buffer_set_u64(target
, value_buf
, value
);
2472 retval
= target_write_memory(target
, address
, 8, 1, value_buf
);
2473 if (retval
!= ERROR_OK
)
2474 LOG_DEBUG("failed: %i", retval
);
2479 int target_write_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2482 uint8_t value_buf
[4];
2483 if (!target_was_examined(target
)) {
2484 LOG_ERROR("Target not examined yet");
2488 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2492 target_buffer_set_u32(target
, value_buf
, value
);
2493 retval
= target_write_memory(target
, address
, 4, 1, value_buf
);
2494 if (retval
!= ERROR_OK
)
2495 LOG_DEBUG("failed: %i", retval
);
2500 int target_write_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2503 uint8_t value_buf
[2];
2504 if (!target_was_examined(target
)) {
2505 LOG_ERROR("Target not examined yet");
2509 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2513 target_buffer_set_u16(target
, value_buf
, value
);
2514 retval
= target_write_memory(target
, address
, 2, 1, value_buf
);
2515 if (retval
!= ERROR_OK
)
2516 LOG_DEBUG("failed: %i", retval
);
2521 int target_write_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2524 if (!target_was_examined(target
)) {
2525 LOG_ERROR("Target not examined yet");
2529 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2532 retval
= target_write_memory(target
, address
, 1, 1, &value
);
2533 if (retval
!= ERROR_OK
)
2534 LOG_DEBUG("failed: %i", retval
);
2539 int target_write_phys_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2542 uint8_t value_buf
[8];
2543 if (!target_was_examined(target
)) {
2544 LOG_ERROR("Target not examined yet");
2548 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2552 target_buffer_set_u64(target
, value_buf
, value
);
2553 retval
= target_write_phys_memory(target
, address
, 8, 1, value_buf
);
2554 if (retval
!= ERROR_OK
)
2555 LOG_DEBUG("failed: %i", retval
);
2560 int target_write_phys_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2563 uint8_t value_buf
[4];
2564 if (!target_was_examined(target
)) {
2565 LOG_ERROR("Target not examined yet");
2569 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2573 target_buffer_set_u32(target
, value_buf
, value
);
2574 retval
= target_write_phys_memory(target
, address
, 4, 1, value_buf
);
2575 if (retval
!= ERROR_OK
)
2576 LOG_DEBUG("failed: %i", retval
);
2581 int target_write_phys_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2584 uint8_t value_buf
[2];
2585 if (!target_was_examined(target
)) {
2586 LOG_ERROR("Target not examined yet");
2590 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2594 target_buffer_set_u16(target
, value_buf
, value
);
2595 retval
= target_write_phys_memory(target
, address
, 2, 1, value_buf
);
2596 if (retval
!= ERROR_OK
)
2597 LOG_DEBUG("failed: %i", retval
);
2602 int target_write_phys_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2605 if (!target_was_examined(target
)) {
2606 LOG_ERROR("Target not examined yet");
2610 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2613 retval
= target_write_phys_memory(target
, address
, 1, 1, &value
);
2614 if (retval
!= ERROR_OK
)
2615 LOG_DEBUG("failed: %i", retval
);
2620 static int find_target(struct command_invocation
*cmd
, const char *name
)
2622 struct target
*target
= get_target(name
);
2623 if (target
== NULL
) {
2624 command_print(cmd
, "Target: %s is unknown, try one of:\n", name
);
2627 if (!target
->tap
->enabled
) {
2628 command_print(cmd
, "Target: TAP %s is disabled, "
2629 "can't be the current target\n",
2630 target
->tap
->dotted_name
);
2634 cmd
->ctx
->current_target
= target
;
2635 if (cmd
->ctx
->current_target_override
)
2636 cmd
->ctx
->current_target_override
= target
;
2642 COMMAND_HANDLER(handle_targets_command
)
2644 int retval
= ERROR_OK
;
2645 if (CMD_ARGC
== 1) {
2646 retval
= find_target(CMD
, CMD_ARGV
[0]);
2647 if (retval
== ERROR_OK
) {
2653 struct target
*target
= all_targets
;
2654 command_print(CMD
, " TargetName Type Endian TapName State ");
2655 command_print(CMD
, "-- ------------------ ---------- ------ ------------------ ------------");
2660 if (target
->tap
->enabled
)
2661 state
= target_state_name(target
);
2663 state
= "tap-disabled";
2665 if (CMD_CTX
->current_target
== target
)
2668 /* keep columns lined up to match the headers above */
2670 "%2d%c %-18s %-10s %-6s %-18s %s",
2671 target
->target_number
,
2673 target_name(target
),
2674 target_type_name(target
),
2675 Jim_Nvp_value2name_simple(nvp_target_endian
,
2676 target
->endianness
)->name
,
2677 target
->tap
->dotted_name
,
2679 target
= target
->next
;
2685 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2687 static int powerDropout
;
2688 static int srstAsserted
;
2690 static int runPowerRestore
;
2691 static int runPowerDropout
;
2692 static int runSrstAsserted
;
2693 static int runSrstDeasserted
;
2695 static int sense_handler(void)
2697 static int prevSrstAsserted
;
2698 static int prevPowerdropout
;
2700 int retval
= jtag_power_dropout(&powerDropout
);
2701 if (retval
!= ERROR_OK
)
2705 powerRestored
= prevPowerdropout
&& !powerDropout
;
2707 runPowerRestore
= 1;
2709 int64_t current
= timeval_ms();
2710 static int64_t lastPower
;
2711 bool waitMore
= lastPower
+ 2000 > current
;
2712 if (powerDropout
&& !waitMore
) {
2713 runPowerDropout
= 1;
2714 lastPower
= current
;
2717 retval
= jtag_srst_asserted(&srstAsserted
);
2718 if (retval
!= ERROR_OK
)
2722 srstDeasserted
= prevSrstAsserted
&& !srstAsserted
;
2724 static int64_t lastSrst
;
2725 waitMore
= lastSrst
+ 2000 > current
;
2726 if (srstDeasserted
&& !waitMore
) {
2727 runSrstDeasserted
= 1;
2731 if (!prevSrstAsserted
&& srstAsserted
)
2732 runSrstAsserted
= 1;
2734 prevSrstAsserted
= srstAsserted
;
2735 prevPowerdropout
= powerDropout
;
2737 if (srstDeasserted
|| powerRestored
) {
2738 /* Other than logging the event we can't do anything here.
2739 * Issuing a reset is a particularly bad idea as we might
2740 * be inside a reset already.
2747 /* process target state changes */
2748 static int handle_target(void *priv
)
2750 Jim_Interp
*interp
= (Jim_Interp
*)priv
;
2751 int retval
= ERROR_OK
;
2753 if (!is_jtag_poll_safe()) {
2754 /* polling is disabled currently */
2758 /* we do not want to recurse here... */
2759 static int recursive
;
2763 /* danger! running these procedures can trigger srst assertions and power dropouts.
2764 * We need to avoid an infinite loop/recursion here and we do that by
2765 * clearing the flags after running these events.
2767 int did_something
= 0;
2768 if (runSrstAsserted
) {
2769 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2770 Jim_Eval(interp
, "srst_asserted");
2773 if (runSrstDeasserted
) {
2774 Jim_Eval(interp
, "srst_deasserted");
2777 if (runPowerDropout
) {
2778 LOG_INFO("Power dropout detected, running power_dropout proc.");
2779 Jim_Eval(interp
, "power_dropout");
2782 if (runPowerRestore
) {
2783 Jim_Eval(interp
, "power_restore");
2787 if (did_something
) {
2788 /* clear detect flags */
2792 /* clear action flags */
2794 runSrstAsserted
= 0;
2795 runSrstDeasserted
= 0;
2796 runPowerRestore
= 0;
2797 runPowerDropout
= 0;
2802 /* Poll targets for state changes unless that's globally disabled.
2803 * Skip targets that are currently disabled.
2805 for (struct target
*target
= all_targets
;
2806 is_jtag_poll_safe() && target
;
2807 target
= target
->next
) {
2809 if (!target_was_examined(target
))
2812 if (!target
->tap
->enabled
)
2815 if (target
->backoff
.times
> target
->backoff
.count
) {
2816 /* do not poll this time as we failed previously */
2817 target
->backoff
.count
++;
2820 target
->backoff
.count
= 0;
2822 /* only poll target if we've got power and srst isn't asserted */
2823 if (!powerDropout
&& !srstAsserted
) {
2824 /* polling may fail silently until the target has been examined */
2825 retval
= target_poll(target
);
2826 if (retval
!= ERROR_OK
) {
2827 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2828 if (target
->backoff
.times
* polling_interval
< 5000) {
2829 target
->backoff
.times
*= 2;
2830 target
->backoff
.times
++;
2833 /* Tell GDB to halt the debugger. This allows the user to
2834 * run monitor commands to handle the situation.
2836 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2838 if (target
->backoff
.times
> 0) {
2839 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target
));
2840 target_reset_examined(target
);
2841 retval
= target_examine_one(target
);
2842 /* Target examination could have failed due to unstable connection,
2843 * but we set the examined flag anyway to repoll it later */
2844 if (retval
!= ERROR_OK
) {
2845 target
->examined
= true;
2846 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2847 target
->backoff
.times
* polling_interval
);
2852 /* Since we succeeded, we reset backoff count */
2853 target
->backoff
.times
= 0;
2860 COMMAND_HANDLER(handle_reg_command
)
2862 struct target
*target
;
2863 struct reg
*reg
= NULL
;
2869 target
= get_current_target(CMD_CTX
);
2871 /* list all available registers for the current target */
2872 if (CMD_ARGC
== 0) {
2873 struct reg_cache
*cache
= target
->reg_cache
;
2879 command_print(CMD
, "===== %s", cache
->name
);
2881 for (i
= 0, reg
= cache
->reg_list
;
2882 i
< cache
->num_regs
;
2883 i
++, reg
++, count
++) {
2884 if (reg
->exist
== false)
2886 /* only print cached values if they are valid */
2888 value
= buf_to_hex_str(reg
->value
,
2891 "(%i) %s (/%" PRIu32
"): 0x%s%s",
2899 command_print(CMD
, "(%i) %s (/%" PRIu32
")",
2904 cache
= cache
->next
;
2910 /* access a single register by its ordinal number */
2911 if ((CMD_ARGV
[0][0] >= '0') && (CMD_ARGV
[0][0] <= '9')) {
2913 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num
);
2915 struct reg_cache
*cache
= target
->reg_cache
;
2919 for (i
= 0; i
< cache
->num_regs
; i
++) {
2920 if (count
++ == num
) {
2921 reg
= &cache
->reg_list
[i
];
2927 cache
= cache
->next
;
2931 command_print(CMD
, "%i is out of bounds, the current target "
2932 "has only %i registers (0 - %i)", num
, count
, count
- 1);
2936 /* access a single register by its name */
2937 reg
= register_get_by_name(target
->reg_cache
, CMD_ARGV
[0], 1);
2943 assert(reg
!= NULL
); /* give clang a hint that we *know* reg is != NULL here */
2948 /* display a register */
2949 if ((CMD_ARGC
== 1) || ((CMD_ARGC
== 2) && !((CMD_ARGV
[1][0] >= '0')
2950 && (CMD_ARGV
[1][0] <= '9')))) {
2951 if ((CMD_ARGC
== 2) && (strcmp(CMD_ARGV
[1], "force") == 0))
2954 if (reg
->valid
== 0)
2955 reg
->type
->get(reg
);
2956 value
= buf_to_hex_str(reg
->value
, reg
->size
);
2957 command_print(CMD
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2962 /* set register value */
2963 if (CMD_ARGC
== 2) {
2964 uint8_t *buf
= malloc(DIV_ROUND_UP(reg
->size
, 8));
2967 str_to_buf(CMD_ARGV
[1], strlen(CMD_ARGV
[1]), buf
, reg
->size
, 0);
2969 reg
->type
->set(reg
, buf
);
2971 value
= buf_to_hex_str(reg
->value
, reg
->size
);
2972 command_print(CMD
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2980 return ERROR_COMMAND_SYNTAX_ERROR
;
2983 command_print(CMD
, "register %s not found in current target", CMD_ARGV
[0]);
2987 COMMAND_HANDLER(handle_poll_command
)
2989 int retval
= ERROR_OK
;
2990 struct target
*target
= get_current_target(CMD_CTX
);
2992 if (CMD_ARGC
== 0) {
2993 command_print(CMD
, "background polling: %s",
2994 jtag_poll_get_enabled() ? "on" : "off");
2995 command_print(CMD
, "TAP: %s (%s)",
2996 target
->tap
->dotted_name
,
2997 target
->tap
->enabled
? "enabled" : "disabled");
2998 if (!target
->tap
->enabled
)
3000 retval
= target_poll(target
);
3001 if (retval
!= ERROR_OK
)
3003 retval
= target_arch_state(target
);
3004 if (retval
!= ERROR_OK
)
3006 } else if (CMD_ARGC
== 1) {
3008 COMMAND_PARSE_ON_OFF(CMD_ARGV
[0], enable
);
3009 jtag_poll_set_enabled(enable
);
3011 return ERROR_COMMAND_SYNTAX_ERROR
;
3016 COMMAND_HANDLER(handle_wait_halt_command
)
3019 return ERROR_COMMAND_SYNTAX_ERROR
;
3021 unsigned ms
= DEFAULT_HALT_TIMEOUT
;
3022 if (1 == CMD_ARGC
) {
3023 int retval
= parse_uint(CMD_ARGV
[0], &ms
);
3024 if (ERROR_OK
!= retval
)
3025 return ERROR_COMMAND_SYNTAX_ERROR
;
3028 struct target
*target
= get_current_target(CMD_CTX
);
3029 return target_wait_state(target
, TARGET_HALTED
, ms
);
3032 /* wait for target state to change. The trick here is to have a low
3033 * latency for short waits and not to suck up all the CPU time
3036 * After 500ms, keep_alive() is invoked
3038 int target_wait_state(struct target
*target
, enum target_state state
, int ms
)
3041 int64_t then
= 0, cur
;
3045 retval
= target_poll(target
);
3046 if (retval
!= ERROR_OK
)
3048 if (target
->state
== state
)
3053 then
= timeval_ms();
3054 LOG_DEBUG("waiting for target %s...",
3055 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
3061 if ((cur
-then
) > ms
) {
3062 LOG_ERROR("timed out while waiting for target %s",
3063 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
3071 COMMAND_HANDLER(handle_halt_command
)
3075 struct target
*target
= get_current_target(CMD_CTX
);
3077 target
->verbose_halt_msg
= true;
3079 int retval
= target_halt(target
);
3080 if (ERROR_OK
!= retval
)
3083 if (CMD_ARGC
== 1) {
3084 unsigned wait_local
;
3085 retval
= parse_uint(CMD_ARGV
[0], &wait_local
);
3086 if (ERROR_OK
!= retval
)
3087 return ERROR_COMMAND_SYNTAX_ERROR
;
3092 return CALL_COMMAND_HANDLER(handle_wait_halt_command
);
3095 COMMAND_HANDLER(handle_soft_reset_halt_command
)
3097 struct target
*target
= get_current_target(CMD_CTX
);
3099 LOG_USER("requesting target halt and executing a soft reset");
3101 target_soft_reset_halt(target
);
3106 COMMAND_HANDLER(handle_reset_command
)
3109 return ERROR_COMMAND_SYNTAX_ERROR
;
3111 enum target_reset_mode reset_mode
= RESET_RUN
;
3112 if (CMD_ARGC
== 1) {
3114 n
= Jim_Nvp_name2value_simple(nvp_reset_modes
, CMD_ARGV
[0]);
3115 if ((n
->name
== NULL
) || (n
->value
== RESET_UNKNOWN
))
3116 return ERROR_COMMAND_SYNTAX_ERROR
;
3117 reset_mode
= n
->value
;
3120 /* reset *all* targets */
3121 return target_process_reset(CMD
, reset_mode
);
3125 COMMAND_HANDLER(handle_resume_command
)
3129 return ERROR_COMMAND_SYNTAX_ERROR
;
3131 struct target
*target
= get_current_target(CMD_CTX
);
3133 /* with no CMD_ARGV, resume from current pc, addr = 0,
3134 * with one arguments, addr = CMD_ARGV[0],
3135 * handle breakpoints, not debugging */
3136 target_addr_t addr
= 0;
3137 if (CMD_ARGC
== 1) {
3138 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3142 return target_resume(target
, current
, addr
, 1, 0);
3145 COMMAND_HANDLER(handle_step_command
)
3148 return ERROR_COMMAND_SYNTAX_ERROR
;
3152 /* with no CMD_ARGV, step from current pc, addr = 0,
3153 * with one argument addr = CMD_ARGV[0],
3154 * handle breakpoints, debugging */
3155 target_addr_t addr
= 0;
3157 if (CMD_ARGC
== 1) {
3158 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3162 struct target
*target
= get_current_target(CMD_CTX
);
3164 return target_step(target
, current_pc
, addr
, 1);
3167 void target_handle_md_output(struct command_invocation
*cmd
,
3168 struct target
*target
, target_addr_t address
, unsigned size
,
3169 unsigned count
, const uint8_t *buffer
)
3171 const unsigned line_bytecnt
= 32;
3172 unsigned line_modulo
= line_bytecnt
/ size
;
3174 char output
[line_bytecnt
* 4 + 1];
3175 unsigned output_len
= 0;
3177 const char *value_fmt
;
3180 value_fmt
= "%16.16"PRIx64
" ";
3183 value_fmt
= "%8.8"PRIx64
" ";
3186 value_fmt
= "%4.4"PRIx64
" ";
3189 value_fmt
= "%2.2"PRIx64
" ";
3192 /* "can't happen", caller checked */
3193 LOG_ERROR("invalid memory read size: %u", size
);
3197 for (unsigned i
= 0; i
< count
; i
++) {
3198 if (i
% line_modulo
== 0) {
3199 output_len
+= snprintf(output
+ output_len
,
3200 sizeof(output
) - output_len
,
3201 TARGET_ADDR_FMT
": ",
3202 (address
+ (i
* size
)));
3206 const uint8_t *value_ptr
= buffer
+ i
* size
;
3209 value
= target_buffer_get_u64(target
, value_ptr
);
3212 value
= target_buffer_get_u32(target
, value_ptr
);
3215 value
= target_buffer_get_u16(target
, value_ptr
);
3220 output_len
+= snprintf(output
+ output_len
,
3221 sizeof(output
) - output_len
,
3224 if ((i
% line_modulo
== line_modulo
- 1) || (i
== count
- 1)) {
3225 command_print(cmd
, "%s", output
);
3231 COMMAND_HANDLER(handle_md_command
)
3234 return ERROR_COMMAND_SYNTAX_ERROR
;
3237 switch (CMD_NAME
[2]) {
3251 return ERROR_COMMAND_SYNTAX_ERROR
;
3254 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3255 int (*fn
)(struct target
*target
,
3256 target_addr_t address
, uint32_t size_value
, uint32_t count
, uint8_t *buffer
);
3260 fn
= target_read_phys_memory
;
3262 fn
= target_read_memory
;
3263 if ((CMD_ARGC
< 1) || (CMD_ARGC
> 2))
3264 return ERROR_COMMAND_SYNTAX_ERROR
;
3266 target_addr_t address
;
3267 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3271 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], count
);
3273 uint8_t *buffer
= calloc(count
, size
);
3274 if (buffer
== NULL
) {
3275 LOG_ERROR("Failed to allocate md read buffer");
3279 struct target
*target
= get_current_target(CMD_CTX
);
3280 int retval
= fn(target
, address
, size
, count
, buffer
);
3281 if (ERROR_OK
== retval
)
3282 target_handle_md_output(CMD
, target
, address
, size
, count
, buffer
);
3289 typedef int (*target_write_fn
)(struct target
*target
,
3290 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
);
3292 static int target_fill_mem(struct target
*target
,
3293 target_addr_t address
,
3301 /* We have to write in reasonably large chunks to be able
3302 * to fill large memory areas with any sane speed */
3303 const unsigned chunk_size
= 16384;
3304 uint8_t *target_buf
= malloc(chunk_size
* data_size
);
3305 if (target_buf
== NULL
) {
3306 LOG_ERROR("Out of memory");
3310 for (unsigned i
= 0; i
< chunk_size
; i
++) {
3311 switch (data_size
) {
3313 target_buffer_set_u64(target
, target_buf
+ i
* data_size
, b
);
3316 target_buffer_set_u32(target
, target_buf
+ i
* data_size
, b
);
3319 target_buffer_set_u16(target
, target_buf
+ i
* data_size
, b
);
3322 target_buffer_set_u8(target
, target_buf
+ i
* data_size
, b
);
3329 int retval
= ERROR_OK
;
3331 for (unsigned x
= 0; x
< c
; x
+= chunk_size
) {
3334 if (current
> chunk_size
)
3335 current
= chunk_size
;
3336 retval
= fn(target
, address
+ x
* data_size
, data_size
, current
, target_buf
);
3337 if (retval
!= ERROR_OK
)
3339 /* avoid GDB timeouts */
3348 COMMAND_HANDLER(handle_mw_command
)
3351 return ERROR_COMMAND_SYNTAX_ERROR
;
3352 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3357 fn
= target_write_phys_memory
;
3359 fn
= target_write_memory
;
3360 if ((CMD_ARGC
< 2) || (CMD_ARGC
> 3))
3361 return ERROR_COMMAND_SYNTAX_ERROR
;
3363 target_addr_t address
;
3364 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3367 COMMAND_PARSE_NUMBER(u64
, CMD_ARGV
[1], value
);
3371 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[2], count
);
3373 struct target
*target
= get_current_target(CMD_CTX
);
3375 switch (CMD_NAME
[2]) {
3389 return ERROR_COMMAND_SYNTAX_ERROR
;
3392 return target_fill_mem(target
, address
, fn
, wordsize
, value
, count
);
3395 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV
, struct image
*image
,
3396 target_addr_t
*min_address
, target_addr_t
*max_address
)
3398 if (CMD_ARGC
< 1 || CMD_ARGC
> 5)
3399 return ERROR_COMMAND_SYNTAX_ERROR
;
3401 /* a base address isn't always necessary,
3402 * default to 0x0 (i.e. don't relocate) */
3403 if (CMD_ARGC
>= 2) {
3405 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3406 image
->base_address
= addr
;
3407 image
->base_address_set
= true;
3409 image
->base_address_set
= false;
3411 image
->start_address_set
= false;
3414 COMMAND_PARSE_ADDRESS(CMD_ARGV
[3], *min_address
);
3415 if (CMD_ARGC
== 5) {
3416 COMMAND_PARSE_ADDRESS(CMD_ARGV
[4], *max_address
);
3417 /* use size (given) to find max (required) */
3418 *max_address
+= *min_address
;
3421 if (*min_address
> *max_address
)
3422 return ERROR_COMMAND_SYNTAX_ERROR
;
3427 COMMAND_HANDLER(handle_load_image_command
)
3431 uint32_t image_size
;
3432 target_addr_t min_address
= 0;
3433 target_addr_t max_address
= -1;
3436 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
3437 &image
, &min_address
, &max_address
);
3438 if (ERROR_OK
!= retval
)
3441 struct target
*target
= get_current_target(CMD_CTX
);
3443 struct duration bench
;
3444 duration_start(&bench
);
3446 if (image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
) != ERROR_OK
)
3451 for (unsigned int i
= 0; i
< image
.num_sections
; i
++) {
3452 buffer
= malloc(image
.sections
[i
].size
);
3453 if (buffer
== NULL
) {
3455 "error allocating buffer for section (%d bytes)",
3456 (int)(image
.sections
[i
].size
));
3457 retval
= ERROR_FAIL
;
3461 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3462 if (retval
!= ERROR_OK
) {
3467 uint32_t offset
= 0;
3468 uint32_t length
= buf_cnt
;
3470 /* DANGER!!! beware of unsigned comparison here!!! */
3472 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
3473 (image
.sections
[i
].base_address
< max_address
)) {
3475 if (image
.sections
[i
].base_address
< min_address
) {
3476 /* clip addresses below */
3477 offset
+= min_address
-image
.sections
[i
].base_address
;
3481 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
3482 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
3484 retval
= target_write_buffer(target
,
3485 image
.sections
[i
].base_address
+ offset
, length
, buffer
+ offset
);
3486 if (retval
!= ERROR_OK
) {
3490 image_size
+= length
;
3491 command_print(CMD
, "%u bytes written at address " TARGET_ADDR_FMT
"",
3492 (unsigned int)length
,
3493 image
.sections
[i
].base_address
+ offset
);
3499 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3500 command_print(CMD
, "downloaded %" PRIu32
" bytes "
3501 "in %fs (%0.3f KiB/s)", image_size
,
3502 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3505 image_close(&image
);
3511 COMMAND_HANDLER(handle_dump_image_command
)
3513 struct fileio
*fileio
;
3515 int retval
, retvaltemp
;
3516 target_addr_t address
, size
;
3517 struct duration bench
;
3518 struct target
*target
= get_current_target(CMD_CTX
);
3521 return ERROR_COMMAND_SYNTAX_ERROR
;
3523 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], address
);
3524 COMMAND_PARSE_ADDRESS(CMD_ARGV
[2], size
);
3526 uint32_t buf_size
= (size
> 4096) ? 4096 : size
;
3527 buffer
= malloc(buf_size
);
3531 retval
= fileio_open(&fileio
, CMD_ARGV
[0], FILEIO_WRITE
, FILEIO_BINARY
);
3532 if (retval
!= ERROR_OK
) {
3537 duration_start(&bench
);
3540 size_t size_written
;
3541 uint32_t this_run_size
= (size
> buf_size
) ? buf_size
: size
;
3542 retval
= target_read_buffer(target
, address
, this_run_size
, buffer
);
3543 if (retval
!= ERROR_OK
)
3546 retval
= fileio_write(fileio
, this_run_size
, buffer
, &size_written
);
3547 if (retval
!= ERROR_OK
)
3550 size
-= this_run_size
;
3551 address
+= this_run_size
;
3556 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3558 retval
= fileio_size(fileio
, &filesize
);
3559 if (retval
!= ERROR_OK
)
3562 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize
,
3563 duration_elapsed(&bench
), duration_kbps(&bench
, filesize
));
3566 retvaltemp
= fileio_close(fileio
);
3567 if (retvaltemp
!= ERROR_OK
)
3576 IMAGE_CHECKSUM_ONLY
= 2
3579 static COMMAND_HELPER(handle_verify_image_command_internal
, enum verify_mode verify
)
3583 uint32_t image_size
;
3585 uint32_t checksum
= 0;
3586 uint32_t mem_checksum
= 0;
3590 struct target
*target
= get_current_target(CMD_CTX
);
3593 return ERROR_COMMAND_SYNTAX_ERROR
;
3596 LOG_ERROR("no target selected");
3600 struct duration bench
;
3601 duration_start(&bench
);
3603 if (CMD_ARGC
>= 2) {
3605 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3606 image
.base_address
= addr
;
3607 image
.base_address_set
= true;
3609 image
.base_address_set
= false;
3610 image
.base_address
= 0x0;
3613 image
.start_address_set
= false;
3615 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
3616 if (retval
!= ERROR_OK
)
3622 for (unsigned int i
= 0; i
< image
.num_sections
; i
++) {
3623 buffer
= malloc(image
.sections
[i
].size
);
3624 if (buffer
== NULL
) {
3626 "error allocating buffer for section (%" PRIu32
" bytes)",
3627 image
.sections
[i
].size
);
3630 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3631 if (retval
!= ERROR_OK
) {
3636 if (verify
>= IMAGE_VERIFY
) {
3637 /* calculate checksum of image */
3638 retval
= image_calculate_checksum(buffer
, buf_cnt
, &checksum
);
3639 if (retval
!= ERROR_OK
) {
3644 retval
= target_checksum_memory(target
, image
.sections
[i
].base_address
, buf_cnt
, &mem_checksum
);
3645 if (retval
!= ERROR_OK
) {
3649 if ((checksum
!= mem_checksum
) && (verify
== IMAGE_CHECKSUM_ONLY
)) {
3650 LOG_ERROR("checksum mismatch");
3652 retval
= ERROR_FAIL
;
3655 if (checksum
!= mem_checksum
) {
3656 /* failed crc checksum, fall back to a binary compare */
3660 LOG_ERROR("checksum mismatch - attempting binary compare");
3662 data
= malloc(buf_cnt
);
3664 retval
= target_read_buffer(target
, image
.sections
[i
].base_address
, buf_cnt
, data
);
3665 if (retval
== ERROR_OK
) {
3667 for (t
= 0; t
< buf_cnt
; t
++) {
3668 if (data
[t
] != buffer
[t
]) {
3670 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3672 (unsigned)(t
+ image
.sections
[i
].base_address
),
3675 if (diffs
++ >= 127) {
3676 command_print(CMD
, "More than 128 errors, the rest are not printed.");
3688 command_print(CMD
, "address " TARGET_ADDR_FMT
" length 0x%08zx",
3689 image
.sections
[i
].base_address
,
3694 image_size
+= buf_cnt
;
3697 command_print(CMD
, "No more differences found.");
3700 retval
= ERROR_FAIL
;
3701 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3702 command_print(CMD
, "verified %" PRIu32
" bytes "
3703 "in %fs (%0.3f KiB/s)", image_size
,
3704 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3707 image_close(&image
);
3712 COMMAND_HANDLER(handle_verify_image_checksum_command
)
3714 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_CHECKSUM_ONLY
);
3717 COMMAND_HANDLER(handle_verify_image_command
)
3719 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_VERIFY
);
3722 COMMAND_HANDLER(handle_test_image_command
)
3724 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_TEST
);
3727 static int handle_bp_command_list(struct command_invocation
*cmd
)
3729 struct target
*target
= get_current_target(cmd
->ctx
);
3730 struct breakpoint
*breakpoint
= target
->breakpoints
;
3731 while (breakpoint
) {
3732 if (breakpoint
->type
== BKPT_SOFT
) {
3733 char *buf
= buf_to_hex_str(breakpoint
->orig_instr
,
3734 breakpoint
->length
);
3735 command_print(cmd
, "IVA breakpoint: " TARGET_ADDR_FMT
", 0x%x, %i, 0x%s",
3736 breakpoint
->address
,
3738 breakpoint
->set
, buf
);
3741 if ((breakpoint
->address
== 0) && (breakpoint
->asid
!= 0))
3742 command_print(cmd
, "Context breakpoint: 0x%8.8" PRIx32
", 0x%x, %i",
3744 breakpoint
->length
, breakpoint
->set
);
3745 else if ((breakpoint
->address
!= 0) && (breakpoint
->asid
!= 0)) {
3746 command_print(cmd
, "Hybrid breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3747 breakpoint
->address
,
3748 breakpoint
->length
, breakpoint
->set
);
3749 command_print(cmd
, "\t|--->linked with ContextID: 0x%8.8" PRIx32
,
3752 command_print(cmd
, "Breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3753 breakpoint
->address
,
3754 breakpoint
->length
, breakpoint
->set
);
3757 breakpoint
= breakpoint
->next
;
3762 static int handle_bp_command_set(struct command_invocation
*cmd
,
3763 target_addr_t addr
, uint32_t asid
, uint32_t length
, int hw
)
3765 struct target
*target
= get_current_target(cmd
->ctx
);
3769 retval
= breakpoint_add(target
, addr
, length
, hw
);
3770 /* error is always logged in breakpoint_add(), do not print it again */
3771 if (ERROR_OK
== retval
)
3772 command_print(cmd
, "breakpoint set at " TARGET_ADDR_FMT
"", addr
);
3774 } else if (addr
== 0) {
3775 if (target
->type
->add_context_breakpoint
== NULL
) {
3776 LOG_ERROR("Context breakpoint not available");
3777 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
3779 retval
= context_breakpoint_add(target
, asid
, length
, hw
);
3780 /* error is always logged in context_breakpoint_add(), do not print it again */
3781 if (ERROR_OK
== retval
)
3782 command_print(cmd
, "Context breakpoint set at 0x%8.8" PRIx32
"", asid
);
3785 if (target
->type
->add_hybrid_breakpoint
== NULL
) {
3786 LOG_ERROR("Hybrid breakpoint not available");
3787 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
3789 retval
= hybrid_breakpoint_add(target
, addr
, asid
, length
, hw
);
3790 /* error is always logged in hybrid_breakpoint_add(), do not print it again */
3791 if (ERROR_OK
== retval
)
3792 command_print(cmd
, "Hybrid breakpoint set at 0x%8.8" PRIx32
"", asid
);
3797 COMMAND_HANDLER(handle_bp_command
)
3806 return handle_bp_command_list(CMD
);
3810 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3811 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3812 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3815 if (strcmp(CMD_ARGV
[2], "hw") == 0) {
3817 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3818 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3820 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3821 } else if (strcmp(CMD_ARGV
[2], "hw_ctx") == 0) {
3823 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], asid
);
3824 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3826 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3831 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3832 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], asid
);
3833 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], length
);
3834 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3837 return ERROR_COMMAND_SYNTAX_ERROR
;
3841 COMMAND_HANDLER(handle_rbp_command
)
3844 return ERROR_COMMAND_SYNTAX_ERROR
;
3846 struct target
*target
= get_current_target(CMD_CTX
);
3848 if (!strcmp(CMD_ARGV
[0], "all")) {
3849 breakpoint_remove_all(target
);
3852 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3854 breakpoint_remove(target
, addr
);
3860 COMMAND_HANDLER(handle_wp_command
)
3862 struct target
*target
= get_current_target(CMD_CTX
);
3864 if (CMD_ARGC
== 0) {
3865 struct watchpoint
*watchpoint
= target
->watchpoints
;
3867 while (watchpoint
) {
3868 command_print(CMD
, "address: " TARGET_ADDR_FMT
3869 ", len: 0x%8.8" PRIx32
3870 ", r/w/a: %i, value: 0x%8.8" PRIx32
3871 ", mask: 0x%8.8" PRIx32
,
3872 watchpoint
->address
,
3874 (int)watchpoint
->rw
,
3877 watchpoint
= watchpoint
->next
;
3882 enum watchpoint_rw type
= WPT_ACCESS
;
3884 uint32_t length
= 0;
3885 uint32_t data_value
= 0x0;
3886 uint32_t data_mask
= 0xffffffff;
3890 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[4], data_mask
);
3893 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], data_value
);
3896 switch (CMD_ARGV
[2][0]) {
3907 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV
[2][0]);
3908 return ERROR_COMMAND_SYNTAX_ERROR
;
3912 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3913 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3917 return ERROR_COMMAND_SYNTAX_ERROR
;
3920 int retval
= watchpoint_add(target
, addr
, length
, type
,
3921 data_value
, data_mask
);
3922 if (ERROR_OK
!= retval
)
3923 LOG_ERROR("Failure setting watchpoints");
3928 COMMAND_HANDLER(handle_rwp_command
)
3931 return ERROR_COMMAND_SYNTAX_ERROR
;
3934 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3936 struct target
*target
= get_current_target(CMD_CTX
);
3937 watchpoint_remove(target
, addr
);
3943 * Translate a virtual address to a physical address.
3945 * The low-level target implementation must have logged a detailed error
3946 * which is forwarded to telnet/GDB session.
3948 COMMAND_HANDLER(handle_virt2phys_command
)
3951 return ERROR_COMMAND_SYNTAX_ERROR
;
3954 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], va
);
3957 struct target
*target
= get_current_target(CMD_CTX
);
3958 int retval
= target
->type
->virt2phys(target
, va
, &pa
);
3959 if (retval
== ERROR_OK
)
3960 command_print(CMD
, "Physical address " TARGET_ADDR_FMT
"", pa
);
3965 static void writeData(FILE *f
, const void *data
, size_t len
)
3967 size_t written
= fwrite(data
, 1, len
, f
);
3969 LOG_ERROR("failed to write %zu bytes: %s", len
, strerror(errno
));
3972 static void writeLong(FILE *f
, int l
, struct target
*target
)
3976 target_buffer_set_u32(target
, val
, l
);
3977 writeData(f
, val
, 4);
3980 static void writeString(FILE *f
, char *s
)
3982 writeData(f
, s
, strlen(s
));
3985 typedef unsigned char UNIT
[2]; /* unit of profiling */
3987 /* Dump a gmon.out histogram file. */
3988 static void write_gmon(uint32_t *samples
, uint32_t sampleNum
, const char *filename
, bool with_range
,
3989 uint32_t start_address
, uint32_t end_address
, struct target
*target
, uint32_t duration_ms
)
3992 FILE *f
= fopen(filename
, "w");
3995 writeString(f
, "gmon");
3996 writeLong(f
, 0x00000001, target
); /* Version */
3997 writeLong(f
, 0, target
); /* padding */
3998 writeLong(f
, 0, target
); /* padding */
3999 writeLong(f
, 0, target
); /* padding */
4001 uint8_t zero
= 0; /* GMON_TAG_TIME_HIST */
4002 writeData(f
, &zero
, 1);
4004 /* figure out bucket size */
4008 min
= start_address
;
4013 for (i
= 0; i
< sampleNum
; i
++) {
4014 if (min
> samples
[i
])
4016 if (max
< samples
[i
])
4020 /* max should be (largest sample + 1)
4021 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
4025 int addressSpace
= max
- min
;
4026 assert(addressSpace
>= 2);
4028 /* FIXME: What is the reasonable number of buckets?
4029 * The profiling result will be more accurate if there are enough buckets. */
4030 static const uint32_t maxBuckets
= 128 * 1024; /* maximum buckets. */
4031 uint32_t numBuckets
= addressSpace
/ sizeof(UNIT
);
4032 if (numBuckets
> maxBuckets
)
4033 numBuckets
= maxBuckets
;
4034 int *buckets
= malloc(sizeof(int) * numBuckets
);
4035 if (buckets
== NULL
) {
4039 memset(buckets
, 0, sizeof(int) * numBuckets
);
4040 for (i
= 0; i
< sampleNum
; i
++) {
4041 uint32_t address
= samples
[i
];
4043 if ((address
< min
) || (max
<= address
))
4046 long long a
= address
- min
;
4047 long long b
= numBuckets
;
4048 long long c
= addressSpace
;
4049 int index_t
= (a
* b
) / c
; /* danger!!!! int32 overflows */
4053 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
4054 writeLong(f
, min
, target
); /* low_pc */
4055 writeLong(f
, max
, target
); /* high_pc */
4056 writeLong(f
, numBuckets
, target
); /* # of buckets */
4057 float sample_rate
= sampleNum
/ (duration_ms
/ 1000.0);
4058 writeLong(f
, sample_rate
, target
);
4059 writeString(f
, "seconds");
4060 for (i
= 0; i
< (15-strlen("seconds")); i
++)
4061 writeData(f
, &zero
, 1);
4062 writeString(f
, "s");
4064 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
4066 char *data
= malloc(2 * numBuckets
);
4068 for (i
= 0; i
< numBuckets
; i
++) {
4073 data
[i
* 2] = val
&0xff;
4074 data
[i
* 2 + 1] = (val
>> 8) & 0xff;
4077 writeData(f
, data
, numBuckets
* 2);
4085 /* profiling samples the CPU PC as quickly as OpenOCD is able,
4086 * which will be used as a random sampling of PC */
4087 COMMAND_HANDLER(handle_profile_command
)
4089 struct target
*target
= get_current_target(CMD_CTX
);
4091 if ((CMD_ARGC
!= 2) && (CMD_ARGC
!= 4))
4092 return ERROR_COMMAND_SYNTAX_ERROR
;
4094 const uint32_t MAX_PROFILE_SAMPLE_NUM
= 10000;
4096 uint32_t num_of_samples
;
4097 int retval
= ERROR_OK
;
4098 bool halted_before_profiling
= target
->state
== TARGET_HALTED
;
4100 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], offset
);
4102 uint32_t *samples
= malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM
);
4103 if (samples
== NULL
) {
4104 LOG_ERROR("No memory to store samples.");
4108 uint64_t timestart_ms
= timeval_ms();
4110 * Some cores let us sample the PC without the
4111 * annoying halt/resume step; for example, ARMv7 PCSR.
4112 * Provide a way to use that more efficient mechanism.
4114 retval
= target_profiling(target
, samples
, MAX_PROFILE_SAMPLE_NUM
,
4115 &num_of_samples
, offset
);
4116 if (retval
!= ERROR_OK
) {
4120 uint32_t duration_ms
= timeval_ms() - timestart_ms
;
4122 assert(num_of_samples
<= MAX_PROFILE_SAMPLE_NUM
);
4124 retval
= target_poll(target
);
4125 if (retval
!= ERROR_OK
) {
4130 if (target
->state
== TARGET_RUNNING
&& halted_before_profiling
) {
4131 /* The target was halted before we started and is running now. Halt it,
4132 * for consistency. */
4133 retval
= target_halt(target
);
4134 if (retval
!= ERROR_OK
) {
4138 } else if (target
->state
== TARGET_HALTED
&& !halted_before_profiling
) {
4139 /* The target was running before we started and is halted now. Resume
4140 * it, for consistency. */
4141 retval
= target_resume(target
, 1, 0, 0, 0);
4142 if (retval
!= ERROR_OK
) {
4148 retval
= target_poll(target
);
4149 if (retval
!= ERROR_OK
) {
4154 uint32_t start_address
= 0;
4155 uint32_t end_address
= 0;
4156 bool with_range
= false;
4157 if (CMD_ARGC
== 4) {
4159 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], start_address
);
4160 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], end_address
);
4163 write_gmon(samples
, num_of_samples
, CMD_ARGV
[1],
4164 with_range
, start_address
, end_address
, target
, duration_ms
);
4165 command_print(CMD
, "Wrote %s", CMD_ARGV
[1]);
4171 static int new_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t val
)
4174 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4177 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4181 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4182 valObjPtr
= Jim_NewIntObj(interp
, val
);
4183 if (!nameObjPtr
|| !valObjPtr
) {
4188 Jim_IncrRefCount(nameObjPtr
);
4189 Jim_IncrRefCount(valObjPtr
);
4190 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
4191 Jim_DecrRefCount(interp
, nameObjPtr
);
4192 Jim_DecrRefCount(interp
, valObjPtr
);
4194 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
4198 static int jim_mem2array(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4200 struct command_context
*context
;
4201 struct target
*target
;
4203 context
= current_command_context(interp
);
4204 assert(context
!= NULL
);
4206 target
= get_current_target(context
);
4207 if (target
== NULL
) {
4208 LOG_ERROR("mem2array: no current target");
4212 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
4215 static int target_mem2array(Jim_Interp
*interp
, struct target
*target
, int argc
, Jim_Obj
*const *argv
)
4223 const char *varname
;
4229 /* argv[1] = name of array to receive the data
4230 * argv[2] = desired width
4231 * argv[3] = memory address
4232 * argv[4] = count of times to read
4235 if (argc
< 4 || argc
> 5) {
4236 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4239 varname
= Jim_GetString(argv
[0], &len
);
4240 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4242 e
= Jim_GetLong(interp
, argv
[1], &l
);
4247 e
= Jim_GetLong(interp
, argv
[2], &l
);
4251 e
= Jim_GetLong(interp
, argv
[3], &l
);
4257 phys
= Jim_GetString(argv
[4], &n
);
4258 if (!strncmp(phys
, "phys", n
))
4274 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4275 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "Invalid width param, must be 8/16/32", NULL
);
4279 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4280 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: zero width read?", NULL
);
4283 if ((addr
+ (len
* width
)) < addr
) {
4284 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4285 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: addr + len - wraps to zero?", NULL
);
4288 /* absurd transfer size? */
4290 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4291 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: absurd > 64K item request", NULL
);
4296 ((width
== 2) && ((addr
& 1) == 0)) ||
4297 ((width
== 4) && ((addr
& 3) == 0))) {
4301 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4302 sprintf(buf
, "mem2array address: 0x%08" PRIx32
" is not aligned for %" PRIu32
" byte reads",
4305 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4314 size_t buffersize
= 4096;
4315 uint8_t *buffer
= malloc(buffersize
);
4322 /* Slurp... in buffer size chunks */
4324 count
= len
; /* in objects.. */
4325 if (count
> (buffersize
/ width
))
4326 count
= (buffersize
/ width
);
4329 retval
= target_read_phys_memory(target
, addr
, width
, count
, buffer
);
4331 retval
= target_read_memory(target
, addr
, width
, count
, buffer
);
4332 if (retval
!= ERROR_OK
) {
4334 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32
", w=%" PRIu32
", cnt=%" PRIu32
", failed",
4338 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4339 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: cannot read memory", NULL
);
4343 v
= 0; /* shut up gcc */
4344 for (i
= 0; i
< count
; i
++, n
++) {
4347 v
= target_buffer_get_u32(target
, &buffer
[i
*width
]);
4350 v
= target_buffer_get_u16(target
, &buffer
[i
*width
]);
4353 v
= buffer
[i
] & 0x0ff;
4356 new_int_array_element(interp
, varname
, n
, v
);
4359 addr
+= count
* width
;
4365 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4370 static int get_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t *val
)
4373 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4377 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4381 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4387 Jim_IncrRefCount(nameObjPtr
);
4388 valObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, JIM_ERRMSG
);
4389 Jim_DecrRefCount(interp
, nameObjPtr
);
4391 if (valObjPtr
== NULL
)
4394 result
= Jim_GetLong(interp
, valObjPtr
, &l
);
4395 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4400 static int jim_array2mem(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4402 struct command_context
*context
;
4403 struct target
*target
;
4405 context
= current_command_context(interp
);
4406 assert(context
!= NULL
);
4408 target
= get_current_target(context
);
4409 if (target
== NULL
) {
4410 LOG_ERROR("array2mem: no current target");
4414 return target_array2mem(interp
, target
, argc
-1, argv
+ 1);
4417 static int target_array2mem(Jim_Interp
*interp
, struct target
*target
,
4418 int argc
, Jim_Obj
*const *argv
)
4426 const char *varname
;
4432 /* argv[1] = name of array to get the data
4433 * argv[2] = desired width
4434 * argv[3] = memory address
4435 * argv[4] = count to write
4437 if (argc
< 4 || argc
> 5) {
4438 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4441 varname
= Jim_GetString(argv
[0], &len
);
4442 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4444 e
= Jim_GetLong(interp
, argv
[1], &l
);
4449 e
= Jim_GetLong(interp
, argv
[2], &l
);
4453 e
= Jim_GetLong(interp
, argv
[3], &l
);
4459 phys
= Jim_GetString(argv
[4], &n
);
4460 if (!strncmp(phys
, "phys", n
))
4476 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4477 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4478 "Invalid width param, must be 8/16/32", NULL
);
4482 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4483 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4484 "array2mem: zero width read?", NULL
);
4487 if ((addr
+ (len
* width
)) < addr
) {
4488 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4489 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4490 "array2mem: addr + len - wraps to zero?", NULL
);
4493 /* absurd transfer size? */
4495 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4496 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4497 "array2mem: absurd > 64K item request", NULL
);
4502 ((width
== 2) && ((addr
& 1) == 0)) ||
4503 ((width
== 4) && ((addr
& 3) == 0))) {
4507 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4508 sprintf(buf
, "array2mem address: 0x%08" PRIx32
" is not aligned for %" PRIu32
" byte reads",
4511 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4522 size_t buffersize
= 4096;
4523 uint8_t *buffer
= malloc(buffersize
);
4528 /* Slurp... in buffer size chunks */
4530 count
= len
; /* in objects.. */
4531 if (count
> (buffersize
/ width
))
4532 count
= (buffersize
/ width
);
4534 v
= 0; /* shut up gcc */
4535 for (i
= 0; i
< count
; i
++, n
++) {
4536 get_int_array_element(interp
, varname
, n
, &v
);
4539 target_buffer_set_u32(target
, &buffer
[i
* width
], v
);
4542 target_buffer_set_u16(target
, &buffer
[i
* width
], v
);
4545 buffer
[i
] = v
& 0x0ff;
4552 retval
= target_write_phys_memory(target
, addr
, width
, count
, buffer
);
4554 retval
= target_write_memory(target
, addr
, width
, count
, buffer
);
4555 if (retval
!= ERROR_OK
) {
4557 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32
", w=%" PRIu32
", cnt=%" PRIu32
", failed",
4561 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4562 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "array2mem: cannot read memory", NULL
);
4566 addr
+= count
* width
;
4571 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4576 /* FIX? should we propagate errors here rather than printing them
4579 void target_handle_event(struct target
*target
, enum target_event e
)
4581 struct target_event_action
*teap
;
4584 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4585 if (teap
->event
== e
) {
4586 LOG_DEBUG("target(%d): %s (%s) event: %d (%s) action: %s",
4587 target
->target_number
,
4588 target_name(target
),
4589 target_type_name(target
),
4591 Jim_Nvp_value2name_simple(nvp_target_event
, e
)->name
,
4592 Jim_GetString(teap
->body
, NULL
));
4594 /* Override current target by the target an event
4595 * is issued from (lot of scripts need it).
4596 * Return back to previous override as soon
4597 * as the handler processing is done */
4598 struct command_context
*cmd_ctx
= current_command_context(teap
->interp
);
4599 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
4600 cmd_ctx
->current_target_override
= target
;
4602 retval
= Jim_EvalObj(teap
->interp
, teap
->body
);
4604 cmd_ctx
->current_target_override
= saved_target_override
;
4606 if (retval
== ERROR_COMMAND_CLOSE_CONNECTION
)
4609 if (retval
== JIM_RETURN
)
4610 retval
= teap
->interp
->returnCode
;
4612 if (retval
!= JIM_OK
) {
4613 Jim_MakeErrorMessage(teap
->interp
);
4614 LOG_USER("Error executing event %s on target %s:\n%s",
4615 Jim_Nvp_value2name_simple(nvp_target_event
, e
)->name
,
4616 target_name(target
),
4617 Jim_GetString(Jim_GetResult(teap
->interp
), NULL
));
4618 /* clean both error code and stacktrace before return */
4619 Jim_Eval(teap
->interp
, "error \"\" \"\"");
4626 * Returns true only if the target has a handler for the specified event.
4628 bool target_has_event_action(struct target
*target
, enum target_event event
)
4630 struct target_event_action
*teap
;
4632 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4633 if (teap
->event
== event
)
4639 enum target_cfg_param
{
4642 TCFG_WORK_AREA_VIRT
,
4643 TCFG_WORK_AREA_PHYS
,
4644 TCFG_WORK_AREA_SIZE
,
4645 TCFG_WORK_AREA_BACKUP
,
4648 TCFG_CHAIN_POSITION
,
4653 TCFG_GDB_MAX_CONNECTIONS
,
4656 static Jim_Nvp nvp_config_opts
[] = {
4657 { .name
= "-type", .value
= TCFG_TYPE
},
4658 { .name
= "-event", .value
= TCFG_EVENT
},
4659 { .name
= "-work-area-virt", .value
= TCFG_WORK_AREA_VIRT
},
4660 { .name
= "-work-area-phys", .value
= TCFG_WORK_AREA_PHYS
},
4661 { .name
= "-work-area-size", .value
= TCFG_WORK_AREA_SIZE
},
4662 { .name
= "-work-area-backup", .value
= TCFG_WORK_AREA_BACKUP
},
4663 { .name
= "-endian", .value
= TCFG_ENDIAN
},
4664 { .name
= "-coreid", .value
= TCFG_COREID
},
4665 { .name
= "-chain-position", .value
= TCFG_CHAIN_POSITION
},
4666 { .name
= "-dbgbase", .value
= TCFG_DBGBASE
},
4667 { .name
= "-rtos", .value
= TCFG_RTOS
},
4668 { .name
= "-defer-examine", .value
= TCFG_DEFER_EXAMINE
},
4669 { .name
= "-gdb-port", .value
= TCFG_GDB_PORT
},
4670 { .name
= "-gdb-max-connections", .value
= TCFG_GDB_MAX_CONNECTIONS
},
4671 { .name
= NULL
, .value
= -1 }
4674 static int target_configure(Jim_GetOptInfo
*goi
, struct target
*target
)
4681 /* parse config or cget options ... */
4682 while (goi
->argc
> 0) {
4683 Jim_SetEmptyResult(goi
->interp
);
4684 /* Jim_GetOpt_Debug(goi); */
4686 if (target
->type
->target_jim_configure
) {
4687 /* target defines a configure function */
4688 /* target gets first dibs on parameters */
4689 e
= (*(target
->type
->target_jim_configure
))(target
, goi
);
4698 /* otherwise we 'continue' below */
4700 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
4702 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
4708 if (goi
->isconfigure
) {
4709 Jim_SetResultFormatted(goi
->interp
,
4710 "not settable: %s", n
->name
);
4714 if (goi
->argc
!= 0) {
4715 Jim_WrongNumArgs(goi
->interp
,
4716 goi
->argc
, goi
->argv
,
4721 Jim_SetResultString(goi
->interp
,
4722 target_type_name(target
), -1);
4726 if (goi
->argc
== 0) {
4727 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ...");
4731 e
= Jim_GetOpt_Nvp(goi
, nvp_target_event
, &n
);
4733 Jim_GetOpt_NvpUnknown(goi
, nvp_target_event
, 1);
4737 if (goi
->isconfigure
) {
4738 if (goi
->argc
!= 1) {
4739 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
4743 if (goi
->argc
!= 0) {
4744 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
4750 struct target_event_action
*teap
;
4752 teap
= target
->event_action
;
4753 /* replace existing? */
4755 if (teap
->event
== (enum target_event
)n
->value
)
4760 if (goi
->isconfigure
) {
4761 bool replace
= true;
4764 teap
= calloc(1, sizeof(*teap
));
4767 teap
->event
= n
->value
;
4768 teap
->interp
= goi
->interp
;
4769 Jim_GetOpt_Obj(goi
, &o
);
4771 Jim_DecrRefCount(teap
->interp
, teap
->body
);
4772 teap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
4775 * Tcl/TK - "tk events" have a nice feature.
4776 * See the "BIND" command.
4777 * We should support that here.
4778 * You can specify %X and %Y in the event code.
4779 * The idea is: %T - target name.
4780 * The idea is: %N - target number
4781 * The idea is: %E - event name.
4783 Jim_IncrRefCount(teap
->body
);
4786 /* add to head of event list */
4787 teap
->next
= target
->event_action
;
4788 target
->event_action
= teap
;
4790 Jim_SetEmptyResult(goi
->interp
);
4794 Jim_SetEmptyResult(goi
->interp
);
4796 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, teap
->body
));
4802 case TCFG_WORK_AREA_VIRT
:
4803 if (goi
->isconfigure
) {
4804 target_free_all_working_areas(target
);
4805 e
= Jim_GetOpt_Wide(goi
, &w
);
4808 target
->working_area_virt
= w
;
4809 target
->working_area_virt_spec
= true;
4814 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_virt
));
4818 case TCFG_WORK_AREA_PHYS
:
4819 if (goi
->isconfigure
) {
4820 target_free_all_working_areas(target
);
4821 e
= Jim_GetOpt_Wide(goi
, &w
);
4824 target
->working_area_phys
= w
;
4825 target
->working_area_phys_spec
= true;
4830 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_phys
));
4834 case TCFG_WORK_AREA_SIZE
:
4835 if (goi
->isconfigure
) {
4836 target_free_all_working_areas(target
);
4837 e
= Jim_GetOpt_Wide(goi
, &w
);
4840 target
->working_area_size
= w
;
4845 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_size
));
4849 case TCFG_WORK_AREA_BACKUP
:
4850 if (goi
->isconfigure
) {
4851 target_free_all_working_areas(target
);
4852 e
= Jim_GetOpt_Wide(goi
, &w
);
4855 /* make this exactly 1 or 0 */
4856 target
->backup_working_area
= (!!w
);
4861 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->backup_working_area
));
4862 /* loop for more e*/
4867 if (goi
->isconfigure
) {
4868 e
= Jim_GetOpt_Nvp(goi
, nvp_target_endian
, &n
);
4870 Jim_GetOpt_NvpUnknown(goi
, nvp_target_endian
, 1);
4873 target
->endianness
= n
->value
;
4878 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4879 if (n
->name
== NULL
) {
4880 target
->endianness
= TARGET_LITTLE_ENDIAN
;
4881 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4883 Jim_SetResultString(goi
->interp
, n
->name
, -1);
4888 if (goi
->isconfigure
) {
4889 e
= Jim_GetOpt_Wide(goi
, &w
);
4892 target
->coreid
= (int32_t)w
;
4897 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->coreid
));
4901 case TCFG_CHAIN_POSITION
:
4902 if (goi
->isconfigure
) {
4904 struct jtag_tap
*tap
;
4906 if (target
->has_dap
) {
4907 Jim_SetResultString(goi
->interp
,
4908 "target requires -dap parameter instead of -chain-position!", -1);
4912 target_free_all_working_areas(target
);
4913 e
= Jim_GetOpt_Obj(goi
, &o_t
);
4916 tap
= jtag_tap_by_jim_obj(goi
->interp
, o_t
);
4920 target
->tap_configured
= true;
4925 Jim_SetResultString(goi
->interp
, target
->tap
->dotted_name
, -1);
4926 /* loop for more e*/
4929 if (goi
->isconfigure
) {
4930 e
= Jim_GetOpt_Wide(goi
, &w
);
4933 target
->dbgbase
= (uint32_t)w
;
4934 target
->dbgbase_set
= true;
4939 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->dbgbase
));
4945 int result
= rtos_create(goi
, target
);
4946 if (result
!= JIM_OK
)
4952 case TCFG_DEFER_EXAMINE
:
4954 target
->defer_examine
= true;
4959 if (goi
->isconfigure
) {
4960 struct command_context
*cmd_ctx
= current_command_context(goi
->interp
);
4961 if (cmd_ctx
->mode
!= COMMAND_CONFIG
) {
4962 Jim_SetResultString(goi
->interp
, "-gdb-port must be configured before 'init'", -1);
4967 e
= Jim_GetOpt_String(goi
, &s
, NULL
);
4970 target
->gdb_port_override
= strdup(s
);
4975 Jim_SetResultString(goi
->interp
, target
->gdb_port_override
? : "undefined", -1);
4979 case TCFG_GDB_MAX_CONNECTIONS
:
4980 if (goi
->isconfigure
) {
4981 struct command_context
*cmd_ctx
= current_command_context(goi
->interp
);
4982 if (cmd_ctx
->mode
!= COMMAND_CONFIG
) {
4983 Jim_SetResultString(goi
->interp
, "-gdb-max-conenctions must be configured before 'init'", -1);
4987 e
= Jim_GetOpt_Wide(goi
, &w
);
4990 target
->gdb_max_connections
= (w
< 0) ? CONNECTION_LIMIT_UNLIMITED
: (int)w
;
4995 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->gdb_max_connections
));
4998 } /* while (goi->argc) */
5001 /* done - we return */
5005 static int jim_target_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5009 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5010 goi
.isconfigure
= !strcmp(Jim_GetString(argv
[0], NULL
), "configure");
5012 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
5013 "missing: -option ...");
5016 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
5017 return target_configure(&goi
, target
);
5020 static int jim_target_mem2array(Jim_Interp
*interp
,
5021 int argc
, Jim_Obj
*const *argv
)
5023 struct target
*target
= Jim_CmdPrivData(interp
);
5024 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
5027 static int jim_target_array2mem(Jim_Interp
*interp
,
5028 int argc
, Jim_Obj
*const *argv
)
5030 struct target
*target
= Jim_CmdPrivData(interp
);
5031 return target_array2mem(interp
, target
, argc
- 1, argv
+ 1);
5034 static int jim_target_tap_disabled(Jim_Interp
*interp
)
5036 Jim_SetResultFormatted(interp
, "[TAP is disabled]");
5040 static int jim_target_examine(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5042 bool allow_defer
= false;
5045 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5047 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5048 Jim_SetResultFormatted(goi
.interp
,
5049 "usage: %s ['allow-defer']", cmd_name
);
5053 strcmp(Jim_GetString(argv
[1], NULL
), "allow-defer") == 0) {
5056 int e
= Jim_GetOpt_Obj(&goi
, &obj
);
5062 struct target
*target
= Jim_CmdPrivData(interp
);
5063 if (!target
->tap
->enabled
)
5064 return jim_target_tap_disabled(interp
);
5066 if (allow_defer
&& target
->defer_examine
) {
5067 LOG_INFO("Deferring arp_examine of %s", target_name(target
));
5068 LOG_INFO("Use arp_examine command to examine it manually!");
5072 int e
= target
->type
->examine(target
);
5078 static int jim_target_was_examined(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5080 struct target
*target
= Jim_CmdPrivData(interp
);
5082 Jim_SetResultBool(interp
, target_was_examined(target
));
5086 static int jim_target_examine_deferred(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5088 struct target
*target
= Jim_CmdPrivData(interp
);
5090 Jim_SetResultBool(interp
, target
->defer_examine
);
5094 static int jim_target_halt_gdb(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5097 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5100 struct target
*target
= Jim_CmdPrivData(interp
);
5102 if (target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
) != ERROR_OK
)
5108 static int jim_target_poll(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5111 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5114 struct target
*target
= Jim_CmdPrivData(interp
);
5115 if (!target
->tap
->enabled
)
5116 return jim_target_tap_disabled(interp
);
5119 if (!(target_was_examined(target
)))
5120 e
= ERROR_TARGET_NOT_EXAMINED
;
5122 e
= target
->type
->poll(target
);
5128 static int jim_target_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5131 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5133 if (goi
.argc
!= 2) {
5134 Jim_WrongNumArgs(interp
, 0, argv
,
5135 "([tT]|[fF]|assert|deassert) BOOL");
5140 int e
= Jim_GetOpt_Nvp(&goi
, nvp_assert
, &n
);
5142 Jim_GetOpt_NvpUnknown(&goi
, nvp_assert
, 1);
5145 /* the halt or not param */
5147 e
= Jim_GetOpt_Wide(&goi
, &a
);
5151 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
5152 if (!target
->tap
->enabled
)
5153 return jim_target_tap_disabled(interp
);
5155 if (!target
->type
->assert_reset
|| !target
->type
->deassert_reset
) {
5156 Jim_SetResultFormatted(interp
,
5157 "No target-specific reset for %s",
5158 target_name(target
));
5162 if (target
->defer_examine
)
5163 target_reset_examined(target
);
5165 /* determine if we should halt or not. */
5166 target
->reset_halt
= !!a
;
5167 /* When this happens - all workareas are invalid. */
5168 target_free_all_working_areas_restore(target
, 0);
5171 if (n
->value
== NVP_ASSERT
)
5172 e
= target
->type
->assert_reset(target
);
5174 e
= target
->type
->deassert_reset(target
);
5175 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5178 static int jim_target_halt(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5181 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5184 struct target
*target
= Jim_CmdPrivData(interp
);
5185 if (!target
->tap
->enabled
)
5186 return jim_target_tap_disabled(interp
);
5187 int e
= target
->type
->halt(target
);
5188 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5191 static int jim_target_wait_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5194 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5196 /* params: <name> statename timeoutmsecs */
5197 if (goi
.argc
!= 2) {
5198 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5199 Jim_SetResultFormatted(goi
.interp
,
5200 "%s <state_name> <timeout_in_msec>", cmd_name
);
5205 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_state
, &n
);
5207 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_state
, 1);
5211 e
= Jim_GetOpt_Wide(&goi
, &a
);
5214 struct target
*target
= Jim_CmdPrivData(interp
);
5215 if (!target
->tap
->enabled
)
5216 return jim_target_tap_disabled(interp
);
5218 e
= target_wait_state(target
, n
->value
, a
);
5219 if (e
!= ERROR_OK
) {
5220 Jim_Obj
*eObj
= Jim_NewIntObj(interp
, e
);
5221 Jim_SetResultFormatted(goi
.interp
,
5222 "target: %s wait %s fails (%#s) %s",
5223 target_name(target
), n
->name
,
5224 eObj
, target_strerror_safe(e
));
5229 /* List for human, Events defined for this target.
5230 * scripts/programs should use 'name cget -event NAME'
5232 COMMAND_HANDLER(handle_target_event_list
)
5234 struct target
*target
= get_current_target(CMD_CTX
);
5235 struct target_event_action
*teap
= target
->event_action
;
5237 command_print(CMD
, "Event actions for target (%d) %s\n",
5238 target
->target_number
,
5239 target_name(target
));
5240 command_print(CMD
, "%-25s | Body", "Event");
5241 command_print(CMD
, "------------------------- | "
5242 "----------------------------------------");
5244 Jim_Nvp
*opt
= Jim_Nvp_value2name_simple(nvp_target_event
, teap
->event
);
5245 command_print(CMD
, "%-25s | %s",
5246 opt
->name
, Jim_GetString(teap
->body
, NULL
));
5249 command_print(CMD
, "***END***");
5252 static int jim_target_current_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5255 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5258 struct target
*target
= Jim_CmdPrivData(interp
);
5259 Jim_SetResultString(interp
, target_state_name(target
), -1);
5262 static int jim_target_invoke_event(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5265 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5266 if (goi
.argc
!= 1) {
5267 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5268 Jim_SetResultFormatted(goi
.interp
, "%s <eventname>", cmd_name
);
5272 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_event
, &n
);
5274 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_event
, 1);
5277 struct target
*target
= Jim_CmdPrivData(interp
);
5278 target_handle_event(target
, n
->value
);
5282 static const struct command_registration target_instance_command_handlers
[] = {
5284 .name
= "configure",
5285 .mode
= COMMAND_ANY
,
5286 .jim_handler
= jim_target_configure
,
5287 .help
= "configure a new target for use",
5288 .usage
= "[target_attribute ...]",
5292 .mode
= COMMAND_ANY
,
5293 .jim_handler
= jim_target_configure
,
5294 .help
= "returns the specified target attribute",
5295 .usage
= "target_attribute",
5299 .handler
= handle_mw_command
,
5300 .mode
= COMMAND_EXEC
,
5301 .help
= "Write 64-bit word(s) to target memory",
5302 .usage
= "address data [count]",
5306 .handler
= handle_mw_command
,
5307 .mode
= COMMAND_EXEC
,
5308 .help
= "Write 32-bit word(s) to target memory",
5309 .usage
= "address data [count]",
5313 .handler
= handle_mw_command
,
5314 .mode
= COMMAND_EXEC
,
5315 .help
= "Write 16-bit half-word(s) to target memory",
5316 .usage
= "address data [count]",
5320 .handler
= handle_mw_command
,
5321 .mode
= COMMAND_EXEC
,
5322 .help
= "Write byte(s) to target memory",
5323 .usage
= "address data [count]",
5327 .handler
= handle_md_command
,
5328 .mode
= COMMAND_EXEC
,
5329 .help
= "Display target memory as 64-bit words",
5330 .usage
= "address [count]",
5334 .handler
= handle_md_command
,
5335 .mode
= COMMAND_EXEC
,
5336 .help
= "Display target memory as 32-bit words",
5337 .usage
= "address [count]",
5341 .handler
= handle_md_command
,
5342 .mode
= COMMAND_EXEC
,
5343 .help
= "Display target memory as 16-bit half-words",
5344 .usage
= "address [count]",
5348 .handler
= handle_md_command
,
5349 .mode
= COMMAND_EXEC
,
5350 .help
= "Display target memory as 8-bit bytes",
5351 .usage
= "address [count]",
5354 .name
= "array2mem",
5355 .mode
= COMMAND_EXEC
,
5356 .jim_handler
= jim_target_array2mem
,
5357 .help
= "Writes Tcl array of 8/16/32 bit numbers "
5359 .usage
= "arrayname bitwidth address count",
5362 .name
= "mem2array",
5363 .mode
= COMMAND_EXEC
,
5364 .jim_handler
= jim_target_mem2array
,
5365 .help
= "Loads Tcl array of 8/16/32 bit numbers "
5366 "from target memory",
5367 .usage
= "arrayname bitwidth address count",
5370 .name
= "eventlist",
5371 .handler
= handle_target_event_list
,
5372 .mode
= COMMAND_EXEC
,
5373 .help
= "displays a table of events defined for this target",
5378 .mode
= COMMAND_EXEC
,
5379 .jim_handler
= jim_target_current_state
,
5380 .help
= "displays the current state of this target",
5383 .name
= "arp_examine",
5384 .mode
= COMMAND_EXEC
,
5385 .jim_handler
= jim_target_examine
,
5386 .help
= "used internally for reset processing",
5387 .usage
= "['allow-defer']",
5390 .name
= "was_examined",
5391 .mode
= COMMAND_EXEC
,
5392 .jim_handler
= jim_target_was_examined
,
5393 .help
= "used internally for reset processing",
5396 .name
= "examine_deferred",
5397 .mode
= COMMAND_EXEC
,
5398 .jim_handler
= jim_target_examine_deferred
,
5399 .help
= "used internally for reset processing",
5402 .name
= "arp_halt_gdb",
5403 .mode
= COMMAND_EXEC
,
5404 .jim_handler
= jim_target_halt_gdb
,
5405 .help
= "used internally for reset processing to halt GDB",
5409 .mode
= COMMAND_EXEC
,
5410 .jim_handler
= jim_target_poll
,
5411 .help
= "used internally for reset processing",
5414 .name
= "arp_reset",
5415 .mode
= COMMAND_EXEC
,
5416 .jim_handler
= jim_target_reset
,
5417 .help
= "used internally for reset processing",
5421 .mode
= COMMAND_EXEC
,
5422 .jim_handler
= jim_target_halt
,
5423 .help
= "used internally for reset processing",
5426 .name
= "arp_waitstate",
5427 .mode
= COMMAND_EXEC
,
5428 .jim_handler
= jim_target_wait_state
,
5429 .help
= "used internally for reset processing",
5432 .name
= "invoke-event",
5433 .mode
= COMMAND_EXEC
,
5434 .jim_handler
= jim_target_invoke_event
,
5435 .help
= "invoke handler for specified event",
5436 .usage
= "event_name",
5438 COMMAND_REGISTRATION_DONE
5441 static int target_create(Jim_GetOptInfo
*goi
)
5448 struct target
*target
;
5449 struct command_context
*cmd_ctx
;
5451 cmd_ctx
= current_command_context(goi
->interp
);
5452 assert(cmd_ctx
!= NULL
);
5454 if (goi
->argc
< 3) {
5455 Jim_WrongNumArgs(goi
->interp
, 1, goi
->argv
, "?name? ?type? ..options...");
5460 Jim_GetOpt_Obj(goi
, &new_cmd
);
5461 /* does this command exist? */
5462 cmd
= Jim_GetCommand(goi
->interp
, new_cmd
, JIM_ERRMSG
);
5464 cp
= Jim_GetString(new_cmd
, NULL
);
5465 Jim_SetResultFormatted(goi
->interp
, "Command/target: %s Exists", cp
);
5470 e
= Jim_GetOpt_String(goi
, &cp
, NULL
);
5473 struct transport
*tr
= get_current_transport();
5474 if (tr
->override_target
) {
5475 e
= tr
->override_target(&cp
);
5476 if (e
!= ERROR_OK
) {
5477 LOG_ERROR("The selected transport doesn't support this target");
5480 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5482 /* now does target type exist */
5483 for (x
= 0 ; target_types
[x
] ; x
++) {
5484 if (0 == strcmp(cp
, target_types
[x
]->name
)) {
5489 /* check for deprecated name */
5490 if (target_types
[x
]->deprecated_name
) {
5491 if (0 == strcmp(cp
, target_types
[x
]->deprecated_name
)) {
5493 LOG_WARNING("target name is deprecated use: \'%s\'", target_types
[x
]->name
);
5498 if (target_types
[x
] == NULL
) {
5499 Jim_SetResultFormatted(goi
->interp
, "Unknown target type %s, try one of ", cp
);
5500 for (x
= 0 ; target_types
[x
] ; x
++) {
5501 if (target_types
[x
+ 1]) {
5502 Jim_AppendStrings(goi
->interp
,
5503 Jim_GetResult(goi
->interp
),
5504 target_types
[x
]->name
,
5507 Jim_AppendStrings(goi
->interp
,
5508 Jim_GetResult(goi
->interp
),
5510 target_types
[x
]->name
, NULL
);
5517 target
= calloc(1, sizeof(struct target
));
5519 LOG_ERROR("Out of memory");
5523 /* set target number */
5524 target
->target_number
= new_target_number();
5526 /* allocate memory for each unique target type */
5527 target
->type
= malloc(sizeof(struct target_type
));
5528 if (!target
->type
) {
5529 LOG_ERROR("Out of memory");
5534 memcpy(target
->type
, target_types
[x
], sizeof(struct target_type
));
5536 /* will be set by "-endian" */
5537 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5539 /* default to first core, override with -coreid */
5542 target
->working_area
= 0x0;
5543 target
->working_area_size
= 0x0;
5544 target
->working_areas
= NULL
;
5545 target
->backup_working_area
= 0;
5547 target
->state
= TARGET_UNKNOWN
;
5548 target
->debug_reason
= DBG_REASON_UNDEFINED
;
5549 target
->reg_cache
= NULL
;
5550 target
->breakpoints
= NULL
;
5551 target
->watchpoints
= NULL
;
5552 target
->next
= NULL
;
5553 target
->arch_info
= NULL
;
5555 target
->verbose_halt_msg
= true;
5557 target
->halt_issued
= false;
5559 /* initialize trace information */
5560 target
->trace_info
= calloc(1, sizeof(struct trace
));
5561 if (!target
->trace_info
) {
5562 LOG_ERROR("Out of memory");
5568 target
->dbgmsg
= NULL
;
5569 target
->dbg_msg_enabled
= 0;
5571 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5573 target
->rtos
= NULL
;
5574 target
->rtos_auto_detect
= false;
5576 target
->gdb_port_override
= NULL
;
5577 target
->gdb_max_connections
= 1;
5579 /* Do the rest as "configure" options */
5580 goi
->isconfigure
= 1;
5581 e
= target_configure(goi
, target
);
5584 if (target
->has_dap
) {
5585 if (!target
->dap_configured
) {
5586 Jim_SetResultString(goi
->interp
, "-dap ?name? required when creating target", -1);
5590 if (!target
->tap_configured
) {
5591 Jim_SetResultString(goi
->interp
, "-chain-position ?name? required when creating target", -1);
5595 /* tap must be set after target was configured */
5596 if (target
->tap
== NULL
)
5601 rtos_destroy(target
);
5602 free(target
->gdb_port_override
);
5603 free(target
->trace_info
);
5609 if (target
->endianness
== TARGET_ENDIAN_UNKNOWN
) {
5610 /* default endian to little if not specified */
5611 target
->endianness
= TARGET_LITTLE_ENDIAN
;
5614 cp
= Jim_GetString(new_cmd
, NULL
);
5615 target
->cmd_name
= strdup(cp
);
5616 if (!target
->cmd_name
) {
5617 LOG_ERROR("Out of memory");
5618 rtos_destroy(target
);
5619 free(target
->gdb_port_override
);
5620 free(target
->trace_info
);
5626 if (target
->type
->target_create
) {
5627 e
= (*(target
->type
->target_create
))(target
, goi
->interp
);
5628 if (e
!= ERROR_OK
) {
5629 LOG_DEBUG("target_create failed");
5630 free(target
->cmd_name
);
5631 rtos_destroy(target
);
5632 free(target
->gdb_port_override
);
5633 free(target
->trace_info
);
5640 /* create the target specific commands */
5641 if (target
->type
->commands
) {
5642 e
= register_commands(cmd_ctx
, NULL
, target
->type
->commands
);
5644 LOG_ERROR("unable to register '%s' commands", cp
);
5647 /* now - create the new target name command */
5648 const struct command_registration target_subcommands
[] = {
5650 .chain
= target_instance_command_handlers
,
5653 .chain
= target
->type
->commands
,
5655 COMMAND_REGISTRATION_DONE
5657 const struct command_registration target_commands
[] = {
5660 .mode
= COMMAND_ANY
,
5661 .help
= "target command group",
5663 .chain
= target_subcommands
,
5665 COMMAND_REGISTRATION_DONE
5667 e
= register_commands(cmd_ctx
, NULL
, target_commands
);
5668 if (e
!= ERROR_OK
) {
5669 if (target
->type
->deinit_target
)
5670 target
->type
->deinit_target(target
);
5671 free(target
->cmd_name
);
5672 rtos_destroy(target
);
5673 free(target
->gdb_port_override
);
5674 free(target
->trace_info
);
5680 struct command
*c
= command_find_in_context(cmd_ctx
, cp
);
5682 command_set_handler_data(c
, target
);
5684 /* append to end of list */
5685 append_to_list_all_targets(target
);
5687 cmd_ctx
->current_target
= target
;
5691 static int jim_target_current(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5694 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5697 struct command_context
*cmd_ctx
= current_command_context(interp
);
5698 assert(cmd_ctx
!= NULL
);
5700 struct target
*target
= get_current_target_or_null(cmd_ctx
);
5702 Jim_SetResultString(interp
, target_name(target
), -1);
5706 static int jim_target_types(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5709 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5712 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5713 for (unsigned x
= 0; NULL
!= target_types
[x
]; x
++) {
5714 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5715 Jim_NewStringObj(interp
, target_types
[x
]->name
, -1));
5720 static int jim_target_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5723 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5726 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5727 struct target
*target
= all_targets
;
5729 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5730 Jim_NewStringObj(interp
, target_name(target
), -1));
5731 target
= target
->next
;
5736 static int jim_target_smp(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5739 const char *targetname
;
5741 struct target
*target
= (struct target
*) NULL
;
5742 struct target_list
*head
, *curr
, *new;
5743 curr
= (struct target_list
*) NULL
;
5744 head
= (struct target_list
*) NULL
;
5747 LOG_DEBUG("%d", argc
);
5748 /* argv[1] = target to associate in smp
5749 * argv[2] = target to associate in smp
5753 for (i
= 1; i
< argc
; i
++) {
5755 targetname
= Jim_GetString(argv
[i
], &len
);
5756 target
= get_target(targetname
);
5757 LOG_DEBUG("%s ", targetname
);
5759 new = malloc(sizeof(struct target_list
));
5760 new->target
= target
;
5761 new->next
= (struct target_list
*)NULL
;
5762 if (head
== (struct target_list
*)NULL
) {
5771 /* now parse the list of cpu and put the target in smp mode*/
5774 while (curr
!= (struct target_list
*)NULL
) {
5775 target
= curr
->target
;
5777 target
->head
= head
;
5781 if (target
&& target
->rtos
)
5782 retval
= rtos_smp_init(head
->target
);
5788 static int jim_target_create(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5791 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5793 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
5794 "<name> <target_type> [<target_options> ...]");
5797 return target_create(&goi
);
5800 static const struct command_registration target_subcommand_handlers
[] = {
5803 .mode
= COMMAND_CONFIG
,
5804 .handler
= handle_target_init_command
,
5805 .help
= "initialize targets",
5810 .mode
= COMMAND_CONFIG
,
5811 .jim_handler
= jim_target_create
,
5812 .usage
= "name type '-chain-position' name [options ...]",
5813 .help
= "Creates and selects a new target",
5817 .mode
= COMMAND_ANY
,
5818 .jim_handler
= jim_target_current
,
5819 .help
= "Returns the currently selected target",
5823 .mode
= COMMAND_ANY
,
5824 .jim_handler
= jim_target_types
,
5825 .help
= "Returns the available target types as "
5826 "a list of strings",
5830 .mode
= COMMAND_ANY
,
5831 .jim_handler
= jim_target_names
,
5832 .help
= "Returns the names of all targets as a list of strings",
5836 .mode
= COMMAND_ANY
,
5837 .jim_handler
= jim_target_smp
,
5838 .usage
= "targetname1 targetname2 ...",
5839 .help
= "gather several target in a smp list"
5842 COMMAND_REGISTRATION_DONE
5846 target_addr_t address
;
5852 static int fastload_num
;
5853 static struct FastLoad
*fastload
;
5855 static void free_fastload(void)
5857 if (fastload
!= NULL
) {
5858 for (int i
= 0; i
< fastload_num
; i
++)
5859 free(fastload
[i
].data
);
5865 COMMAND_HANDLER(handle_fast_load_image_command
)
5869 uint32_t image_size
;
5870 target_addr_t min_address
= 0;
5871 target_addr_t max_address
= -1;
5875 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
5876 &image
, &min_address
, &max_address
);
5877 if (ERROR_OK
!= retval
)
5880 struct duration bench
;
5881 duration_start(&bench
);
5883 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
);
5884 if (retval
!= ERROR_OK
)
5889 fastload_num
= image
.num_sections
;
5890 fastload
= malloc(sizeof(struct FastLoad
)*image
.num_sections
);
5891 if (fastload
== NULL
) {
5892 command_print(CMD
, "out of memory");
5893 image_close(&image
);
5896 memset(fastload
, 0, sizeof(struct FastLoad
)*image
.num_sections
);
5897 for (unsigned int i
= 0; i
< image
.num_sections
; i
++) {
5898 buffer
= malloc(image
.sections
[i
].size
);
5899 if (buffer
== NULL
) {
5900 command_print(CMD
, "error allocating buffer for section (%d bytes)",
5901 (int)(image
.sections
[i
].size
));
5902 retval
= ERROR_FAIL
;
5906 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
5907 if (retval
!= ERROR_OK
) {
5912 uint32_t offset
= 0;
5913 uint32_t length
= buf_cnt
;
5915 /* DANGER!!! beware of unsigned comparison here!!! */
5917 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
5918 (image
.sections
[i
].base_address
< max_address
)) {
5919 if (image
.sections
[i
].base_address
< min_address
) {
5920 /* clip addresses below */
5921 offset
+= min_address
-image
.sections
[i
].base_address
;
5925 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
5926 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
5928 fastload
[i
].address
= image
.sections
[i
].base_address
+ offset
;
5929 fastload
[i
].data
= malloc(length
);
5930 if (fastload
[i
].data
== NULL
) {
5932 command_print(CMD
, "error allocating buffer for section (%" PRIu32
" bytes)",
5934 retval
= ERROR_FAIL
;
5937 memcpy(fastload
[i
].data
, buffer
+ offset
, length
);
5938 fastload
[i
].length
= length
;
5940 image_size
+= length
;
5941 command_print(CMD
, "%u bytes written at address 0x%8.8x",
5942 (unsigned int)length
,
5943 ((unsigned int)(image
.sections
[i
].base_address
+ offset
)));
5949 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
5950 command_print(CMD
, "Loaded %" PRIu32
" bytes "
5951 "in %fs (%0.3f KiB/s)", image_size
,
5952 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
5955 "WARNING: image has not been loaded to target!"
5956 "You can issue a 'fast_load' to finish loading.");
5959 image_close(&image
);
5961 if (retval
!= ERROR_OK
)
5967 COMMAND_HANDLER(handle_fast_load_command
)
5970 return ERROR_COMMAND_SYNTAX_ERROR
;
5971 if (fastload
== NULL
) {
5972 LOG_ERROR("No image in memory");
5976 int64_t ms
= timeval_ms();
5978 int retval
= ERROR_OK
;
5979 for (i
= 0; i
< fastload_num
; i
++) {
5980 struct target
*target
= get_current_target(CMD_CTX
);
5981 command_print(CMD
, "Write to 0x%08x, length 0x%08x",
5982 (unsigned int)(fastload
[i
].address
),
5983 (unsigned int)(fastload
[i
].length
));
5984 retval
= target_write_buffer(target
, fastload
[i
].address
, fastload
[i
].length
, fastload
[i
].data
);
5985 if (retval
!= ERROR_OK
)
5987 size
+= fastload
[i
].length
;
5989 if (retval
== ERROR_OK
) {
5990 int64_t after
= timeval_ms();
5991 command_print(CMD
, "Loaded image %f kBytes/s", (float)(size
/1024.0)/((float)(after
-ms
)/1000.0));
5996 static const struct command_registration target_command_handlers
[] = {
5999 .handler
= handle_targets_command
,
6000 .mode
= COMMAND_ANY
,
6001 .help
= "change current default target (one parameter) "
6002 "or prints table of all targets (no parameters)",
6003 .usage
= "[target]",
6007 .mode
= COMMAND_CONFIG
,
6008 .help
= "configure target",
6009 .chain
= target_subcommand_handlers
,
6012 COMMAND_REGISTRATION_DONE
6015 int target_register_commands(struct command_context
*cmd_ctx
)
6017 return register_commands(cmd_ctx
, NULL
, target_command_handlers
);
6020 static bool target_reset_nag
= true;
6022 bool get_target_reset_nag(void)
6024 return target_reset_nag
;
6027 COMMAND_HANDLER(handle_target_reset_nag
)
6029 return CALL_COMMAND_HANDLER(handle_command_parse_bool
,
6030 &target_reset_nag
, "Nag after each reset about options to improve "
6034 COMMAND_HANDLER(handle_ps_command
)
6036 struct target
*target
= get_current_target(CMD_CTX
);
6038 if (target
->state
!= TARGET_HALTED
) {
6039 LOG_INFO("target not halted !!");
6043 if ((target
->rtos
) && (target
->rtos
->type
)
6044 && (target
->rtos
->type
->ps_command
)) {
6045 display
= target
->rtos
->type
->ps_command(target
);
6046 command_print(CMD
, "%s", display
);
6051 return ERROR_TARGET_FAILURE
;
6055 static void binprint(struct command_invocation
*cmd
, const char *text
, const uint8_t *buf
, int size
)
6058 command_print_sameline(cmd
, "%s", text
);
6059 for (int i
= 0; i
< size
; i
++)
6060 command_print_sameline(cmd
, " %02x", buf
[i
]);
6061 command_print(cmd
, " ");
6064 COMMAND_HANDLER(handle_test_mem_access_command
)
6066 struct target
*target
= get_current_target(CMD_CTX
);
6068 int retval
= ERROR_OK
;
6070 if (target
->state
!= TARGET_HALTED
) {
6071 LOG_INFO("target not halted !!");
6076 return ERROR_COMMAND_SYNTAX_ERROR
;
6078 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], test_size
);
6081 size_t num_bytes
= test_size
+ 4;
6083 struct working_area
*wa
= NULL
;
6084 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
6085 if (retval
!= ERROR_OK
) {
6086 LOG_ERROR("Not enough working area");
6090 uint8_t *test_pattern
= malloc(num_bytes
);
6092 for (size_t i
= 0; i
< num_bytes
; i
++)
6093 test_pattern
[i
] = rand();
6095 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6096 if (retval
!= ERROR_OK
) {
6097 LOG_ERROR("Test pattern write failed");
6101 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6102 for (int size
= 1; size
<= 4; size
*= 2) {
6103 for (int offset
= 0; offset
< 4; offset
++) {
6104 uint32_t count
= test_size
/ size
;
6105 size_t host_bufsiz
= (count
+ 2) * size
+ host_offset
;
6106 uint8_t *read_ref
= malloc(host_bufsiz
);
6107 uint8_t *read_buf
= malloc(host_bufsiz
);
6109 for (size_t i
= 0; i
< host_bufsiz
; i
++) {
6110 read_ref
[i
] = rand();
6111 read_buf
[i
] = read_ref
[i
];
6113 command_print_sameline(CMD
,
6114 "Test read %" PRIu32
" x %d @ %d to %saligned buffer: ", count
,
6115 size
, offset
, host_offset
? "un" : "");
6117 struct duration bench
;
6118 duration_start(&bench
);
6120 retval
= target_read_memory(target
, wa
->address
+ offset
, size
, count
,
6121 read_buf
+ size
+ host_offset
);
6123 duration_measure(&bench
);
6125 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6126 command_print(CMD
, "Unsupported alignment");
6128 } else if (retval
!= ERROR_OK
) {
6129 command_print(CMD
, "Memory read failed");
6133 /* replay on host */
6134 memcpy(read_ref
+ size
+ host_offset
, test_pattern
+ offset
, count
* size
);
6137 int result
= memcmp(read_ref
, read_buf
, host_bufsiz
);
6139 command_print(CMD
, "Pass in %fs (%0.3f KiB/s)",
6140 duration_elapsed(&bench
),
6141 duration_kbps(&bench
, count
* size
));
6143 command_print(CMD
, "Compare failed");
6144 binprint(CMD
, "ref:", read_ref
, host_bufsiz
);
6145 binprint(CMD
, "buf:", read_buf
, host_bufsiz
);
6158 target_free_working_area(target
, wa
);
6161 num_bytes
= test_size
+ 4 + 4 + 4;
6163 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
6164 if (retval
!= ERROR_OK
) {
6165 LOG_ERROR("Not enough working area");
6169 test_pattern
= malloc(num_bytes
);
6171 for (size_t i
= 0; i
< num_bytes
; i
++)
6172 test_pattern
[i
] = rand();
6174 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6175 for (int size
= 1; size
<= 4; size
*= 2) {
6176 for (int offset
= 0; offset
< 4; offset
++) {
6177 uint32_t count
= test_size
/ size
;
6178 size_t host_bufsiz
= count
* size
+ host_offset
;
6179 uint8_t *read_ref
= malloc(num_bytes
);
6180 uint8_t *read_buf
= malloc(num_bytes
);
6181 uint8_t *write_buf
= malloc(host_bufsiz
);
6183 for (size_t i
= 0; i
< host_bufsiz
; i
++)
6184 write_buf
[i
] = rand();
6185 command_print_sameline(CMD
,
6186 "Test write %" PRIu32
" x %d @ %d from %saligned buffer: ", count
,
6187 size
, offset
, host_offset
? "un" : "");
6189 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6190 if (retval
!= ERROR_OK
) {
6191 command_print(CMD
, "Test pattern write failed");
6195 /* replay on host */
6196 memcpy(read_ref
, test_pattern
, num_bytes
);
6197 memcpy(read_ref
+ size
+ offset
, write_buf
+ host_offset
, count
* size
);
6199 struct duration bench
;
6200 duration_start(&bench
);
6202 retval
= target_write_memory(target
, wa
->address
+ size
+ offset
, size
, count
,
6203 write_buf
+ host_offset
);
6205 duration_measure(&bench
);
6207 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6208 command_print(CMD
, "Unsupported alignment");
6210 } else if (retval
!= ERROR_OK
) {
6211 command_print(CMD
, "Memory write failed");
6216 retval
= target_read_memory(target
, wa
->address
, 1, num_bytes
, read_buf
);
6217 if (retval
!= ERROR_OK
) {
6218 command_print(CMD
, "Test pattern write failed");
6223 int result
= memcmp(read_ref
, read_buf
, num_bytes
);
6225 command_print(CMD
, "Pass in %fs (%0.3f KiB/s)",
6226 duration_elapsed(&bench
),
6227 duration_kbps(&bench
, count
* size
));
6229 command_print(CMD
, "Compare failed");
6230 binprint(CMD
, "ref:", read_ref
, num_bytes
);
6231 binprint(CMD
, "buf:", read_buf
, num_bytes
);
6243 target_free_working_area(target
, wa
);
6247 static const struct command_registration target_exec_command_handlers
[] = {
6249 .name
= "fast_load_image",
6250 .handler
= handle_fast_load_image_command
,
6251 .mode
= COMMAND_ANY
,
6252 .help
= "Load image into server memory for later use by "
6253 "fast_load; primarily for profiling",
6254 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6255 "[min_address [max_length]]",
6258 .name
= "fast_load",
6259 .handler
= handle_fast_load_command
,
6260 .mode
= COMMAND_EXEC
,
6261 .help
= "loads active fast load image to current target "
6262 "- mainly for profiling purposes",
6267 .handler
= handle_profile_command
,
6268 .mode
= COMMAND_EXEC
,
6269 .usage
= "seconds filename [start end]",
6270 .help
= "profiling samples the CPU PC",
6272 /** @todo don't register virt2phys() unless target supports it */
6274 .name
= "virt2phys",
6275 .handler
= handle_virt2phys_command
,
6276 .mode
= COMMAND_ANY
,
6277 .help
= "translate a virtual address into a physical address",
6278 .usage
= "virtual_address",
6282 .handler
= handle_reg_command
,
6283 .mode
= COMMAND_EXEC
,
6284 .help
= "display (reread from target with \"force\") or set a register; "
6285 "with no arguments, displays all registers and their values",
6286 .usage
= "[(register_number|register_name) [(value|'force')]]",
6290 .handler
= handle_poll_command
,
6291 .mode
= COMMAND_EXEC
,
6292 .help
= "poll target state; or reconfigure background polling",
6293 .usage
= "['on'|'off']",
6296 .name
= "wait_halt",
6297 .handler
= handle_wait_halt_command
,
6298 .mode
= COMMAND_EXEC
,
6299 .help
= "wait up to the specified number of milliseconds "
6300 "(default 5000) for a previously requested halt",
6301 .usage
= "[milliseconds]",
6305 .handler
= handle_halt_command
,
6306 .mode
= COMMAND_EXEC
,
6307 .help
= "request target to halt, then wait up to the specified "
6308 "number of milliseconds (default 5000) for it to complete",
6309 .usage
= "[milliseconds]",
6313 .handler
= handle_resume_command
,
6314 .mode
= COMMAND_EXEC
,
6315 .help
= "resume target execution from current PC or address",
6316 .usage
= "[address]",
6320 .handler
= handle_reset_command
,
6321 .mode
= COMMAND_EXEC
,
6322 .usage
= "[run|halt|init]",
6323 .help
= "Reset all targets into the specified mode. "
6324 "Default reset mode is run, if not given.",
6327 .name
= "soft_reset_halt",
6328 .handler
= handle_soft_reset_halt_command
,
6329 .mode
= COMMAND_EXEC
,
6331 .help
= "halt the target and do a soft reset",
6335 .handler
= handle_step_command
,
6336 .mode
= COMMAND_EXEC
,
6337 .help
= "step one instruction from current PC or address",
6338 .usage
= "[address]",
6342 .handler
= handle_md_command
,
6343 .mode
= COMMAND_EXEC
,
6344 .help
= "display memory double-words",
6345 .usage
= "['phys'] address [count]",
6349 .handler
= handle_md_command
,
6350 .mode
= COMMAND_EXEC
,
6351 .help
= "display memory words",
6352 .usage
= "['phys'] address [count]",
6356 .handler
= handle_md_command
,
6357 .mode
= COMMAND_EXEC
,
6358 .help
= "display memory half-words",
6359 .usage
= "['phys'] address [count]",
6363 .handler
= handle_md_command
,
6364 .mode
= COMMAND_EXEC
,
6365 .help
= "display memory bytes",
6366 .usage
= "['phys'] address [count]",
6370 .handler
= handle_mw_command
,
6371 .mode
= COMMAND_EXEC
,
6372 .help
= "write memory double-word",
6373 .usage
= "['phys'] address value [count]",
6377 .handler
= handle_mw_command
,
6378 .mode
= COMMAND_EXEC
,
6379 .help
= "write memory word",
6380 .usage
= "['phys'] address value [count]",
6384 .handler
= handle_mw_command
,
6385 .mode
= COMMAND_EXEC
,
6386 .help
= "write memory half-word",
6387 .usage
= "['phys'] address value [count]",
6391 .handler
= handle_mw_command
,
6392 .mode
= COMMAND_EXEC
,
6393 .help
= "write memory byte",
6394 .usage
= "['phys'] address value [count]",
6398 .handler
= handle_bp_command
,
6399 .mode
= COMMAND_EXEC
,
6400 .help
= "list or set hardware or software breakpoint",
6401 .usage
= "[<address> [<asid>] <length> ['hw'|'hw_ctx']]",
6405 .handler
= handle_rbp_command
,
6406 .mode
= COMMAND_EXEC
,
6407 .help
= "remove breakpoint",
6408 .usage
= "'all' | address",
6412 .handler
= handle_wp_command
,
6413 .mode
= COMMAND_EXEC
,
6414 .help
= "list (no params) or create watchpoints",
6415 .usage
= "[address length [('r'|'w'|'a') value [mask]]]",
6419 .handler
= handle_rwp_command
,
6420 .mode
= COMMAND_EXEC
,
6421 .help
= "remove watchpoint",
6425 .name
= "load_image",
6426 .handler
= handle_load_image_command
,
6427 .mode
= COMMAND_EXEC
,
6428 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6429 "[min_address] [max_length]",
6432 .name
= "dump_image",
6433 .handler
= handle_dump_image_command
,
6434 .mode
= COMMAND_EXEC
,
6435 .usage
= "filename address size",
6438 .name
= "verify_image_checksum",
6439 .handler
= handle_verify_image_checksum_command
,
6440 .mode
= COMMAND_EXEC
,
6441 .usage
= "filename [offset [type]]",
6444 .name
= "verify_image",
6445 .handler
= handle_verify_image_command
,
6446 .mode
= COMMAND_EXEC
,
6447 .usage
= "filename [offset [type]]",
6450 .name
= "test_image",
6451 .handler
= handle_test_image_command
,
6452 .mode
= COMMAND_EXEC
,
6453 .usage
= "filename [offset [type]]",
6456 .name
= "mem2array",
6457 .mode
= COMMAND_EXEC
,
6458 .jim_handler
= jim_mem2array
,
6459 .help
= "read 8/16/32 bit memory and return as a TCL array "
6460 "for script processing",
6461 .usage
= "arrayname bitwidth address count",
6464 .name
= "array2mem",
6465 .mode
= COMMAND_EXEC
,
6466 .jim_handler
= jim_array2mem
,
6467 .help
= "convert a TCL array to memory locations "
6468 "and write the 8/16/32 bit values",
6469 .usage
= "arrayname bitwidth address count",
6472 .name
= "reset_nag",
6473 .handler
= handle_target_reset_nag
,
6474 .mode
= COMMAND_ANY
,
6475 .help
= "Nag after each reset about options that could have been "
6476 "enabled to improve performance. ",
6477 .usage
= "['enable'|'disable']",
6481 .handler
= handle_ps_command
,
6482 .mode
= COMMAND_EXEC
,
6483 .help
= "list all tasks ",
6487 .name
= "test_mem_access",
6488 .handler
= handle_test_mem_access_command
,
6489 .mode
= COMMAND_EXEC
,
6490 .help
= "Test the target's memory access functions",
6494 COMMAND_REGISTRATION_DONE
6496 static int target_register_user_commands(struct command_context
*cmd_ctx
)
6498 int retval
= ERROR_OK
;
6499 retval
= target_request_register_commands(cmd_ctx
);
6500 if (retval
!= ERROR_OK
)
6503 retval
= trace_register_commands(cmd_ctx
);
6504 if (retval
!= ERROR_OK
)
6508 return register_commands(cmd_ctx
, NULL
, target_exec_command_handlers
);