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);
75 static int target_profiling_default(struct target *target, uint32_t *samples,
76 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds);
79 extern struct target_type arm7tdmi_target;
80 extern struct target_type arm720t_target;
81 extern struct target_type arm9tdmi_target;
82 extern struct target_type arm920t_target;
83 extern struct target_type arm966e_target;
84 extern struct target_type arm946e_target;
85 extern struct target_type arm926ejs_target;
86 extern struct target_type fa526_target;
87 extern struct target_type feroceon_target;
88 extern struct target_type dragonite_target;
89 extern struct target_type xscale_target;
90 extern struct target_type cortexm_target;
91 extern struct target_type cortexa_target;
92 extern struct target_type aarch64_target;
93 extern struct target_type cortexr4_target;
94 extern struct target_type arm11_target;
95 extern struct target_type ls1_sap_target;
96 extern struct target_type mips_m4k_target;
97 extern struct target_type avr_target;
98 extern struct target_type dsp563xx_target;
99 extern struct target_type dsp5680xx_target;
100 extern struct target_type testee_target;
101 extern struct target_type avr32_ap7k_target;
102 extern struct target_type hla_target;
103 extern struct target_type nds32_v2_target;
104 extern struct target_type nds32_v3_target;
105 extern struct target_type nds32_v3m_target;
106 extern struct target_type or1k_target;
107 extern struct target_type quark_x10xx_target;
108 extern struct target_type quark_d20xx_target;
109 extern struct target_type stm8_target;
110 extern struct target_type riscv_target;
111 extern struct target_type mem_ap_target;
112 extern struct target_type esirisc_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 LIST_HEAD(target_reset_callback_list);
158 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" },
205 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
206 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
208 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
209 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
210 { .value = TARGET_EVENT_RESET_ASSERT, .name = "reset-assert" },
211 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
212 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
213 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
214 { .value = TARGET_EVENT_RESET_INIT, .name = "reset-init" },
215 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
217 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
218 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
220 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
221 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
223 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
224 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
226 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
227 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
229 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
230 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
232 { .value = TARGET_EVENT_TRACE_CONFIG, .name = "trace-config" },
234 { .name = NULL, .value = -1 }
237 static const Jim_Nvp nvp_target_state[] = {
238 { .name = "unknown", .value = TARGET_UNKNOWN },
239 { .name = "running", .value = TARGET_RUNNING },
240 { .name = "halted", .value = TARGET_HALTED },
241 { .name = "reset", .value = TARGET_RESET },
242 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
243 { .name = NULL, .value = -1 },
246 static const Jim_Nvp nvp_target_debug_reason[] = {
247 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
248 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
249 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
250 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
251 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
252 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
253 { .name = "program-exit" , .value = DBG_REASON_EXIT },
254 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
255 { .name = NULL, .value = -1 },
258 static const Jim_Nvp nvp_target_endian[] = {
259 { .name = "big", .value = TARGET_BIG_ENDIAN },
260 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
261 { .name = "be", .value = TARGET_BIG_ENDIAN },
262 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
263 { .name = NULL, .value = -1 },
266 static const Jim_Nvp nvp_reset_modes[] = {
267 { .name = "unknown", .value = RESET_UNKNOWN },
268 { .name = "run" , .value = RESET_RUN },
269 { .name = "halt" , .value = RESET_HALT },
270 { .name = "init" , .value = RESET_INIT },
271 { .name = NULL , .value = -1 },
274 const char *debug_reason_name(struct target *t)
278 cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
279 t->debug_reason)->name;
281 LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
282 cp = "(*BUG*unknown*BUG*)";
287 const char *target_state_name(struct target *t)
290 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
292 LOG_ERROR("Invalid target state: %d", (int)(t->state));
293 cp = "(*BUG*unknown*BUG*)";
296 if (!target_was_examined(t) && t->defer_examine)
297 cp = "examine deferred";
302 const char *target_event_name(enum target_event event)
305 cp = Jim_Nvp_value2name_simple(nvp_target_event, event)->name;
307 LOG_ERROR("Invalid target event: %d", (int)(event));
308 cp = "(*BUG*unknown*BUG*)";
313 const char *target_reset_mode_name(enum target_reset_mode reset_mode)
316 cp = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode)->name;
318 LOG_ERROR("Invalid target reset mode: %d", (int)(reset_mode));
319 cp = "(*BUG*unknown*BUG*)";
324 /* determine the number of the new target */
325 static int new_target_number(void)
330 /* number is 0 based */
334 if (x < t->target_number)
335 x = t->target_number;
341 /* read a uint64_t from a buffer in target memory endianness */
342 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer)
344 if (target->endianness == TARGET_LITTLE_ENDIAN)
345 return le_to_h_u64(buffer);
347 return be_to_h_u64(buffer);
350 /* read a uint32_t from a buffer in target memory endianness */
351 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
353 if (target->endianness == TARGET_LITTLE_ENDIAN)
354 return le_to_h_u32(buffer);
356 return be_to_h_u32(buffer);
359 /* read a uint24_t from a buffer in target memory endianness */
360 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
362 if (target->endianness == TARGET_LITTLE_ENDIAN)
363 return le_to_h_u24(buffer);
365 return be_to_h_u24(buffer);
368 /* read a uint16_t from a buffer in target memory endianness */
369 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
371 if (target->endianness == TARGET_LITTLE_ENDIAN)
372 return le_to_h_u16(buffer);
374 return be_to_h_u16(buffer);
377 /* read a uint8_t from a buffer in target memory endianness */
378 static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
380 return *buffer & 0x0ff;
383 /* write a uint64_t to a buffer in target memory endianness */
384 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value)
386 if (target->endianness == TARGET_LITTLE_ENDIAN)
387 h_u64_to_le(buffer, value);
389 h_u64_to_be(buffer, value);
392 /* write a uint32_t to a buffer in target memory endianness */
393 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
395 if (target->endianness == TARGET_LITTLE_ENDIAN)
396 h_u32_to_le(buffer, value);
398 h_u32_to_be(buffer, value);
401 /* write a uint24_t to a buffer in target memory endianness */
402 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
404 if (target->endianness == TARGET_LITTLE_ENDIAN)
405 h_u24_to_le(buffer, value);
407 h_u24_to_be(buffer, value);
410 /* write a uint16_t to a buffer in target memory endianness */
411 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
413 if (target->endianness == TARGET_LITTLE_ENDIAN)
414 h_u16_to_le(buffer, value);
416 h_u16_to_be(buffer, value);
419 /* write a uint8_t to a buffer in target memory endianness */
420 static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
425 /* write a uint64_t array to a buffer in target memory endianness */
426 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf)
429 for (i = 0; i < count; i++)
430 dstbuf[i] = target_buffer_get_u64(target, &buffer[i * 8]);
433 /* write a uint32_t array to a buffer in target memory endianness */
434 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
437 for (i = 0; i < count; i++)
438 dstbuf[i] = target_buffer_get_u32(target, &buffer[i * 4]);
441 /* write a uint16_t array to a buffer in target memory endianness */
442 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
445 for (i = 0; i < count; i++)
446 dstbuf[i] = target_buffer_get_u16(target, &buffer[i * 2]);
449 /* write a uint64_t array to a buffer in target memory endianness */
450 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf)
453 for (i = 0; i < count; i++)
454 target_buffer_set_u64(target, &buffer[i * 8], srcbuf[i]);
457 /* write a uint32_t array to a buffer in target memory endianness */
458 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf)
461 for (i = 0; i < count; i++)
462 target_buffer_set_u32(target, &buffer[i * 4], srcbuf[i]);
465 /* write a uint16_t array to a buffer in target memory endianness */
466 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf)
469 for (i = 0; i < count; i++)
470 target_buffer_set_u16(target, &buffer[i * 2], srcbuf[i]);
473 /* return a pointer to a configured target; id is name or number */
474 struct target *get_target(const char *id)
476 struct target *target;
478 /* try as tcltarget name */
479 for (target = all_targets; target; target = target->next) {
480 if (target_name(target) == NULL)
482 if (strcmp(id, target_name(target)) == 0)
486 /* It's OK to remove this fallback sometime after August 2010 or so */
488 /* no match, try as number */
490 if (parse_uint(id, &num) != ERROR_OK)
493 for (target = all_targets; target; target = target->next) {
494 if (target->target_number == (int)num) {
495 LOG_WARNING("use '%s' as target identifier, not '%u'",
496 target_name(target), num);
504 /* returns a pointer to the n-th configured target */
505 struct target *get_target_by_num(int num)
507 struct target *target = all_targets;
510 if (target->target_number == num)
512 target = target->next;
518 struct target *get_current_target(struct command_context *cmd_ctx)
520 struct target *target = get_current_target_or_null(cmd_ctx);
522 if (target == NULL) {
523 LOG_ERROR("BUG: current_target out of bounds");
530 struct target *get_current_target_or_null(struct command_context *cmd_ctx)
532 return cmd_ctx->current_target_override
533 ? cmd_ctx->current_target_override
534 : cmd_ctx->current_target;
537 int target_poll(struct target *target)
541 /* We can't poll until after examine */
542 if (!target_was_examined(target)) {
543 /* Fail silently lest we pollute the log */
547 retval = target->type->poll(target);
548 if (retval != ERROR_OK)
551 if (target->halt_issued) {
552 if (target->state == TARGET_HALTED)
553 target->halt_issued = false;
555 int64_t t = timeval_ms() - target->halt_issued_time;
556 if (t > DEFAULT_HALT_TIMEOUT) {
557 target->halt_issued = false;
558 LOG_INFO("Halt timed out, wake up GDB.");
559 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
567 int target_halt(struct target *target)
570 /* We can't poll until after examine */
571 if (!target_was_examined(target)) {
572 LOG_ERROR("Target not examined yet");
576 retval = target->type->halt(target);
577 if (retval != ERROR_OK)
580 target->halt_issued = true;
581 target->halt_issued_time = timeval_ms();
587 * Make the target (re)start executing using its saved execution
588 * context (possibly with some modifications).
590 * @param target Which target should start executing.
591 * @param current True to use the target's saved program counter instead
592 * of the address parameter
593 * @param address Optionally used as the program counter.
594 * @param handle_breakpoints True iff breakpoints at the resumption PC
595 * should be skipped. (For example, maybe execution was stopped by
596 * such a breakpoint, in which case it would be counterprodutive to
598 * @param debug_execution False if all working areas allocated by OpenOCD
599 * should be released and/or restored to their original contents.
600 * (This would for example be true to run some downloaded "helper"
601 * algorithm code, which resides in one such working buffer and uses
602 * another for data storage.)
604 * @todo Resolve the ambiguity about what the "debug_execution" flag
605 * signifies. For example, Target implementations don't agree on how
606 * it relates to invalidation of the register cache, or to whether
607 * breakpoints and watchpoints should be enabled. (It would seem wrong
608 * to enable breakpoints when running downloaded "helper" algorithms
609 * (debug_execution true), since the breakpoints would be set to match
610 * target firmware being debugged, not the helper algorithm.... and
611 * enabling them could cause such helpers to malfunction (for example,
612 * by overwriting data with a breakpoint instruction. On the other
613 * hand the infrastructure for running such helpers might use this
614 * procedure but rely on hardware breakpoint to detect termination.)
616 int target_resume(struct target *target, int current, target_addr_t address,
617 int handle_breakpoints, int debug_execution)
621 /* We can't poll until after examine */
622 if (!target_was_examined(target)) {
623 LOG_ERROR("Target not examined yet");
627 target_call_event_callbacks(target, TARGET_EVENT_RESUME_START);
629 /* note that resume *must* be asynchronous. The CPU can halt before
630 * we poll. The CPU can even halt at the current PC as a result of
631 * a software breakpoint being inserted by (a bug?) the application.
633 retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution);
634 if (retval != ERROR_OK)
637 target_call_event_callbacks(target, TARGET_EVENT_RESUME_END);
642 static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
647 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
648 if (n->name == NULL) {
649 LOG_ERROR("invalid reset mode");
653 struct target *target;
654 for (target = all_targets; target; target = target->next)
655 target_call_reset_callbacks(target, reset_mode);
657 /* disable polling during reset to make reset event scripts
658 * more predictable, i.e. dr/irscan & pathmove in events will
659 * not have JTAG operations injected into the middle of a sequence.
661 bool save_poll = jtag_poll_get_enabled();
663 jtag_poll_set_enabled(false);
665 sprintf(buf, "ocd_process_reset %s", n->name);
666 retval = Jim_Eval(cmd_ctx->interp, buf);
668 jtag_poll_set_enabled(save_poll);
670 if (retval != JIM_OK) {
671 Jim_MakeErrorMessage(cmd_ctx->interp);
672 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
676 /* We want any events to be processed before the prompt */
677 retval = target_call_timer_callbacks_now();
679 for (target = all_targets; target; target = target->next) {
680 target->type->check_reset(target);
681 target->running_alg = false;
687 static int identity_virt2phys(struct target *target,
688 target_addr_t virtual, target_addr_t *physical)
694 static int no_mmu(struct target *target, int *enabled)
700 static int default_examine(struct target *target)
702 target_set_examined(target);
706 /* no check by default */
707 static int default_check_reset(struct target *target)
712 int target_examine_one(struct target *target)
714 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
716 int retval = target->type->examine(target);
717 if (retval != ERROR_OK)
720 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
725 static int jtag_enable_callback(enum jtag_event event, void *priv)
727 struct target *target = priv;
729 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
732 jtag_unregister_event_callback(jtag_enable_callback, target);
734 return target_examine_one(target);
737 /* Targets that correctly implement init + examine, i.e.
738 * no communication with target during init:
742 int target_examine(void)
744 int retval = ERROR_OK;
745 struct target *target;
747 for (target = all_targets; target; target = target->next) {
748 /* defer examination, but don't skip it */
749 if (!target->tap->enabled) {
750 jtag_register_event_callback(jtag_enable_callback,
755 if (target->defer_examine)
758 retval = target_examine_one(target);
759 if (retval != ERROR_OK)
765 const char *target_type_name(struct target *target)
767 return target->type->name;
770 static int target_soft_reset_halt(struct target *target)
772 if (!target_was_examined(target)) {
773 LOG_ERROR("Target not examined yet");
776 if (!target->type->soft_reset_halt) {
777 LOG_ERROR("Target %s does not support soft_reset_halt",
778 target_name(target));
781 return target->type->soft_reset_halt(target);
785 * Downloads a target-specific native code algorithm to the target,
786 * and executes it. * Note that some targets may need to set up, enable,
787 * and tear down a breakpoint (hard or * soft) to detect algorithm
788 * termination, while others may support lower overhead schemes where
789 * soft breakpoints embedded in the algorithm automatically terminate the
792 * @param target used to run the algorithm
793 * @param arch_info target-specific description of the algorithm.
795 int target_run_algorithm(struct target *target,
796 int num_mem_params, struct mem_param *mem_params,
797 int num_reg_params, struct reg_param *reg_param,
798 uint32_t entry_point, uint32_t exit_point,
799 int timeout_ms, void *arch_info)
801 int retval = ERROR_FAIL;
803 if (!target_was_examined(target)) {
804 LOG_ERROR("Target not examined yet");
807 if (!target->type->run_algorithm) {
808 LOG_ERROR("Target type '%s' does not support %s",
809 target_type_name(target), __func__);
813 target->running_alg = true;
814 retval = target->type->run_algorithm(target,
815 num_mem_params, mem_params,
816 num_reg_params, reg_param,
817 entry_point, exit_point, timeout_ms, arch_info);
818 target->running_alg = false;
825 * Executes a target-specific native code algorithm and leaves it running.
827 * @param target used to run the algorithm
828 * @param arch_info target-specific description of the algorithm.
830 int target_start_algorithm(struct target *target,
831 int num_mem_params, struct mem_param *mem_params,
832 int num_reg_params, struct reg_param *reg_params,
833 uint32_t entry_point, uint32_t exit_point,
836 int retval = ERROR_FAIL;
838 if (!target_was_examined(target)) {
839 LOG_ERROR("Target not examined yet");
842 if (!target->type->start_algorithm) {
843 LOG_ERROR("Target type '%s' does not support %s",
844 target_type_name(target), __func__);
847 if (target->running_alg) {
848 LOG_ERROR("Target is already running an algorithm");
852 target->running_alg = true;
853 retval = target->type->start_algorithm(target,
854 num_mem_params, mem_params,
855 num_reg_params, reg_params,
856 entry_point, exit_point, arch_info);
863 * Waits for an algorithm started with target_start_algorithm() to complete.
865 * @param target used to run the algorithm
866 * @param arch_info target-specific description of the algorithm.
868 int target_wait_algorithm(struct target *target,
869 int num_mem_params, struct mem_param *mem_params,
870 int num_reg_params, struct reg_param *reg_params,
871 uint32_t exit_point, int timeout_ms,
874 int retval = ERROR_FAIL;
876 if (!target->type->wait_algorithm) {
877 LOG_ERROR("Target type '%s' does not support %s",
878 target_type_name(target), __func__);
881 if (!target->running_alg) {
882 LOG_ERROR("Target is not running an algorithm");
886 retval = target->type->wait_algorithm(target,
887 num_mem_params, mem_params,
888 num_reg_params, reg_params,
889 exit_point, timeout_ms, arch_info);
890 if (retval != ERROR_TARGET_TIMEOUT)
891 target->running_alg = false;
898 * Streams data to a circular buffer on target intended for consumption by code
899 * running asynchronously on target.
901 * This is intended for applications where target-specific native code runs
902 * on the target, receives data from the circular buffer, does something with
903 * it (most likely writing it to a flash memory), and advances the circular
906 * This assumes that the helper algorithm has already been loaded to the target,
907 * but has not been started yet. Given memory and register parameters are passed
910 * The buffer is defined by (buffer_start, buffer_size) arguments and has the
913 * [buffer_start + 0, buffer_start + 4):
914 * Write Pointer address (aka head). Written and updated by this
915 * routine when new data is written to the circular buffer.
916 * [buffer_start + 4, buffer_start + 8):
917 * Read Pointer address (aka tail). Updated by code running on the
918 * target after it consumes data.
919 * [buffer_start + 8, buffer_start + buffer_size):
920 * Circular buffer contents.
922 * See contrib/loaders/flash/stm32f1x.S for an example.
924 * @param target used to run the algorithm
925 * @param buffer address on the host where data to be sent is located
926 * @param count number of blocks to send
927 * @param block_size size in bytes of each block
928 * @param num_mem_params count of memory-based params to pass to algorithm
929 * @param mem_params memory-based params to pass to algorithm
930 * @param num_reg_params count of register-based params to pass to algorithm
931 * @param reg_params memory-based params to pass to algorithm
932 * @param buffer_start address on the target of the circular buffer structure
933 * @param buffer_size size of the circular buffer structure
934 * @param entry_point address on the target to execute to start the algorithm
935 * @param exit_point address at which to set a breakpoint to catch the
936 * end of the algorithm; can be 0 if target triggers a breakpoint itself
939 int target_run_flash_async_algorithm(struct target *target,
940 const uint8_t *buffer, uint32_t count, int block_size,
941 int num_mem_params, struct mem_param *mem_params,
942 int num_reg_params, struct reg_param *reg_params,
943 uint32_t buffer_start, uint32_t buffer_size,
944 uint32_t entry_point, uint32_t exit_point, void *arch_info)
949 const uint8_t *buffer_orig = buffer;
951 /* Set up working area. First word is write pointer, second word is read pointer,
952 * rest is fifo data area. */
953 uint32_t wp_addr = buffer_start;
954 uint32_t rp_addr = buffer_start + 4;
955 uint32_t fifo_start_addr = buffer_start + 8;
956 uint32_t fifo_end_addr = buffer_start + buffer_size;
958 uint32_t wp = fifo_start_addr;
959 uint32_t rp = fifo_start_addr;
961 /* validate block_size is 2^n */
962 assert(!block_size || !(block_size & (block_size - 1)));
964 retval = target_write_u32(target, wp_addr, wp);
965 if (retval != ERROR_OK)
967 retval = target_write_u32(target, rp_addr, rp);
968 if (retval != ERROR_OK)
971 /* Start up algorithm on target and let it idle while writing the first chunk */
972 retval = target_start_algorithm(target, num_mem_params, mem_params,
973 num_reg_params, reg_params,
978 if (retval != ERROR_OK) {
979 LOG_ERROR("error starting target flash write algorithm");
985 retval = target_read_u32(target, rp_addr, &rp);
986 if (retval != ERROR_OK) {
987 LOG_ERROR("failed to get read pointer");
991 LOG_DEBUG("offs 0x%zx count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32,
992 (size_t) (buffer - buffer_orig), count, wp, rp);
995 LOG_ERROR("flash write algorithm aborted by target");
996 retval = ERROR_FLASH_OPERATION_FAILED;
1000 if (((rp - fifo_start_addr) & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
1001 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
1005 /* Count the number of bytes available in the fifo without
1006 * crossing the wrap around. Make sure to not fill it completely,
1007 * because that would make wp == rp and that's the empty condition. */
1008 uint32_t thisrun_bytes;
1010 thisrun_bytes = rp - wp - block_size;
1011 else if (rp > fifo_start_addr)
1012 thisrun_bytes = fifo_end_addr - wp;
1014 thisrun_bytes = fifo_end_addr - wp - block_size;
1016 if (thisrun_bytes == 0) {
1017 /* Throttle polling a bit if transfer is (much) faster than flash
1018 * programming. The exact delay shouldn't matter as long as it's
1019 * less than buffer size / flash speed. This is very unlikely to
1020 * run when using high latency connections such as USB. */
1023 /* to stop an infinite loop on some targets check and increment a timeout
1024 * this issue was observed on a stellaris using the new ICDI interface */
1025 if (timeout++ >= 500) {
1026 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
1027 return ERROR_FLASH_OPERATION_FAILED;
1032 /* reset our timeout */
1035 /* Limit to the amount of data we actually want to write */
1036 if (thisrun_bytes > count * block_size)
1037 thisrun_bytes = count * block_size;
1039 /* Write data to fifo */
1040 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
1041 if (retval != ERROR_OK)
1044 /* Update counters and wrap write pointer */
1045 buffer += thisrun_bytes;
1046 count -= thisrun_bytes / block_size;
1047 wp += thisrun_bytes;
1048 if (wp >= fifo_end_addr)
1049 wp = fifo_start_addr;
1051 /* Store updated write pointer to target */
1052 retval = target_write_u32(target, wp_addr, wp);
1053 if (retval != ERROR_OK)
1056 /* Avoid GDB timeouts */
1060 if (retval != ERROR_OK) {
1061 /* abort flash write algorithm on target */
1062 target_write_u32(target, wp_addr, 0);
1065 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
1066 num_reg_params, reg_params,
1071 if (retval2 != ERROR_OK) {
1072 LOG_ERROR("error waiting for target flash write algorithm");
1076 if (retval == ERROR_OK) {
1077 /* check if algorithm set rp = 0 after fifo writer loop finished */
1078 retval = target_read_u32(target, rp_addr, &rp);
1079 if (retval == ERROR_OK && rp == 0) {
1080 LOG_ERROR("flash write algorithm aborted by target");
1081 retval = ERROR_FLASH_OPERATION_FAILED;
1088 int target_read_memory(struct target *target,
1089 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
1091 if (!target_was_examined(target)) {
1092 LOG_ERROR("Target not examined yet");
1095 if (!target->type->read_memory) {
1096 LOG_ERROR("Target %s doesn't support read_memory", target_name(target));
1099 return target->type->read_memory(target, address, size, count, buffer);
1102 int target_read_phys_memory(struct target *target,
1103 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer)
1105 if (!target_was_examined(target)) {
1106 LOG_ERROR("Target not examined yet");
1109 if (!target->type->read_phys_memory) {
1110 LOG_ERROR("Target %s doesn't support read_phys_memory", target_name(target));
1113 return target->type->read_phys_memory(target, address, size, count, buffer);
1116 int target_write_memory(struct target *target,
1117 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
1119 if (!target_was_examined(target)) {
1120 LOG_ERROR("Target not examined yet");
1123 if (!target->type->write_memory) {
1124 LOG_ERROR("Target %s doesn't support write_memory", target_name(target));
1127 return target->type->write_memory(target, address, size, count, buffer);
1130 int target_write_phys_memory(struct target *target,
1131 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
1133 if (!target_was_examined(target)) {
1134 LOG_ERROR("Target not examined yet");
1137 if (!target->type->write_phys_memory) {
1138 LOG_ERROR("Target %s doesn't support write_phys_memory", target_name(target));
1141 return target->type->write_phys_memory(target, address, size, count, buffer);
1144 int target_add_breakpoint(struct target *target,
1145 struct breakpoint *breakpoint)
1147 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
1148 LOG_WARNING("target %s is not halted (add breakpoint)", target_name(target));
1149 return ERROR_TARGET_NOT_HALTED;
1151 return target->type->add_breakpoint(target, breakpoint);
1154 int target_add_context_breakpoint(struct target *target,
1155 struct breakpoint *breakpoint)
1157 if (target->state != TARGET_HALTED) {
1158 LOG_WARNING("target %s is not halted (add context breakpoint)", target_name(target));
1159 return ERROR_TARGET_NOT_HALTED;
1161 return target->type->add_context_breakpoint(target, breakpoint);
1164 int target_add_hybrid_breakpoint(struct target *target,
1165 struct breakpoint *breakpoint)
1167 if (target->state != TARGET_HALTED) {
1168 LOG_WARNING("target %s is not halted (add hybrid breakpoint)", target_name(target));
1169 return ERROR_TARGET_NOT_HALTED;
1171 return target->type->add_hybrid_breakpoint(target, breakpoint);
1174 int target_remove_breakpoint(struct target *target,
1175 struct breakpoint *breakpoint)
1177 return target->type->remove_breakpoint(target, breakpoint);
1180 int target_add_watchpoint(struct target *target,
1181 struct watchpoint *watchpoint)
1183 if (target->state != TARGET_HALTED) {
1184 LOG_WARNING("target %s is not halted (add watchpoint)", target_name(target));
1185 return ERROR_TARGET_NOT_HALTED;
1187 return target->type->add_watchpoint(target, watchpoint);
1189 int target_remove_watchpoint(struct target *target,
1190 struct watchpoint *watchpoint)
1192 return target->type->remove_watchpoint(target, watchpoint);
1194 int target_hit_watchpoint(struct target *target,
1195 struct watchpoint **hit_watchpoint)
1197 if (target->state != TARGET_HALTED) {
1198 LOG_WARNING("target %s is not halted (hit watchpoint)", target->cmd_name);
1199 return ERROR_TARGET_NOT_HALTED;
1202 if (target->type->hit_watchpoint == NULL) {
1203 /* For backward compatible, if hit_watchpoint is not implemented,
1204 * return ERROR_FAIL such that gdb_server will not take the nonsense
1209 return target->type->hit_watchpoint(target, hit_watchpoint);
1212 const char *target_get_gdb_arch(struct target *target)
1214 if (target->type->get_gdb_arch == NULL)
1216 return target->type->get_gdb_arch(target);
1219 int target_get_gdb_reg_list(struct target *target,
1220 struct reg **reg_list[], int *reg_list_size,
1221 enum target_register_class reg_class)
1223 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size, reg_class);
1226 bool target_supports_gdb_connection(struct target *target)
1229 * based on current code, we can simply exclude all the targets that
1230 * don't provide get_gdb_reg_list; this could change with new targets.
1232 return !!target->type->get_gdb_reg_list;
1235 int target_step(struct target *target,
1236 int current, target_addr_t address, int handle_breakpoints)
1238 return target->type->step(target, current, address, handle_breakpoints);
1241 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info)
1243 if (target->state != TARGET_HALTED) {
1244 LOG_WARNING("target %s is not halted (gdb fileio)", target->cmd_name);
1245 return ERROR_TARGET_NOT_HALTED;
1247 return target->type->get_gdb_fileio_info(target, fileio_info);
1250 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c)
1252 if (target->state != TARGET_HALTED) {
1253 LOG_WARNING("target %s is not halted (gdb fileio end)", target->cmd_name);
1254 return ERROR_TARGET_NOT_HALTED;
1256 return target->type->gdb_fileio_end(target, retcode, fileio_errno, ctrl_c);
1259 int target_profiling(struct target *target, uint32_t *samples,
1260 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
1262 if (target->state != TARGET_HALTED) {
1263 LOG_WARNING("target %s is not halted (profiling)", target->cmd_name);
1264 return ERROR_TARGET_NOT_HALTED;
1266 return target->type->profiling(target, samples, max_num_samples,
1267 num_samples, seconds);
1271 * Reset the @c examined flag for the given target.
1272 * Pure paranoia -- targets are zeroed on allocation.
1274 static void target_reset_examined(struct target *target)
1276 target->examined = false;
1279 static int handle_target(void *priv);
1281 static int target_init_one(struct command_context *cmd_ctx,
1282 struct target *target)
1284 target_reset_examined(target);
1286 struct target_type *type = target->type;
1287 if (type->examine == NULL)
1288 type->examine = default_examine;
1290 if (type->check_reset == NULL)
1291 type->check_reset = default_check_reset;
1293 assert(type->init_target != NULL);
1295 int retval = type->init_target(cmd_ctx, target);
1296 if (ERROR_OK != retval) {
1297 LOG_ERROR("target '%s' init failed", target_name(target));
1301 /* Sanity-check MMU support ... stub in what we must, to help
1302 * implement it in stages, but warn if we need to do so.
1305 if (type->virt2phys == NULL) {
1306 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1307 type->virt2phys = identity_virt2phys;
1310 /* Make sure no-MMU targets all behave the same: make no
1311 * distinction between physical and virtual addresses, and
1312 * ensure that virt2phys() is always an identity mapping.
1314 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1315 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1318 type->write_phys_memory = type->write_memory;
1319 type->read_phys_memory = type->read_memory;
1320 type->virt2phys = identity_virt2phys;
1323 if (target->type->read_buffer == NULL)
1324 target->type->read_buffer = target_read_buffer_default;
1326 if (target->type->write_buffer == NULL)
1327 target->type->write_buffer = target_write_buffer_default;
1329 if (target->type->get_gdb_fileio_info == NULL)
1330 target->type->get_gdb_fileio_info = target_get_gdb_fileio_info_default;
1332 if (target->type->gdb_fileio_end == NULL)
1333 target->type->gdb_fileio_end = target_gdb_fileio_end_default;
1335 if (target->type->profiling == NULL)
1336 target->type->profiling = target_profiling_default;
1341 static int target_init(struct command_context *cmd_ctx)
1343 struct target *target;
1346 for (target = all_targets; target; target = target->next) {
1347 retval = target_init_one(cmd_ctx, target);
1348 if (ERROR_OK != retval)
1355 retval = target_register_user_commands(cmd_ctx);
1356 if (ERROR_OK != retval)
1359 retval = target_register_timer_callback(&handle_target,
1360 polling_interval, 1, cmd_ctx->interp);
1361 if (ERROR_OK != retval)
1367 COMMAND_HANDLER(handle_target_init_command)
1372 return ERROR_COMMAND_SYNTAX_ERROR;
1374 static bool target_initialized;
1375 if (target_initialized) {
1376 LOG_INFO("'target init' has already been called");
1379 target_initialized = true;
1381 retval = command_run_line(CMD_CTX, "init_targets");
1382 if (ERROR_OK != retval)
1385 retval = command_run_line(CMD_CTX, "init_target_events");
1386 if (ERROR_OK != retval)
1389 retval = command_run_line(CMD_CTX, "init_board");
1390 if (ERROR_OK != retval)
1393 LOG_DEBUG("Initializing targets...");
1394 return target_init(CMD_CTX);
1397 int target_register_event_callback(int (*callback)(struct target *target,
1398 enum target_event event, void *priv), void *priv)
1400 struct target_event_callback **callbacks_p = &target_event_callbacks;
1402 if (callback == NULL)
1403 return ERROR_COMMAND_SYNTAX_ERROR;
1406 while ((*callbacks_p)->next)
1407 callbacks_p = &((*callbacks_p)->next);
1408 callbacks_p = &((*callbacks_p)->next);
1411 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1412 (*callbacks_p)->callback = callback;
1413 (*callbacks_p)->priv = priv;
1414 (*callbacks_p)->next = NULL;
1419 int target_register_reset_callback(int (*callback)(struct target *target,
1420 enum target_reset_mode reset_mode, void *priv), void *priv)
1422 struct target_reset_callback *entry;
1424 if (callback == NULL)
1425 return ERROR_COMMAND_SYNTAX_ERROR;
1427 entry = malloc(sizeof(struct target_reset_callback));
1428 if (entry == NULL) {
1429 LOG_ERROR("error allocating buffer for reset callback entry");
1430 return ERROR_COMMAND_SYNTAX_ERROR;
1433 entry->callback = callback;
1435 list_add(&entry->list, &target_reset_callback_list);
1441 int target_register_trace_callback(int (*callback)(struct target *target,
1442 size_t len, uint8_t *data, void *priv), void *priv)
1444 struct target_trace_callback *entry;
1446 if (callback == NULL)
1447 return ERROR_COMMAND_SYNTAX_ERROR;
1449 entry = malloc(sizeof(struct target_trace_callback));
1450 if (entry == NULL) {
1451 LOG_ERROR("error allocating buffer for trace callback entry");
1452 return ERROR_COMMAND_SYNTAX_ERROR;
1455 entry->callback = callback;
1457 list_add(&entry->list, &target_trace_callback_list);
1463 int target_register_timer_callback(int (*callback)(void *priv),
1464 unsigned int time_ms, enum target_timer_type type, void *priv)
1466 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1468 if (callback == NULL)
1469 return ERROR_COMMAND_SYNTAX_ERROR;
1472 while ((*callbacks_p)->next)
1473 callbacks_p = &((*callbacks_p)->next);
1474 callbacks_p = &((*callbacks_p)->next);
1477 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1478 (*callbacks_p)->callback = callback;
1479 (*callbacks_p)->type = type;
1480 (*callbacks_p)->time_ms = time_ms;
1481 (*callbacks_p)->removed = false;
1483 gettimeofday(&(*callbacks_p)->when, NULL);
1484 timeval_add_time(&(*callbacks_p)->when, 0, time_ms * 1000);
1486 (*callbacks_p)->priv = priv;
1487 (*callbacks_p)->next = NULL;
1492 int target_unregister_event_callback(int (*callback)(struct target *target,
1493 enum target_event event, void *priv), void *priv)
1495 struct target_event_callback **p = &target_event_callbacks;
1496 struct target_event_callback *c = target_event_callbacks;
1498 if (callback == NULL)
1499 return ERROR_COMMAND_SYNTAX_ERROR;
1502 struct target_event_callback *next = c->next;
1503 if ((c->callback == callback) && (c->priv == priv)) {
1515 int target_unregister_reset_callback(int (*callback)(struct target *target,
1516 enum target_reset_mode reset_mode, void *priv), void *priv)
1518 struct target_reset_callback *entry;
1520 if (callback == NULL)
1521 return ERROR_COMMAND_SYNTAX_ERROR;
1523 list_for_each_entry(entry, &target_reset_callback_list, list) {
1524 if (entry->callback == callback && entry->priv == priv) {
1525 list_del(&entry->list);
1534 int target_unregister_trace_callback(int (*callback)(struct target *target,
1535 size_t len, uint8_t *data, void *priv), void *priv)
1537 struct target_trace_callback *entry;
1539 if (callback == NULL)
1540 return ERROR_COMMAND_SYNTAX_ERROR;
1542 list_for_each_entry(entry, &target_trace_callback_list, list) {
1543 if (entry->callback == callback && entry->priv == priv) {
1544 list_del(&entry->list);
1553 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1555 if (callback == NULL)
1556 return ERROR_COMMAND_SYNTAX_ERROR;
1558 for (struct target_timer_callback *c = target_timer_callbacks;
1560 if ((c->callback == callback) && (c->priv == priv)) {
1569 int target_call_event_callbacks(struct target *target, enum target_event event)
1571 struct target_event_callback *callback = target_event_callbacks;
1572 struct target_event_callback *next_callback;
1574 if (event == TARGET_EVENT_HALTED) {
1575 /* execute early halted first */
1576 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1579 LOG_DEBUG("target event %i (%s)", event,
1580 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1582 target_handle_event(target, event);
1585 next_callback = callback->next;
1586 callback->callback(target, event, callback->priv);
1587 callback = next_callback;
1593 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode)
1595 struct target_reset_callback *callback;
1597 LOG_DEBUG("target reset %i (%s)", reset_mode,
1598 Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode)->name);
1600 list_for_each_entry(callback, &target_reset_callback_list, list)
1601 callback->callback(target, reset_mode, callback->priv);
1606 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data)
1608 struct target_trace_callback *callback;
1610 list_for_each_entry(callback, &target_trace_callback_list, list)
1611 callback->callback(target, len, data, callback->priv);
1616 static int target_timer_callback_periodic_restart(
1617 struct target_timer_callback *cb, struct timeval *now)
1620 timeval_add_time(&cb->when, 0, cb->time_ms * 1000L);
1624 static int target_call_timer_callback(struct target_timer_callback *cb,
1625 struct timeval *now)
1627 cb->callback(cb->priv);
1629 if (cb->type == TARGET_TIMER_TYPE_PERIODIC)
1630 return target_timer_callback_periodic_restart(cb, now);
1632 return target_unregister_timer_callback(cb->callback, cb->priv);
1635 static int target_call_timer_callbacks_check_time(int checktime)
1637 static bool callback_processing;
1639 /* Do not allow nesting */
1640 if (callback_processing)
1643 callback_processing = true;
1648 gettimeofday(&now, NULL);
1650 /* Store an address of the place containing a pointer to the
1651 * next item; initially, that's a standalone "root of the
1652 * list" variable. */
1653 struct target_timer_callback **callback = &target_timer_callbacks;
1655 if ((*callback)->removed) {
1656 struct target_timer_callback *p = *callback;
1657 *callback = (*callback)->next;
1662 bool call_it = (*callback)->callback &&
1663 ((!checktime && (*callback)->type == TARGET_TIMER_TYPE_PERIODIC) ||
1664 timeval_compare(&now, &(*callback)->when) >= 0);
1667 target_call_timer_callback(*callback, &now);
1669 callback = &(*callback)->next;
1672 callback_processing = false;
1676 int target_call_timer_callbacks(void)
1678 return target_call_timer_callbacks_check_time(1);
1681 /* invoke periodic callbacks immediately */
1682 int target_call_timer_callbacks_now(void)
1684 return target_call_timer_callbacks_check_time(0);
1687 /* Prints the working area layout for debug purposes */
1688 static void print_wa_layout(struct target *target)
1690 struct working_area *c = target->working_areas;
1693 LOG_DEBUG("%c%c " TARGET_ADDR_FMT "-" TARGET_ADDR_FMT " (%" PRIu32 " bytes)",
1694 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1695 c->address, c->address + c->size - 1, c->size);
1700 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1701 static void target_split_working_area(struct working_area *area, uint32_t size)
1703 assert(area->free); /* Shouldn't split an allocated area */
1704 assert(size <= area->size); /* Caller should guarantee this */
1706 /* Split only if not already the right size */
1707 if (size < area->size) {
1708 struct working_area *new_wa = malloc(sizeof(*new_wa));
1713 new_wa->next = area->next;
1714 new_wa->size = area->size - size;
1715 new_wa->address = area->address + size;
1716 new_wa->backup = NULL;
1717 new_wa->user = NULL;
1718 new_wa->free = true;
1720 area->next = new_wa;
1723 /* If backup memory was allocated to this area, it has the wrong size
1724 * now so free it and it will be reallocated if/when needed */
1727 area->backup = NULL;
1732 /* Merge all adjacent free areas into one */
1733 static void target_merge_working_areas(struct target *target)
1735 struct working_area *c = target->working_areas;
1737 while (c && c->next) {
1738 assert(c->next->address == c->address + c->size); /* This is an invariant */
1740 /* Find two adjacent free areas */
1741 if (c->free && c->next->free) {
1742 /* Merge the last into the first */
1743 c->size += c->next->size;
1745 /* Remove the last */
1746 struct working_area *to_be_freed = c->next;
1747 c->next = c->next->next;
1748 if (to_be_freed->backup)
1749 free(to_be_freed->backup);
1752 /* If backup memory was allocated to the remaining area, it's has
1753 * the wrong size now */
1764 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1766 /* Reevaluate working area address based on MMU state*/
1767 if (target->working_areas == NULL) {
1771 retval = target->type->mmu(target, &enabled);
1772 if (retval != ERROR_OK)
1776 if (target->working_area_phys_spec) {
1777 LOG_DEBUG("MMU disabled, using physical "
1778 "address for working memory " TARGET_ADDR_FMT,
1779 target->working_area_phys);
1780 target->working_area = target->working_area_phys;
1782 LOG_ERROR("No working memory available. "
1783 "Specify -work-area-phys to target.");
1784 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1787 if (target->working_area_virt_spec) {
1788 LOG_DEBUG("MMU enabled, using virtual "
1789 "address for working memory " TARGET_ADDR_FMT,
1790 target->working_area_virt);
1791 target->working_area = target->working_area_virt;
1793 LOG_ERROR("No working memory available. "
1794 "Specify -work-area-virt to target.");
1795 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1799 /* Set up initial working area on first call */
1800 struct working_area *new_wa = malloc(sizeof(*new_wa));
1802 new_wa->next = NULL;
1803 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1804 new_wa->address = target->working_area;
1805 new_wa->backup = NULL;
1806 new_wa->user = NULL;
1807 new_wa->free = true;
1810 target->working_areas = new_wa;
1813 /* only allocate multiples of 4 byte */
1815 size = (size + 3) & (~3UL);
1817 struct working_area *c = target->working_areas;
1819 /* Find the first large enough working area */
1821 if (c->free && c->size >= size)
1827 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1829 /* Split the working area into the requested size */
1830 target_split_working_area(c, size);
1832 LOG_DEBUG("allocated new working area of %" PRIu32 " bytes at address " TARGET_ADDR_FMT,
1835 if (target->backup_working_area) {
1836 if (c->backup == NULL) {
1837 c->backup = malloc(c->size);
1838 if (c->backup == NULL)
1842 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1843 if (retval != ERROR_OK)
1847 /* mark as used, and return the new (reused) area */
1854 print_wa_layout(target);
1859 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1863 retval = target_alloc_working_area_try(target, size, area);
1864 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1865 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1870 static int target_restore_working_area(struct target *target, struct working_area *area)
1872 int retval = ERROR_OK;
1874 if (target->backup_working_area && area->backup != NULL) {
1875 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1876 if (retval != ERROR_OK)
1877 LOG_ERROR("failed to restore %" PRIu32 " bytes of working area at address " TARGET_ADDR_FMT,
1878 area->size, area->address);
1884 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1885 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1887 int retval = ERROR_OK;
1893 retval = target_restore_working_area(target, area);
1894 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1895 if (retval != ERROR_OK)
1901 LOG_DEBUG("freed %" PRIu32 " bytes of working area at address " TARGET_ADDR_FMT,
1902 area->size, area->address);
1904 /* mark user pointer invalid */
1905 /* TODO: Is this really safe? It points to some previous caller's memory.
1906 * How could we know that the area pointer is still in that place and not
1907 * some other vital data? What's the purpose of this, anyway? */
1911 target_merge_working_areas(target);
1913 print_wa_layout(target);
1918 int target_free_working_area(struct target *target, struct working_area *area)
1920 return target_free_working_area_restore(target, area, 1);
1923 /* free resources and restore memory, if restoring memory fails,
1924 * free up resources anyway
1926 static void target_free_all_working_areas_restore(struct target *target, int restore)
1928 struct working_area *c = target->working_areas;
1930 LOG_DEBUG("freeing all working areas");
1932 /* Loop through all areas, restoring the allocated ones and marking them as free */
1936 target_restore_working_area(target, c);
1938 *c->user = NULL; /* Same as above */
1944 /* Run a merge pass to combine all areas into one */
1945 target_merge_working_areas(target);
1947 print_wa_layout(target);
1950 void target_free_all_working_areas(struct target *target)
1952 target_free_all_working_areas_restore(target, 1);
1954 /* Now we have none or only one working area marked as free */
1955 if (target->working_areas) {
1956 /* Free the last one to allow on-the-fly moving and resizing */
1957 free(target->working_areas->backup);
1958 free(target->working_areas);
1959 target->working_areas = NULL;
1963 /* Find the largest number of bytes that can be allocated */
1964 uint32_t target_get_working_area_avail(struct target *target)
1966 struct working_area *c = target->working_areas;
1967 uint32_t max_size = 0;
1970 return target->working_area_size;
1973 if (c->free && max_size < c->size)
1982 static void target_destroy(struct target *target)
1984 if (target->type->deinit_target)
1985 target->type->deinit_target(target);
1987 if (target->semihosting)
1988 free(target->semihosting);
1990 jtag_unregister_event_callback(jtag_enable_callback, target);
1992 struct target_event_action *teap = target->event_action;
1994 struct target_event_action *next = teap->next;
1995 Jim_DecrRefCount(teap->interp, teap->body);
2000 target_free_all_working_areas(target);
2002 /* release the targets SMP list */
2004 struct target_list *head = target->head;
2005 while (head != NULL) {
2006 struct target_list *pos = head->next;
2007 head->target->smp = 0;
2014 free(target->gdb_port_override);
2016 free(target->trace_info);
2017 free(target->fileio_info);
2018 free(target->cmd_name);
2022 void target_quit(void)
2024 struct target_event_callback *pe = target_event_callbacks;
2026 struct target_event_callback *t = pe->next;
2030 target_event_callbacks = NULL;
2032 struct target_timer_callback *pt = target_timer_callbacks;
2034 struct target_timer_callback *t = pt->next;
2038 target_timer_callbacks = NULL;
2040 for (struct target *target = all_targets; target;) {
2044 target_destroy(target);
2051 int target_arch_state(struct target *target)
2054 if (target == NULL) {
2055 LOG_WARNING("No target has been configured");
2059 if (target->state != TARGET_HALTED)
2062 retval = target->type->arch_state(target);
2066 static int target_get_gdb_fileio_info_default(struct target *target,
2067 struct gdb_fileio_info *fileio_info)
2069 /* If target does not support semi-hosting function, target
2070 has no need to provide .get_gdb_fileio_info callback.
2071 It just return ERROR_FAIL and gdb_server will return "Txx"
2072 as target halted every time. */
2076 static int target_gdb_fileio_end_default(struct target *target,
2077 int retcode, int fileio_errno, bool ctrl_c)
2082 static int target_profiling_default(struct target *target, uint32_t *samples,
2083 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
2085 struct timeval timeout, now;
2087 gettimeofday(&timeout, NULL);
2088 timeval_add_time(&timeout, seconds, 0);
2090 LOG_INFO("Starting profiling. Halting and resuming the"
2091 " target as often as we can...");
2093 uint32_t sample_count = 0;
2094 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
2095 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
2097 int retval = ERROR_OK;
2099 target_poll(target);
2100 if (target->state == TARGET_HALTED) {
2101 uint32_t t = buf_get_u32(reg->value, 0, 32);
2102 samples[sample_count++] = t;
2103 /* current pc, addr = 0, do not handle breakpoints, not debugging */
2104 retval = target_resume(target, 1, 0, 0, 0);
2105 target_poll(target);
2106 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
2107 } else if (target->state == TARGET_RUNNING) {
2108 /* We want to quickly sample the PC. */
2109 retval = target_halt(target);
2111 LOG_INFO("Target not halted or running");
2116 if (retval != ERROR_OK)
2119 gettimeofday(&now, NULL);
2120 if ((sample_count >= max_num_samples) || timeval_compare(&now, &timeout) >= 0) {
2121 LOG_INFO("Profiling completed. %" PRIu32 " samples.", sample_count);
2126 *num_samples = sample_count;
2130 /* Single aligned words are guaranteed to use 16 or 32 bit access
2131 * mode respectively, otherwise data is handled as quickly as
2134 int target_write_buffer(struct target *target, target_addr_t address, uint32_t size, const uint8_t *buffer)
2136 LOG_DEBUG("writing buffer of %" PRIi32 " byte at " TARGET_ADDR_FMT,
2139 if (!target_was_examined(target)) {
2140 LOG_ERROR("Target not examined yet");
2147 if ((address + size - 1) < address) {
2148 /* GDB can request this when e.g. PC is 0xfffffffc */
2149 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT ", 0x%08" PRIx32 ")",
2155 return target->type->write_buffer(target, address, size, buffer);
2158 static int target_write_buffer_default(struct target *target,
2159 target_addr_t address, uint32_t count, const uint8_t *buffer)
2163 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2164 * will have something to do with the size we leave to it. */
2165 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2166 if (address & size) {
2167 int retval = target_write_memory(target, address, size, 1, buffer);
2168 if (retval != ERROR_OK)
2176 /* Write the data with as large access size as possible. */
2177 for (; size > 0; size /= 2) {
2178 uint32_t aligned = count - count % size;
2180 int retval = target_write_memory(target, address, size, aligned / size, buffer);
2181 if (retval != ERROR_OK)
2192 /* Single aligned words are guaranteed to use 16 or 32 bit access
2193 * mode respectively, otherwise data is handled as quickly as
2196 int target_read_buffer(struct target *target, target_addr_t address, uint32_t size, uint8_t *buffer)
2198 LOG_DEBUG("reading buffer of %" PRIi32 " byte at " TARGET_ADDR_FMT,
2201 if (!target_was_examined(target)) {
2202 LOG_ERROR("Target not examined yet");
2209 if ((address + size - 1) < address) {
2210 /* GDB can request this when e.g. PC is 0xfffffffc */
2211 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT ", 0x%08" PRIx32 ")",
2217 return target->type->read_buffer(target, address, size, buffer);
2220 static int target_read_buffer_default(struct target *target, target_addr_t address, uint32_t count, uint8_t *buffer)
2224 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2225 * will have something to do with the size we leave to it. */
2226 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2227 if (address & size) {
2228 int retval = target_read_memory(target, address, size, 1, buffer);
2229 if (retval != ERROR_OK)
2237 /* Read the data with as large access size as possible. */
2238 for (; size > 0; size /= 2) {
2239 uint32_t aligned = count - count % size;
2241 int retval = target_read_memory(target, address, size, aligned / size, buffer);
2242 if (retval != ERROR_OK)
2253 int target_checksum_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t* crc)
2258 uint32_t checksum = 0;
2259 if (!target_was_examined(target)) {
2260 LOG_ERROR("Target not examined yet");
2264 retval = target->type->checksum_memory(target, address, size, &checksum);
2265 if (retval != ERROR_OK) {
2266 buffer = malloc(size);
2267 if (buffer == NULL) {
2268 LOG_ERROR("error allocating buffer for section (%" PRId32 " bytes)", size);
2269 return ERROR_COMMAND_SYNTAX_ERROR;
2271 retval = target_read_buffer(target, address, size, buffer);
2272 if (retval != ERROR_OK) {
2277 /* convert to target endianness */
2278 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
2279 uint32_t target_data;
2280 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
2281 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
2284 retval = image_calculate_checksum(buffer, size, &checksum);
2293 int target_blank_check_memory(struct target *target,
2294 struct target_memory_check_block *blocks, int num_blocks,
2295 uint8_t erased_value)
2297 if (!target_was_examined(target)) {
2298 LOG_ERROR("Target not examined yet");
2302 if (target->type->blank_check_memory == NULL)
2303 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
2305 return target->type->blank_check_memory(target, blocks, num_blocks, erased_value);
2308 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value)
2310 uint8_t value_buf[8];
2311 if (!target_was_examined(target)) {
2312 LOG_ERROR("Target not examined yet");
2316 int retval = target_read_memory(target, address, 8, 1, value_buf);
2318 if (retval == ERROR_OK) {
2319 *value = target_buffer_get_u64(target, value_buf);
2320 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2325 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2332 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value)
2334 uint8_t value_buf[4];
2335 if (!target_was_examined(target)) {
2336 LOG_ERROR("Target not examined yet");
2340 int retval = target_read_memory(target, address, 4, 1, value_buf);
2342 if (retval == ERROR_OK) {
2343 *value = target_buffer_get_u32(target, value_buf);
2344 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2349 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2356 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value)
2358 uint8_t value_buf[2];
2359 if (!target_was_examined(target)) {
2360 LOG_ERROR("Target not examined yet");
2364 int retval = target_read_memory(target, address, 2, 1, value_buf);
2366 if (retval == ERROR_OK) {
2367 *value = target_buffer_get_u16(target, value_buf);
2368 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%4.4" PRIx16,
2373 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2380 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value)
2382 if (!target_was_examined(target)) {
2383 LOG_ERROR("Target not examined yet");
2387 int retval = target_read_memory(target, address, 1, 1, value);
2389 if (retval == ERROR_OK) {
2390 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2395 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2402 int target_write_u64(struct target *target, target_addr_t address, uint64_t value)
2405 uint8_t value_buf[8];
2406 if (!target_was_examined(target)) {
2407 LOG_ERROR("Target not examined yet");
2411 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2415 target_buffer_set_u64(target, value_buf, value);
2416 retval = target_write_memory(target, address, 8, 1, value_buf);
2417 if (retval != ERROR_OK)
2418 LOG_DEBUG("failed: %i", retval);
2423 int target_write_u32(struct target *target, target_addr_t address, uint32_t value)
2426 uint8_t value_buf[4];
2427 if (!target_was_examined(target)) {
2428 LOG_ERROR("Target not examined yet");
2432 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2436 target_buffer_set_u32(target, value_buf, value);
2437 retval = target_write_memory(target, address, 4, 1, value_buf);
2438 if (retval != ERROR_OK)
2439 LOG_DEBUG("failed: %i", retval);
2444 int target_write_u16(struct target *target, target_addr_t address, uint16_t value)
2447 uint8_t value_buf[2];
2448 if (!target_was_examined(target)) {
2449 LOG_ERROR("Target not examined yet");
2453 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx16,
2457 target_buffer_set_u16(target, value_buf, value);
2458 retval = target_write_memory(target, address, 2, 1, value_buf);
2459 if (retval != ERROR_OK)
2460 LOG_DEBUG("failed: %i", retval);
2465 int target_write_u8(struct target *target, target_addr_t address, uint8_t value)
2468 if (!target_was_examined(target)) {
2469 LOG_ERROR("Target not examined yet");
2473 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2476 retval = target_write_memory(target, address, 1, 1, &value);
2477 if (retval != ERROR_OK)
2478 LOG_DEBUG("failed: %i", retval);
2483 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value)
2486 uint8_t value_buf[8];
2487 if (!target_was_examined(target)) {
2488 LOG_ERROR("Target not examined yet");
2492 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2496 target_buffer_set_u64(target, value_buf, value);
2497 retval = target_write_phys_memory(target, address, 8, 1, value_buf);
2498 if (retval != ERROR_OK)
2499 LOG_DEBUG("failed: %i", retval);
2504 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value)
2507 uint8_t value_buf[4];
2508 if (!target_was_examined(target)) {
2509 LOG_ERROR("Target not examined yet");
2513 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2517 target_buffer_set_u32(target, value_buf, value);
2518 retval = target_write_phys_memory(target, address, 4, 1, value_buf);
2519 if (retval != ERROR_OK)
2520 LOG_DEBUG("failed: %i", retval);
2525 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value)
2528 uint8_t value_buf[2];
2529 if (!target_was_examined(target)) {
2530 LOG_ERROR("Target not examined yet");
2534 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx16,
2538 target_buffer_set_u16(target, value_buf, value);
2539 retval = target_write_phys_memory(target, address, 2, 1, value_buf);
2540 if (retval != ERROR_OK)
2541 LOG_DEBUG("failed: %i", retval);
2546 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value)
2549 if (!target_was_examined(target)) {
2550 LOG_ERROR("Target not examined yet");
2554 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2557 retval = target_write_phys_memory(target, address, 1, 1, &value);
2558 if (retval != ERROR_OK)
2559 LOG_DEBUG("failed: %i", retval);
2564 static int find_target(struct command_context *cmd_ctx, const char *name)
2566 struct target *target = get_target(name);
2567 if (target == NULL) {
2568 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2571 if (!target->tap->enabled) {
2572 LOG_USER("Target: TAP %s is disabled, "
2573 "can't be the current target\n",
2574 target->tap->dotted_name);
2578 cmd_ctx->current_target = target;
2579 if (cmd_ctx->current_target_override)
2580 cmd_ctx->current_target_override = target;
2586 COMMAND_HANDLER(handle_targets_command)
2588 int retval = ERROR_OK;
2589 if (CMD_ARGC == 1) {
2590 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2591 if (retval == ERROR_OK) {
2597 struct target *target = all_targets;
2598 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2599 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2604 if (target->tap->enabled)
2605 state = target_state_name(target);
2607 state = "tap-disabled";
2609 if (CMD_CTX->current_target == target)
2612 /* keep columns lined up to match the headers above */
2613 command_print(CMD_CTX,
2614 "%2d%c %-18s %-10s %-6s %-18s %s",
2615 target->target_number,
2617 target_name(target),
2618 target_type_name(target),
2619 Jim_Nvp_value2name_simple(nvp_target_endian,
2620 target->endianness)->name,
2621 target->tap->dotted_name,
2623 target = target->next;
2629 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2631 static int powerDropout;
2632 static int srstAsserted;
2634 static int runPowerRestore;
2635 static int runPowerDropout;
2636 static int runSrstAsserted;
2637 static int runSrstDeasserted;
2639 static int sense_handler(void)
2641 static int prevSrstAsserted;
2642 static int prevPowerdropout;
2644 int retval = jtag_power_dropout(&powerDropout);
2645 if (retval != ERROR_OK)
2649 powerRestored = prevPowerdropout && !powerDropout;
2651 runPowerRestore = 1;
2653 int64_t current = timeval_ms();
2654 static int64_t lastPower;
2655 bool waitMore = lastPower + 2000 > current;
2656 if (powerDropout && !waitMore) {
2657 runPowerDropout = 1;
2658 lastPower = current;
2661 retval = jtag_srst_asserted(&srstAsserted);
2662 if (retval != ERROR_OK)
2666 srstDeasserted = prevSrstAsserted && !srstAsserted;
2668 static int64_t lastSrst;
2669 waitMore = lastSrst + 2000 > current;
2670 if (srstDeasserted && !waitMore) {
2671 runSrstDeasserted = 1;
2675 if (!prevSrstAsserted && srstAsserted)
2676 runSrstAsserted = 1;
2678 prevSrstAsserted = srstAsserted;
2679 prevPowerdropout = powerDropout;
2681 if (srstDeasserted || powerRestored) {
2682 /* Other than logging the event we can't do anything here.
2683 * Issuing a reset is a particularly bad idea as we might
2684 * be inside a reset already.
2691 /* process target state changes */
2692 static int handle_target(void *priv)
2694 Jim_Interp *interp = (Jim_Interp *)priv;
2695 int retval = ERROR_OK;
2697 if (!is_jtag_poll_safe()) {
2698 /* polling is disabled currently */
2702 /* we do not want to recurse here... */
2703 static int recursive;
2707 /* danger! running these procedures can trigger srst assertions and power dropouts.
2708 * We need to avoid an infinite loop/recursion here and we do that by
2709 * clearing the flags after running these events.
2711 int did_something = 0;
2712 if (runSrstAsserted) {
2713 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2714 Jim_Eval(interp, "srst_asserted");
2717 if (runSrstDeasserted) {
2718 Jim_Eval(interp, "srst_deasserted");
2721 if (runPowerDropout) {
2722 LOG_INFO("Power dropout detected, running power_dropout proc.");
2723 Jim_Eval(interp, "power_dropout");
2726 if (runPowerRestore) {
2727 Jim_Eval(interp, "power_restore");
2731 if (did_something) {
2732 /* clear detect flags */
2736 /* clear action flags */
2738 runSrstAsserted = 0;
2739 runSrstDeasserted = 0;
2740 runPowerRestore = 0;
2741 runPowerDropout = 0;
2746 /* Poll targets for state changes unless that's globally disabled.
2747 * Skip targets that are currently disabled.
2749 for (struct target *target = all_targets;
2750 is_jtag_poll_safe() && target;
2751 target = target->next) {
2753 if (!target_was_examined(target))
2756 if (!target->tap->enabled)
2759 if (target->backoff.times > target->backoff.count) {
2760 /* do not poll this time as we failed previously */
2761 target->backoff.count++;
2764 target->backoff.count = 0;
2766 /* only poll target if we've got power and srst isn't asserted */
2767 if (!powerDropout && !srstAsserted) {
2768 /* polling may fail silently until the target has been examined */
2769 retval = target_poll(target);
2770 if (retval != ERROR_OK) {
2771 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2772 if (target->backoff.times * polling_interval < 5000) {
2773 target->backoff.times *= 2;
2774 target->backoff.times++;
2777 /* Tell GDB to halt the debugger. This allows the user to
2778 * run monitor commands to handle the situation.
2780 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2782 if (target->backoff.times > 0) {
2783 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target));
2784 target_reset_examined(target);
2785 retval = target_examine_one(target);
2786 /* Target examination could have failed due to unstable connection,
2787 * but we set the examined flag anyway to repoll it later */
2788 if (retval != ERROR_OK) {
2789 target->examined = true;
2790 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2791 target->backoff.times * polling_interval);
2796 /* Since we succeeded, we reset backoff count */
2797 target->backoff.times = 0;
2804 COMMAND_HANDLER(handle_reg_command)
2806 struct target *target;
2807 struct reg *reg = NULL;
2813 target = get_current_target(CMD_CTX);
2815 /* list all available registers for the current target */
2816 if (CMD_ARGC == 0) {
2817 struct reg_cache *cache = target->reg_cache;
2823 command_print(CMD_CTX, "===== %s", cache->name);
2825 for (i = 0, reg = cache->reg_list;
2826 i < cache->num_regs;
2827 i++, reg++, count++) {
2828 if (reg->exist == false)
2830 /* only print cached values if they are valid */
2832 value = buf_to_str(reg->value,
2834 command_print(CMD_CTX,
2835 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2843 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2848 cache = cache->next;
2854 /* access a single register by its ordinal number */
2855 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2857 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2859 struct reg_cache *cache = target->reg_cache;
2863 for (i = 0; i < cache->num_regs; i++) {
2864 if (count++ == num) {
2865 reg = &cache->reg_list[i];
2871 cache = cache->next;
2875 command_print(CMD_CTX, "%i is out of bounds, the current target "
2876 "has only %i registers (0 - %i)", num, count, count - 1);
2880 /* access a single register by its name */
2881 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2887 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2892 /* display a register */
2893 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2894 && (CMD_ARGV[1][0] <= '9')))) {
2895 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2898 if (reg->valid == 0)
2899 reg->type->get(reg);
2900 value = buf_to_str(reg->value, reg->size, 16);
2901 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2906 /* set register value */
2907 if (CMD_ARGC == 2) {
2908 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2911 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2913 reg->type->set(reg, buf);
2915 value = buf_to_str(reg->value, reg->size, 16);
2916 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2924 return ERROR_COMMAND_SYNTAX_ERROR;
2927 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2931 COMMAND_HANDLER(handle_poll_command)
2933 int retval = ERROR_OK;
2934 struct target *target = get_current_target(CMD_CTX);
2936 if (CMD_ARGC == 0) {
2937 command_print(CMD_CTX, "background polling: %s",
2938 jtag_poll_get_enabled() ? "on" : "off");
2939 command_print(CMD_CTX, "TAP: %s (%s)",
2940 target->tap->dotted_name,
2941 target->tap->enabled ? "enabled" : "disabled");
2942 if (!target->tap->enabled)
2944 retval = target_poll(target);
2945 if (retval != ERROR_OK)
2947 retval = target_arch_state(target);
2948 if (retval != ERROR_OK)
2950 } else if (CMD_ARGC == 1) {
2952 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2953 jtag_poll_set_enabled(enable);
2955 return ERROR_COMMAND_SYNTAX_ERROR;
2960 COMMAND_HANDLER(handle_wait_halt_command)
2963 return ERROR_COMMAND_SYNTAX_ERROR;
2965 unsigned ms = DEFAULT_HALT_TIMEOUT;
2966 if (1 == CMD_ARGC) {
2967 int retval = parse_uint(CMD_ARGV[0], &ms);
2968 if (ERROR_OK != retval)
2969 return ERROR_COMMAND_SYNTAX_ERROR;
2972 struct target *target = get_current_target(CMD_CTX);
2973 return target_wait_state(target, TARGET_HALTED, ms);
2976 /* wait for target state to change. The trick here is to have a low
2977 * latency for short waits and not to suck up all the CPU time
2980 * After 500ms, keep_alive() is invoked
2982 int target_wait_state(struct target *target, enum target_state state, int ms)
2985 int64_t then = 0, cur;
2989 retval = target_poll(target);
2990 if (retval != ERROR_OK)
2992 if (target->state == state)
2997 then = timeval_ms();
2998 LOG_DEBUG("waiting for target %s...",
2999 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
3005 if ((cur-then) > ms) {
3006 LOG_ERROR("timed out while waiting for target %s",
3007 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
3015 COMMAND_HANDLER(handle_halt_command)
3019 struct target *target = get_current_target(CMD_CTX);
3021 target->verbose_halt_msg = true;
3023 int retval = target_halt(target);
3024 if (ERROR_OK != retval)
3027 if (CMD_ARGC == 1) {
3028 unsigned wait_local;
3029 retval = parse_uint(CMD_ARGV[0], &wait_local);
3030 if (ERROR_OK != retval)
3031 return ERROR_COMMAND_SYNTAX_ERROR;
3036 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
3039 COMMAND_HANDLER(handle_soft_reset_halt_command)
3041 struct target *target = get_current_target(CMD_CTX);
3043 LOG_USER("requesting target halt and executing a soft reset");
3045 target_soft_reset_halt(target);
3050 COMMAND_HANDLER(handle_reset_command)
3053 return ERROR_COMMAND_SYNTAX_ERROR;
3055 enum target_reset_mode reset_mode = RESET_RUN;
3056 if (CMD_ARGC == 1) {
3058 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
3059 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
3060 return ERROR_COMMAND_SYNTAX_ERROR;
3061 reset_mode = n->value;
3064 /* reset *all* targets */
3065 return target_process_reset(CMD_CTX, reset_mode);
3069 COMMAND_HANDLER(handle_resume_command)
3073 return ERROR_COMMAND_SYNTAX_ERROR;
3075 struct target *target = get_current_target(CMD_CTX);
3077 /* with no CMD_ARGV, resume from current pc, addr = 0,
3078 * with one arguments, addr = CMD_ARGV[0],
3079 * handle breakpoints, not debugging */
3080 target_addr_t addr = 0;
3081 if (CMD_ARGC == 1) {
3082 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3086 return target_resume(target, current, addr, 1, 0);
3089 COMMAND_HANDLER(handle_step_command)
3092 return ERROR_COMMAND_SYNTAX_ERROR;
3096 /* with no CMD_ARGV, step from current pc, addr = 0,
3097 * with one argument addr = CMD_ARGV[0],
3098 * handle breakpoints, debugging */
3099 target_addr_t addr = 0;
3101 if (CMD_ARGC == 1) {
3102 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3106 struct target *target = get_current_target(CMD_CTX);
3108 return target->type->step(target, current_pc, addr, 1);
3111 static void handle_md_output(struct command_context *cmd_ctx,
3112 struct target *target, target_addr_t address, unsigned size,
3113 unsigned count, const uint8_t *buffer)
3115 const unsigned line_bytecnt = 32;
3116 unsigned line_modulo = line_bytecnt / size;
3118 char output[line_bytecnt * 4 + 1];
3119 unsigned output_len = 0;
3121 const char *value_fmt;
3124 value_fmt = "%16.16"PRIx64" ";
3127 value_fmt = "%8.8"PRIx64" ";
3130 value_fmt = "%4.4"PRIx64" ";
3133 value_fmt = "%2.2"PRIx64" ";
3136 /* "can't happen", caller checked */
3137 LOG_ERROR("invalid memory read size: %u", size);
3141 for (unsigned i = 0; i < count; i++) {
3142 if (i % line_modulo == 0) {
3143 output_len += snprintf(output + output_len,
3144 sizeof(output) - output_len,
3145 TARGET_ADDR_FMT ": ",
3146 (address + (i * size)));
3150 const uint8_t *value_ptr = buffer + i * size;
3153 value = target_buffer_get_u64(target, value_ptr);
3156 value = target_buffer_get_u32(target, value_ptr);
3159 value = target_buffer_get_u16(target, value_ptr);
3164 output_len += snprintf(output + output_len,
3165 sizeof(output) - output_len,
3168 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
3169 command_print(cmd_ctx, "%s", output);
3175 COMMAND_HANDLER(handle_md_command)
3178 return ERROR_COMMAND_SYNTAX_ERROR;
3181 switch (CMD_NAME[2]) {
3195 return ERROR_COMMAND_SYNTAX_ERROR;
3198 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
3199 int (*fn)(struct target *target,
3200 target_addr_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
3204 fn = target_read_phys_memory;
3206 fn = target_read_memory;
3207 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
3208 return ERROR_COMMAND_SYNTAX_ERROR;
3210 target_addr_t address;
3211 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
3215 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
3217 uint8_t *buffer = calloc(count, size);
3218 if (buffer == NULL) {
3219 LOG_ERROR("Failed to allocate md read buffer");
3223 struct target *target = get_current_target(CMD_CTX);
3224 int retval = fn(target, address, size, count, buffer);
3225 if (ERROR_OK == retval)
3226 handle_md_output(CMD_CTX, target, address, size, count, buffer);
3233 typedef int (*target_write_fn)(struct target *target,
3234 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
3236 static int target_fill_mem(struct target *target,
3237 target_addr_t address,
3245 /* We have to write in reasonably large chunks to be able
3246 * to fill large memory areas with any sane speed */
3247 const unsigned chunk_size = 16384;
3248 uint8_t *target_buf = malloc(chunk_size * data_size);
3249 if (target_buf == NULL) {
3250 LOG_ERROR("Out of memory");
3254 for (unsigned i = 0; i < chunk_size; i++) {
3255 switch (data_size) {
3257 target_buffer_set_u64(target, target_buf + i * data_size, b);
3260 target_buffer_set_u32(target, target_buf + i * data_size, b);
3263 target_buffer_set_u16(target, target_buf + i * data_size, b);
3266 target_buffer_set_u8(target, target_buf + i * data_size, b);
3273 int retval = ERROR_OK;
3275 for (unsigned x = 0; x < c; x += chunk_size) {
3278 if (current > chunk_size)
3279 current = chunk_size;
3280 retval = fn(target, address + x * data_size, data_size, current, target_buf);
3281 if (retval != ERROR_OK)
3283 /* avoid GDB timeouts */
3292 COMMAND_HANDLER(handle_mw_command)
3295 return ERROR_COMMAND_SYNTAX_ERROR;
3296 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
3301 fn = target_write_phys_memory;
3303 fn = target_write_memory;
3304 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
3305 return ERROR_COMMAND_SYNTAX_ERROR;
3307 target_addr_t address;
3308 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
3310 target_addr_t value;
3311 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], value);
3315 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
3317 struct target *target = get_current_target(CMD_CTX);
3319 switch (CMD_NAME[2]) {
3333 return ERROR_COMMAND_SYNTAX_ERROR;
3336 return target_fill_mem(target, address, fn, wordsize, value, count);
3339 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
3340 target_addr_t *min_address, target_addr_t *max_address)
3342 if (CMD_ARGC < 1 || CMD_ARGC > 5)
3343 return ERROR_COMMAND_SYNTAX_ERROR;
3345 /* a base address isn't always necessary,
3346 * default to 0x0 (i.e. don't relocate) */
3347 if (CMD_ARGC >= 2) {
3349 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], addr);
3350 image->base_address = addr;
3351 image->base_address_set = 1;
3353 image->base_address_set = 0;
3355 image->start_address_set = 0;
3358 COMMAND_PARSE_ADDRESS(CMD_ARGV[3], *min_address);
3359 if (CMD_ARGC == 5) {
3360 COMMAND_PARSE_ADDRESS(CMD_ARGV[4], *max_address);
3361 /* use size (given) to find max (required) */
3362 *max_address += *min_address;
3365 if (*min_address > *max_address)
3366 return ERROR_COMMAND_SYNTAX_ERROR;
3371 COMMAND_HANDLER(handle_load_image_command)
3375 uint32_t image_size;
3376 target_addr_t min_address = 0;
3377 target_addr_t max_address = -1;
3381 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
3382 &image, &min_address, &max_address);
3383 if (ERROR_OK != retval)
3386 struct target *target = get_current_target(CMD_CTX);
3388 struct duration bench;
3389 duration_start(&bench);
3391 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
3396 for (i = 0; i < image.num_sections; i++) {
3397 buffer = malloc(image.sections[i].size);
3398 if (buffer == NULL) {
3399 command_print(CMD_CTX,
3400 "error allocating buffer for section (%d bytes)",
3401 (int)(image.sections[i].size));
3402 retval = ERROR_FAIL;
3406 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3407 if (retval != ERROR_OK) {
3412 uint32_t offset = 0;
3413 uint32_t length = buf_cnt;
3415 /* DANGER!!! beware of unsigned comparision here!!! */
3417 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
3418 (image.sections[i].base_address < max_address)) {
3420 if (image.sections[i].base_address < min_address) {
3421 /* clip addresses below */
3422 offset += min_address-image.sections[i].base_address;
3426 if (image.sections[i].base_address + buf_cnt > max_address)
3427 length -= (image.sections[i].base_address + buf_cnt)-max_address;
3429 retval = target_write_buffer(target,
3430 image.sections[i].base_address + offset, length, buffer + offset);
3431 if (retval != ERROR_OK) {
3435 image_size += length;
3436 command_print(CMD_CTX, "%u bytes written at address " TARGET_ADDR_FMT "",
3437 (unsigned int)length,
3438 image.sections[i].base_address + offset);
3444 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3445 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
3446 "in %fs (%0.3f KiB/s)", image_size,
3447 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3450 image_close(&image);
3456 COMMAND_HANDLER(handle_dump_image_command)
3458 struct fileio *fileio;
3460 int retval, retvaltemp;
3461 target_addr_t address, size;
3462 struct duration bench;
3463 struct target *target = get_current_target(CMD_CTX);
3466 return ERROR_COMMAND_SYNTAX_ERROR;
3468 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], address);
3469 COMMAND_PARSE_ADDRESS(CMD_ARGV[2], size);
3471 uint32_t buf_size = (size > 4096) ? 4096 : size;
3472 buffer = malloc(buf_size);
3476 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
3477 if (retval != ERROR_OK) {
3482 duration_start(&bench);
3485 size_t size_written;
3486 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
3487 retval = target_read_buffer(target, address, this_run_size, buffer);
3488 if (retval != ERROR_OK)
3491 retval = fileio_write(fileio, this_run_size, buffer, &size_written);
3492 if (retval != ERROR_OK)
3495 size -= this_run_size;
3496 address += this_run_size;
3501 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3503 retval = fileio_size(fileio, &filesize);
3504 if (retval != ERROR_OK)
3506 command_print(CMD_CTX,
3507 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize,
3508 duration_elapsed(&bench), duration_kbps(&bench, filesize));
3511 retvaltemp = fileio_close(fileio);
3512 if (retvaltemp != ERROR_OK)
3521 IMAGE_CHECKSUM_ONLY = 2
3524 static COMMAND_HELPER(handle_verify_image_command_internal, enum verify_mode verify)
3528 uint32_t image_size;
3531 uint32_t checksum = 0;
3532 uint32_t mem_checksum = 0;
3536 struct target *target = get_current_target(CMD_CTX);
3539 return ERROR_COMMAND_SYNTAX_ERROR;
3542 LOG_ERROR("no target selected");
3546 struct duration bench;
3547 duration_start(&bench);
3549 if (CMD_ARGC >= 2) {
3551 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], addr);
3552 image.base_address = addr;
3553 image.base_address_set = 1;
3555 image.base_address_set = 0;
3556 image.base_address = 0x0;
3559 image.start_address_set = 0;
3561 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
3562 if (retval != ERROR_OK)
3568 for (i = 0; i < image.num_sections; i++) {
3569 buffer = malloc(image.sections[i].size);
3570 if (buffer == NULL) {
3571 command_print(CMD_CTX,
3572 "error allocating buffer for section (%d bytes)",
3573 (int)(image.sections[i].size));
3576 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3577 if (retval != ERROR_OK) {
3582 if (verify >= IMAGE_VERIFY) {
3583 /* calculate checksum of image */
3584 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3585 if (retval != ERROR_OK) {
3590 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3591 if (retval != ERROR_OK) {
3595 if ((checksum != mem_checksum) && (verify == IMAGE_CHECKSUM_ONLY)) {
3596 LOG_ERROR("checksum mismatch");
3598 retval = ERROR_FAIL;
3601 if (checksum != mem_checksum) {
3602 /* failed crc checksum, fall back to a binary compare */
3606 LOG_ERROR("checksum mismatch - attempting binary compare");
3608 data = malloc(buf_cnt);
3610 /* Can we use 32bit word accesses? */
3612 int count = buf_cnt;
3613 if ((count % 4) == 0) {
3617 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3618 if (retval == ERROR_OK) {
3620 for (t = 0; t < buf_cnt; t++) {
3621 if (data[t] != buffer[t]) {
3622 command_print(CMD_CTX,
3623 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3625 (unsigned)(t + image.sections[i].base_address),
3628 if (diffs++ >= 127) {
3629 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3641 command_print(CMD_CTX, "address " TARGET_ADDR_FMT " length 0x%08zx",
3642 image.sections[i].base_address,
3647 image_size += buf_cnt;
3650 command_print(CMD_CTX, "No more differences found.");
3653 retval = ERROR_FAIL;
3654 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3655 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3656 "in %fs (%0.3f KiB/s)", image_size,
3657 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3660 image_close(&image);
3665 COMMAND_HANDLER(handle_verify_image_checksum_command)
3667 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_CHECKSUM_ONLY);
3670 COMMAND_HANDLER(handle_verify_image_command)
3672 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_VERIFY);
3675 COMMAND_HANDLER(handle_test_image_command)
3677 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_TEST);
3680 static int handle_bp_command_list(struct command_context *cmd_ctx)
3682 struct target *target = get_current_target(cmd_ctx);
3683 struct breakpoint *breakpoint = target->breakpoints;
3684 while (breakpoint) {
3685 if (breakpoint->type == BKPT_SOFT) {
3686 char *buf = buf_to_str(breakpoint->orig_instr,
3687 breakpoint->length, 16);
3688 command_print(cmd_ctx, "IVA breakpoint: " TARGET_ADDR_FMT ", 0x%x, %i, 0x%s",
3689 breakpoint->address,
3691 breakpoint->set, buf);
3694 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3695 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3697 breakpoint->length, breakpoint->set);
3698 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3699 command_print(cmd_ctx, "Hybrid breakpoint(IVA): " TARGET_ADDR_FMT ", 0x%x, %i",
3700 breakpoint->address,
3701 breakpoint->length, breakpoint->set);
3702 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3705 command_print(cmd_ctx, "Breakpoint(IVA): " TARGET_ADDR_FMT ", 0x%x, %i",
3706 breakpoint->address,
3707 breakpoint->length, breakpoint->set);
3710 breakpoint = breakpoint->next;
3715 static int handle_bp_command_set(struct command_context *cmd_ctx,
3716 target_addr_t addr, uint32_t asid, uint32_t length, int hw)
3718 struct target *target = get_current_target(cmd_ctx);
3722 retval = breakpoint_add(target, addr, length, hw);
3723 /* error is always logged in breakpoint_add(), do not print it again */
3724 if (ERROR_OK == retval)
3725 command_print(cmd_ctx, "breakpoint set at " TARGET_ADDR_FMT "", addr);
3727 } else if (addr == 0) {
3728 if (target->type->add_context_breakpoint == NULL) {
3729 LOG_ERROR("Context breakpoint not available");
3730 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
3732 retval = context_breakpoint_add(target, asid, length, hw);
3733 /* error is always logged in context_breakpoint_add(), do not print it again */
3734 if (ERROR_OK == retval)
3735 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3738 if (target->type->add_hybrid_breakpoint == NULL) {
3739 LOG_ERROR("Hybrid breakpoint not available");
3740 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
3742 retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3743 /* error is always logged in hybrid_breakpoint_add(), do not print it again */
3744 if (ERROR_OK == retval)
3745 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3750 COMMAND_HANDLER(handle_bp_command)
3759 return handle_bp_command_list(CMD_CTX);
3763 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3764 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3765 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3768 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3770 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3771 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3773 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3774 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3776 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3777 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3779 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3784 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3785 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3786 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3787 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3790 return ERROR_COMMAND_SYNTAX_ERROR;
3794 COMMAND_HANDLER(handle_rbp_command)
3797 return ERROR_COMMAND_SYNTAX_ERROR;
3800 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3802 struct target *target = get_current_target(CMD_CTX);
3803 breakpoint_remove(target, addr);
3808 COMMAND_HANDLER(handle_wp_command)
3810 struct target *target = get_current_target(CMD_CTX);
3812 if (CMD_ARGC == 0) {
3813 struct watchpoint *watchpoint = target->watchpoints;
3815 while (watchpoint) {
3816 command_print(CMD_CTX, "address: " TARGET_ADDR_FMT
3817 ", len: 0x%8.8" PRIx32
3818 ", r/w/a: %i, value: 0x%8.8" PRIx32
3819 ", mask: 0x%8.8" PRIx32,
3820 watchpoint->address,
3822 (int)watchpoint->rw,
3825 watchpoint = watchpoint->next;
3830 enum watchpoint_rw type = WPT_ACCESS;
3832 uint32_t length = 0;
3833 uint32_t data_value = 0x0;
3834 uint32_t data_mask = 0xffffffff;
3838 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3841 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3844 switch (CMD_ARGV[2][0]) {
3855 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3856 return ERROR_COMMAND_SYNTAX_ERROR;
3860 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3861 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3865 return ERROR_COMMAND_SYNTAX_ERROR;
3868 int retval = watchpoint_add(target, addr, length, type,
3869 data_value, data_mask);
3870 if (ERROR_OK != retval)
3871 LOG_ERROR("Failure setting watchpoints");
3876 COMMAND_HANDLER(handle_rwp_command)
3879 return ERROR_COMMAND_SYNTAX_ERROR;
3882 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3884 struct target *target = get_current_target(CMD_CTX);
3885 watchpoint_remove(target, addr);
3891 * Translate a virtual address to a physical address.
3893 * The low-level target implementation must have logged a detailed error
3894 * which is forwarded to telnet/GDB session.
3896 COMMAND_HANDLER(handle_virt2phys_command)
3899 return ERROR_COMMAND_SYNTAX_ERROR;
3902 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], va);
3905 struct target *target = get_current_target(CMD_CTX);
3906 int retval = target->type->virt2phys(target, va, &pa);
3907 if (retval == ERROR_OK)
3908 command_print(CMD_CTX, "Physical address " TARGET_ADDR_FMT "", pa);
3913 static void writeData(FILE *f, const void *data, size_t len)
3915 size_t written = fwrite(data, 1, len, f);
3917 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3920 static void writeLong(FILE *f, int l, struct target *target)
3924 target_buffer_set_u32(target, val, l);
3925 writeData(f, val, 4);
3928 static void writeString(FILE *f, char *s)
3930 writeData(f, s, strlen(s));
3933 typedef unsigned char UNIT[2]; /* unit of profiling */
3935 /* Dump a gmon.out histogram file. */
3936 static void write_gmon(uint32_t *samples, uint32_t sampleNum, const char *filename, bool with_range,
3937 uint32_t start_address, uint32_t end_address, struct target *target, uint32_t duration_ms)
3940 FILE *f = fopen(filename, "w");
3943 writeString(f, "gmon");
3944 writeLong(f, 0x00000001, target); /* Version */
3945 writeLong(f, 0, target); /* padding */
3946 writeLong(f, 0, target); /* padding */
3947 writeLong(f, 0, target); /* padding */
3949 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3950 writeData(f, &zero, 1);
3952 /* figure out bucket size */
3956 min = start_address;
3961 for (i = 0; i < sampleNum; i++) {
3962 if (min > samples[i])
3964 if (max < samples[i])
3968 /* max should be (largest sample + 1)
3969 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
3973 int addressSpace = max - min;
3974 assert(addressSpace >= 2);
3976 /* FIXME: What is the reasonable number of buckets?
3977 * The profiling result will be more accurate if there are enough buckets. */
3978 static const uint32_t maxBuckets = 128 * 1024; /* maximum buckets. */
3979 uint32_t numBuckets = addressSpace / sizeof(UNIT);
3980 if (numBuckets > maxBuckets)
3981 numBuckets = maxBuckets;
3982 int *buckets = malloc(sizeof(int) * numBuckets);
3983 if (buckets == NULL) {
3987 memset(buckets, 0, sizeof(int) * numBuckets);
3988 for (i = 0; i < sampleNum; i++) {
3989 uint32_t address = samples[i];
3991 if ((address < min) || (max <= address))
3994 long long a = address - min;
3995 long long b = numBuckets;
3996 long long c = addressSpace;
3997 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
4001 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
4002 writeLong(f, min, target); /* low_pc */
4003 writeLong(f, max, target); /* high_pc */
4004 writeLong(f, numBuckets, target); /* # of buckets */
4005 float sample_rate = sampleNum / (duration_ms / 1000.0);
4006 writeLong(f, sample_rate, target);
4007 writeString(f, "seconds");
4008 for (i = 0; i < (15-strlen("seconds")); i++)
4009 writeData(f, &zero, 1);
4010 writeString(f, "s");
4012 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
4014 char *data = malloc(2 * numBuckets);
4016 for (i = 0; i < numBuckets; i++) {
4021 data[i * 2] = val&0xff;
4022 data[i * 2 + 1] = (val >> 8) & 0xff;
4025 writeData(f, data, numBuckets * 2);
4033 /* profiling samples the CPU PC as quickly as OpenOCD is able,
4034 * which will be used as a random sampling of PC */
4035 COMMAND_HANDLER(handle_profile_command)
4037 struct target *target = get_current_target(CMD_CTX);
4039 if ((CMD_ARGC != 2) && (CMD_ARGC != 4))
4040 return ERROR_COMMAND_SYNTAX_ERROR;
4042 const uint32_t MAX_PROFILE_SAMPLE_NUM = 10000;
4044 uint32_t num_of_samples;
4045 int retval = ERROR_OK;
4047 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], offset);
4049 uint32_t *samples = malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM);
4050 if (samples == NULL) {
4051 LOG_ERROR("No memory to store samples.");
4055 uint64_t timestart_ms = timeval_ms();
4057 * Some cores let us sample the PC without the
4058 * annoying halt/resume step; for example, ARMv7 PCSR.
4059 * Provide a way to use that more efficient mechanism.
4061 retval = target_profiling(target, samples, MAX_PROFILE_SAMPLE_NUM,
4062 &num_of_samples, offset);
4063 if (retval != ERROR_OK) {
4067 uint32_t duration_ms = timeval_ms() - timestart_ms;
4069 assert(num_of_samples <= MAX_PROFILE_SAMPLE_NUM);
4071 retval = target_poll(target);
4072 if (retval != ERROR_OK) {
4076 if (target->state == TARGET_RUNNING) {
4077 retval = target_halt(target);
4078 if (retval != ERROR_OK) {
4084 retval = target_poll(target);
4085 if (retval != ERROR_OK) {
4090 uint32_t start_address = 0;
4091 uint32_t end_address = 0;
4092 bool with_range = false;
4093 if (CMD_ARGC == 4) {
4095 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], start_address);
4096 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], end_address);
4099 write_gmon(samples, num_of_samples, CMD_ARGV[1],
4100 with_range, start_address, end_address, target, duration_ms);
4101 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
4107 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
4110 Jim_Obj *nameObjPtr, *valObjPtr;
4113 namebuf = alloc_printf("%s(%d)", varname, idx);
4117 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
4118 valObjPtr = Jim_NewIntObj(interp, val);
4119 if (!nameObjPtr || !valObjPtr) {
4124 Jim_IncrRefCount(nameObjPtr);
4125 Jim_IncrRefCount(valObjPtr);
4126 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
4127 Jim_DecrRefCount(interp, nameObjPtr);
4128 Jim_DecrRefCount(interp, valObjPtr);
4130 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
4134 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4136 struct command_context *context;
4137 struct target *target;
4139 context = current_command_context(interp);
4140 assert(context != NULL);
4142 target = get_current_target(context);
4143 if (target == NULL) {
4144 LOG_ERROR("mem2array: no current target");
4148 return target_mem2array(interp, target, argc - 1, argv + 1);
4151 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
4159 const char *varname;
4165 /* argv[1] = name of array to receive the data
4166 * argv[2] = desired width
4167 * argv[3] = memory address
4168 * argv[4] = count of times to read
4171 if (argc < 4 || argc > 5) {
4172 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems [phys]");
4175 varname = Jim_GetString(argv[0], &len);
4176 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4178 e = Jim_GetLong(interp, argv[1], &l);
4183 e = Jim_GetLong(interp, argv[2], &l);
4187 e = Jim_GetLong(interp, argv[3], &l);
4193 phys = Jim_GetString(argv[4], &n);
4194 if (!strncmp(phys, "phys", n))
4210 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4211 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
4215 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4216 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
4219 if ((addr + (len * width)) < addr) {
4220 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4221 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
4224 /* absurd transfer size? */
4226 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4227 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
4232 ((width == 2) && ((addr & 1) == 0)) ||
4233 ((width == 4) && ((addr & 3) == 0))) {
4237 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4238 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4241 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4250 size_t buffersize = 4096;
4251 uint8_t *buffer = malloc(buffersize);
4258 /* Slurp... in buffer size chunks */
4260 count = len; /* in objects.. */
4261 if (count > (buffersize / width))
4262 count = (buffersize / width);
4265 retval = target_read_phys_memory(target, addr, width, count, buffer);
4267 retval = target_read_memory(target, addr, width, count, buffer);
4268 if (retval != ERROR_OK) {
4270 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4274 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4275 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
4279 v = 0; /* shut up gcc */
4280 for (i = 0; i < count ; i++, n++) {
4283 v = target_buffer_get_u32(target, &buffer[i*width]);
4286 v = target_buffer_get_u16(target, &buffer[i*width]);
4289 v = buffer[i] & 0x0ff;
4292 new_int_array_element(interp, varname, n, v);
4295 addr += count * width;
4301 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4306 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
4309 Jim_Obj *nameObjPtr, *valObjPtr;
4313 namebuf = alloc_printf("%s(%d)", varname, idx);
4317 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
4323 Jim_IncrRefCount(nameObjPtr);
4324 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
4325 Jim_DecrRefCount(interp, nameObjPtr);
4327 if (valObjPtr == NULL)
4330 result = Jim_GetLong(interp, valObjPtr, &l);
4331 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4336 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4338 struct command_context *context;
4339 struct target *target;
4341 context = current_command_context(interp);
4342 assert(context != NULL);
4344 target = get_current_target(context);
4345 if (target == NULL) {
4346 LOG_ERROR("array2mem: no current target");
4350 return target_array2mem(interp, target, argc-1, argv + 1);
4353 static int target_array2mem(Jim_Interp *interp, struct target *target,
4354 int argc, Jim_Obj *const *argv)
4362 const char *varname;
4368 /* argv[1] = name of array to get the data
4369 * argv[2] = desired width
4370 * argv[3] = memory address
4371 * argv[4] = count to write
4373 if (argc < 4 || argc > 5) {
4374 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems [phys]");
4377 varname = Jim_GetString(argv[0], &len);
4378 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4380 e = Jim_GetLong(interp, argv[1], &l);
4385 e = Jim_GetLong(interp, argv[2], &l);
4389 e = Jim_GetLong(interp, argv[3], &l);
4395 phys = Jim_GetString(argv[4], &n);
4396 if (!strncmp(phys, "phys", n))
4412 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4413 Jim_AppendStrings(interp, Jim_GetResult(interp),
4414 "Invalid width param, must be 8/16/32", NULL);
4418 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4419 Jim_AppendStrings(interp, Jim_GetResult(interp),
4420 "array2mem: zero width read?", NULL);
4423 if ((addr + (len * width)) < addr) {
4424 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4425 Jim_AppendStrings(interp, Jim_GetResult(interp),
4426 "array2mem: addr + len - wraps to zero?", NULL);
4429 /* absurd transfer size? */
4431 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4432 Jim_AppendStrings(interp, Jim_GetResult(interp),
4433 "array2mem: absurd > 64K item request", NULL);
4438 ((width == 2) && ((addr & 1) == 0)) ||
4439 ((width == 4) && ((addr & 3) == 0))) {
4443 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4444 sprintf(buf, "array2mem address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4447 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4458 size_t buffersize = 4096;
4459 uint8_t *buffer = malloc(buffersize);
4464 /* Slurp... in buffer size chunks */
4466 count = len; /* in objects.. */
4467 if (count > (buffersize / width))
4468 count = (buffersize / width);
4470 v = 0; /* shut up gcc */
4471 for (i = 0; i < count; i++, n++) {
4472 get_int_array_element(interp, varname, n, &v);
4475 target_buffer_set_u32(target, &buffer[i * width], v);
4478 target_buffer_set_u16(target, &buffer[i * width], v);
4481 buffer[i] = v & 0x0ff;
4488 retval = target_write_phys_memory(target, addr, width, count, buffer);
4490 retval = target_write_memory(target, addr, width, count, buffer);
4491 if (retval != ERROR_OK) {
4493 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4497 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4498 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
4502 addr += count * width;
4507 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4512 /* FIX? should we propagate errors here rather than printing them
4515 void target_handle_event(struct target *target, enum target_event e)
4517 struct target_event_action *teap;
4519 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4520 if (teap->event == e) {
4521 LOG_DEBUG("target(%d): %s (%s) event: %d (%s) action: %s",
4522 target->target_number,
4523 target_name(target),
4524 target_type_name(target),
4526 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
4527 Jim_GetString(teap->body, NULL));
4529 /* Override current target by the target an event
4530 * is issued from (lot of scripts need it).
4531 * Return back to previous override as soon
4532 * as the handler processing is done */
4533 struct command_context *cmd_ctx = current_command_context(teap->interp);
4534 struct target *saved_target_override = cmd_ctx->current_target_override;
4535 cmd_ctx->current_target_override = target;
4537 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
4538 Jim_MakeErrorMessage(teap->interp);
4539 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
4542 cmd_ctx->current_target_override = saved_target_override;
4548 * Returns true only if the target has a handler for the specified event.
4550 bool target_has_event_action(struct target *target, enum target_event event)
4552 struct target_event_action *teap;
4554 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4555 if (teap->event == event)
4561 enum target_cfg_param {
4564 TCFG_WORK_AREA_VIRT,
4565 TCFG_WORK_AREA_PHYS,
4566 TCFG_WORK_AREA_SIZE,
4567 TCFG_WORK_AREA_BACKUP,
4570 TCFG_CHAIN_POSITION,
4577 static Jim_Nvp nvp_config_opts[] = {
4578 { .name = "-type", .value = TCFG_TYPE },
4579 { .name = "-event", .value = TCFG_EVENT },
4580 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
4581 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
4582 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
4583 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
4584 { .name = "-endian" , .value = TCFG_ENDIAN },
4585 { .name = "-coreid", .value = TCFG_COREID },
4586 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
4587 { .name = "-dbgbase", .value = TCFG_DBGBASE },
4588 { .name = "-rtos", .value = TCFG_RTOS },
4589 { .name = "-defer-examine", .value = TCFG_DEFER_EXAMINE },
4590 { .name = "-gdb-port", .value = TCFG_GDB_PORT },
4591 { .name = NULL, .value = -1 }
4594 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
4601 /* parse config or cget options ... */
4602 while (goi->argc > 0) {
4603 Jim_SetEmptyResult(goi->interp);
4604 /* Jim_GetOpt_Debug(goi); */
4606 if (target->type->target_jim_configure) {
4607 /* target defines a configure function */
4608 /* target gets first dibs on parameters */
4609 e = (*(target->type->target_jim_configure))(target, goi);
4618 /* otherwise we 'continue' below */
4620 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
4622 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
4628 if (goi->isconfigure) {
4629 Jim_SetResultFormatted(goi->interp,
4630 "not settable: %s", n->name);
4634 if (goi->argc != 0) {
4635 Jim_WrongNumArgs(goi->interp,
4636 goi->argc, goi->argv,
4641 Jim_SetResultString(goi->interp,
4642 target_type_name(target), -1);
4646 if (goi->argc == 0) {
4647 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4651 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4653 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4657 if (goi->isconfigure) {
4658 if (goi->argc != 1) {
4659 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4663 if (goi->argc != 0) {
4664 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4670 struct target_event_action *teap;
4672 teap = target->event_action;
4673 /* replace existing? */
4675 if (teap->event == (enum target_event)n->value)
4680 if (goi->isconfigure) {
4681 bool replace = true;
4684 teap = calloc(1, sizeof(*teap));
4687 teap->event = n->value;
4688 teap->interp = goi->interp;
4689 Jim_GetOpt_Obj(goi, &o);
4691 Jim_DecrRefCount(teap->interp, teap->body);
4692 teap->body = Jim_DuplicateObj(goi->interp, o);
4695 * Tcl/TK - "tk events" have a nice feature.
4696 * See the "BIND" command.
4697 * We should support that here.
4698 * You can specify %X and %Y in the event code.
4699 * The idea is: %T - target name.
4700 * The idea is: %N - target number
4701 * The idea is: %E - event name.
4703 Jim_IncrRefCount(teap->body);
4706 /* add to head of event list */
4707 teap->next = target->event_action;
4708 target->event_action = teap;
4710 Jim_SetEmptyResult(goi->interp);
4714 Jim_SetEmptyResult(goi->interp);
4716 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4722 case TCFG_WORK_AREA_VIRT:
4723 if (goi->isconfigure) {
4724 target_free_all_working_areas(target);
4725 e = Jim_GetOpt_Wide(goi, &w);
4728 target->working_area_virt = w;
4729 target->working_area_virt_spec = true;
4734 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4738 case TCFG_WORK_AREA_PHYS:
4739 if (goi->isconfigure) {
4740 target_free_all_working_areas(target);
4741 e = Jim_GetOpt_Wide(goi, &w);
4744 target->working_area_phys = w;
4745 target->working_area_phys_spec = true;
4750 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4754 case TCFG_WORK_AREA_SIZE:
4755 if (goi->isconfigure) {
4756 target_free_all_working_areas(target);
4757 e = Jim_GetOpt_Wide(goi, &w);
4760 target->working_area_size = w;
4765 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4769 case TCFG_WORK_AREA_BACKUP:
4770 if (goi->isconfigure) {
4771 target_free_all_working_areas(target);
4772 e = Jim_GetOpt_Wide(goi, &w);
4775 /* make this exactly 1 or 0 */
4776 target->backup_working_area = (!!w);
4781 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4782 /* loop for more e*/
4787 if (goi->isconfigure) {
4788 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4790 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4793 target->endianness = n->value;
4798 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4799 if (n->name == NULL) {
4800 target->endianness = TARGET_LITTLE_ENDIAN;
4801 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4803 Jim_SetResultString(goi->interp, n->name, -1);
4808 if (goi->isconfigure) {
4809 e = Jim_GetOpt_Wide(goi, &w);
4812 target->coreid = (int32_t)w;
4817 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4821 case TCFG_CHAIN_POSITION:
4822 if (goi->isconfigure) {
4824 struct jtag_tap *tap;
4826 if (target->has_dap) {
4827 Jim_SetResultString(goi->interp,
4828 "target requires -dap parameter instead of -chain-position!", -1);
4832 target_free_all_working_areas(target);
4833 e = Jim_GetOpt_Obj(goi, &o_t);
4836 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4840 target->tap_configured = true;
4845 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4846 /* loop for more e*/
4849 if (goi->isconfigure) {
4850 e = Jim_GetOpt_Wide(goi, &w);
4853 target->dbgbase = (uint32_t)w;
4854 target->dbgbase_set = true;
4859 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4865 int result = rtos_create(goi, target);
4866 if (result != JIM_OK)
4872 case TCFG_DEFER_EXAMINE:
4874 target->defer_examine = true;
4879 if (goi->isconfigure) {
4881 e = Jim_GetOpt_String(goi, &s, NULL);
4884 target->gdb_port_override = strdup(s);
4889 Jim_SetResultString(goi->interp, target->gdb_port_override ? : "undefined", -1);
4893 } /* while (goi->argc) */
4896 /* done - we return */
4900 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4904 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4905 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4907 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4908 "missing: -option ...");
4911 struct target *target = Jim_CmdPrivData(goi.interp);
4912 return target_configure(&goi, target);
4915 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4917 const char *cmd_name = Jim_GetString(argv[0], NULL);
4920 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4922 if (goi.argc < 2 || goi.argc > 4) {
4923 Jim_SetResultFormatted(goi.interp,
4924 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4929 fn = target_write_memory;
4932 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4934 struct Jim_Obj *obj;
4935 e = Jim_GetOpt_Obj(&goi, &obj);
4939 fn = target_write_phys_memory;
4943 e = Jim_GetOpt_Wide(&goi, &a);
4948 e = Jim_GetOpt_Wide(&goi, &b);
4953 if (goi.argc == 1) {
4954 e = Jim_GetOpt_Wide(&goi, &c);
4959 /* all args must be consumed */
4963 struct target *target = Jim_CmdPrivData(goi.interp);
4965 if (strcasecmp(cmd_name, "mww") == 0)
4967 else if (strcasecmp(cmd_name, "mwh") == 0)
4969 else if (strcasecmp(cmd_name, "mwb") == 0)
4972 LOG_ERROR("command '%s' unknown: ", cmd_name);
4976 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4980 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4982 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4983 * mdh [phys] <address> [<count>] - for 16 bit reads
4984 * mdb [phys] <address> [<count>] - for 8 bit reads
4986 * Count defaults to 1.
4988 * Calls target_read_memory or target_read_phys_memory depending on
4989 * the presence of the "phys" argument
4990 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4991 * to int representation in base16.
4992 * Also outputs read data in a human readable form using command_print
4994 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4995 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4996 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4997 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4998 * on success, with [<count>] number of elements.
5000 * In case of little endian target:
5001 * Example1: "mdw 0x00000000" returns "10123456"
5002 * Exmaple2: "mdh 0x00000000 1" returns "3456"
5003 * Example3: "mdb 0x00000000" returns "56"
5004 * Example4: "mdh 0x00000000 2" returns "3456 1012"
5005 * Example5: "mdb 0x00000000 3" returns "56 34 12"
5007 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5009 const char *cmd_name = Jim_GetString(argv[0], NULL);
5012 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5014 if ((goi.argc < 1) || (goi.argc > 3)) {
5015 Jim_SetResultFormatted(goi.interp,
5016 "usage: %s [phys] <address> [<count>]", cmd_name);
5020 int (*fn)(struct target *target,
5021 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
5022 fn = target_read_memory;
5025 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
5027 struct Jim_Obj *obj;
5028 e = Jim_GetOpt_Obj(&goi, &obj);
5032 fn = target_read_phys_memory;
5035 /* Read address parameter */
5037 e = Jim_GetOpt_Wide(&goi, &addr);
5041 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
5043 if (goi.argc == 1) {
5044 e = Jim_GetOpt_Wide(&goi, &count);
5050 /* all args must be consumed */
5054 jim_wide dwidth = 1; /* shut up gcc */
5055 if (strcasecmp(cmd_name, "mdw") == 0)
5057 else if (strcasecmp(cmd_name, "mdh") == 0)
5059 else if (strcasecmp(cmd_name, "mdb") == 0)
5062 LOG_ERROR("command '%s' unknown: ", cmd_name);
5066 /* convert count to "bytes" */
5067 int bytes = count * dwidth;
5069 struct target *target = Jim_CmdPrivData(goi.interp);
5070 uint8_t target_buf[32];
5073 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
5075 /* Try to read out next block */
5076 e = fn(target, addr, dwidth, y / dwidth, target_buf);
5078 if (e != ERROR_OK) {
5079 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
5083 command_print_sameline(NULL, "0x%08x ", (int)(addr));
5086 for (x = 0; x < 16 && x < y; x += 4) {
5087 z = target_buffer_get_u32(target, &(target_buf[x]));
5088 command_print_sameline(NULL, "%08x ", (int)(z));
5090 for (; (x < 16) ; x += 4)
5091 command_print_sameline(NULL, " ");
5094 for (x = 0; x < 16 && x < y; x += 2) {
5095 z = target_buffer_get_u16(target, &(target_buf[x]));
5096 command_print_sameline(NULL, "%04x ", (int)(z));
5098 for (; (x < 16) ; x += 2)
5099 command_print_sameline(NULL, " ");
5103 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
5104 z = target_buffer_get_u8(target, &(target_buf[x]));
5105 command_print_sameline(NULL, "%02x ", (int)(z));
5107 for (; (x < 16) ; x += 1)
5108 command_print_sameline(NULL, " ");
5111 /* ascii-ify the bytes */
5112 for (x = 0 ; x < y ; x++) {
5113 if ((target_buf[x] >= 0x20) &&
5114 (target_buf[x] <= 0x7e)) {
5118 target_buf[x] = '.';
5123 target_buf[x] = ' ';
5128 /* print - with a newline */
5129 command_print_sameline(NULL, "%s\n", target_buf);
5137 static int jim_target_mem2array(Jim_Interp *interp,
5138 int argc, Jim_Obj *const *argv)
5140 struct target *target = Jim_CmdPrivData(interp);
5141 return target_mem2array(interp, target, argc - 1, argv + 1);
5144 static int jim_target_array2mem(Jim_Interp *interp,
5145 int argc, Jim_Obj *const *argv)
5147 struct target *target = Jim_CmdPrivData(interp);
5148 return target_array2mem(interp, target, argc - 1, argv + 1);
5151 static int jim_target_tap_disabled(Jim_Interp *interp)
5153 Jim_SetResultFormatted(interp, "[TAP is disabled]");
5157 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5159 bool allow_defer = false;
5162 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5164 const char *cmd_name = Jim_GetString(argv[0], NULL);
5165 Jim_SetResultFormatted(goi.interp,
5166 "usage: %s ['allow-defer']", cmd_name);
5170 strcmp(Jim_GetString(argv[1], NULL), "allow-defer") == 0) {
5172 struct Jim_Obj *obj;
5173 int e = Jim_GetOpt_Obj(&goi, &obj);
5179 struct target *target = Jim_CmdPrivData(interp);
5180 if (!target->tap->enabled)
5181 return jim_target_tap_disabled(interp);
5183 if (allow_defer && target->defer_examine) {
5184 LOG_INFO("Deferring arp_examine of %s", target_name(target));
5185 LOG_INFO("Use arp_examine command to examine it manually!");
5189 int e = target->type->examine(target);
5195 static int jim_target_was_examined(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
5197 struct target *target = Jim_CmdPrivData(interp);
5199 Jim_SetResultBool(interp, target_was_examined(target));
5203 static int jim_target_examine_deferred(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
5205 struct target *target = Jim_CmdPrivData(interp);
5207 Jim_SetResultBool(interp, target->defer_examine);
5211 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5214 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5217 struct target *target = Jim_CmdPrivData(interp);
5219 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
5225 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5228 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5231 struct target *target = Jim_CmdPrivData(interp);
5232 if (!target->tap->enabled)
5233 return jim_target_tap_disabled(interp);
5236 if (!(target_was_examined(target)))
5237 e = ERROR_TARGET_NOT_EXAMINED;
5239 e = target->type->poll(target);
5245 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5248 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5250 if (goi.argc != 2) {
5251 Jim_WrongNumArgs(interp, 0, argv,
5252 "([tT]|[fF]|assert|deassert) BOOL");
5257 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
5259 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
5262 /* the halt or not param */
5264 e = Jim_GetOpt_Wide(&goi, &a);
5268 struct target *target = Jim_CmdPrivData(goi.interp);
5269 if (!target->tap->enabled)
5270 return jim_target_tap_disabled(interp);
5272 if (!target->type->assert_reset || !target->type->deassert_reset) {
5273 Jim_SetResultFormatted(interp,
5274 "No target-specific reset for %s",
5275 target_name(target));
5279 if (target->defer_examine)
5280 target_reset_examined(target);
5282 /* determine if we should halt or not. */
5283 target->reset_halt = !!a;
5284 /* When this happens - all workareas are invalid. */
5285 target_free_all_working_areas_restore(target, 0);
5288 if (n->value == NVP_ASSERT)
5289 e = target->type->assert_reset(target);
5291 e = target->type->deassert_reset(target);
5292 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
5295 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5298 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5301 struct target *target = Jim_CmdPrivData(interp);
5302 if (!target->tap->enabled)
5303 return jim_target_tap_disabled(interp);
5304 int e = target->type->halt(target);
5305 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
5308 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5311 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5313 /* params: <name> statename timeoutmsecs */
5314 if (goi.argc != 2) {
5315 const char *cmd_name = Jim_GetString(argv[0], NULL);
5316 Jim_SetResultFormatted(goi.interp,
5317 "%s <state_name> <timeout_in_msec>", cmd_name);
5322 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
5324 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
5328 e = Jim_GetOpt_Wide(&goi, &a);
5331 struct target *target = Jim_CmdPrivData(interp);
5332 if (!target->tap->enabled)
5333 return jim_target_tap_disabled(interp);
5335 e = target_wait_state(target, n->value, a);
5336 if (e != ERROR_OK) {
5337 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
5338 Jim_SetResultFormatted(goi.interp,
5339 "target: %s wait %s fails (%#s) %s",
5340 target_name(target), n->name,
5341 eObj, target_strerror_safe(e));
5342 Jim_FreeNewObj(interp, eObj);
5347 /* List for human, Events defined for this target.
5348 * scripts/programs should use 'name cget -event NAME'
5350 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5352 struct command_context *cmd_ctx = current_command_context(interp);
5353 assert(cmd_ctx != NULL);
5355 struct target *target = Jim_CmdPrivData(interp);
5356 struct target_event_action *teap = target->event_action;
5357 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
5358 target->target_number,
5359 target_name(target));
5360 command_print(cmd_ctx, "%-25s | Body", "Event");
5361 command_print(cmd_ctx, "------------------------- | "
5362 "----------------------------------------");
5364 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
5365 command_print(cmd_ctx, "%-25s | %s",
5366 opt->name, Jim_GetString(teap->body, NULL));
5369 command_print(cmd_ctx, "***END***");
5372 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5375 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5378 struct target *target = Jim_CmdPrivData(interp);
5379 Jim_SetResultString(interp, target_state_name(target), -1);
5382 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5385 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5386 if (goi.argc != 1) {
5387 const char *cmd_name = Jim_GetString(argv[0], NULL);
5388 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
5392 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
5394 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
5397 struct target *target = Jim_CmdPrivData(interp);
5398 target_handle_event(target, n->value);
5402 static const struct command_registration target_instance_command_handlers[] = {
5404 .name = "configure",
5405 .mode = COMMAND_CONFIG,
5406 .jim_handler = jim_target_configure,
5407 .help = "configure a new target for use",
5408 .usage = "[target_attribute ...]",
5412 .mode = COMMAND_ANY,
5413 .jim_handler = jim_target_configure,
5414 .help = "returns the specified target attribute",
5415 .usage = "target_attribute",
5419 .mode = COMMAND_EXEC,
5420 .jim_handler = jim_target_mw,
5421 .help = "Write 32-bit word(s) to target memory",
5422 .usage = "address data [count]",
5426 .mode = COMMAND_EXEC,
5427 .jim_handler = jim_target_mw,
5428 .help = "Write 16-bit half-word(s) to target memory",
5429 .usage = "address data [count]",
5433 .mode = COMMAND_EXEC,
5434 .jim_handler = jim_target_mw,
5435 .help = "Write byte(s) to target memory",
5436 .usage = "address data [count]",
5440 .mode = COMMAND_EXEC,
5441 .jim_handler = jim_target_md,
5442 .help = "Display target memory as 32-bit words",
5443 .usage = "address [count]",
5447 .mode = COMMAND_EXEC,
5448 .jim_handler = jim_target_md,
5449 .help = "Display target memory as 16-bit half-words",
5450 .usage = "address [count]",
5454 .mode = COMMAND_EXEC,
5455 .jim_handler = jim_target_md,
5456 .help = "Display target memory as 8-bit bytes",
5457 .usage = "address [count]",
5460 .name = "array2mem",
5461 .mode = COMMAND_EXEC,
5462 .jim_handler = jim_target_array2mem,
5463 .help = "Writes Tcl array of 8/16/32 bit numbers "
5465 .usage = "arrayname bitwidth address count",
5468 .name = "mem2array",
5469 .mode = COMMAND_EXEC,
5470 .jim_handler = jim_target_mem2array,
5471 .help = "Loads Tcl array of 8/16/32 bit numbers "
5472 "from target memory",
5473 .usage = "arrayname bitwidth address count",
5476 .name = "eventlist",
5477 .mode = COMMAND_EXEC,
5478 .jim_handler = jim_target_event_list,
5479 .help = "displays a table of events defined for this target",
5483 .mode = COMMAND_EXEC,
5484 .jim_handler = jim_target_current_state,
5485 .help = "displays the current state of this target",
5488 .name = "arp_examine",
5489 .mode = COMMAND_EXEC,
5490 .jim_handler = jim_target_examine,
5491 .help = "used internally for reset processing",
5492 .usage = "['allow-defer']",
5495 .name = "was_examined",
5496 .mode = COMMAND_EXEC,
5497 .jim_handler = jim_target_was_examined,
5498 .help = "used internally for reset processing",
5501 .name = "examine_deferred",
5502 .mode = COMMAND_EXEC,
5503 .jim_handler = jim_target_examine_deferred,
5504 .help = "used internally for reset processing",
5507 .name = "arp_halt_gdb",
5508 .mode = COMMAND_EXEC,
5509 .jim_handler = jim_target_halt_gdb,
5510 .help = "used internally for reset processing to halt GDB",
5514 .mode = COMMAND_EXEC,
5515 .jim_handler = jim_target_poll,
5516 .help = "used internally for reset processing",
5519 .name = "arp_reset",
5520 .mode = COMMAND_EXEC,
5521 .jim_handler = jim_target_reset,
5522 .help = "used internally for reset processing",
5526 .mode = COMMAND_EXEC,
5527 .jim_handler = jim_target_halt,
5528 .help = "used internally for reset processing",
5531 .name = "arp_waitstate",
5532 .mode = COMMAND_EXEC,
5533 .jim_handler = jim_target_wait_state,
5534 .help = "used internally for reset processing",
5537 .name = "invoke-event",
5538 .mode = COMMAND_EXEC,
5539 .jim_handler = jim_target_invoke_event,
5540 .help = "invoke handler for specified event",
5541 .usage = "event_name",
5543 COMMAND_REGISTRATION_DONE
5546 static int target_create(Jim_GetOptInfo *goi)
5553 struct target *target;
5554 struct command_context *cmd_ctx;
5556 cmd_ctx = current_command_context(goi->interp);
5557 assert(cmd_ctx != NULL);
5559 if (goi->argc < 3) {
5560 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
5565 Jim_GetOpt_Obj(goi, &new_cmd);
5566 /* does this command exist? */
5567 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
5569 cp = Jim_GetString(new_cmd, NULL);
5570 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
5575 e = Jim_GetOpt_String(goi, &cp, NULL);
5578 struct transport *tr = get_current_transport();
5579 if (tr->override_target) {
5580 e = tr->override_target(&cp);
5581 if (e != ERROR_OK) {
5582 LOG_ERROR("The selected transport doesn't support this target");
5585 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5587 /* now does target type exist */
5588 for (x = 0 ; target_types[x] ; x++) {
5589 if (0 == strcmp(cp, target_types[x]->name)) {
5594 /* check for deprecated name */
5595 if (target_types[x]->deprecated_name) {
5596 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
5598 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
5603 if (target_types[x] == NULL) {
5604 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
5605 for (x = 0 ; target_types[x] ; x++) {
5606 if (target_types[x + 1]) {
5607 Jim_AppendStrings(goi->interp,
5608 Jim_GetResult(goi->interp),
5609 target_types[x]->name,
5612 Jim_AppendStrings(goi->interp,
5613 Jim_GetResult(goi->interp),
5615 target_types[x]->name, NULL);
5622 target = calloc(1, sizeof(struct target));
5623 /* set target number */
5624 target->target_number = new_target_number();
5625 cmd_ctx->current_target = target;
5627 /* allocate memory for each unique target type */
5628 target->type = calloc(1, sizeof(struct target_type));
5630 memcpy(target->type, target_types[x], sizeof(struct target_type));
5632 /* will be set by "-endian" */
5633 target->endianness = TARGET_ENDIAN_UNKNOWN;
5635 /* default to first core, override with -coreid */
5638 target->working_area = 0x0;
5639 target->working_area_size = 0x0;
5640 target->working_areas = NULL;
5641 target->backup_working_area = 0;
5643 target->state = TARGET_UNKNOWN;
5644 target->debug_reason = DBG_REASON_UNDEFINED;
5645 target->reg_cache = NULL;
5646 target->breakpoints = NULL;
5647 target->watchpoints = NULL;
5648 target->next = NULL;
5649 target->arch_info = NULL;
5651 target->verbose_halt_msg = true;
5653 target->halt_issued = false;
5655 /* initialize trace information */
5656 target->trace_info = calloc(1, sizeof(struct trace));
5658 target->dbgmsg = NULL;
5659 target->dbg_msg_enabled = 0;
5661 target->endianness = TARGET_ENDIAN_UNKNOWN;
5663 target->rtos = NULL;
5664 target->rtos_auto_detect = false;
5666 target->gdb_port_override = NULL;
5668 /* Do the rest as "configure" options */
5669 goi->isconfigure = 1;
5670 e = target_configure(goi, target);
5673 if (target->has_dap) {
5674 if (!target->dap_configured) {
5675 Jim_SetResultString(goi->interp, "-dap ?name? required when creating target", -1);
5679 if (!target->tap_configured) {
5680 Jim_SetResultString(goi->interp, "-chain-position ?name? required when creating target", -1);
5684 /* tap must be set after target was configured */
5685 if (target->tap == NULL)
5690 free(target->gdb_port_override);
5696 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
5697 /* default endian to little if not specified */
5698 target->endianness = TARGET_LITTLE_ENDIAN;
5701 cp = Jim_GetString(new_cmd, NULL);
5702 target->cmd_name = strdup(cp);
5704 if (target->type->target_create) {
5705 e = (*(target->type->target_create))(target, goi->interp);
5706 if (e != ERROR_OK) {
5707 LOG_DEBUG("target_create failed");
5708 free(target->gdb_port_override);
5710 free(target->cmd_name);
5716 /* create the target specific commands */
5717 if (target->type->commands) {
5718 e = register_commands(cmd_ctx, NULL, target->type->commands);
5720 LOG_ERROR("unable to register '%s' commands", cp);
5723 /* append to end of list */
5725 struct target **tpp;
5726 tpp = &(all_targets);
5728 tpp = &((*tpp)->next);
5732 /* now - create the new target name command */
5733 const struct command_registration target_subcommands[] = {
5735 .chain = target_instance_command_handlers,
5738 .chain = target->type->commands,
5740 COMMAND_REGISTRATION_DONE
5742 const struct command_registration target_commands[] = {
5745 .mode = COMMAND_ANY,
5746 .help = "target command group",
5748 .chain = target_subcommands,
5750 COMMAND_REGISTRATION_DONE
5752 e = register_commands(cmd_ctx, NULL, target_commands);
5756 struct command *c = command_find_in_context(cmd_ctx, cp);
5758 command_set_handler_data(c, target);
5760 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5763 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5766 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5769 struct command_context *cmd_ctx = current_command_context(interp);
5770 assert(cmd_ctx != NULL);
5772 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5776 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5779 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5782 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5783 for (unsigned x = 0; NULL != target_types[x]; x++) {
5784 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5785 Jim_NewStringObj(interp, target_types[x]->name, -1));
5790 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5793 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5796 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5797 struct target *target = all_targets;
5799 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5800 Jim_NewStringObj(interp, target_name(target), -1));
5801 target = target->next;
5806 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5809 const char *targetname;
5811 struct target *target = (struct target *) NULL;
5812 struct target_list *head, *curr, *new;
5813 curr = (struct target_list *) NULL;
5814 head = (struct target_list *) NULL;
5817 LOG_DEBUG("%d", argc);
5818 /* argv[1] = target to associate in smp
5819 * argv[2] = target to assoicate in smp
5823 for (i = 1; i < argc; i++) {
5825 targetname = Jim_GetString(argv[i], &len);
5826 target = get_target(targetname);
5827 LOG_DEBUG("%s ", targetname);
5829 new = malloc(sizeof(struct target_list));
5830 new->target = target;
5831 new->next = (struct target_list *)NULL;
5832 if (head == (struct target_list *)NULL) {
5841 /* now parse the list of cpu and put the target in smp mode*/
5844 while (curr != (struct target_list *)NULL) {
5845 target = curr->target;
5847 target->head = head;
5851 if (target && target->rtos)
5852 retval = rtos_smp_init(head->target);
5858 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5861 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5863 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5864 "<name> <target_type> [<target_options> ...]");
5867 return target_create(&goi);
5870 static const struct command_registration target_subcommand_handlers[] = {
5873 .mode = COMMAND_CONFIG,
5874 .handler = handle_target_init_command,
5875 .help = "initialize targets",
5879 .mode = COMMAND_CONFIG,
5880 .jim_handler = jim_target_create,
5881 .usage = "name type '-chain-position' name [options ...]",
5882 .help = "Creates and selects a new target",
5886 .mode = COMMAND_ANY,
5887 .jim_handler = jim_target_current,
5888 .help = "Returns the currently selected target",
5892 .mode = COMMAND_ANY,
5893 .jim_handler = jim_target_types,
5894 .help = "Returns the available target types as "
5895 "a list of strings",
5899 .mode = COMMAND_ANY,
5900 .jim_handler = jim_target_names,
5901 .help = "Returns the names of all targets as a list of strings",
5905 .mode = COMMAND_ANY,
5906 .jim_handler = jim_target_smp,
5907 .usage = "targetname1 targetname2 ...",
5908 .help = "gather several target in a smp list"
5911 COMMAND_REGISTRATION_DONE
5915 target_addr_t address;
5921 static int fastload_num;
5922 static struct FastLoad *fastload;
5924 static void free_fastload(void)
5926 if (fastload != NULL) {
5928 for (i = 0; i < fastload_num; i++) {
5929 if (fastload[i].data)
5930 free(fastload[i].data);
5937 COMMAND_HANDLER(handle_fast_load_image_command)
5941 uint32_t image_size;
5942 target_addr_t min_address = 0;
5943 target_addr_t max_address = -1;
5948 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5949 &image, &min_address, &max_address);
5950 if (ERROR_OK != retval)
5953 struct duration bench;
5954 duration_start(&bench);
5956 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5957 if (retval != ERROR_OK)
5962 fastload_num = image.num_sections;
5963 fastload = malloc(sizeof(struct FastLoad)*image.num_sections);
5964 if (fastload == NULL) {
5965 command_print(CMD_CTX, "out of memory");
5966 image_close(&image);
5969 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5970 for (i = 0; i < image.num_sections; i++) {
5971 buffer = malloc(image.sections[i].size);
5972 if (buffer == NULL) {
5973 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5974 (int)(image.sections[i].size));
5975 retval = ERROR_FAIL;
5979 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5980 if (retval != ERROR_OK) {
5985 uint32_t offset = 0;
5986 uint32_t length = buf_cnt;
5988 /* DANGER!!! beware of unsigned comparision here!!! */
5990 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5991 (image.sections[i].base_address < max_address)) {
5992 if (image.sections[i].base_address < min_address) {
5993 /* clip addresses below */
5994 offset += min_address-image.sections[i].base_address;
5998 if (image.sections[i].base_address + buf_cnt > max_address)
5999 length -= (image.sections[i].base_address + buf_cnt)-max_address;
6001 fastload[i].address = image.sections[i].base_address + offset;
6002 fastload[i].data = malloc(length);
6003 if (fastload[i].data == NULL) {
6005 command_print(CMD_CTX, "error allocating buffer for section (%" PRIu32 " bytes)",
6007 retval = ERROR_FAIL;
6010 memcpy(fastload[i].data, buffer + offset, length);
6011 fastload[i].length = length;
6013 image_size += length;
6014 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
6015 (unsigned int)length,
6016 ((unsigned int)(image.sections[i].base_address + offset)));
6022 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
6023 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
6024 "in %fs (%0.3f KiB/s)", image_size,
6025 duration_elapsed(&bench), duration_kbps(&bench, image_size));
6027 command_print(CMD_CTX,
6028 "WARNING: image has not been loaded to target!"
6029 "You can issue a 'fast_load' to finish loading.");
6032 image_close(&image);
6034 if (retval != ERROR_OK)
6040 COMMAND_HANDLER(handle_fast_load_command)
6043 return ERROR_COMMAND_SYNTAX_ERROR;
6044 if (fastload == NULL) {
6045 LOG_ERROR("No image in memory");
6049 int64_t ms = timeval_ms();
6051 int retval = ERROR_OK;
6052 for (i = 0; i < fastload_num; i++) {
6053 struct target *target = get_current_target(CMD_CTX);
6054 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
6055 (unsigned int)(fastload[i].address),
6056 (unsigned int)(fastload[i].length));
6057 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
6058 if (retval != ERROR_OK)
6060 size += fastload[i].length;
6062 if (retval == ERROR_OK) {
6063 int64_t after = timeval_ms();
6064 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
6069 static const struct command_registration target_command_handlers[] = {
6072 .handler = handle_targets_command,
6073 .mode = COMMAND_ANY,
6074 .help = "change current default target (one parameter) "
6075 "or prints table of all targets (no parameters)",
6076 .usage = "[target]",
6080 .mode = COMMAND_CONFIG,
6081 .help = "configure target",
6083 .chain = target_subcommand_handlers,
6085 COMMAND_REGISTRATION_DONE
6088 int target_register_commands(struct command_context *cmd_ctx)
6090 return register_commands(cmd_ctx, NULL, target_command_handlers);
6093 static bool target_reset_nag = true;
6095 bool get_target_reset_nag(void)
6097 return target_reset_nag;
6100 COMMAND_HANDLER(handle_target_reset_nag)
6102 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
6103 &target_reset_nag, "Nag after each reset about options to improve "
6107 COMMAND_HANDLER(handle_ps_command)
6109 struct target *target = get_current_target(CMD_CTX);
6111 if (target->state != TARGET_HALTED) {
6112 LOG_INFO("target not halted !!");
6116 if ((target->rtos) && (target->rtos->type)
6117 && (target->rtos->type->ps_command)) {
6118 display = target->rtos->type->ps_command(target);
6119 command_print(CMD_CTX, "%s", display);
6124 return ERROR_TARGET_FAILURE;
6128 static void binprint(struct command_context *cmd_ctx, const char *text, const uint8_t *buf, int size)
6131 command_print_sameline(cmd_ctx, "%s", text);
6132 for (int i = 0; i < size; i++)
6133 command_print_sameline(cmd_ctx, " %02x", buf[i]);
6134 command_print(cmd_ctx, " ");
6137 COMMAND_HANDLER(handle_test_mem_access_command)
6139 struct target *target = get_current_target(CMD_CTX);
6141 int retval = ERROR_OK;
6143 if (target->state != TARGET_HALTED) {
6144 LOG_INFO("target not halted !!");
6149 return ERROR_COMMAND_SYNTAX_ERROR;
6151 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], test_size);
6154 size_t num_bytes = test_size + 4;
6156 struct working_area *wa = NULL;
6157 retval = target_alloc_working_area(target, num_bytes, &wa);
6158 if (retval != ERROR_OK) {
6159 LOG_ERROR("Not enough working area");
6163 uint8_t *test_pattern = malloc(num_bytes);
6165 for (size_t i = 0; i < num_bytes; i++)
6166 test_pattern[i] = rand();
6168 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
6169 if (retval != ERROR_OK) {
6170 LOG_ERROR("Test pattern write failed");
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 + 2) * size + host_offset;
6179 uint8_t *read_ref = malloc(host_bufsiz);
6180 uint8_t *read_buf = malloc(host_bufsiz);
6182 for (size_t i = 0; i < host_bufsiz; i++) {
6183 read_ref[i] = rand();
6184 read_buf[i] = read_ref[i];
6186 command_print_sameline(CMD_CTX,
6187 "Test read %" PRIu32 " x %d @ %d to %saligned buffer: ", count,
6188 size, offset, host_offset ? "un" : "");
6190 struct duration bench;
6191 duration_start(&bench);
6193 retval = target_read_memory(target, wa->address + offset, size, count,
6194 read_buf + size + host_offset);
6196 duration_measure(&bench);
6198 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
6199 command_print(CMD_CTX, "Unsupported alignment");
6201 } else if (retval != ERROR_OK) {
6202 command_print(CMD_CTX, "Memory read failed");
6206 /* replay on host */
6207 memcpy(read_ref + size + host_offset, test_pattern + offset, count * size);
6210 int result = memcmp(read_ref, read_buf, host_bufsiz);
6212 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
6213 duration_elapsed(&bench),
6214 duration_kbps(&bench, count * size));
6216 command_print(CMD_CTX, "Compare failed");
6217 binprint(CMD_CTX, "ref:", read_ref, host_bufsiz);
6218 binprint(CMD_CTX, "buf:", read_buf, host_bufsiz);
6231 target_free_working_area(target, wa);
6234 num_bytes = test_size + 4 + 4 + 4;
6236 retval = target_alloc_working_area(target, num_bytes, &wa);
6237 if (retval != ERROR_OK) {
6238 LOG_ERROR("Not enough working area");
6242 test_pattern = malloc(num_bytes);
6244 for (size_t i = 0; i < num_bytes; i++)
6245 test_pattern[i] = rand();
6247 for (int host_offset = 0; host_offset <= 1; host_offset++) {
6248 for (int size = 1; size <= 4; size *= 2) {
6249 for (int offset = 0; offset < 4; offset++) {
6250 uint32_t count = test_size / size;
6251 size_t host_bufsiz = count * size + host_offset;
6252 uint8_t *read_ref = malloc(num_bytes);
6253 uint8_t *read_buf = malloc(num_bytes);
6254 uint8_t *write_buf = malloc(host_bufsiz);
6256 for (size_t i = 0; i < host_bufsiz; i++)
6257 write_buf[i] = rand();
6258 command_print_sameline(CMD_CTX,
6259 "Test write %" PRIu32 " x %d @ %d from %saligned buffer: ", count,
6260 size, offset, host_offset ? "un" : "");
6262 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
6263 if (retval != ERROR_OK) {
6264 command_print(CMD_CTX, "Test pattern write failed");
6268 /* replay on host */
6269 memcpy(read_ref, test_pattern, num_bytes);
6270 memcpy(read_ref + size + offset, write_buf + host_offset, count * size);
6272 struct duration bench;
6273 duration_start(&bench);
6275 retval = target_write_memory(target, wa->address + size + offset, size, count,
6276 write_buf + host_offset);
6278 duration_measure(&bench);
6280 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
6281 command_print(CMD_CTX, "Unsupported alignment");
6283 } else if (retval != ERROR_OK) {
6284 command_print(CMD_CTX, "Memory write failed");
6289 retval = target_read_memory(target, wa->address, 1, num_bytes, read_buf);
6290 if (retval != ERROR_OK) {
6291 command_print(CMD_CTX, "Test pattern write failed");
6296 int result = memcmp(read_ref, read_buf, num_bytes);
6298 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
6299 duration_elapsed(&bench),
6300 duration_kbps(&bench, count * size));
6302 command_print(CMD_CTX, "Compare failed");
6303 binprint(CMD_CTX, "ref:", read_ref, num_bytes);
6304 binprint(CMD_CTX, "buf:", read_buf, num_bytes);
6316 target_free_working_area(target, wa);
6320 static const struct command_registration target_exec_command_handlers[] = {
6322 .name = "fast_load_image",
6323 .handler = handle_fast_load_image_command,
6324 .mode = COMMAND_ANY,
6325 .help = "Load image into server memory for later use by "
6326 "fast_load; primarily for profiling",
6327 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
6328 "[min_address [max_length]]",
6331 .name = "fast_load",
6332 .handler = handle_fast_load_command,
6333 .mode = COMMAND_EXEC,
6334 .help = "loads active fast load image to current target "
6335 "- mainly for profiling purposes",
6340 .handler = handle_profile_command,
6341 .mode = COMMAND_EXEC,
6342 .usage = "seconds filename [start end]",
6343 .help = "profiling samples the CPU PC",
6345 /** @todo don't register virt2phys() unless target supports it */
6347 .name = "virt2phys",
6348 .handler = handle_virt2phys_command,
6349 .mode = COMMAND_ANY,
6350 .help = "translate a virtual address into a physical address",
6351 .usage = "virtual_address",
6355 .handler = handle_reg_command,
6356 .mode = COMMAND_EXEC,
6357 .help = "display (reread from target with \"force\") or set a register; "
6358 "with no arguments, displays all registers and their values",
6359 .usage = "[(register_number|register_name) [(value|'force')]]",
6363 .handler = handle_poll_command,
6364 .mode = COMMAND_EXEC,
6365 .help = "poll target state; or reconfigure background polling",
6366 .usage = "['on'|'off']",
6369 .name = "wait_halt",
6370 .handler = handle_wait_halt_command,
6371 .mode = COMMAND_EXEC,
6372 .help = "wait up to the specified number of milliseconds "
6373 "(default 5000) for a previously requested halt",
6374 .usage = "[milliseconds]",
6378 .handler = handle_halt_command,
6379 .mode = COMMAND_EXEC,
6380 .help = "request target to halt, then wait up to the specified"
6381 "number of milliseconds (default 5000) for it to complete",
6382 .usage = "[milliseconds]",
6386 .handler = handle_resume_command,
6387 .mode = COMMAND_EXEC,
6388 .help = "resume target execution from current PC or address",
6389 .usage = "[address]",
6393 .handler = handle_reset_command,
6394 .mode = COMMAND_EXEC,
6395 .usage = "[run|halt|init]",
6396 .help = "Reset all targets into the specified mode."
6397 "Default reset mode is run, if not given.",
6400 .name = "soft_reset_halt",
6401 .handler = handle_soft_reset_halt_command,
6402 .mode = COMMAND_EXEC,
6404 .help = "halt the target and do a soft reset",
6408 .handler = handle_step_command,
6409 .mode = COMMAND_EXEC,
6410 .help = "step one instruction from current PC or address",
6411 .usage = "[address]",
6415 .handler = handle_md_command,
6416 .mode = COMMAND_EXEC,
6417 .help = "display memory words",
6418 .usage = "['phys'] address [count]",
6422 .handler = handle_md_command,
6423 .mode = COMMAND_EXEC,
6424 .help = "display memory words",
6425 .usage = "['phys'] address [count]",
6429 .handler = handle_md_command,
6430 .mode = COMMAND_EXEC,
6431 .help = "display memory half-words",
6432 .usage = "['phys'] address [count]",
6436 .handler = handle_md_command,
6437 .mode = COMMAND_EXEC,
6438 .help = "display memory bytes",
6439 .usage = "['phys'] address [count]",
6443 .handler = handle_mw_command,
6444 .mode = COMMAND_EXEC,
6445 .help = "write memory word",
6446 .usage = "['phys'] address value [count]",
6450 .handler = handle_mw_command,
6451 .mode = COMMAND_EXEC,
6452 .help = "write memory word",
6453 .usage = "['phys'] address value [count]",
6457 .handler = handle_mw_command,
6458 .mode = COMMAND_EXEC,
6459 .help = "write memory half-word",
6460 .usage = "['phys'] address value [count]",
6464 .handler = handle_mw_command,
6465 .mode = COMMAND_EXEC,
6466 .help = "write memory byte",
6467 .usage = "['phys'] address value [count]",
6471 .handler = handle_bp_command,
6472 .mode = COMMAND_EXEC,
6473 .help = "list or set hardware or software breakpoint",
6474 .usage = "<address> [<asid>] <length> ['hw'|'hw_ctx']",
6478 .handler = handle_rbp_command,
6479 .mode = COMMAND_EXEC,
6480 .help = "remove breakpoint",
6485 .handler = handle_wp_command,
6486 .mode = COMMAND_EXEC,
6487 .help = "list (no params) or create watchpoints",
6488 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
6492 .handler = handle_rwp_command,
6493 .mode = COMMAND_EXEC,
6494 .help = "remove watchpoint",
6498 .name = "load_image",
6499 .handler = handle_load_image_command,
6500 .mode = COMMAND_EXEC,
6501 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
6502 "[min_address] [max_length]",
6505 .name = "dump_image",
6506 .handler = handle_dump_image_command,
6507 .mode = COMMAND_EXEC,
6508 .usage = "filename address size",
6511 .name = "verify_image_checksum",
6512 .handler = handle_verify_image_checksum_command,
6513 .mode = COMMAND_EXEC,
6514 .usage = "filename [offset [type]]",
6517 .name = "verify_image",
6518 .handler = handle_verify_image_command,
6519 .mode = COMMAND_EXEC,
6520 .usage = "filename [offset [type]]",
6523 .name = "test_image",
6524 .handler = handle_test_image_command,
6525 .mode = COMMAND_EXEC,
6526 .usage = "filename [offset [type]]",
6529 .name = "mem2array",
6530 .mode = COMMAND_EXEC,
6531 .jim_handler = jim_mem2array,
6532 .help = "read 8/16/32 bit memory and return as a TCL array "
6533 "for script processing",
6534 .usage = "arrayname bitwidth address count",
6537 .name = "array2mem",
6538 .mode = COMMAND_EXEC,
6539 .jim_handler = jim_array2mem,
6540 .help = "convert a TCL array to memory locations "
6541 "and write the 8/16/32 bit values",
6542 .usage = "arrayname bitwidth address count",
6545 .name = "reset_nag",
6546 .handler = handle_target_reset_nag,
6547 .mode = COMMAND_ANY,
6548 .help = "Nag after each reset about options that could have been "
6549 "enabled to improve performance. ",
6550 .usage = "['enable'|'disable']",
6554 .handler = handle_ps_command,
6555 .mode = COMMAND_EXEC,
6556 .help = "list all tasks ",
6560 .name = "test_mem_access",
6561 .handler = handle_test_mem_access_command,
6562 .mode = COMMAND_EXEC,
6563 .help = "Test the target's memory access functions",
6567 COMMAND_REGISTRATION_DONE
6569 static int target_register_user_commands(struct command_context *cmd_ctx)
6571 int retval = ERROR_OK;
6572 retval = target_request_register_commands(cmd_ctx);
6573 if (retval != ERROR_OK)
6576 retval = trace_register_commands(cmd_ctx);
6577 if (retval != ERROR_OK)
6581 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);