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), int time_ms, int periodic, void *priv)
1465 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1467 if (callback == NULL)
1468 return ERROR_COMMAND_SYNTAX_ERROR;
1471 while ((*callbacks_p)->next)
1472 callbacks_p = &((*callbacks_p)->next);
1473 callbacks_p = &((*callbacks_p)->next);
1476 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1477 (*callbacks_p)->callback = callback;
1478 (*callbacks_p)->periodic = periodic;
1479 (*callbacks_p)->time_ms = time_ms;
1480 (*callbacks_p)->removed = false;
1482 gettimeofday(&(*callbacks_p)->when, NULL);
1483 timeval_add_time(&(*callbacks_p)->when, 0, time_ms * 1000);
1485 (*callbacks_p)->priv = priv;
1486 (*callbacks_p)->next = NULL;
1491 int target_unregister_event_callback(int (*callback)(struct target *target,
1492 enum target_event event, void *priv), void *priv)
1494 struct target_event_callback **p = &target_event_callbacks;
1495 struct target_event_callback *c = target_event_callbacks;
1497 if (callback == NULL)
1498 return ERROR_COMMAND_SYNTAX_ERROR;
1501 struct target_event_callback *next = c->next;
1502 if ((c->callback == callback) && (c->priv == priv)) {
1514 int target_unregister_reset_callback(int (*callback)(struct target *target,
1515 enum target_reset_mode reset_mode, void *priv), void *priv)
1517 struct target_reset_callback *entry;
1519 if (callback == NULL)
1520 return ERROR_COMMAND_SYNTAX_ERROR;
1522 list_for_each_entry(entry, &target_reset_callback_list, list) {
1523 if (entry->callback == callback && entry->priv == priv) {
1524 list_del(&entry->list);
1533 int target_unregister_trace_callback(int (*callback)(struct target *target,
1534 size_t len, uint8_t *data, void *priv), void *priv)
1536 struct target_trace_callback *entry;
1538 if (callback == NULL)
1539 return ERROR_COMMAND_SYNTAX_ERROR;
1541 list_for_each_entry(entry, &target_trace_callback_list, list) {
1542 if (entry->callback == callback && entry->priv == priv) {
1543 list_del(&entry->list);
1552 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1554 if (callback == NULL)
1555 return ERROR_COMMAND_SYNTAX_ERROR;
1557 for (struct target_timer_callback *c = target_timer_callbacks;
1559 if ((c->callback == callback) && (c->priv == priv)) {
1568 int target_call_event_callbacks(struct target *target, enum target_event event)
1570 struct target_event_callback *callback = target_event_callbacks;
1571 struct target_event_callback *next_callback;
1573 if (event == TARGET_EVENT_HALTED) {
1574 /* execute early halted first */
1575 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1578 LOG_DEBUG("target event %i (%s)", event,
1579 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1581 target_handle_event(target, event);
1584 next_callback = callback->next;
1585 callback->callback(target, event, callback->priv);
1586 callback = next_callback;
1592 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode)
1594 struct target_reset_callback *callback;
1596 LOG_DEBUG("target reset %i (%s)", reset_mode,
1597 Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode)->name);
1599 list_for_each_entry(callback, &target_reset_callback_list, list)
1600 callback->callback(target, reset_mode, callback->priv);
1605 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data)
1607 struct target_trace_callback *callback;
1609 list_for_each_entry(callback, &target_trace_callback_list, list)
1610 callback->callback(target, len, data, callback->priv);
1615 static int target_timer_callback_periodic_restart(
1616 struct target_timer_callback *cb, struct timeval *now)
1619 timeval_add_time(&cb->when, 0, cb->time_ms * 1000L);
1623 static int target_call_timer_callback(struct target_timer_callback *cb,
1624 struct timeval *now)
1626 cb->callback(cb->priv);
1629 return target_timer_callback_periodic_restart(cb, now);
1631 return target_unregister_timer_callback(cb->callback, cb->priv);
1634 static int target_call_timer_callbacks_check_time(int checktime)
1636 static bool callback_processing;
1638 /* Do not allow nesting */
1639 if (callback_processing)
1642 callback_processing = true;
1647 gettimeofday(&now, NULL);
1649 /* Store an address of the place containing a pointer to the
1650 * next item; initially, that's a standalone "root of the
1651 * list" variable. */
1652 struct target_timer_callback **callback = &target_timer_callbacks;
1654 if ((*callback)->removed) {
1655 struct target_timer_callback *p = *callback;
1656 *callback = (*callback)->next;
1661 bool call_it = (*callback)->callback &&
1662 ((!checktime && (*callback)->periodic) ||
1663 timeval_compare(&now, &(*callback)->when) >= 0);
1666 target_call_timer_callback(*callback, &now);
1668 callback = &(*callback)->next;
1671 callback_processing = false;
1675 int target_call_timer_callbacks(void)
1677 return target_call_timer_callbacks_check_time(1);
1680 /* invoke periodic callbacks immediately */
1681 int target_call_timer_callbacks_now(void)
1683 return target_call_timer_callbacks_check_time(0);
1686 /* Prints the working area layout for debug purposes */
1687 static void print_wa_layout(struct target *target)
1689 struct working_area *c = target->working_areas;
1692 LOG_DEBUG("%c%c " TARGET_ADDR_FMT "-" TARGET_ADDR_FMT " (%" PRIu32 " bytes)",
1693 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1694 c->address, c->address + c->size - 1, c->size);
1699 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1700 static void target_split_working_area(struct working_area *area, uint32_t size)
1702 assert(area->free); /* Shouldn't split an allocated area */
1703 assert(size <= area->size); /* Caller should guarantee this */
1705 /* Split only if not already the right size */
1706 if (size < area->size) {
1707 struct working_area *new_wa = malloc(sizeof(*new_wa));
1712 new_wa->next = area->next;
1713 new_wa->size = area->size - size;
1714 new_wa->address = area->address + size;
1715 new_wa->backup = NULL;
1716 new_wa->user = NULL;
1717 new_wa->free = true;
1719 area->next = new_wa;
1722 /* If backup memory was allocated to this area, it has the wrong size
1723 * now so free it and it will be reallocated if/when needed */
1726 area->backup = NULL;
1731 /* Merge all adjacent free areas into one */
1732 static void target_merge_working_areas(struct target *target)
1734 struct working_area *c = target->working_areas;
1736 while (c && c->next) {
1737 assert(c->next->address == c->address + c->size); /* This is an invariant */
1739 /* Find two adjacent free areas */
1740 if (c->free && c->next->free) {
1741 /* Merge the last into the first */
1742 c->size += c->next->size;
1744 /* Remove the last */
1745 struct working_area *to_be_freed = c->next;
1746 c->next = c->next->next;
1747 if (to_be_freed->backup)
1748 free(to_be_freed->backup);
1751 /* If backup memory was allocated to the remaining area, it's has
1752 * the wrong size now */
1763 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1765 /* Reevaluate working area address based on MMU state*/
1766 if (target->working_areas == NULL) {
1770 retval = target->type->mmu(target, &enabled);
1771 if (retval != ERROR_OK)
1775 if (target->working_area_phys_spec) {
1776 LOG_DEBUG("MMU disabled, using physical "
1777 "address for working memory " TARGET_ADDR_FMT,
1778 target->working_area_phys);
1779 target->working_area = target->working_area_phys;
1781 LOG_ERROR("No working memory available. "
1782 "Specify -work-area-phys to target.");
1783 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1786 if (target->working_area_virt_spec) {
1787 LOG_DEBUG("MMU enabled, using virtual "
1788 "address for working memory " TARGET_ADDR_FMT,
1789 target->working_area_virt);
1790 target->working_area = target->working_area_virt;
1792 LOG_ERROR("No working memory available. "
1793 "Specify -work-area-virt to target.");
1794 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1798 /* Set up initial working area on first call */
1799 struct working_area *new_wa = malloc(sizeof(*new_wa));
1801 new_wa->next = NULL;
1802 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1803 new_wa->address = target->working_area;
1804 new_wa->backup = NULL;
1805 new_wa->user = NULL;
1806 new_wa->free = true;
1809 target->working_areas = new_wa;
1812 /* only allocate multiples of 4 byte */
1814 size = (size + 3) & (~3UL);
1816 struct working_area *c = target->working_areas;
1818 /* Find the first large enough working area */
1820 if (c->free && c->size >= size)
1826 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1828 /* Split the working area into the requested size */
1829 target_split_working_area(c, size);
1831 LOG_DEBUG("allocated new working area of %" PRIu32 " bytes at address " TARGET_ADDR_FMT,
1834 if (target->backup_working_area) {
1835 if (c->backup == NULL) {
1836 c->backup = malloc(c->size);
1837 if (c->backup == NULL)
1841 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1842 if (retval != ERROR_OK)
1846 /* mark as used, and return the new (reused) area */
1853 print_wa_layout(target);
1858 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1862 retval = target_alloc_working_area_try(target, size, area);
1863 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1864 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1869 static int target_restore_working_area(struct target *target, struct working_area *area)
1871 int retval = ERROR_OK;
1873 if (target->backup_working_area && area->backup != NULL) {
1874 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1875 if (retval != ERROR_OK)
1876 LOG_ERROR("failed to restore %" PRIu32 " bytes of working area at address " TARGET_ADDR_FMT,
1877 area->size, area->address);
1883 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1884 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1886 int retval = ERROR_OK;
1892 retval = target_restore_working_area(target, area);
1893 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1894 if (retval != ERROR_OK)
1900 LOG_DEBUG("freed %" PRIu32 " bytes of working area at address " TARGET_ADDR_FMT,
1901 area->size, area->address);
1903 /* mark user pointer invalid */
1904 /* TODO: Is this really safe? It points to some previous caller's memory.
1905 * How could we know that the area pointer is still in that place and not
1906 * some other vital data? What's the purpose of this, anyway? */
1910 target_merge_working_areas(target);
1912 print_wa_layout(target);
1917 int target_free_working_area(struct target *target, struct working_area *area)
1919 return target_free_working_area_restore(target, area, 1);
1922 /* free resources and restore memory, if restoring memory fails,
1923 * free up resources anyway
1925 static void target_free_all_working_areas_restore(struct target *target, int restore)
1927 struct working_area *c = target->working_areas;
1929 LOG_DEBUG("freeing all working areas");
1931 /* Loop through all areas, restoring the allocated ones and marking them as free */
1935 target_restore_working_area(target, c);
1937 *c->user = NULL; /* Same as above */
1943 /* Run a merge pass to combine all areas into one */
1944 target_merge_working_areas(target);
1946 print_wa_layout(target);
1949 void target_free_all_working_areas(struct target *target)
1951 target_free_all_working_areas_restore(target, 1);
1953 /* Now we have none or only one working area marked as free */
1954 if (target->working_areas) {
1955 /* Free the last one to allow on-the-fly moving and resizing */
1956 free(target->working_areas->backup);
1957 free(target->working_areas);
1958 target->working_areas = NULL;
1962 /* Find the largest number of bytes that can be allocated */
1963 uint32_t target_get_working_area_avail(struct target *target)
1965 struct working_area *c = target->working_areas;
1966 uint32_t max_size = 0;
1969 return target->working_area_size;
1972 if (c->free && max_size < c->size)
1981 static void target_destroy(struct target *target)
1983 if (target->type->deinit_target)
1984 target->type->deinit_target(target);
1986 if (target->semihosting)
1987 free(target->semihosting);
1989 jtag_unregister_event_callback(jtag_enable_callback, target);
1991 struct target_event_action *teap = target->event_action;
1993 struct target_event_action *next = teap->next;
1994 Jim_DecrRefCount(teap->interp, teap->body);
1999 target_free_all_working_areas(target);
2001 /* release the targets SMP list */
2003 struct target_list *head = target->head;
2004 while (head != NULL) {
2005 struct target_list *pos = head->next;
2006 head->target->smp = 0;
2013 free(target->gdb_port_override);
2015 free(target->trace_info);
2016 free(target->fileio_info);
2017 free(target->cmd_name);
2021 void target_quit(void)
2023 struct target_event_callback *pe = target_event_callbacks;
2025 struct target_event_callback *t = pe->next;
2029 target_event_callbacks = NULL;
2031 struct target_timer_callback *pt = target_timer_callbacks;
2033 struct target_timer_callback *t = pt->next;
2037 target_timer_callbacks = NULL;
2039 for (struct target *target = all_targets; target;) {
2043 target_destroy(target);
2050 int target_arch_state(struct target *target)
2053 if (target == NULL) {
2054 LOG_WARNING("No target has been configured");
2058 if (target->state != TARGET_HALTED)
2061 retval = target->type->arch_state(target);
2065 static int target_get_gdb_fileio_info_default(struct target *target,
2066 struct gdb_fileio_info *fileio_info)
2068 /* If target does not support semi-hosting function, target
2069 has no need to provide .get_gdb_fileio_info callback.
2070 It just return ERROR_FAIL and gdb_server will return "Txx"
2071 as target halted every time. */
2075 static int target_gdb_fileio_end_default(struct target *target,
2076 int retcode, int fileio_errno, bool ctrl_c)
2081 static int target_profiling_default(struct target *target, uint32_t *samples,
2082 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
2084 struct timeval timeout, now;
2086 gettimeofday(&timeout, NULL);
2087 timeval_add_time(&timeout, seconds, 0);
2089 LOG_INFO("Starting profiling. Halting and resuming the"
2090 " target as often as we can...");
2092 uint32_t sample_count = 0;
2093 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
2094 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
2096 int retval = ERROR_OK;
2098 target_poll(target);
2099 if (target->state == TARGET_HALTED) {
2100 uint32_t t = buf_get_u32(reg->value, 0, 32);
2101 samples[sample_count++] = t;
2102 /* current pc, addr = 0, do not handle breakpoints, not debugging */
2103 retval = target_resume(target, 1, 0, 0, 0);
2104 target_poll(target);
2105 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
2106 } else if (target->state == TARGET_RUNNING) {
2107 /* We want to quickly sample the PC. */
2108 retval = target_halt(target);
2110 LOG_INFO("Target not halted or running");
2115 if (retval != ERROR_OK)
2118 gettimeofday(&now, NULL);
2119 if ((sample_count >= max_num_samples) || timeval_compare(&now, &timeout) >= 0) {
2120 LOG_INFO("Profiling completed. %" PRIu32 " samples.", sample_count);
2125 *num_samples = sample_count;
2129 /* Single aligned words are guaranteed to use 16 or 32 bit access
2130 * mode respectively, otherwise data is handled as quickly as
2133 int target_write_buffer(struct target *target, target_addr_t address, uint32_t size, const uint8_t *buffer)
2135 LOG_DEBUG("writing buffer of %" PRIi32 " byte at " TARGET_ADDR_FMT,
2138 if (!target_was_examined(target)) {
2139 LOG_ERROR("Target not examined yet");
2146 if ((address + size - 1) < address) {
2147 /* GDB can request this when e.g. PC is 0xfffffffc */
2148 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT ", 0x%08" PRIx32 ")",
2154 return target->type->write_buffer(target, address, size, buffer);
2157 static int target_write_buffer_default(struct target *target,
2158 target_addr_t address, uint32_t count, const uint8_t *buffer)
2162 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2163 * will have something to do with the size we leave to it. */
2164 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2165 if (address & size) {
2166 int retval = target_write_memory(target, address, size, 1, buffer);
2167 if (retval != ERROR_OK)
2175 /* Write the data with as large access size as possible. */
2176 for (; size > 0; size /= 2) {
2177 uint32_t aligned = count - count % size;
2179 int retval = target_write_memory(target, address, size, aligned / size, buffer);
2180 if (retval != ERROR_OK)
2191 /* Single aligned words are guaranteed to use 16 or 32 bit access
2192 * mode respectively, otherwise data is handled as quickly as
2195 int target_read_buffer(struct target *target, target_addr_t address, uint32_t size, uint8_t *buffer)
2197 LOG_DEBUG("reading buffer of %" PRIi32 " byte at " TARGET_ADDR_FMT,
2200 if (!target_was_examined(target)) {
2201 LOG_ERROR("Target not examined yet");
2208 if ((address + size - 1) < address) {
2209 /* GDB can request this when e.g. PC is 0xfffffffc */
2210 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT ", 0x%08" PRIx32 ")",
2216 return target->type->read_buffer(target, address, size, buffer);
2219 static int target_read_buffer_default(struct target *target, target_addr_t address, uint32_t count, uint8_t *buffer)
2223 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2224 * will have something to do with the size we leave to it. */
2225 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2226 if (address & size) {
2227 int retval = target_read_memory(target, address, size, 1, buffer);
2228 if (retval != ERROR_OK)
2236 /* Read the data with as large access size as possible. */
2237 for (; size > 0; size /= 2) {
2238 uint32_t aligned = count - count % size;
2240 int retval = target_read_memory(target, address, size, aligned / size, buffer);
2241 if (retval != ERROR_OK)
2252 int target_checksum_memory(struct target *target, target_addr_t address, uint32_t size, uint32_t* crc)
2257 uint32_t checksum = 0;
2258 if (!target_was_examined(target)) {
2259 LOG_ERROR("Target not examined yet");
2263 retval = target->type->checksum_memory(target, address, size, &checksum);
2264 if (retval != ERROR_OK) {
2265 buffer = malloc(size);
2266 if (buffer == NULL) {
2267 LOG_ERROR("error allocating buffer for section (%" PRId32 " bytes)", size);
2268 return ERROR_COMMAND_SYNTAX_ERROR;
2270 retval = target_read_buffer(target, address, size, buffer);
2271 if (retval != ERROR_OK) {
2276 /* convert to target endianness */
2277 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
2278 uint32_t target_data;
2279 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
2280 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
2283 retval = image_calculate_checksum(buffer, size, &checksum);
2292 int target_blank_check_memory(struct target *target,
2293 struct target_memory_check_block *blocks, int num_blocks,
2294 uint8_t erased_value)
2296 if (!target_was_examined(target)) {
2297 LOG_ERROR("Target not examined yet");
2301 if (target->type->blank_check_memory == NULL)
2302 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
2304 return target->type->blank_check_memory(target, blocks, num_blocks, erased_value);
2307 int target_read_u64(struct target *target, target_addr_t address, uint64_t *value)
2309 uint8_t value_buf[8];
2310 if (!target_was_examined(target)) {
2311 LOG_ERROR("Target not examined yet");
2315 int retval = target_read_memory(target, address, 8, 1, value_buf);
2317 if (retval == ERROR_OK) {
2318 *value = target_buffer_get_u64(target, value_buf);
2319 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2324 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2331 int target_read_u32(struct target *target, target_addr_t address, uint32_t *value)
2333 uint8_t value_buf[4];
2334 if (!target_was_examined(target)) {
2335 LOG_ERROR("Target not examined yet");
2339 int retval = target_read_memory(target, address, 4, 1, value_buf);
2341 if (retval == ERROR_OK) {
2342 *value = target_buffer_get_u32(target, value_buf);
2343 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2348 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2355 int target_read_u16(struct target *target, target_addr_t address, uint16_t *value)
2357 uint8_t value_buf[2];
2358 if (!target_was_examined(target)) {
2359 LOG_ERROR("Target not examined yet");
2363 int retval = target_read_memory(target, address, 2, 1, value_buf);
2365 if (retval == ERROR_OK) {
2366 *value = target_buffer_get_u16(target, value_buf);
2367 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%4.4" PRIx16,
2372 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2379 int target_read_u8(struct target *target, target_addr_t address, uint8_t *value)
2381 if (!target_was_examined(target)) {
2382 LOG_ERROR("Target not examined yet");
2386 int retval = target_read_memory(target, address, 1, 1, value);
2388 if (retval == ERROR_OK) {
2389 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2394 LOG_DEBUG("address: " TARGET_ADDR_FMT " failed",
2401 int target_write_u64(struct target *target, target_addr_t address, uint64_t value)
2404 uint8_t value_buf[8];
2405 if (!target_was_examined(target)) {
2406 LOG_ERROR("Target not examined yet");
2410 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2414 target_buffer_set_u64(target, value_buf, value);
2415 retval = target_write_memory(target, address, 8, 1, value_buf);
2416 if (retval != ERROR_OK)
2417 LOG_DEBUG("failed: %i", retval);
2422 int target_write_u32(struct target *target, target_addr_t address, uint32_t value)
2425 uint8_t value_buf[4];
2426 if (!target_was_examined(target)) {
2427 LOG_ERROR("Target not examined yet");
2431 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2435 target_buffer_set_u32(target, value_buf, value);
2436 retval = target_write_memory(target, address, 4, 1, value_buf);
2437 if (retval != ERROR_OK)
2438 LOG_DEBUG("failed: %i", retval);
2443 int target_write_u16(struct target *target, target_addr_t address, uint16_t value)
2446 uint8_t value_buf[2];
2447 if (!target_was_examined(target)) {
2448 LOG_ERROR("Target not examined yet");
2452 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx16,
2456 target_buffer_set_u16(target, value_buf, value);
2457 retval = target_write_memory(target, address, 2, 1, value_buf);
2458 if (retval != ERROR_OK)
2459 LOG_DEBUG("failed: %i", retval);
2464 int target_write_u8(struct target *target, target_addr_t address, uint8_t value)
2467 if (!target_was_examined(target)) {
2468 LOG_ERROR("Target not examined yet");
2472 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2475 retval = target_write_memory(target, address, 1, 1, &value);
2476 if (retval != ERROR_OK)
2477 LOG_DEBUG("failed: %i", retval);
2482 int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value)
2485 uint8_t value_buf[8];
2486 if (!target_was_examined(target)) {
2487 LOG_ERROR("Target not examined yet");
2491 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%16.16" PRIx64 "",
2495 target_buffer_set_u64(target, value_buf, value);
2496 retval = target_write_phys_memory(target, address, 8, 1, value_buf);
2497 if (retval != ERROR_OK)
2498 LOG_DEBUG("failed: %i", retval);
2503 int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value)
2506 uint8_t value_buf[4];
2507 if (!target_was_examined(target)) {
2508 LOG_ERROR("Target not examined yet");
2512 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx32 "",
2516 target_buffer_set_u32(target, value_buf, value);
2517 retval = target_write_phys_memory(target, address, 4, 1, value_buf);
2518 if (retval != ERROR_OK)
2519 LOG_DEBUG("failed: %i", retval);
2524 int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value)
2527 uint8_t value_buf[2];
2528 if (!target_was_examined(target)) {
2529 LOG_ERROR("Target not examined yet");
2533 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%8.8" PRIx16,
2537 target_buffer_set_u16(target, value_buf, value);
2538 retval = target_write_phys_memory(target, address, 2, 1, value_buf);
2539 if (retval != ERROR_OK)
2540 LOG_DEBUG("failed: %i", retval);
2545 int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value)
2548 if (!target_was_examined(target)) {
2549 LOG_ERROR("Target not examined yet");
2553 LOG_DEBUG("address: " TARGET_ADDR_FMT ", value: 0x%2.2" PRIx8,
2556 retval = target_write_phys_memory(target, address, 1, 1, &value);
2557 if (retval != ERROR_OK)
2558 LOG_DEBUG("failed: %i", retval);
2563 static int find_target(struct command_context *cmd_ctx, const char *name)
2565 struct target *target = get_target(name);
2566 if (target == NULL) {
2567 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2570 if (!target->tap->enabled) {
2571 LOG_USER("Target: TAP %s is disabled, "
2572 "can't be the current target\n",
2573 target->tap->dotted_name);
2577 cmd_ctx->current_target = target;
2578 if (cmd_ctx->current_target_override)
2579 cmd_ctx->current_target_override = target;
2585 COMMAND_HANDLER(handle_targets_command)
2587 int retval = ERROR_OK;
2588 if (CMD_ARGC == 1) {
2589 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2590 if (retval == ERROR_OK) {
2596 struct target *target = all_targets;
2597 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2598 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2603 if (target->tap->enabled)
2604 state = target_state_name(target);
2606 state = "tap-disabled";
2608 if (CMD_CTX->current_target == target)
2611 /* keep columns lined up to match the headers above */
2612 command_print(CMD_CTX,
2613 "%2d%c %-18s %-10s %-6s %-18s %s",
2614 target->target_number,
2616 target_name(target),
2617 target_type_name(target),
2618 Jim_Nvp_value2name_simple(nvp_target_endian,
2619 target->endianness)->name,
2620 target->tap->dotted_name,
2622 target = target->next;
2628 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2630 static int powerDropout;
2631 static int srstAsserted;
2633 static int runPowerRestore;
2634 static int runPowerDropout;
2635 static int runSrstAsserted;
2636 static int runSrstDeasserted;
2638 static int sense_handler(void)
2640 static int prevSrstAsserted;
2641 static int prevPowerdropout;
2643 int retval = jtag_power_dropout(&powerDropout);
2644 if (retval != ERROR_OK)
2648 powerRestored = prevPowerdropout && !powerDropout;
2650 runPowerRestore = 1;
2652 int64_t current = timeval_ms();
2653 static int64_t lastPower;
2654 bool waitMore = lastPower + 2000 > current;
2655 if (powerDropout && !waitMore) {
2656 runPowerDropout = 1;
2657 lastPower = current;
2660 retval = jtag_srst_asserted(&srstAsserted);
2661 if (retval != ERROR_OK)
2665 srstDeasserted = prevSrstAsserted && !srstAsserted;
2667 static int64_t lastSrst;
2668 waitMore = lastSrst + 2000 > current;
2669 if (srstDeasserted && !waitMore) {
2670 runSrstDeasserted = 1;
2674 if (!prevSrstAsserted && srstAsserted)
2675 runSrstAsserted = 1;
2677 prevSrstAsserted = srstAsserted;
2678 prevPowerdropout = powerDropout;
2680 if (srstDeasserted || powerRestored) {
2681 /* Other than logging the event we can't do anything here.
2682 * Issuing a reset is a particularly bad idea as we might
2683 * be inside a reset already.
2690 /* process target state changes */
2691 static int handle_target(void *priv)
2693 Jim_Interp *interp = (Jim_Interp *)priv;
2694 int retval = ERROR_OK;
2696 if (!is_jtag_poll_safe()) {
2697 /* polling is disabled currently */
2701 /* we do not want to recurse here... */
2702 static int recursive;
2706 /* danger! running these procedures can trigger srst assertions and power dropouts.
2707 * We need to avoid an infinite loop/recursion here and we do that by
2708 * clearing the flags after running these events.
2710 int did_something = 0;
2711 if (runSrstAsserted) {
2712 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2713 Jim_Eval(interp, "srst_asserted");
2716 if (runSrstDeasserted) {
2717 Jim_Eval(interp, "srst_deasserted");
2720 if (runPowerDropout) {
2721 LOG_INFO("Power dropout detected, running power_dropout proc.");
2722 Jim_Eval(interp, "power_dropout");
2725 if (runPowerRestore) {
2726 Jim_Eval(interp, "power_restore");
2730 if (did_something) {
2731 /* clear detect flags */
2735 /* clear action flags */
2737 runSrstAsserted = 0;
2738 runSrstDeasserted = 0;
2739 runPowerRestore = 0;
2740 runPowerDropout = 0;
2745 /* Poll targets for state changes unless that's globally disabled.
2746 * Skip targets that are currently disabled.
2748 for (struct target *target = all_targets;
2749 is_jtag_poll_safe() && target;
2750 target = target->next) {
2752 if (!target_was_examined(target))
2755 if (!target->tap->enabled)
2758 if (target->backoff.times > target->backoff.count) {
2759 /* do not poll this time as we failed previously */
2760 target->backoff.count++;
2763 target->backoff.count = 0;
2765 /* only poll target if we've got power and srst isn't asserted */
2766 if (!powerDropout && !srstAsserted) {
2767 /* polling may fail silently until the target has been examined */
2768 retval = target_poll(target);
2769 if (retval != ERROR_OK) {
2770 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2771 if (target->backoff.times * polling_interval < 5000) {
2772 target->backoff.times *= 2;
2773 target->backoff.times++;
2776 /* Tell GDB to halt the debugger. This allows the user to
2777 * run monitor commands to handle the situation.
2779 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2781 if (target->backoff.times > 0) {
2782 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target));
2783 target_reset_examined(target);
2784 retval = target_examine_one(target);
2785 /* Target examination could have failed due to unstable connection,
2786 * but we set the examined flag anyway to repoll it later */
2787 if (retval != ERROR_OK) {
2788 target->examined = true;
2789 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2790 target->backoff.times * polling_interval);
2795 /* Since we succeeded, we reset backoff count */
2796 target->backoff.times = 0;
2803 COMMAND_HANDLER(handle_reg_command)
2805 struct target *target;
2806 struct reg *reg = NULL;
2812 target = get_current_target(CMD_CTX);
2814 /* list all available registers for the current target */
2815 if (CMD_ARGC == 0) {
2816 struct reg_cache *cache = target->reg_cache;
2822 command_print(CMD_CTX, "===== %s", cache->name);
2824 for (i = 0, reg = cache->reg_list;
2825 i < cache->num_regs;
2826 i++, reg++, count++) {
2827 if (reg->exist == false)
2829 /* only print cached values if they are valid */
2831 value = buf_to_str(reg->value,
2833 command_print(CMD_CTX,
2834 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2842 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2847 cache = cache->next;
2853 /* access a single register by its ordinal number */
2854 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2856 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2858 struct reg_cache *cache = target->reg_cache;
2862 for (i = 0; i < cache->num_regs; i++) {
2863 if (count++ == num) {
2864 reg = &cache->reg_list[i];
2870 cache = cache->next;
2874 command_print(CMD_CTX, "%i is out of bounds, the current target "
2875 "has only %i registers (0 - %i)", num, count, count - 1);
2879 /* access a single register by its name */
2880 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2886 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2891 /* display a register */
2892 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2893 && (CMD_ARGV[1][0] <= '9')))) {
2894 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2897 if (reg->valid == 0)
2898 reg->type->get(reg);
2899 value = buf_to_str(reg->value, reg->size, 16);
2900 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2905 /* set register value */
2906 if (CMD_ARGC == 2) {
2907 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2910 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2912 reg->type->set(reg, buf);
2914 value = buf_to_str(reg->value, reg->size, 16);
2915 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2923 return ERROR_COMMAND_SYNTAX_ERROR;
2926 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2930 COMMAND_HANDLER(handle_poll_command)
2932 int retval = ERROR_OK;
2933 struct target *target = get_current_target(CMD_CTX);
2935 if (CMD_ARGC == 0) {
2936 command_print(CMD_CTX, "background polling: %s",
2937 jtag_poll_get_enabled() ? "on" : "off");
2938 command_print(CMD_CTX, "TAP: %s (%s)",
2939 target->tap->dotted_name,
2940 target->tap->enabled ? "enabled" : "disabled");
2941 if (!target->tap->enabled)
2943 retval = target_poll(target);
2944 if (retval != ERROR_OK)
2946 retval = target_arch_state(target);
2947 if (retval != ERROR_OK)
2949 } else if (CMD_ARGC == 1) {
2951 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2952 jtag_poll_set_enabled(enable);
2954 return ERROR_COMMAND_SYNTAX_ERROR;
2959 COMMAND_HANDLER(handle_wait_halt_command)
2962 return ERROR_COMMAND_SYNTAX_ERROR;
2964 unsigned ms = DEFAULT_HALT_TIMEOUT;
2965 if (1 == CMD_ARGC) {
2966 int retval = parse_uint(CMD_ARGV[0], &ms);
2967 if (ERROR_OK != retval)
2968 return ERROR_COMMAND_SYNTAX_ERROR;
2971 struct target *target = get_current_target(CMD_CTX);
2972 return target_wait_state(target, TARGET_HALTED, ms);
2975 /* wait for target state to change. The trick here is to have a low
2976 * latency for short waits and not to suck up all the CPU time
2979 * After 500ms, keep_alive() is invoked
2981 int target_wait_state(struct target *target, enum target_state state, int ms)
2984 int64_t then = 0, cur;
2988 retval = target_poll(target);
2989 if (retval != ERROR_OK)
2991 if (target->state == state)
2996 then = timeval_ms();
2997 LOG_DEBUG("waiting for target %s...",
2998 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
3004 if ((cur-then) > ms) {
3005 LOG_ERROR("timed out while waiting for target %s",
3006 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
3014 COMMAND_HANDLER(handle_halt_command)
3018 struct target *target = get_current_target(CMD_CTX);
3020 target->verbose_halt_msg = true;
3022 int retval = target_halt(target);
3023 if (ERROR_OK != retval)
3026 if (CMD_ARGC == 1) {
3027 unsigned wait_local;
3028 retval = parse_uint(CMD_ARGV[0], &wait_local);
3029 if (ERROR_OK != retval)
3030 return ERROR_COMMAND_SYNTAX_ERROR;
3035 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
3038 COMMAND_HANDLER(handle_soft_reset_halt_command)
3040 struct target *target = get_current_target(CMD_CTX);
3042 LOG_USER("requesting target halt and executing a soft reset");
3044 target_soft_reset_halt(target);
3049 COMMAND_HANDLER(handle_reset_command)
3052 return ERROR_COMMAND_SYNTAX_ERROR;
3054 enum target_reset_mode reset_mode = RESET_RUN;
3055 if (CMD_ARGC == 1) {
3057 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
3058 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
3059 return ERROR_COMMAND_SYNTAX_ERROR;
3060 reset_mode = n->value;
3063 /* reset *all* targets */
3064 return target_process_reset(CMD_CTX, reset_mode);
3068 COMMAND_HANDLER(handle_resume_command)
3072 return ERROR_COMMAND_SYNTAX_ERROR;
3074 struct target *target = get_current_target(CMD_CTX);
3076 /* with no CMD_ARGV, resume from current pc, addr = 0,
3077 * with one arguments, addr = CMD_ARGV[0],
3078 * handle breakpoints, not debugging */
3079 target_addr_t addr = 0;
3080 if (CMD_ARGC == 1) {
3081 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3085 return target_resume(target, current, addr, 1, 0);
3088 COMMAND_HANDLER(handle_step_command)
3091 return ERROR_COMMAND_SYNTAX_ERROR;
3095 /* with no CMD_ARGV, step from current pc, addr = 0,
3096 * with one argument addr = CMD_ARGV[0],
3097 * handle breakpoints, debugging */
3098 target_addr_t addr = 0;
3100 if (CMD_ARGC == 1) {
3101 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3105 struct target *target = get_current_target(CMD_CTX);
3107 return target->type->step(target, current_pc, addr, 1);
3110 static void handle_md_output(struct command_context *cmd_ctx,
3111 struct target *target, target_addr_t address, unsigned size,
3112 unsigned count, const uint8_t *buffer)
3114 const unsigned line_bytecnt = 32;
3115 unsigned line_modulo = line_bytecnt / size;
3117 char output[line_bytecnt * 4 + 1];
3118 unsigned output_len = 0;
3120 const char *value_fmt;
3123 value_fmt = "%16.16"PRIx64" ";
3126 value_fmt = "%8.8"PRIx64" ";
3129 value_fmt = "%4.4"PRIx64" ";
3132 value_fmt = "%2.2"PRIx64" ";
3135 /* "can't happen", caller checked */
3136 LOG_ERROR("invalid memory read size: %u", size);
3140 for (unsigned i = 0; i < count; i++) {
3141 if (i % line_modulo == 0) {
3142 output_len += snprintf(output + output_len,
3143 sizeof(output) - output_len,
3144 TARGET_ADDR_FMT ": ",
3145 (address + (i * size)));
3149 const uint8_t *value_ptr = buffer + i * size;
3152 value = target_buffer_get_u64(target, value_ptr);
3155 value = target_buffer_get_u32(target, value_ptr);
3158 value = target_buffer_get_u16(target, value_ptr);
3163 output_len += snprintf(output + output_len,
3164 sizeof(output) - output_len,
3167 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
3168 command_print(cmd_ctx, "%s", output);
3174 COMMAND_HANDLER(handle_md_command)
3177 return ERROR_COMMAND_SYNTAX_ERROR;
3180 switch (CMD_NAME[2]) {
3194 return ERROR_COMMAND_SYNTAX_ERROR;
3197 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
3198 int (*fn)(struct target *target,
3199 target_addr_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
3203 fn = target_read_phys_memory;
3205 fn = target_read_memory;
3206 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
3207 return ERROR_COMMAND_SYNTAX_ERROR;
3209 target_addr_t address;
3210 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
3214 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
3216 uint8_t *buffer = calloc(count, size);
3217 if (buffer == NULL) {
3218 LOG_ERROR("Failed to allocate md read buffer");
3222 struct target *target = get_current_target(CMD_CTX);
3223 int retval = fn(target, address, size, count, buffer);
3224 if (ERROR_OK == retval)
3225 handle_md_output(CMD_CTX, target, address, size, count, buffer);
3232 typedef int (*target_write_fn)(struct target *target,
3233 target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
3235 static int target_fill_mem(struct target *target,
3236 target_addr_t address,
3244 /* We have to write in reasonably large chunks to be able
3245 * to fill large memory areas with any sane speed */
3246 const unsigned chunk_size = 16384;
3247 uint8_t *target_buf = malloc(chunk_size * data_size);
3248 if (target_buf == NULL) {
3249 LOG_ERROR("Out of memory");
3253 for (unsigned i = 0; i < chunk_size; i++) {
3254 switch (data_size) {
3256 target_buffer_set_u64(target, target_buf + i * data_size, b);
3259 target_buffer_set_u32(target, target_buf + i * data_size, b);
3262 target_buffer_set_u16(target, target_buf + i * data_size, b);
3265 target_buffer_set_u8(target, target_buf + i * data_size, b);
3272 int retval = ERROR_OK;
3274 for (unsigned x = 0; x < c; x += chunk_size) {
3277 if (current > chunk_size)
3278 current = chunk_size;
3279 retval = fn(target, address + x * data_size, data_size, current, target_buf);
3280 if (retval != ERROR_OK)
3282 /* avoid GDB timeouts */
3291 COMMAND_HANDLER(handle_mw_command)
3294 return ERROR_COMMAND_SYNTAX_ERROR;
3295 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
3300 fn = target_write_phys_memory;
3302 fn = target_write_memory;
3303 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
3304 return ERROR_COMMAND_SYNTAX_ERROR;
3306 target_addr_t address;
3307 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], address);
3309 target_addr_t value;
3310 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], value);
3314 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
3316 struct target *target = get_current_target(CMD_CTX);
3318 switch (CMD_NAME[2]) {
3332 return ERROR_COMMAND_SYNTAX_ERROR;
3335 return target_fill_mem(target, address, fn, wordsize, value, count);
3338 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
3339 target_addr_t *min_address, target_addr_t *max_address)
3341 if (CMD_ARGC < 1 || CMD_ARGC > 5)
3342 return ERROR_COMMAND_SYNTAX_ERROR;
3344 /* a base address isn't always necessary,
3345 * default to 0x0 (i.e. don't relocate) */
3346 if (CMD_ARGC >= 2) {
3348 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], addr);
3349 image->base_address = addr;
3350 image->base_address_set = 1;
3352 image->base_address_set = 0;
3354 image->start_address_set = 0;
3357 COMMAND_PARSE_ADDRESS(CMD_ARGV[3], *min_address);
3358 if (CMD_ARGC == 5) {
3359 COMMAND_PARSE_ADDRESS(CMD_ARGV[4], *max_address);
3360 /* use size (given) to find max (required) */
3361 *max_address += *min_address;
3364 if (*min_address > *max_address)
3365 return ERROR_COMMAND_SYNTAX_ERROR;
3370 COMMAND_HANDLER(handle_load_image_command)
3374 uint32_t image_size;
3375 target_addr_t min_address = 0;
3376 target_addr_t max_address = -1;
3380 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
3381 &image, &min_address, &max_address);
3382 if (ERROR_OK != retval)
3385 struct target *target = get_current_target(CMD_CTX);
3387 struct duration bench;
3388 duration_start(&bench);
3390 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
3395 for (i = 0; i < image.num_sections; i++) {
3396 buffer = malloc(image.sections[i].size);
3397 if (buffer == NULL) {
3398 command_print(CMD_CTX,
3399 "error allocating buffer for section (%d bytes)",
3400 (int)(image.sections[i].size));
3401 retval = ERROR_FAIL;
3405 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3406 if (retval != ERROR_OK) {
3411 uint32_t offset = 0;
3412 uint32_t length = buf_cnt;
3414 /* DANGER!!! beware of unsigned comparision here!!! */
3416 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
3417 (image.sections[i].base_address < max_address)) {
3419 if (image.sections[i].base_address < min_address) {
3420 /* clip addresses below */
3421 offset += min_address-image.sections[i].base_address;
3425 if (image.sections[i].base_address + buf_cnt > max_address)
3426 length -= (image.sections[i].base_address + buf_cnt)-max_address;
3428 retval = target_write_buffer(target,
3429 image.sections[i].base_address + offset, length, buffer + offset);
3430 if (retval != ERROR_OK) {
3434 image_size += length;
3435 command_print(CMD_CTX, "%u bytes written at address " TARGET_ADDR_FMT "",
3436 (unsigned int)length,
3437 image.sections[i].base_address + offset);
3443 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3444 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
3445 "in %fs (%0.3f KiB/s)", image_size,
3446 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3449 image_close(&image);
3455 COMMAND_HANDLER(handle_dump_image_command)
3457 struct fileio *fileio;
3459 int retval, retvaltemp;
3460 target_addr_t address, size;
3461 struct duration bench;
3462 struct target *target = get_current_target(CMD_CTX);
3465 return ERROR_COMMAND_SYNTAX_ERROR;
3467 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], address);
3468 COMMAND_PARSE_ADDRESS(CMD_ARGV[2], size);
3470 uint32_t buf_size = (size > 4096) ? 4096 : size;
3471 buffer = malloc(buf_size);
3475 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
3476 if (retval != ERROR_OK) {
3481 duration_start(&bench);
3484 size_t size_written;
3485 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
3486 retval = target_read_buffer(target, address, this_run_size, buffer);
3487 if (retval != ERROR_OK)
3490 retval = fileio_write(fileio, this_run_size, buffer, &size_written);
3491 if (retval != ERROR_OK)
3494 size -= this_run_size;
3495 address += this_run_size;
3500 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3502 retval = fileio_size(fileio, &filesize);
3503 if (retval != ERROR_OK)
3505 command_print(CMD_CTX,
3506 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize,
3507 duration_elapsed(&bench), duration_kbps(&bench, filesize));
3510 retvaltemp = fileio_close(fileio);
3511 if (retvaltemp != ERROR_OK)
3520 IMAGE_CHECKSUM_ONLY = 2
3523 static COMMAND_HELPER(handle_verify_image_command_internal, enum verify_mode verify)
3527 uint32_t image_size;
3530 uint32_t checksum = 0;
3531 uint32_t mem_checksum = 0;
3535 struct target *target = get_current_target(CMD_CTX);
3538 return ERROR_COMMAND_SYNTAX_ERROR;
3541 LOG_ERROR("no target selected");
3545 struct duration bench;
3546 duration_start(&bench);
3548 if (CMD_ARGC >= 2) {
3550 COMMAND_PARSE_ADDRESS(CMD_ARGV[1], addr);
3551 image.base_address = addr;
3552 image.base_address_set = 1;
3554 image.base_address_set = 0;
3555 image.base_address = 0x0;
3558 image.start_address_set = 0;
3560 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
3561 if (retval != ERROR_OK)
3567 for (i = 0; i < image.num_sections; i++) {
3568 buffer = malloc(image.sections[i].size);
3569 if (buffer == NULL) {
3570 command_print(CMD_CTX,
3571 "error allocating buffer for section (%d bytes)",
3572 (int)(image.sections[i].size));
3575 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3576 if (retval != ERROR_OK) {
3581 if (verify >= IMAGE_VERIFY) {
3582 /* calculate checksum of image */
3583 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3584 if (retval != ERROR_OK) {
3589 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3590 if (retval != ERROR_OK) {
3594 if ((checksum != mem_checksum) && (verify == IMAGE_CHECKSUM_ONLY)) {
3595 LOG_ERROR("checksum mismatch");
3597 retval = ERROR_FAIL;
3600 if (checksum != mem_checksum) {
3601 /* failed crc checksum, fall back to a binary compare */
3605 LOG_ERROR("checksum mismatch - attempting binary compare");
3607 data = malloc(buf_cnt);
3609 /* Can we use 32bit word accesses? */
3611 int count = buf_cnt;
3612 if ((count % 4) == 0) {
3616 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3617 if (retval == ERROR_OK) {
3619 for (t = 0; t < buf_cnt; t++) {
3620 if (data[t] != buffer[t]) {
3621 command_print(CMD_CTX,
3622 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3624 (unsigned)(t + image.sections[i].base_address),
3627 if (diffs++ >= 127) {
3628 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3640 command_print(CMD_CTX, "address " TARGET_ADDR_FMT " length 0x%08zx",
3641 image.sections[i].base_address,
3646 image_size += buf_cnt;
3649 command_print(CMD_CTX, "No more differences found.");
3652 retval = ERROR_FAIL;
3653 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3654 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3655 "in %fs (%0.3f KiB/s)", image_size,
3656 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3659 image_close(&image);
3664 COMMAND_HANDLER(handle_verify_image_checksum_command)
3666 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_CHECKSUM_ONLY);
3669 COMMAND_HANDLER(handle_verify_image_command)
3671 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_VERIFY);
3674 COMMAND_HANDLER(handle_test_image_command)
3676 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, IMAGE_TEST);
3679 static int handle_bp_command_list(struct command_context *cmd_ctx)
3681 struct target *target = get_current_target(cmd_ctx);
3682 struct breakpoint *breakpoint = target->breakpoints;
3683 while (breakpoint) {
3684 if (breakpoint->type == BKPT_SOFT) {
3685 char *buf = buf_to_str(breakpoint->orig_instr,
3686 breakpoint->length, 16);
3687 command_print(cmd_ctx, "IVA breakpoint: " TARGET_ADDR_FMT ", 0x%x, %i, 0x%s",
3688 breakpoint->address,
3690 breakpoint->set, buf);
3693 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3694 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3696 breakpoint->length, breakpoint->set);
3697 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3698 command_print(cmd_ctx, "Hybrid breakpoint(IVA): " TARGET_ADDR_FMT ", 0x%x, %i",
3699 breakpoint->address,
3700 breakpoint->length, breakpoint->set);
3701 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3704 command_print(cmd_ctx, "Breakpoint(IVA): " TARGET_ADDR_FMT ", 0x%x, %i",
3705 breakpoint->address,
3706 breakpoint->length, breakpoint->set);
3709 breakpoint = breakpoint->next;
3714 static int handle_bp_command_set(struct command_context *cmd_ctx,
3715 target_addr_t addr, uint32_t asid, uint32_t length, int hw)
3717 struct target *target = get_current_target(cmd_ctx);
3721 retval = breakpoint_add(target, addr, length, hw);
3722 if (ERROR_OK == retval)
3723 command_print(cmd_ctx, "breakpoint set at " TARGET_ADDR_FMT "", addr);
3725 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3728 } else if (addr == 0) {
3729 if (target->type->add_context_breakpoint == NULL) {
3730 LOG_WARNING("Context breakpoint not available");
3733 retval = context_breakpoint_add(target, asid, length, hw);
3734 if (ERROR_OK == retval)
3735 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3737 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3741 if (target->type->add_hybrid_breakpoint == NULL) {
3742 LOG_WARNING("Hybrid breakpoint not available");
3745 retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3746 if (ERROR_OK == retval)
3747 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3749 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3756 COMMAND_HANDLER(handle_bp_command)
3765 return handle_bp_command_list(CMD_CTX);
3769 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3770 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3771 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3774 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3776 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3777 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3779 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3780 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3782 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3783 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3785 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3790 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3791 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3792 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3793 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3796 return ERROR_COMMAND_SYNTAX_ERROR;
3800 COMMAND_HANDLER(handle_rbp_command)
3803 return ERROR_COMMAND_SYNTAX_ERROR;
3806 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], addr);
3808 struct target *target = get_current_target(CMD_CTX);
3809 breakpoint_remove(target, addr);
3814 COMMAND_HANDLER(handle_wp_command)
3816 struct target *target = get_current_target(CMD_CTX);
3818 if (CMD_ARGC == 0) {
3819 struct watchpoint *watchpoint = target->watchpoints;
3821 while (watchpoint) {
3822 command_print(CMD_CTX, "address: " TARGET_ADDR_FMT
3823 ", len: 0x%8.8" PRIx32
3824 ", r/w/a: %i, value: 0x%8.8" PRIx32
3825 ", mask: 0x%8.8" PRIx32,
3826 watchpoint->address,
3828 (int)watchpoint->rw,
3831 watchpoint = watchpoint->next;
3836 enum watchpoint_rw type = WPT_ACCESS;
3838 uint32_t length = 0;
3839 uint32_t data_value = 0x0;
3840 uint32_t data_mask = 0xffffffff;
3844 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3847 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3850 switch (CMD_ARGV[2][0]) {
3861 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3862 return ERROR_COMMAND_SYNTAX_ERROR;
3866 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3867 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3871 return ERROR_COMMAND_SYNTAX_ERROR;
3874 int retval = watchpoint_add(target, addr, length, type,
3875 data_value, data_mask);
3876 if (ERROR_OK != retval)
3877 LOG_ERROR("Failure setting watchpoints");
3882 COMMAND_HANDLER(handle_rwp_command)
3885 return ERROR_COMMAND_SYNTAX_ERROR;
3888 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3890 struct target *target = get_current_target(CMD_CTX);
3891 watchpoint_remove(target, addr);
3897 * Translate a virtual address to a physical address.
3899 * The low-level target implementation must have logged a detailed error
3900 * which is forwarded to telnet/GDB session.
3902 COMMAND_HANDLER(handle_virt2phys_command)
3905 return ERROR_COMMAND_SYNTAX_ERROR;
3908 COMMAND_PARSE_ADDRESS(CMD_ARGV[0], va);
3911 struct target *target = get_current_target(CMD_CTX);
3912 int retval = target->type->virt2phys(target, va, &pa);
3913 if (retval == ERROR_OK)
3914 command_print(CMD_CTX, "Physical address " TARGET_ADDR_FMT "", pa);
3919 static void writeData(FILE *f, const void *data, size_t len)
3921 size_t written = fwrite(data, 1, len, f);
3923 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3926 static void writeLong(FILE *f, int l, struct target *target)
3930 target_buffer_set_u32(target, val, l);
3931 writeData(f, val, 4);
3934 static void writeString(FILE *f, char *s)
3936 writeData(f, s, strlen(s));
3939 typedef unsigned char UNIT[2]; /* unit of profiling */
3941 /* Dump a gmon.out histogram file. */
3942 static void write_gmon(uint32_t *samples, uint32_t sampleNum, const char *filename, bool with_range,
3943 uint32_t start_address, uint32_t end_address, struct target *target, uint32_t duration_ms)
3946 FILE *f = fopen(filename, "w");
3949 writeString(f, "gmon");
3950 writeLong(f, 0x00000001, target); /* Version */
3951 writeLong(f, 0, target); /* padding */
3952 writeLong(f, 0, target); /* padding */
3953 writeLong(f, 0, target); /* padding */
3955 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3956 writeData(f, &zero, 1);
3958 /* figure out bucket size */
3962 min = start_address;
3967 for (i = 0; i < sampleNum; i++) {
3968 if (min > samples[i])
3970 if (max < samples[i])
3974 /* max should be (largest sample + 1)
3975 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
3979 int addressSpace = max - min;
3980 assert(addressSpace >= 2);
3982 /* FIXME: What is the reasonable number of buckets?
3983 * The profiling result will be more accurate if there are enough buckets. */
3984 static const uint32_t maxBuckets = 128 * 1024; /* maximum buckets. */
3985 uint32_t numBuckets = addressSpace / sizeof(UNIT);
3986 if (numBuckets > maxBuckets)
3987 numBuckets = maxBuckets;
3988 int *buckets = malloc(sizeof(int) * numBuckets);
3989 if (buckets == NULL) {
3993 memset(buckets, 0, sizeof(int) * numBuckets);
3994 for (i = 0; i < sampleNum; i++) {
3995 uint32_t address = samples[i];
3997 if ((address < min) || (max <= address))
4000 long long a = address - min;
4001 long long b = numBuckets;
4002 long long c = addressSpace;
4003 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
4007 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
4008 writeLong(f, min, target); /* low_pc */
4009 writeLong(f, max, target); /* high_pc */
4010 writeLong(f, numBuckets, target); /* # of buckets */
4011 float sample_rate = sampleNum / (duration_ms / 1000.0);
4012 writeLong(f, sample_rate, target);
4013 writeString(f, "seconds");
4014 for (i = 0; i < (15-strlen("seconds")); i++)
4015 writeData(f, &zero, 1);
4016 writeString(f, "s");
4018 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
4020 char *data = malloc(2 * numBuckets);
4022 for (i = 0; i < numBuckets; i++) {
4027 data[i * 2] = val&0xff;
4028 data[i * 2 + 1] = (val >> 8) & 0xff;
4031 writeData(f, data, numBuckets * 2);
4039 /* profiling samples the CPU PC as quickly as OpenOCD is able,
4040 * which will be used as a random sampling of PC */
4041 COMMAND_HANDLER(handle_profile_command)
4043 struct target *target = get_current_target(CMD_CTX);
4045 if ((CMD_ARGC != 2) && (CMD_ARGC != 4))
4046 return ERROR_COMMAND_SYNTAX_ERROR;
4048 const uint32_t MAX_PROFILE_SAMPLE_NUM = 10000;
4050 uint32_t num_of_samples;
4051 int retval = ERROR_OK;
4053 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], offset);
4055 uint32_t *samples = malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM);
4056 if (samples == NULL) {
4057 LOG_ERROR("No memory to store samples.");
4061 uint64_t timestart_ms = timeval_ms();
4063 * Some cores let us sample the PC without the
4064 * annoying halt/resume step; for example, ARMv7 PCSR.
4065 * Provide a way to use that more efficient mechanism.
4067 retval = target_profiling(target, samples, MAX_PROFILE_SAMPLE_NUM,
4068 &num_of_samples, offset);
4069 if (retval != ERROR_OK) {
4073 uint32_t duration_ms = timeval_ms() - timestart_ms;
4075 assert(num_of_samples <= MAX_PROFILE_SAMPLE_NUM);
4077 retval = target_poll(target);
4078 if (retval != ERROR_OK) {
4082 if (target->state == TARGET_RUNNING) {
4083 retval = target_halt(target);
4084 if (retval != ERROR_OK) {
4090 retval = target_poll(target);
4091 if (retval != ERROR_OK) {
4096 uint32_t start_address = 0;
4097 uint32_t end_address = 0;
4098 bool with_range = false;
4099 if (CMD_ARGC == 4) {
4101 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], start_address);
4102 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], end_address);
4105 write_gmon(samples, num_of_samples, CMD_ARGV[1],
4106 with_range, start_address, end_address, target, duration_ms);
4107 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
4113 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
4116 Jim_Obj *nameObjPtr, *valObjPtr;
4119 namebuf = alloc_printf("%s(%d)", varname, idx);
4123 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
4124 valObjPtr = Jim_NewIntObj(interp, val);
4125 if (!nameObjPtr || !valObjPtr) {
4130 Jim_IncrRefCount(nameObjPtr);
4131 Jim_IncrRefCount(valObjPtr);
4132 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
4133 Jim_DecrRefCount(interp, nameObjPtr);
4134 Jim_DecrRefCount(interp, valObjPtr);
4136 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
4140 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4142 struct command_context *context;
4143 struct target *target;
4145 context = current_command_context(interp);
4146 assert(context != NULL);
4148 target = get_current_target(context);
4149 if (target == NULL) {
4150 LOG_ERROR("mem2array: no current target");
4154 return target_mem2array(interp, target, argc - 1, argv + 1);
4157 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
4165 const char *varname;
4171 /* argv[1] = name of array to receive the data
4172 * argv[2] = desired width
4173 * argv[3] = memory address
4174 * argv[4] = count of times to read
4177 if (argc < 4 || argc > 5) {
4178 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems [phys]");
4181 varname = Jim_GetString(argv[0], &len);
4182 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4184 e = Jim_GetLong(interp, argv[1], &l);
4189 e = Jim_GetLong(interp, argv[2], &l);
4193 e = Jim_GetLong(interp, argv[3], &l);
4199 phys = Jim_GetString(argv[4], &n);
4200 if (!strncmp(phys, "phys", n))
4216 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4217 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
4221 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4222 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
4225 if ((addr + (len * width)) < addr) {
4226 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4227 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
4230 /* absurd transfer size? */
4232 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4233 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
4238 ((width == 2) && ((addr & 1) == 0)) ||
4239 ((width == 4) && ((addr & 3) == 0))) {
4243 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4244 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4247 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4256 size_t buffersize = 4096;
4257 uint8_t *buffer = malloc(buffersize);
4264 /* Slurp... in buffer size chunks */
4266 count = len; /* in objects.. */
4267 if (count > (buffersize / width))
4268 count = (buffersize / width);
4271 retval = target_read_phys_memory(target, addr, width, count, buffer);
4273 retval = target_read_memory(target, addr, width, count, buffer);
4274 if (retval != ERROR_OK) {
4276 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4280 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4281 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
4285 v = 0; /* shut up gcc */
4286 for (i = 0; i < count ; i++, n++) {
4289 v = target_buffer_get_u32(target, &buffer[i*width]);
4292 v = target_buffer_get_u16(target, &buffer[i*width]);
4295 v = buffer[i] & 0x0ff;
4298 new_int_array_element(interp, varname, n, v);
4301 addr += count * width;
4307 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4312 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
4315 Jim_Obj *nameObjPtr, *valObjPtr;
4319 namebuf = alloc_printf("%s(%d)", varname, idx);
4323 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
4329 Jim_IncrRefCount(nameObjPtr);
4330 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
4331 Jim_DecrRefCount(interp, nameObjPtr);
4333 if (valObjPtr == NULL)
4336 result = Jim_GetLong(interp, valObjPtr, &l);
4337 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4342 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4344 struct command_context *context;
4345 struct target *target;
4347 context = current_command_context(interp);
4348 assert(context != NULL);
4350 target = get_current_target(context);
4351 if (target == NULL) {
4352 LOG_ERROR("array2mem: no current target");
4356 return target_array2mem(interp, target, argc-1, argv + 1);
4359 static int target_array2mem(Jim_Interp *interp, struct target *target,
4360 int argc, Jim_Obj *const *argv)
4368 const char *varname;
4374 /* argv[1] = name of array to get the data
4375 * argv[2] = desired width
4376 * argv[3] = memory address
4377 * argv[4] = count to write
4379 if (argc < 4 || argc > 5) {
4380 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems [phys]");
4383 varname = Jim_GetString(argv[0], &len);
4384 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4386 e = Jim_GetLong(interp, argv[1], &l);
4391 e = Jim_GetLong(interp, argv[2], &l);
4395 e = Jim_GetLong(interp, argv[3], &l);
4401 phys = Jim_GetString(argv[4], &n);
4402 if (!strncmp(phys, "phys", n))
4418 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4419 Jim_AppendStrings(interp, Jim_GetResult(interp),
4420 "Invalid width param, must be 8/16/32", NULL);
4424 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4425 Jim_AppendStrings(interp, Jim_GetResult(interp),
4426 "array2mem: zero width read?", NULL);
4429 if ((addr + (len * width)) < addr) {
4430 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4431 Jim_AppendStrings(interp, Jim_GetResult(interp),
4432 "array2mem: addr + len - wraps to zero?", NULL);
4435 /* absurd transfer size? */
4437 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4438 Jim_AppendStrings(interp, Jim_GetResult(interp),
4439 "array2mem: absurd > 64K item request", NULL);
4444 ((width == 2) && ((addr & 1) == 0)) ||
4445 ((width == 4) && ((addr & 3) == 0))) {
4449 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4450 sprintf(buf, "array2mem address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4453 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4464 size_t buffersize = 4096;
4465 uint8_t *buffer = malloc(buffersize);
4470 /* Slurp... in buffer size chunks */
4472 count = len; /* in objects.. */
4473 if (count > (buffersize / width))
4474 count = (buffersize / width);
4476 v = 0; /* shut up gcc */
4477 for (i = 0; i < count; i++, n++) {
4478 get_int_array_element(interp, varname, n, &v);
4481 target_buffer_set_u32(target, &buffer[i * width], v);
4484 target_buffer_set_u16(target, &buffer[i * width], v);
4487 buffer[i] = v & 0x0ff;
4494 retval = target_write_phys_memory(target, addr, width, count, buffer);
4496 retval = target_write_memory(target, addr, width, count, buffer);
4497 if (retval != ERROR_OK) {
4499 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4503 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4504 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
4508 addr += count * width;
4513 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4518 /* FIX? should we propagate errors here rather than printing them
4521 void target_handle_event(struct target *target, enum target_event e)
4523 struct target_event_action *teap;
4525 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4526 if (teap->event == e) {
4527 LOG_DEBUG("target(%d): %s (%s) event: %d (%s) action: %s",
4528 target->target_number,
4529 target_name(target),
4530 target_type_name(target),
4532 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
4533 Jim_GetString(teap->body, NULL));
4535 /* Override current target by the target an event
4536 * is issued from (lot of scripts need it).
4537 * Return back to previous override as soon
4538 * as the handler processing is done */
4539 struct command_context *cmd_ctx = current_command_context(teap->interp);
4540 struct target *saved_target_override = cmd_ctx->current_target_override;
4541 cmd_ctx->current_target_override = target;
4543 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
4544 Jim_MakeErrorMessage(teap->interp);
4545 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
4548 cmd_ctx->current_target_override = saved_target_override;
4554 * Returns true only if the target has a handler for the specified event.
4556 bool target_has_event_action(struct target *target, enum target_event event)
4558 struct target_event_action *teap;
4560 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4561 if (teap->event == event)
4567 enum target_cfg_param {
4570 TCFG_WORK_AREA_VIRT,
4571 TCFG_WORK_AREA_PHYS,
4572 TCFG_WORK_AREA_SIZE,
4573 TCFG_WORK_AREA_BACKUP,
4576 TCFG_CHAIN_POSITION,
4583 static Jim_Nvp nvp_config_opts[] = {
4584 { .name = "-type", .value = TCFG_TYPE },
4585 { .name = "-event", .value = TCFG_EVENT },
4586 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
4587 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
4588 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
4589 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
4590 { .name = "-endian" , .value = TCFG_ENDIAN },
4591 { .name = "-coreid", .value = TCFG_COREID },
4592 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
4593 { .name = "-dbgbase", .value = TCFG_DBGBASE },
4594 { .name = "-rtos", .value = TCFG_RTOS },
4595 { .name = "-defer-examine", .value = TCFG_DEFER_EXAMINE },
4596 { .name = "-gdb-port", .value = TCFG_GDB_PORT },
4597 { .name = NULL, .value = -1 }
4600 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
4607 /* parse config or cget options ... */
4608 while (goi->argc > 0) {
4609 Jim_SetEmptyResult(goi->interp);
4610 /* Jim_GetOpt_Debug(goi); */
4612 if (target->type->target_jim_configure) {
4613 /* target defines a configure function */
4614 /* target gets first dibs on parameters */
4615 e = (*(target->type->target_jim_configure))(target, goi);
4624 /* otherwise we 'continue' below */
4626 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
4628 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
4634 if (goi->isconfigure) {
4635 Jim_SetResultFormatted(goi->interp,
4636 "not settable: %s", n->name);
4640 if (goi->argc != 0) {
4641 Jim_WrongNumArgs(goi->interp,
4642 goi->argc, goi->argv,
4647 Jim_SetResultString(goi->interp,
4648 target_type_name(target), -1);
4652 if (goi->argc == 0) {
4653 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4657 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4659 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4663 if (goi->isconfigure) {
4664 if (goi->argc != 1) {
4665 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4669 if (goi->argc != 0) {
4670 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4676 struct target_event_action *teap;
4678 teap = target->event_action;
4679 /* replace existing? */
4681 if (teap->event == (enum target_event)n->value)
4686 if (goi->isconfigure) {
4687 bool replace = true;
4690 teap = calloc(1, sizeof(*teap));
4693 teap->event = n->value;
4694 teap->interp = goi->interp;
4695 Jim_GetOpt_Obj(goi, &o);
4697 Jim_DecrRefCount(teap->interp, teap->body);
4698 teap->body = Jim_DuplicateObj(goi->interp, o);
4701 * Tcl/TK - "tk events" have a nice feature.
4702 * See the "BIND" command.
4703 * We should support that here.
4704 * You can specify %X and %Y in the event code.
4705 * The idea is: %T - target name.
4706 * The idea is: %N - target number
4707 * The idea is: %E - event name.
4709 Jim_IncrRefCount(teap->body);
4712 /* add to head of event list */
4713 teap->next = target->event_action;
4714 target->event_action = teap;
4716 Jim_SetEmptyResult(goi->interp);
4720 Jim_SetEmptyResult(goi->interp);
4722 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4728 case TCFG_WORK_AREA_VIRT:
4729 if (goi->isconfigure) {
4730 target_free_all_working_areas(target);
4731 e = Jim_GetOpt_Wide(goi, &w);
4734 target->working_area_virt = w;
4735 target->working_area_virt_spec = true;
4740 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4744 case TCFG_WORK_AREA_PHYS:
4745 if (goi->isconfigure) {
4746 target_free_all_working_areas(target);
4747 e = Jim_GetOpt_Wide(goi, &w);
4750 target->working_area_phys = w;
4751 target->working_area_phys_spec = true;
4756 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4760 case TCFG_WORK_AREA_SIZE:
4761 if (goi->isconfigure) {
4762 target_free_all_working_areas(target);
4763 e = Jim_GetOpt_Wide(goi, &w);
4766 target->working_area_size = w;
4771 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4775 case TCFG_WORK_AREA_BACKUP:
4776 if (goi->isconfigure) {
4777 target_free_all_working_areas(target);
4778 e = Jim_GetOpt_Wide(goi, &w);
4781 /* make this exactly 1 or 0 */
4782 target->backup_working_area = (!!w);
4787 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4788 /* loop for more e*/
4793 if (goi->isconfigure) {
4794 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4796 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4799 target->endianness = n->value;
4804 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4805 if (n->name == NULL) {
4806 target->endianness = TARGET_LITTLE_ENDIAN;
4807 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4809 Jim_SetResultString(goi->interp, n->name, -1);
4814 if (goi->isconfigure) {
4815 e = Jim_GetOpt_Wide(goi, &w);
4818 target->coreid = (int32_t)w;
4823 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4827 case TCFG_CHAIN_POSITION:
4828 if (goi->isconfigure) {
4830 struct jtag_tap *tap;
4832 if (target->has_dap) {
4833 Jim_SetResultString(goi->interp,
4834 "target requires -dap parameter instead of -chain-position!", -1);
4838 target_free_all_working_areas(target);
4839 e = Jim_GetOpt_Obj(goi, &o_t);
4842 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4846 target->tap_configured = true;
4851 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4852 /* loop for more e*/
4855 if (goi->isconfigure) {
4856 e = Jim_GetOpt_Wide(goi, &w);
4859 target->dbgbase = (uint32_t)w;
4860 target->dbgbase_set = true;
4865 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4871 int result = rtos_create(goi, target);
4872 if (result != JIM_OK)
4878 case TCFG_DEFER_EXAMINE:
4880 target->defer_examine = true;
4885 if (goi->isconfigure) {
4887 e = Jim_GetOpt_String(goi, &s, NULL);
4890 target->gdb_port_override = strdup(s);
4895 Jim_SetResultString(goi->interp, target->gdb_port_override ? : "undefined", -1);
4899 } /* while (goi->argc) */
4902 /* done - we return */
4906 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4910 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4911 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4913 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4914 "missing: -option ...");
4917 struct target *target = Jim_CmdPrivData(goi.interp);
4918 return target_configure(&goi, target);
4921 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4923 const char *cmd_name = Jim_GetString(argv[0], NULL);
4926 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4928 if (goi.argc < 2 || goi.argc > 4) {
4929 Jim_SetResultFormatted(goi.interp,
4930 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4935 fn = target_write_memory;
4938 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4940 struct Jim_Obj *obj;
4941 e = Jim_GetOpt_Obj(&goi, &obj);
4945 fn = target_write_phys_memory;
4949 e = Jim_GetOpt_Wide(&goi, &a);
4954 e = Jim_GetOpt_Wide(&goi, &b);
4959 if (goi.argc == 1) {
4960 e = Jim_GetOpt_Wide(&goi, &c);
4965 /* all args must be consumed */
4969 struct target *target = Jim_CmdPrivData(goi.interp);
4971 if (strcasecmp(cmd_name, "mww") == 0)
4973 else if (strcasecmp(cmd_name, "mwh") == 0)
4975 else if (strcasecmp(cmd_name, "mwb") == 0)
4978 LOG_ERROR("command '%s' unknown: ", cmd_name);
4982 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4986 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4988 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4989 * mdh [phys] <address> [<count>] - for 16 bit reads
4990 * mdb [phys] <address> [<count>] - for 8 bit reads
4992 * Count defaults to 1.
4994 * Calls target_read_memory or target_read_phys_memory depending on
4995 * the presence of the "phys" argument
4996 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4997 * to int representation in base16.
4998 * Also outputs read data in a human readable form using command_print
5000 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
5001 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
5002 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
5003 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
5004 * on success, with [<count>] number of elements.
5006 * In case of little endian target:
5007 * Example1: "mdw 0x00000000" returns "10123456"
5008 * Exmaple2: "mdh 0x00000000 1" returns "3456"
5009 * Example3: "mdb 0x00000000" returns "56"
5010 * Example4: "mdh 0x00000000 2" returns "3456 1012"
5011 * Example5: "mdb 0x00000000 3" returns "56 34 12"
5013 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5015 const char *cmd_name = Jim_GetString(argv[0], NULL);
5018 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5020 if ((goi.argc < 1) || (goi.argc > 3)) {
5021 Jim_SetResultFormatted(goi.interp,
5022 "usage: %s [phys] <address> [<count>]", cmd_name);
5026 int (*fn)(struct target *target,
5027 target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
5028 fn = target_read_memory;
5031 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
5033 struct Jim_Obj *obj;
5034 e = Jim_GetOpt_Obj(&goi, &obj);
5038 fn = target_read_phys_memory;
5041 /* Read address parameter */
5043 e = Jim_GetOpt_Wide(&goi, &addr);
5047 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
5049 if (goi.argc == 1) {
5050 e = Jim_GetOpt_Wide(&goi, &count);
5056 /* all args must be consumed */
5060 jim_wide dwidth = 1; /* shut up gcc */
5061 if (strcasecmp(cmd_name, "mdw") == 0)
5063 else if (strcasecmp(cmd_name, "mdh") == 0)
5065 else if (strcasecmp(cmd_name, "mdb") == 0)
5068 LOG_ERROR("command '%s' unknown: ", cmd_name);
5072 /* convert count to "bytes" */
5073 int bytes = count * dwidth;
5075 struct target *target = Jim_CmdPrivData(goi.interp);
5076 uint8_t target_buf[32];
5079 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
5081 /* Try to read out next block */
5082 e = fn(target, addr, dwidth, y / dwidth, target_buf);
5084 if (e != ERROR_OK) {
5085 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
5089 command_print_sameline(NULL, "0x%08x ", (int)(addr));
5092 for (x = 0; x < 16 && x < y; x += 4) {
5093 z = target_buffer_get_u32(target, &(target_buf[x]));
5094 command_print_sameline(NULL, "%08x ", (int)(z));
5096 for (; (x < 16) ; x += 4)
5097 command_print_sameline(NULL, " ");
5100 for (x = 0; x < 16 && x < y; x += 2) {
5101 z = target_buffer_get_u16(target, &(target_buf[x]));
5102 command_print_sameline(NULL, "%04x ", (int)(z));
5104 for (; (x < 16) ; x += 2)
5105 command_print_sameline(NULL, " ");
5109 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
5110 z = target_buffer_get_u8(target, &(target_buf[x]));
5111 command_print_sameline(NULL, "%02x ", (int)(z));
5113 for (; (x < 16) ; x += 1)
5114 command_print_sameline(NULL, " ");
5117 /* ascii-ify the bytes */
5118 for (x = 0 ; x < y ; x++) {
5119 if ((target_buf[x] >= 0x20) &&
5120 (target_buf[x] <= 0x7e)) {
5124 target_buf[x] = '.';
5129 target_buf[x] = ' ';
5134 /* print - with a newline */
5135 command_print_sameline(NULL, "%s\n", target_buf);
5143 static int jim_target_mem2array(Jim_Interp *interp,
5144 int argc, Jim_Obj *const *argv)
5146 struct target *target = Jim_CmdPrivData(interp);
5147 return target_mem2array(interp, target, argc - 1, argv + 1);
5150 static int jim_target_array2mem(Jim_Interp *interp,
5151 int argc, Jim_Obj *const *argv)
5153 struct target *target = Jim_CmdPrivData(interp);
5154 return target_array2mem(interp, target, argc - 1, argv + 1);
5157 static int jim_target_tap_disabled(Jim_Interp *interp)
5159 Jim_SetResultFormatted(interp, "[TAP is disabled]");
5163 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5165 bool allow_defer = false;
5168 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5170 const char *cmd_name = Jim_GetString(argv[0], NULL);
5171 Jim_SetResultFormatted(goi.interp,
5172 "usage: %s ['allow-defer']", cmd_name);
5176 strcmp(Jim_GetString(argv[1], NULL), "allow-defer") == 0) {
5178 struct Jim_Obj *obj;
5179 int e = Jim_GetOpt_Obj(&goi, &obj);
5185 struct target *target = Jim_CmdPrivData(interp);
5186 if (!target->tap->enabled)
5187 return jim_target_tap_disabled(interp);
5189 if (allow_defer && target->defer_examine) {
5190 LOG_INFO("Deferring arp_examine of %s", target_name(target));
5191 LOG_INFO("Use arp_examine command to examine it manually!");
5195 int e = target->type->examine(target);
5201 static int jim_target_was_examined(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
5203 struct target *target = Jim_CmdPrivData(interp);
5205 Jim_SetResultBool(interp, target_was_examined(target));
5209 static int jim_target_examine_deferred(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
5211 struct target *target = Jim_CmdPrivData(interp);
5213 Jim_SetResultBool(interp, target->defer_examine);
5217 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5220 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5223 struct target *target = Jim_CmdPrivData(interp);
5225 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
5231 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5234 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5237 struct target *target = Jim_CmdPrivData(interp);
5238 if (!target->tap->enabled)
5239 return jim_target_tap_disabled(interp);
5242 if (!(target_was_examined(target)))
5243 e = ERROR_TARGET_NOT_EXAMINED;
5245 e = target->type->poll(target);
5251 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5254 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5256 if (goi.argc != 2) {
5257 Jim_WrongNumArgs(interp, 0, argv,
5258 "([tT]|[fF]|assert|deassert) BOOL");
5263 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
5265 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
5268 /* the halt or not param */
5270 e = Jim_GetOpt_Wide(&goi, &a);
5274 struct target *target = Jim_CmdPrivData(goi.interp);
5275 if (!target->tap->enabled)
5276 return jim_target_tap_disabled(interp);
5278 if (!target->type->assert_reset || !target->type->deassert_reset) {
5279 Jim_SetResultFormatted(interp,
5280 "No target-specific reset for %s",
5281 target_name(target));
5285 if (target->defer_examine)
5286 target_reset_examined(target);
5288 /* determine if we should halt or not. */
5289 target->reset_halt = !!a;
5290 /* When this happens - all workareas are invalid. */
5291 target_free_all_working_areas_restore(target, 0);
5294 if (n->value == NVP_ASSERT)
5295 e = target->type->assert_reset(target);
5297 e = target->type->deassert_reset(target);
5298 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
5301 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5304 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5307 struct target *target = Jim_CmdPrivData(interp);
5308 if (!target->tap->enabled)
5309 return jim_target_tap_disabled(interp);
5310 int e = target->type->halt(target);
5311 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
5314 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5317 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5319 /* params: <name> statename timeoutmsecs */
5320 if (goi.argc != 2) {
5321 const char *cmd_name = Jim_GetString(argv[0], NULL);
5322 Jim_SetResultFormatted(goi.interp,
5323 "%s <state_name> <timeout_in_msec>", cmd_name);
5328 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
5330 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
5334 e = Jim_GetOpt_Wide(&goi, &a);
5337 struct target *target = Jim_CmdPrivData(interp);
5338 if (!target->tap->enabled)
5339 return jim_target_tap_disabled(interp);
5341 e = target_wait_state(target, n->value, a);
5342 if (e != ERROR_OK) {
5343 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
5344 Jim_SetResultFormatted(goi.interp,
5345 "target: %s wait %s fails (%#s) %s",
5346 target_name(target), n->name,
5347 eObj, target_strerror_safe(e));
5348 Jim_FreeNewObj(interp, eObj);
5353 /* List for human, Events defined for this target.
5354 * scripts/programs should use 'name cget -event NAME'
5356 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5358 struct command_context *cmd_ctx = current_command_context(interp);
5359 assert(cmd_ctx != NULL);
5361 struct target *target = Jim_CmdPrivData(interp);
5362 struct target_event_action *teap = target->event_action;
5363 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
5364 target->target_number,
5365 target_name(target));
5366 command_print(cmd_ctx, "%-25s | Body", "Event");
5367 command_print(cmd_ctx, "------------------------- | "
5368 "----------------------------------------");
5370 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
5371 command_print(cmd_ctx, "%-25s | %s",
5372 opt->name, Jim_GetString(teap->body, NULL));
5375 command_print(cmd_ctx, "***END***");
5378 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5381 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5384 struct target *target = Jim_CmdPrivData(interp);
5385 Jim_SetResultString(interp, target_state_name(target), -1);
5388 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5391 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5392 if (goi.argc != 1) {
5393 const char *cmd_name = Jim_GetString(argv[0], NULL);
5394 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
5398 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
5400 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
5403 struct target *target = Jim_CmdPrivData(interp);
5404 target_handle_event(target, n->value);
5408 static const struct command_registration target_instance_command_handlers[] = {
5410 .name = "configure",
5411 .mode = COMMAND_CONFIG,
5412 .jim_handler = jim_target_configure,
5413 .help = "configure a new target for use",
5414 .usage = "[target_attribute ...]",
5418 .mode = COMMAND_ANY,
5419 .jim_handler = jim_target_configure,
5420 .help = "returns the specified target attribute",
5421 .usage = "target_attribute",
5425 .mode = COMMAND_EXEC,
5426 .jim_handler = jim_target_mw,
5427 .help = "Write 32-bit word(s) to target memory",
5428 .usage = "address data [count]",
5432 .mode = COMMAND_EXEC,
5433 .jim_handler = jim_target_mw,
5434 .help = "Write 16-bit half-word(s) to target memory",
5435 .usage = "address data [count]",
5439 .mode = COMMAND_EXEC,
5440 .jim_handler = jim_target_mw,
5441 .help = "Write byte(s) to target memory",
5442 .usage = "address data [count]",
5446 .mode = COMMAND_EXEC,
5447 .jim_handler = jim_target_md,
5448 .help = "Display target memory as 32-bit words",
5449 .usage = "address [count]",
5453 .mode = COMMAND_EXEC,
5454 .jim_handler = jim_target_md,
5455 .help = "Display target memory as 16-bit half-words",
5456 .usage = "address [count]",
5460 .mode = COMMAND_EXEC,
5461 .jim_handler = jim_target_md,
5462 .help = "Display target memory as 8-bit bytes",
5463 .usage = "address [count]",
5466 .name = "array2mem",
5467 .mode = COMMAND_EXEC,
5468 .jim_handler = jim_target_array2mem,
5469 .help = "Writes Tcl array of 8/16/32 bit numbers "
5471 .usage = "arrayname bitwidth address count",
5474 .name = "mem2array",
5475 .mode = COMMAND_EXEC,
5476 .jim_handler = jim_target_mem2array,
5477 .help = "Loads Tcl array of 8/16/32 bit numbers "
5478 "from target memory",
5479 .usage = "arrayname bitwidth address count",
5482 .name = "eventlist",
5483 .mode = COMMAND_EXEC,
5484 .jim_handler = jim_target_event_list,
5485 .help = "displays a table of events defined for this target",
5489 .mode = COMMAND_EXEC,
5490 .jim_handler = jim_target_current_state,
5491 .help = "displays the current state of this target",
5494 .name = "arp_examine",
5495 .mode = COMMAND_EXEC,
5496 .jim_handler = jim_target_examine,
5497 .help = "used internally for reset processing",
5498 .usage = "['allow-defer']",
5501 .name = "was_examined",
5502 .mode = COMMAND_EXEC,
5503 .jim_handler = jim_target_was_examined,
5504 .help = "used internally for reset processing",
5507 .name = "examine_deferred",
5508 .mode = COMMAND_EXEC,
5509 .jim_handler = jim_target_examine_deferred,
5510 .help = "used internally for reset processing",
5513 .name = "arp_halt_gdb",
5514 .mode = COMMAND_EXEC,
5515 .jim_handler = jim_target_halt_gdb,
5516 .help = "used internally for reset processing to halt GDB",
5520 .mode = COMMAND_EXEC,
5521 .jim_handler = jim_target_poll,
5522 .help = "used internally for reset processing",
5525 .name = "arp_reset",
5526 .mode = COMMAND_EXEC,
5527 .jim_handler = jim_target_reset,
5528 .help = "used internally for reset processing",
5532 .mode = COMMAND_EXEC,
5533 .jim_handler = jim_target_halt,
5534 .help = "used internally for reset processing",
5537 .name = "arp_waitstate",
5538 .mode = COMMAND_EXEC,
5539 .jim_handler = jim_target_wait_state,
5540 .help = "used internally for reset processing",
5543 .name = "invoke-event",
5544 .mode = COMMAND_EXEC,
5545 .jim_handler = jim_target_invoke_event,
5546 .help = "invoke handler for specified event",
5547 .usage = "event_name",
5549 COMMAND_REGISTRATION_DONE
5552 static int target_create(Jim_GetOptInfo *goi)
5559 struct target *target;
5560 struct command_context *cmd_ctx;
5562 cmd_ctx = current_command_context(goi->interp);
5563 assert(cmd_ctx != NULL);
5565 if (goi->argc < 3) {
5566 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
5571 Jim_GetOpt_Obj(goi, &new_cmd);
5572 /* does this command exist? */
5573 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
5575 cp = Jim_GetString(new_cmd, NULL);
5576 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
5581 e = Jim_GetOpt_String(goi, &cp, NULL);
5584 struct transport *tr = get_current_transport();
5585 if (tr->override_target) {
5586 e = tr->override_target(&cp);
5587 if (e != ERROR_OK) {
5588 LOG_ERROR("The selected transport doesn't support this target");
5591 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5593 /* now does target type exist */
5594 for (x = 0 ; target_types[x] ; x++) {
5595 if (0 == strcmp(cp, target_types[x]->name)) {
5600 /* check for deprecated name */
5601 if (target_types[x]->deprecated_name) {
5602 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
5604 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
5609 if (target_types[x] == NULL) {
5610 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
5611 for (x = 0 ; target_types[x] ; x++) {
5612 if (target_types[x + 1]) {
5613 Jim_AppendStrings(goi->interp,
5614 Jim_GetResult(goi->interp),
5615 target_types[x]->name,
5618 Jim_AppendStrings(goi->interp,
5619 Jim_GetResult(goi->interp),
5621 target_types[x]->name, NULL);
5628 target = calloc(1, sizeof(struct target));
5629 /* set target number */
5630 target->target_number = new_target_number();
5631 cmd_ctx->current_target = target;
5633 /* allocate memory for each unique target type */
5634 target->type = calloc(1, sizeof(struct target_type));
5636 memcpy(target->type, target_types[x], sizeof(struct target_type));
5638 /* will be set by "-endian" */
5639 target->endianness = TARGET_ENDIAN_UNKNOWN;
5641 /* default to first core, override with -coreid */
5644 target->working_area = 0x0;
5645 target->working_area_size = 0x0;
5646 target->working_areas = NULL;
5647 target->backup_working_area = 0;
5649 target->state = TARGET_UNKNOWN;
5650 target->debug_reason = DBG_REASON_UNDEFINED;
5651 target->reg_cache = NULL;
5652 target->breakpoints = NULL;
5653 target->watchpoints = NULL;
5654 target->next = NULL;
5655 target->arch_info = NULL;
5657 target->verbose_halt_msg = true;
5659 target->halt_issued = false;
5661 /* initialize trace information */
5662 target->trace_info = calloc(1, sizeof(struct trace));
5664 target->dbgmsg = NULL;
5665 target->dbg_msg_enabled = 0;
5667 target->endianness = TARGET_ENDIAN_UNKNOWN;
5669 target->rtos = NULL;
5670 target->rtos_auto_detect = false;
5672 target->gdb_port_override = NULL;
5674 /* Do the rest as "configure" options */
5675 goi->isconfigure = 1;
5676 e = target_configure(goi, target);
5679 if (target->has_dap) {
5680 if (!target->dap_configured) {
5681 Jim_SetResultString(goi->interp, "-dap ?name? required when creating target", -1);
5685 if (!target->tap_configured) {
5686 Jim_SetResultString(goi->interp, "-chain-position ?name? required when creating target", -1);
5690 /* tap must be set after target was configured */
5691 if (target->tap == NULL)
5696 free(target->gdb_port_override);
5702 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
5703 /* default endian to little if not specified */
5704 target->endianness = TARGET_LITTLE_ENDIAN;
5707 cp = Jim_GetString(new_cmd, NULL);
5708 target->cmd_name = strdup(cp);
5710 if (target->type->target_create) {
5711 e = (*(target->type->target_create))(target, goi->interp);
5712 if (e != ERROR_OK) {
5713 LOG_DEBUG("target_create failed");
5714 free(target->gdb_port_override);
5716 free(target->cmd_name);
5722 /* create the target specific commands */
5723 if (target->type->commands) {
5724 e = register_commands(cmd_ctx, NULL, target->type->commands);
5726 LOG_ERROR("unable to register '%s' commands", cp);
5729 /* append to end of list */
5731 struct target **tpp;
5732 tpp = &(all_targets);
5734 tpp = &((*tpp)->next);
5738 /* now - create the new target name command */
5739 const struct command_registration target_subcommands[] = {
5741 .chain = target_instance_command_handlers,
5744 .chain = target->type->commands,
5746 COMMAND_REGISTRATION_DONE
5748 const struct command_registration target_commands[] = {
5751 .mode = COMMAND_ANY,
5752 .help = "target command group",
5754 .chain = target_subcommands,
5756 COMMAND_REGISTRATION_DONE
5758 e = register_commands(cmd_ctx, NULL, target_commands);
5762 struct command *c = command_find_in_context(cmd_ctx, cp);
5764 command_set_handler_data(c, target);
5766 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5769 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5772 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5775 struct command_context *cmd_ctx = current_command_context(interp);
5776 assert(cmd_ctx != NULL);
5778 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5782 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5785 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5788 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5789 for (unsigned x = 0; NULL != target_types[x]; x++) {
5790 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5791 Jim_NewStringObj(interp, target_types[x]->name, -1));
5796 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5799 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5802 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5803 struct target *target = all_targets;
5805 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5806 Jim_NewStringObj(interp, target_name(target), -1));
5807 target = target->next;
5812 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5815 const char *targetname;
5817 struct target *target = (struct target *) NULL;
5818 struct target_list *head, *curr, *new;
5819 curr = (struct target_list *) NULL;
5820 head = (struct target_list *) NULL;
5823 LOG_DEBUG("%d", argc);
5824 /* argv[1] = target to associate in smp
5825 * argv[2] = target to assoicate in smp
5829 for (i = 1; i < argc; i++) {
5831 targetname = Jim_GetString(argv[i], &len);
5832 target = get_target(targetname);
5833 LOG_DEBUG("%s ", targetname);
5835 new = malloc(sizeof(struct target_list));
5836 new->target = target;
5837 new->next = (struct target_list *)NULL;
5838 if (head == (struct target_list *)NULL) {
5847 /* now parse the list of cpu and put the target in smp mode*/
5850 while (curr != (struct target_list *)NULL) {
5851 target = curr->target;
5853 target->head = head;
5857 if (target && target->rtos)
5858 retval = rtos_smp_init(head->target);
5864 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5867 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5869 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5870 "<name> <target_type> [<target_options> ...]");
5873 return target_create(&goi);
5876 static const struct command_registration target_subcommand_handlers[] = {
5879 .mode = COMMAND_CONFIG,
5880 .handler = handle_target_init_command,
5881 .help = "initialize targets",
5885 /* REVISIT this should be COMMAND_CONFIG ... */
5886 .mode = COMMAND_ANY,
5887 .jim_handler = jim_target_create,
5888 .usage = "name type '-chain-position' name [options ...]",
5889 .help = "Creates and selects a new target",
5893 .mode = COMMAND_ANY,
5894 .jim_handler = jim_target_current,
5895 .help = "Returns the currently selected target",
5899 .mode = COMMAND_ANY,
5900 .jim_handler = jim_target_types,
5901 .help = "Returns the available target types as "
5902 "a list of strings",
5906 .mode = COMMAND_ANY,
5907 .jim_handler = jim_target_names,
5908 .help = "Returns the names of all targets as a list of strings",
5912 .mode = COMMAND_ANY,
5913 .jim_handler = jim_target_smp,
5914 .usage = "targetname1 targetname2 ...",
5915 .help = "gather several target in a smp list"
5918 COMMAND_REGISTRATION_DONE
5922 target_addr_t address;
5928 static int fastload_num;
5929 static struct FastLoad *fastload;
5931 static void free_fastload(void)
5933 if (fastload != NULL) {
5935 for (i = 0; i < fastload_num; i++) {
5936 if (fastload[i].data)
5937 free(fastload[i].data);
5944 COMMAND_HANDLER(handle_fast_load_image_command)
5948 uint32_t image_size;
5949 target_addr_t min_address = 0;
5950 target_addr_t max_address = -1;
5955 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5956 &image, &min_address, &max_address);
5957 if (ERROR_OK != retval)
5960 struct duration bench;
5961 duration_start(&bench);
5963 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5964 if (retval != ERROR_OK)
5969 fastload_num = image.num_sections;
5970 fastload = malloc(sizeof(struct FastLoad)*image.num_sections);
5971 if (fastload == NULL) {
5972 command_print(CMD_CTX, "out of memory");
5973 image_close(&image);
5976 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5977 for (i = 0; i < image.num_sections; i++) {
5978 buffer = malloc(image.sections[i].size);
5979 if (buffer == NULL) {
5980 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5981 (int)(image.sections[i].size));
5982 retval = ERROR_FAIL;
5986 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5987 if (retval != ERROR_OK) {
5992 uint32_t offset = 0;
5993 uint32_t length = buf_cnt;
5995 /* DANGER!!! beware of unsigned comparision here!!! */
5997 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5998 (image.sections[i].base_address < max_address)) {
5999 if (image.sections[i].base_address < min_address) {
6000 /* clip addresses below */
6001 offset += min_address-image.sections[i].base_address;
6005 if (image.sections[i].base_address + buf_cnt > max_address)
6006 length -= (image.sections[i].base_address + buf_cnt)-max_address;
6008 fastload[i].address = image.sections[i].base_address + offset;
6009 fastload[i].data = malloc(length);
6010 if (fastload[i].data == NULL) {
6012 command_print(CMD_CTX, "error allocating buffer for section (%" PRIu32 " bytes)",
6014 retval = ERROR_FAIL;
6017 memcpy(fastload[i].data, buffer + offset, length);
6018 fastload[i].length = length;
6020 image_size += length;
6021 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
6022 (unsigned int)length,
6023 ((unsigned int)(image.sections[i].base_address + offset)));
6029 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
6030 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
6031 "in %fs (%0.3f KiB/s)", image_size,
6032 duration_elapsed(&bench), duration_kbps(&bench, image_size));
6034 command_print(CMD_CTX,
6035 "WARNING: image has not been loaded to target!"
6036 "You can issue a 'fast_load' to finish loading.");
6039 image_close(&image);
6041 if (retval != ERROR_OK)
6047 COMMAND_HANDLER(handle_fast_load_command)
6050 return ERROR_COMMAND_SYNTAX_ERROR;
6051 if (fastload == NULL) {
6052 LOG_ERROR("No image in memory");
6056 int64_t ms = timeval_ms();
6058 int retval = ERROR_OK;
6059 for (i = 0; i < fastload_num; i++) {
6060 struct target *target = get_current_target(CMD_CTX);
6061 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
6062 (unsigned int)(fastload[i].address),
6063 (unsigned int)(fastload[i].length));
6064 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
6065 if (retval != ERROR_OK)
6067 size += fastload[i].length;
6069 if (retval == ERROR_OK) {
6070 int64_t after = timeval_ms();
6071 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
6076 static const struct command_registration target_command_handlers[] = {
6079 .handler = handle_targets_command,
6080 .mode = COMMAND_ANY,
6081 .help = "change current default target (one parameter) "
6082 "or prints table of all targets (no parameters)",
6083 .usage = "[target]",
6087 .mode = COMMAND_CONFIG,
6088 .help = "configure target",
6090 .chain = target_subcommand_handlers,
6092 COMMAND_REGISTRATION_DONE
6095 int target_register_commands(struct command_context *cmd_ctx)
6097 return register_commands(cmd_ctx, NULL, target_command_handlers);
6100 static bool target_reset_nag = true;
6102 bool get_target_reset_nag(void)
6104 return target_reset_nag;
6107 COMMAND_HANDLER(handle_target_reset_nag)
6109 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
6110 &target_reset_nag, "Nag after each reset about options to improve "
6114 COMMAND_HANDLER(handle_ps_command)
6116 struct target *target = get_current_target(CMD_CTX);
6118 if (target->state != TARGET_HALTED) {
6119 LOG_INFO("target not halted !!");
6123 if ((target->rtos) && (target->rtos->type)
6124 && (target->rtos->type->ps_command)) {
6125 display = target->rtos->type->ps_command(target);
6126 command_print(CMD_CTX, "%s", display);
6131 return ERROR_TARGET_FAILURE;
6135 static void binprint(struct command_context *cmd_ctx, const char *text, const uint8_t *buf, int size)
6138 command_print_sameline(cmd_ctx, "%s", text);
6139 for (int i = 0; i < size; i++)
6140 command_print_sameline(cmd_ctx, " %02x", buf[i]);
6141 command_print(cmd_ctx, " ");
6144 COMMAND_HANDLER(handle_test_mem_access_command)
6146 struct target *target = get_current_target(CMD_CTX);
6148 int retval = ERROR_OK;
6150 if (target->state != TARGET_HALTED) {
6151 LOG_INFO("target not halted !!");
6156 return ERROR_COMMAND_SYNTAX_ERROR;
6158 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], test_size);
6161 size_t num_bytes = test_size + 4;
6163 struct working_area *wa = NULL;
6164 retval = target_alloc_working_area(target, num_bytes, &wa);
6165 if (retval != ERROR_OK) {
6166 LOG_ERROR("Not enough working area");
6170 uint8_t *test_pattern = malloc(num_bytes);
6172 for (size_t i = 0; i < num_bytes; i++)
6173 test_pattern[i] = rand();
6175 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
6176 if (retval != ERROR_OK) {
6177 LOG_ERROR("Test pattern write failed");
6181 for (int host_offset = 0; host_offset <= 1; host_offset++) {
6182 for (int size = 1; size <= 4; size *= 2) {
6183 for (int offset = 0; offset < 4; offset++) {
6184 uint32_t count = test_size / size;
6185 size_t host_bufsiz = (count + 2) * size + host_offset;
6186 uint8_t *read_ref = malloc(host_bufsiz);
6187 uint8_t *read_buf = malloc(host_bufsiz);
6189 for (size_t i = 0; i < host_bufsiz; i++) {
6190 read_ref[i] = rand();
6191 read_buf[i] = read_ref[i];
6193 command_print_sameline(CMD_CTX,
6194 "Test read %" PRIu32 " x %d @ %d to %saligned buffer: ", count,
6195 size, offset, host_offset ? "un" : "");
6197 struct duration bench;
6198 duration_start(&bench);
6200 retval = target_read_memory(target, wa->address + offset, size, count,
6201 read_buf + size + host_offset);
6203 duration_measure(&bench);
6205 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
6206 command_print(CMD_CTX, "Unsupported alignment");
6208 } else if (retval != ERROR_OK) {
6209 command_print(CMD_CTX, "Memory read failed");
6213 /* replay on host */
6214 memcpy(read_ref + size + host_offset, test_pattern + offset, count * size);
6217 int result = memcmp(read_ref, read_buf, host_bufsiz);
6219 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
6220 duration_elapsed(&bench),
6221 duration_kbps(&bench, count * size));
6223 command_print(CMD_CTX, "Compare failed");
6224 binprint(CMD_CTX, "ref:", read_ref, host_bufsiz);
6225 binprint(CMD_CTX, "buf:", read_buf, host_bufsiz);
6238 target_free_working_area(target, wa);
6241 num_bytes = test_size + 4 + 4 + 4;
6243 retval = target_alloc_working_area(target, num_bytes, &wa);
6244 if (retval != ERROR_OK) {
6245 LOG_ERROR("Not enough working area");
6249 test_pattern = malloc(num_bytes);
6251 for (size_t i = 0; i < num_bytes; i++)
6252 test_pattern[i] = rand();
6254 for (int host_offset = 0; host_offset <= 1; host_offset++) {
6255 for (int size = 1; size <= 4; size *= 2) {
6256 for (int offset = 0; offset < 4; offset++) {
6257 uint32_t count = test_size / size;
6258 size_t host_bufsiz = count * size + host_offset;
6259 uint8_t *read_ref = malloc(num_bytes);
6260 uint8_t *read_buf = malloc(num_bytes);
6261 uint8_t *write_buf = malloc(host_bufsiz);
6263 for (size_t i = 0; i < host_bufsiz; i++)
6264 write_buf[i] = rand();
6265 command_print_sameline(CMD_CTX,
6266 "Test write %" PRIu32 " x %d @ %d from %saligned buffer: ", count,
6267 size, offset, host_offset ? "un" : "");
6269 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
6270 if (retval != ERROR_OK) {
6271 command_print(CMD_CTX, "Test pattern write failed");
6275 /* replay on host */
6276 memcpy(read_ref, test_pattern, num_bytes);
6277 memcpy(read_ref + size + offset, write_buf + host_offset, count * size);
6279 struct duration bench;
6280 duration_start(&bench);
6282 retval = target_write_memory(target, wa->address + size + offset, size, count,
6283 write_buf + host_offset);
6285 duration_measure(&bench);
6287 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
6288 command_print(CMD_CTX, "Unsupported alignment");
6290 } else if (retval != ERROR_OK) {
6291 command_print(CMD_CTX, "Memory write failed");
6296 retval = target_read_memory(target, wa->address, 1, num_bytes, read_buf);
6297 if (retval != ERROR_OK) {
6298 command_print(CMD_CTX, "Test pattern write failed");
6303 int result = memcmp(read_ref, read_buf, num_bytes);
6305 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
6306 duration_elapsed(&bench),
6307 duration_kbps(&bench, count * size));
6309 command_print(CMD_CTX, "Compare failed");
6310 binprint(CMD_CTX, "ref:", read_ref, num_bytes);
6311 binprint(CMD_CTX, "buf:", read_buf, num_bytes);
6323 target_free_working_area(target, wa);
6327 static const struct command_registration target_exec_command_handlers[] = {
6329 .name = "fast_load_image",
6330 .handler = handle_fast_load_image_command,
6331 .mode = COMMAND_ANY,
6332 .help = "Load image into server memory for later use by "
6333 "fast_load; primarily for profiling",
6334 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
6335 "[min_address [max_length]]",
6338 .name = "fast_load",
6339 .handler = handle_fast_load_command,
6340 .mode = COMMAND_EXEC,
6341 .help = "loads active fast load image to current target "
6342 "- mainly for profiling purposes",
6347 .handler = handle_profile_command,
6348 .mode = COMMAND_EXEC,
6349 .usage = "seconds filename [start end]",
6350 .help = "profiling samples the CPU PC",
6352 /** @todo don't register virt2phys() unless target supports it */
6354 .name = "virt2phys",
6355 .handler = handle_virt2phys_command,
6356 .mode = COMMAND_ANY,
6357 .help = "translate a virtual address into a physical address",
6358 .usage = "virtual_address",
6362 .handler = handle_reg_command,
6363 .mode = COMMAND_EXEC,
6364 .help = "display (reread from target with \"force\") or set a register; "
6365 "with no arguments, displays all registers and their values",
6366 .usage = "[(register_number|register_name) [(value|'force')]]",
6370 .handler = handle_poll_command,
6371 .mode = COMMAND_EXEC,
6372 .help = "poll target state; or reconfigure background polling",
6373 .usage = "['on'|'off']",
6376 .name = "wait_halt",
6377 .handler = handle_wait_halt_command,
6378 .mode = COMMAND_EXEC,
6379 .help = "wait up to the specified number of milliseconds "
6380 "(default 5000) for a previously requested halt",
6381 .usage = "[milliseconds]",
6385 .handler = handle_halt_command,
6386 .mode = COMMAND_EXEC,
6387 .help = "request target to halt, then wait up to the specified"
6388 "number of milliseconds (default 5000) for it to complete",
6389 .usage = "[milliseconds]",
6393 .handler = handle_resume_command,
6394 .mode = COMMAND_EXEC,
6395 .help = "resume target execution from current PC or address",
6396 .usage = "[address]",
6400 .handler = handle_reset_command,
6401 .mode = COMMAND_EXEC,
6402 .usage = "[run|halt|init]",
6403 .help = "Reset all targets into the specified mode."
6404 "Default reset mode is run, if not given.",
6407 .name = "soft_reset_halt",
6408 .handler = handle_soft_reset_halt_command,
6409 .mode = COMMAND_EXEC,
6411 .help = "halt the target and do a soft reset",
6415 .handler = handle_step_command,
6416 .mode = COMMAND_EXEC,
6417 .help = "step one instruction from current PC or address",
6418 .usage = "[address]",
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 words",
6432 .usage = "['phys'] address [count]",
6436 .handler = handle_md_command,
6437 .mode = COMMAND_EXEC,
6438 .help = "display memory half-words",
6439 .usage = "['phys'] address [count]",
6443 .handler = handle_md_command,
6444 .mode = COMMAND_EXEC,
6445 .help = "display memory bytes",
6446 .usage = "['phys'] address [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 word",
6460 .usage = "['phys'] address value [count]",
6464 .handler = handle_mw_command,
6465 .mode = COMMAND_EXEC,
6466 .help = "write memory half-word",
6467 .usage = "['phys'] address value [count]",
6471 .handler = handle_mw_command,
6472 .mode = COMMAND_EXEC,
6473 .help = "write memory byte",
6474 .usage = "['phys'] address value [count]",
6478 .handler = handle_bp_command,
6479 .mode = COMMAND_EXEC,
6480 .help = "list or set hardware or software breakpoint",
6481 .usage = "<address> [<asid>] <length> ['hw'|'hw_ctx']",
6485 .handler = handle_rbp_command,
6486 .mode = COMMAND_EXEC,
6487 .help = "remove breakpoint",
6492 .handler = handle_wp_command,
6493 .mode = COMMAND_EXEC,
6494 .help = "list (no params) or create watchpoints",
6495 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
6499 .handler = handle_rwp_command,
6500 .mode = COMMAND_EXEC,
6501 .help = "remove watchpoint",
6505 .name = "load_image",
6506 .handler = handle_load_image_command,
6507 .mode = COMMAND_EXEC,
6508 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
6509 "[min_address] [max_length]",
6512 .name = "dump_image",
6513 .handler = handle_dump_image_command,
6514 .mode = COMMAND_EXEC,
6515 .usage = "filename address size",
6518 .name = "verify_image_checksum",
6519 .handler = handle_verify_image_checksum_command,
6520 .mode = COMMAND_EXEC,
6521 .usage = "filename [offset [type]]",
6524 .name = "verify_image",
6525 .handler = handle_verify_image_command,
6526 .mode = COMMAND_EXEC,
6527 .usage = "filename [offset [type]]",
6530 .name = "test_image",
6531 .handler = handle_test_image_command,
6532 .mode = COMMAND_EXEC,
6533 .usage = "filename [offset [type]]",
6536 .name = "mem2array",
6537 .mode = COMMAND_EXEC,
6538 .jim_handler = jim_mem2array,
6539 .help = "read 8/16/32 bit memory and return as a TCL array "
6540 "for script processing",
6541 .usage = "arrayname bitwidth address count",
6544 .name = "array2mem",
6545 .mode = COMMAND_EXEC,
6546 .jim_handler = jim_array2mem,
6547 .help = "convert a TCL array to memory locations "
6548 "and write the 8/16/32 bit values",
6549 .usage = "arrayname bitwidth address count",
6552 .name = "reset_nag",
6553 .handler = handle_target_reset_nag,
6554 .mode = COMMAND_ANY,
6555 .help = "Nag after each reset about options that could have been "
6556 "enabled to improve performance. ",
6557 .usage = "['enable'|'disable']",
6561 .handler = handle_ps_command,
6562 .mode = COMMAND_EXEC,
6563 .help = "list all tasks ",
6567 .name = "test_mem_access",
6568 .handler = handle_test_mem_access_command,
6569 .mode = COMMAND_EXEC,
6570 .help = "Test the target's memory access functions",
6574 COMMAND_REGISTRATION_DONE
6576 static int target_register_user_commands(struct command_context *cmd_ctx)
6578 int retval = ERROR_OK;
6579 retval = target_request_register_commands(cmd_ctx);
6580 if (retval != ERROR_OK)
6583 retval = trace_register_commands(cmd_ctx);
6584 if (retval != ERROR_OK)
6588 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);