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, write to the *
38 * Free Software Foundation, Inc., *
39 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
40 ***************************************************************************/
46 #include <helper/time_support.h>
47 #include <jtag/jtag.h>
48 #include <flash/nor/core.h>
51 #include "target_type.h"
52 #include "target_request.h"
53 #include "breakpoints.h"
57 #include "rtos/rtos.h"
59 /* default halt wait timeout (ms) */
60 #define DEFAULT_HALT_TIMEOUT 5000
62 static int target_read_buffer_default(struct target *target, uint32_t address,
63 uint32_t size, uint8_t *buffer);
64 static int target_write_buffer_default(struct target *target, uint32_t address,
65 uint32_t size, 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);
73 extern struct target_type arm7tdmi_target;
74 extern struct target_type arm720t_target;
75 extern struct target_type arm9tdmi_target;
76 extern struct target_type arm920t_target;
77 extern struct target_type arm966e_target;
78 extern struct target_type arm946e_target;
79 extern struct target_type arm926ejs_target;
80 extern struct target_type fa526_target;
81 extern struct target_type feroceon_target;
82 extern struct target_type dragonite_target;
83 extern struct target_type xscale_target;
84 extern struct target_type cortexm3_target;
85 extern struct target_type cortexa8_target;
86 extern struct target_type cortexr4_target;
87 extern struct target_type arm11_target;
88 extern struct target_type mips_m4k_target;
89 extern struct target_type avr_target;
90 extern struct target_type dsp563xx_target;
91 extern struct target_type dsp5680xx_target;
92 extern struct target_type testee_target;
93 extern struct target_type avr32_ap7k_target;
94 extern struct target_type hla_target;
95 extern struct target_type nds32_v2_target;
96 extern struct target_type nds32_v3_target;
97 extern struct target_type nds32_v3m_target;
99 static struct target_type *target_types[] = {
128 struct target *all_targets;
129 static struct target_event_callback *target_event_callbacks;
130 static struct target_timer_callback *target_timer_callbacks;
131 static const int polling_interval = 100;
133 static const Jim_Nvp nvp_assert[] = {
134 { .name = "assert", NVP_ASSERT },
135 { .name = "deassert", NVP_DEASSERT },
136 { .name = "T", NVP_ASSERT },
137 { .name = "F", NVP_DEASSERT },
138 { .name = "t", NVP_ASSERT },
139 { .name = "f", NVP_DEASSERT },
140 { .name = NULL, .value = -1 }
143 static const Jim_Nvp nvp_error_target[] = {
144 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
145 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
146 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
147 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
148 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
149 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
150 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
151 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
152 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
153 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
154 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
155 { .value = -1, .name = NULL }
158 static const char *target_strerror_safe(int err)
162 n = Jim_Nvp_value2name_simple(nvp_error_target, err);
169 static const Jim_Nvp nvp_target_event[] = {
171 { .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
172 { .value = TARGET_EVENT_HALTED, .name = "halted" },
173 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
174 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
175 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
177 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
178 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
180 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
181 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
182 { .value = TARGET_EVENT_RESET_ASSERT, .name = "reset-assert" },
183 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
184 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
185 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
186 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
187 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
188 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
189 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
190 { .value = TARGET_EVENT_RESET_INIT, .name = "reset-init" },
191 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
193 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
194 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
196 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
197 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
199 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
200 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
202 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
203 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
205 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
206 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
208 { .name = NULL, .value = -1 }
211 static const Jim_Nvp nvp_target_state[] = {
212 { .name = "unknown", .value = TARGET_UNKNOWN },
213 { .name = "running", .value = TARGET_RUNNING },
214 { .name = "halted", .value = TARGET_HALTED },
215 { .name = "reset", .value = TARGET_RESET },
216 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
217 { .name = NULL, .value = -1 },
220 static const Jim_Nvp nvp_target_debug_reason[] = {
221 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
222 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
223 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
224 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
225 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
226 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
227 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
228 { .name = NULL, .value = -1 },
231 static const Jim_Nvp nvp_target_endian[] = {
232 { .name = "big", .value = TARGET_BIG_ENDIAN },
233 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
234 { .name = "be", .value = TARGET_BIG_ENDIAN },
235 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
236 { .name = NULL, .value = -1 },
239 static const Jim_Nvp nvp_reset_modes[] = {
240 { .name = "unknown", .value = RESET_UNKNOWN },
241 { .name = "run" , .value = RESET_RUN },
242 { .name = "halt" , .value = RESET_HALT },
243 { .name = "init" , .value = RESET_INIT },
244 { .name = NULL , .value = -1 },
247 const char *debug_reason_name(struct target *t)
251 cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
252 t->debug_reason)->name;
254 LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
255 cp = "(*BUG*unknown*BUG*)";
260 const char *target_state_name(struct target *t)
263 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
265 LOG_ERROR("Invalid target state: %d", (int)(t->state));
266 cp = "(*BUG*unknown*BUG*)";
271 /* determine the number of the new target */
272 static int new_target_number(void)
277 /* number is 0 based */
281 if (x < t->target_number)
282 x = t->target_number;
288 /* read a uint32_t from a buffer in target memory endianness */
289 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
291 if (target->endianness == TARGET_LITTLE_ENDIAN)
292 return le_to_h_u32(buffer);
294 return be_to_h_u32(buffer);
297 /* read a uint24_t from a buffer in target memory endianness */
298 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
300 if (target->endianness == TARGET_LITTLE_ENDIAN)
301 return le_to_h_u24(buffer);
303 return be_to_h_u24(buffer);
306 /* read a uint16_t from a buffer in target memory endianness */
307 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
309 if (target->endianness == TARGET_LITTLE_ENDIAN)
310 return le_to_h_u16(buffer);
312 return be_to_h_u16(buffer);
315 /* read a uint8_t from a buffer in target memory endianness */
316 static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
318 return *buffer & 0x0ff;
321 /* write a uint32_t to a buffer in target memory endianness */
322 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
324 if (target->endianness == TARGET_LITTLE_ENDIAN)
325 h_u32_to_le(buffer, value);
327 h_u32_to_be(buffer, value);
330 /* write a uint24_t to a buffer in target memory endianness */
331 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
333 if (target->endianness == TARGET_LITTLE_ENDIAN)
334 h_u24_to_le(buffer, value);
336 h_u24_to_be(buffer, value);
339 /* write a uint16_t to a buffer in target memory endianness */
340 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
342 if (target->endianness == TARGET_LITTLE_ENDIAN)
343 h_u16_to_le(buffer, value);
345 h_u16_to_be(buffer, value);
348 /* write a uint8_t to a buffer in target memory endianness */
349 static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
354 /* write a uint32_t array to a buffer in target memory endianness */
355 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
358 for (i = 0; i < count; i++)
359 dstbuf[i] = target_buffer_get_u32(target, &buffer[i * 4]);
362 /* write a uint16_t array to a buffer in target memory endianness */
363 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
366 for (i = 0; i < count; i++)
367 dstbuf[i] = target_buffer_get_u16(target, &buffer[i * 2]);
370 /* write a uint32_t array to a buffer in target memory endianness */
371 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf)
374 for (i = 0; i < count; i++)
375 target_buffer_set_u32(target, &buffer[i * 4], srcbuf[i]);
378 /* write a uint16_t array to a buffer in target memory endianness */
379 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf)
382 for (i = 0; i < count; i++)
383 target_buffer_set_u16(target, &buffer[i * 2], srcbuf[i]);
386 /* return a pointer to a configured target; id is name or number */
387 struct target *get_target(const char *id)
389 struct target *target;
391 /* try as tcltarget name */
392 for (target = all_targets; target; target = target->next) {
393 if (target_name(target) == NULL)
395 if (strcmp(id, target_name(target)) == 0)
399 /* It's OK to remove this fallback sometime after August 2010 or so */
401 /* no match, try as number */
403 if (parse_uint(id, &num) != ERROR_OK)
406 for (target = all_targets; target; target = target->next) {
407 if (target->target_number == (int)num) {
408 LOG_WARNING("use '%s' as target identifier, not '%u'",
409 target_name(target), num);
417 /* returns a pointer to the n-th configured target */
418 static struct target *get_target_by_num(int num)
420 struct target *target = all_targets;
423 if (target->target_number == num)
425 target = target->next;
431 struct target *get_current_target(struct command_context *cmd_ctx)
433 struct target *target = get_target_by_num(cmd_ctx->current_target);
435 if (target == NULL) {
436 LOG_ERROR("BUG: current_target out of bounds");
443 int target_poll(struct target *target)
447 /* We can't poll until after examine */
448 if (!target_was_examined(target)) {
449 /* Fail silently lest we pollute the log */
453 retval = target->type->poll(target);
454 if (retval != ERROR_OK)
457 if (target->halt_issued) {
458 if (target->state == TARGET_HALTED)
459 target->halt_issued = false;
461 long long t = timeval_ms() - target->halt_issued_time;
462 if (t > DEFAULT_HALT_TIMEOUT) {
463 target->halt_issued = false;
464 LOG_INFO("Halt timed out, wake up GDB.");
465 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
473 int target_halt(struct target *target)
476 /* We can't poll until after examine */
477 if (!target_was_examined(target)) {
478 LOG_ERROR("Target not examined yet");
482 retval = target->type->halt(target);
483 if (retval != ERROR_OK)
486 target->halt_issued = true;
487 target->halt_issued_time = timeval_ms();
493 * Make the target (re)start executing using its saved execution
494 * context (possibly with some modifications).
496 * @param target Which target should start executing.
497 * @param current True to use the target's saved program counter instead
498 * of the address parameter
499 * @param address Optionally used as the program counter.
500 * @param handle_breakpoints True iff breakpoints at the resumption PC
501 * should be skipped. (For example, maybe execution was stopped by
502 * such a breakpoint, in which case it would be counterprodutive to
504 * @param debug_execution False if all working areas allocated by OpenOCD
505 * should be released and/or restored to their original contents.
506 * (This would for example be true to run some downloaded "helper"
507 * algorithm code, which resides in one such working buffer and uses
508 * another for data storage.)
510 * @todo Resolve the ambiguity about what the "debug_execution" flag
511 * signifies. For example, Target implementations don't agree on how
512 * it relates to invalidation of the register cache, or to whether
513 * breakpoints and watchpoints should be enabled. (It would seem wrong
514 * to enable breakpoints when running downloaded "helper" algorithms
515 * (debug_execution true), since the breakpoints would be set to match
516 * target firmware being debugged, not the helper algorithm.... and
517 * enabling them could cause such helpers to malfunction (for example,
518 * by overwriting data with a breakpoint instruction. On the other
519 * hand the infrastructure for running such helpers might use this
520 * procedure but rely on hardware breakpoint to detect termination.)
522 int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
526 /* We can't poll until after examine */
527 if (!target_was_examined(target)) {
528 LOG_ERROR("Target not examined yet");
532 target_call_event_callbacks(target, TARGET_EVENT_RESUME_START);
534 /* note that resume *must* be asynchronous. The CPU can halt before
535 * we poll. The CPU can even halt at the current PC as a result of
536 * a software breakpoint being inserted by (a bug?) the application.
538 retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution);
539 if (retval != ERROR_OK)
542 target_call_event_callbacks(target, TARGET_EVENT_RESUME_END);
547 static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
552 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
553 if (n->name == NULL) {
554 LOG_ERROR("invalid reset mode");
558 /* disable polling during reset to make reset event scripts
559 * more predictable, i.e. dr/irscan & pathmove in events will
560 * not have JTAG operations injected into the middle of a sequence.
562 bool save_poll = jtag_poll_get_enabled();
564 jtag_poll_set_enabled(false);
566 sprintf(buf, "ocd_process_reset %s", n->name);
567 retval = Jim_Eval(cmd_ctx->interp, buf);
569 jtag_poll_set_enabled(save_poll);
571 if (retval != JIM_OK) {
572 Jim_MakeErrorMessage(cmd_ctx->interp);
573 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
577 /* We want any events to be processed before the prompt */
578 retval = target_call_timer_callbacks_now();
580 struct target *target;
581 for (target = all_targets; target; target = target->next)
582 target->type->check_reset(target);
587 static int identity_virt2phys(struct target *target,
588 uint32_t virtual, uint32_t *physical)
594 static int no_mmu(struct target *target, int *enabled)
600 static int default_examine(struct target *target)
602 target_set_examined(target);
606 /* no check by default */
607 static int default_check_reset(struct target *target)
612 int target_examine_one(struct target *target)
614 return target->type->examine(target);
617 static int jtag_enable_callback(enum jtag_event event, void *priv)
619 struct target *target = priv;
621 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
624 jtag_unregister_event_callback(jtag_enable_callback, target);
626 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
628 int retval = target_examine_one(target);
629 if (retval != ERROR_OK)
632 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
637 /* Targets that correctly implement init + examine, i.e.
638 * no communication with target during init:
642 int target_examine(void)
644 int retval = ERROR_OK;
645 struct target *target;
647 for (target = all_targets; target; target = target->next) {
648 /* defer examination, but don't skip it */
649 if (!target->tap->enabled) {
650 jtag_register_event_callback(jtag_enable_callback,
655 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
657 retval = target_examine_one(target);
658 if (retval != ERROR_OK)
661 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
666 const char *target_type_name(struct target *target)
668 return target->type->name;
671 static int target_soft_reset_halt(struct target *target)
673 if (!target_was_examined(target)) {
674 LOG_ERROR("Target not examined yet");
677 if (!target->type->soft_reset_halt) {
678 LOG_ERROR("Target %s does not support soft_reset_halt",
679 target_name(target));
682 return target->type->soft_reset_halt(target);
686 * Downloads a target-specific native code algorithm to the target,
687 * and executes it. * Note that some targets may need to set up, enable,
688 * and tear down a breakpoint (hard or * soft) to detect algorithm
689 * termination, while others may support lower overhead schemes where
690 * soft breakpoints embedded in the algorithm automatically terminate the
693 * @param target used to run the algorithm
694 * @param arch_info target-specific description of the algorithm.
696 int target_run_algorithm(struct target *target,
697 int num_mem_params, struct mem_param *mem_params,
698 int num_reg_params, struct reg_param *reg_param,
699 uint32_t entry_point, uint32_t exit_point,
700 int timeout_ms, void *arch_info)
702 int retval = ERROR_FAIL;
704 if (!target_was_examined(target)) {
705 LOG_ERROR("Target not examined yet");
708 if (!target->type->run_algorithm) {
709 LOG_ERROR("Target type '%s' does not support %s",
710 target_type_name(target), __func__);
714 target->running_alg = true;
715 retval = target->type->run_algorithm(target,
716 num_mem_params, mem_params,
717 num_reg_params, reg_param,
718 entry_point, exit_point, timeout_ms, arch_info);
719 target->running_alg = false;
726 * Downloads a target-specific native code algorithm to the target,
727 * executes and leaves it running.
729 * @param target used to run the algorithm
730 * @param arch_info target-specific description of the algorithm.
732 int target_start_algorithm(struct target *target,
733 int num_mem_params, struct mem_param *mem_params,
734 int num_reg_params, struct reg_param *reg_params,
735 uint32_t entry_point, uint32_t exit_point,
738 int retval = ERROR_FAIL;
740 if (!target_was_examined(target)) {
741 LOG_ERROR("Target not examined yet");
744 if (!target->type->start_algorithm) {
745 LOG_ERROR("Target type '%s' does not support %s",
746 target_type_name(target), __func__);
749 if (target->running_alg) {
750 LOG_ERROR("Target is already running an algorithm");
754 target->running_alg = true;
755 retval = target->type->start_algorithm(target,
756 num_mem_params, mem_params,
757 num_reg_params, reg_params,
758 entry_point, exit_point, arch_info);
765 * Waits for an algorithm started with target_start_algorithm() to complete.
767 * @param target used to run the algorithm
768 * @param arch_info target-specific description of the algorithm.
770 int target_wait_algorithm(struct target *target,
771 int num_mem_params, struct mem_param *mem_params,
772 int num_reg_params, struct reg_param *reg_params,
773 uint32_t exit_point, int timeout_ms,
776 int retval = ERROR_FAIL;
778 if (!target->type->wait_algorithm) {
779 LOG_ERROR("Target type '%s' does not support %s",
780 target_type_name(target), __func__);
783 if (!target->running_alg) {
784 LOG_ERROR("Target is not running an algorithm");
788 retval = target->type->wait_algorithm(target,
789 num_mem_params, mem_params,
790 num_reg_params, reg_params,
791 exit_point, timeout_ms, arch_info);
792 if (retval != ERROR_TARGET_TIMEOUT)
793 target->running_alg = false;
800 * Executes a target-specific native code algorithm in the target.
801 * It differs from target_run_algorithm in that the algorithm is asynchronous.
802 * Because of this it requires an compliant algorithm:
803 * see contrib/loaders/flash/stm32f1x.S for example.
805 * @param target used to run the algorithm
808 int target_run_flash_async_algorithm(struct target *target,
809 uint8_t *buffer, uint32_t count, int block_size,
810 int num_mem_params, struct mem_param *mem_params,
811 int num_reg_params, struct reg_param *reg_params,
812 uint32_t buffer_start, uint32_t buffer_size,
813 uint32_t entry_point, uint32_t exit_point, void *arch_info)
818 /* Set up working area. First word is write pointer, second word is read pointer,
819 * rest is fifo data area. */
820 uint32_t wp_addr = buffer_start;
821 uint32_t rp_addr = buffer_start + 4;
822 uint32_t fifo_start_addr = buffer_start + 8;
823 uint32_t fifo_end_addr = buffer_start + buffer_size;
825 uint32_t wp = fifo_start_addr;
826 uint32_t rp = fifo_start_addr;
828 /* validate block_size is 2^n */
829 assert(!block_size || !(block_size & (block_size - 1)));
831 retval = target_write_u32(target, wp_addr, wp);
832 if (retval != ERROR_OK)
834 retval = target_write_u32(target, rp_addr, rp);
835 if (retval != ERROR_OK)
838 /* Start up algorithm on target and let it idle while writing the first chunk */
839 retval = target_start_algorithm(target, num_mem_params, mem_params,
840 num_reg_params, reg_params,
845 if (retval != ERROR_OK) {
846 LOG_ERROR("error starting target flash write algorithm");
852 retval = target_read_u32(target, rp_addr, &rp);
853 if (retval != ERROR_OK) {
854 LOG_ERROR("failed to get read pointer");
858 LOG_DEBUG("count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32, count, wp, rp);
861 LOG_ERROR("flash write algorithm aborted by target");
862 retval = ERROR_FLASH_OPERATION_FAILED;
866 if ((rp & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
867 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
871 /* Count the number of bytes available in the fifo without
872 * crossing the wrap around. Make sure to not fill it completely,
873 * because that would make wp == rp and that's the empty condition. */
874 uint32_t thisrun_bytes;
876 thisrun_bytes = rp - wp - block_size;
877 else if (rp > fifo_start_addr)
878 thisrun_bytes = fifo_end_addr - wp;
880 thisrun_bytes = fifo_end_addr - wp - block_size;
882 if (thisrun_bytes == 0) {
883 /* Throttle polling a bit if transfer is (much) faster than flash
884 * programming. The exact delay shouldn't matter as long as it's
885 * less than buffer size / flash speed. This is very unlikely to
886 * run when using high latency connections such as USB. */
889 /* to stop an infinite loop on some targets check and increment a timeout
890 * this issue was observed on a stellaris using the new ICDI interface */
891 if (timeout++ >= 500) {
892 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
893 return ERROR_FLASH_OPERATION_FAILED;
898 /* reset our timeout */
901 /* Limit to the amount of data we actually want to write */
902 if (thisrun_bytes > count * block_size)
903 thisrun_bytes = count * block_size;
905 /* Write data to fifo */
906 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
907 if (retval != ERROR_OK)
910 /* Update counters and wrap write pointer */
911 buffer += thisrun_bytes;
912 count -= thisrun_bytes / block_size;
914 if (wp >= fifo_end_addr)
915 wp = fifo_start_addr;
917 /* Store updated write pointer to target */
918 retval = target_write_u32(target, wp_addr, wp);
919 if (retval != ERROR_OK)
923 if (retval != ERROR_OK) {
924 /* abort flash write algorithm on target */
925 target_write_u32(target, wp_addr, 0);
928 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
929 num_reg_params, reg_params,
934 if (retval2 != ERROR_OK) {
935 LOG_ERROR("error waiting for target flash write algorithm");
942 int target_read_memory(struct target *target,
943 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
945 if (!target_was_examined(target)) {
946 LOG_ERROR("Target not examined yet");
949 return target->type->read_memory(target, address, size, count, buffer);
952 int target_read_phys_memory(struct target *target,
953 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
955 if (!target_was_examined(target)) {
956 LOG_ERROR("Target not examined yet");
959 return target->type->read_phys_memory(target, address, size, count, buffer);
962 int target_write_memory(struct target *target,
963 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
965 if (!target_was_examined(target)) {
966 LOG_ERROR("Target not examined yet");
969 return target->type->write_memory(target, address, size, count, buffer);
972 int target_write_phys_memory(struct target *target,
973 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
975 if (!target_was_examined(target)) {
976 LOG_ERROR("Target not examined yet");
979 return target->type->write_phys_memory(target, address, size, count, buffer);
982 static int target_bulk_write_memory_default(struct target *target,
983 uint32_t address, uint32_t count, const uint8_t *buffer)
985 return target_write_memory(target, address, 4, count, buffer);
988 int target_add_breakpoint(struct target *target,
989 struct breakpoint *breakpoint)
991 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
992 LOG_WARNING("target %s is not halted", target_name(target));
993 return ERROR_TARGET_NOT_HALTED;
995 return target->type->add_breakpoint(target, breakpoint);
998 int target_add_context_breakpoint(struct target *target,
999 struct breakpoint *breakpoint)
1001 if (target->state != TARGET_HALTED) {
1002 LOG_WARNING("target %s is not halted", target_name(target));
1003 return ERROR_TARGET_NOT_HALTED;
1005 return target->type->add_context_breakpoint(target, breakpoint);
1008 int target_add_hybrid_breakpoint(struct target *target,
1009 struct breakpoint *breakpoint)
1011 if (target->state != TARGET_HALTED) {
1012 LOG_WARNING("target %s is not halted", target_name(target));
1013 return ERROR_TARGET_NOT_HALTED;
1015 return target->type->add_hybrid_breakpoint(target, breakpoint);
1018 int target_remove_breakpoint(struct target *target,
1019 struct breakpoint *breakpoint)
1021 return target->type->remove_breakpoint(target, breakpoint);
1024 int target_add_watchpoint(struct target *target,
1025 struct watchpoint *watchpoint)
1027 if (target->state != TARGET_HALTED) {
1028 LOG_WARNING("target %s is not halted", target_name(target));
1029 return ERROR_TARGET_NOT_HALTED;
1031 return target->type->add_watchpoint(target, watchpoint);
1033 int target_remove_watchpoint(struct target *target,
1034 struct watchpoint *watchpoint)
1036 return target->type->remove_watchpoint(target, watchpoint);
1039 int target_get_gdb_reg_list(struct target *target,
1040 struct reg **reg_list[], int *reg_list_size,
1041 enum target_register_class reg_class)
1043 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size, reg_class);
1045 int target_step(struct target *target,
1046 int current, uint32_t address, int handle_breakpoints)
1048 return target->type->step(target, current, address, handle_breakpoints);
1052 * Reset the @c examined flag for the given target.
1053 * Pure paranoia -- targets are zeroed on allocation.
1055 static void target_reset_examined(struct target *target)
1057 target->examined = false;
1060 static int err_read_phys_memory(struct target *target, uint32_t address,
1061 uint32_t size, uint32_t count, uint8_t *buffer)
1063 LOG_ERROR("Not implemented: %s", __func__);
1067 static int err_write_phys_memory(struct target *target, uint32_t address,
1068 uint32_t size, uint32_t count, const uint8_t *buffer)
1070 LOG_ERROR("Not implemented: %s", __func__);
1074 static int handle_target(void *priv);
1076 static int target_init_one(struct command_context *cmd_ctx,
1077 struct target *target)
1079 target_reset_examined(target);
1081 struct target_type *type = target->type;
1082 if (type->examine == NULL)
1083 type->examine = default_examine;
1085 if (type->check_reset == NULL)
1086 type->check_reset = default_check_reset;
1088 assert(type->init_target != NULL);
1090 int retval = type->init_target(cmd_ctx, target);
1091 if (ERROR_OK != retval) {
1092 LOG_ERROR("target '%s' init failed", target_name(target));
1096 /* Sanity-check MMU support ... stub in what we must, to help
1097 * implement it in stages, but warn if we need to do so.
1100 if (type->write_phys_memory == NULL) {
1101 LOG_ERROR("type '%s' is missing write_phys_memory",
1103 type->write_phys_memory = err_write_phys_memory;
1105 if (type->read_phys_memory == NULL) {
1106 LOG_ERROR("type '%s' is missing read_phys_memory",
1108 type->read_phys_memory = err_read_phys_memory;
1110 if (type->virt2phys == NULL) {
1111 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1112 type->virt2phys = identity_virt2phys;
1115 /* Make sure no-MMU targets all behave the same: make no
1116 * distinction between physical and virtual addresses, and
1117 * ensure that virt2phys() is always an identity mapping.
1119 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1120 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1123 type->write_phys_memory = type->write_memory;
1124 type->read_phys_memory = type->read_memory;
1125 type->virt2phys = identity_virt2phys;
1128 if (target->type->read_buffer == NULL)
1129 target->type->read_buffer = target_read_buffer_default;
1131 if (target->type->write_buffer == NULL)
1132 target->type->write_buffer = target_write_buffer_default;
1134 if (target->type->bulk_write_memory == NULL)
1135 target->type->bulk_write_memory = target_bulk_write_memory_default;
1140 static int target_init(struct command_context *cmd_ctx)
1142 struct target *target;
1145 for (target = all_targets; target; target = target->next) {
1146 retval = target_init_one(cmd_ctx, target);
1147 if (ERROR_OK != retval)
1154 retval = target_register_user_commands(cmd_ctx);
1155 if (ERROR_OK != retval)
1158 retval = target_register_timer_callback(&handle_target,
1159 polling_interval, 1, cmd_ctx->interp);
1160 if (ERROR_OK != retval)
1166 COMMAND_HANDLER(handle_target_init_command)
1171 return ERROR_COMMAND_SYNTAX_ERROR;
1173 static bool target_initialized;
1174 if (target_initialized) {
1175 LOG_INFO("'target init' has already been called");
1178 target_initialized = true;
1180 retval = command_run_line(CMD_CTX, "init_targets");
1181 if (ERROR_OK != retval)
1184 retval = command_run_line(CMD_CTX, "init_board");
1185 if (ERROR_OK != retval)
1188 LOG_DEBUG("Initializing targets...");
1189 return target_init(CMD_CTX);
1192 int target_register_event_callback(int (*callback)(struct target *target,
1193 enum target_event event, void *priv), void *priv)
1195 struct target_event_callback **callbacks_p = &target_event_callbacks;
1197 if (callback == NULL)
1198 return ERROR_COMMAND_SYNTAX_ERROR;
1201 while ((*callbacks_p)->next)
1202 callbacks_p = &((*callbacks_p)->next);
1203 callbacks_p = &((*callbacks_p)->next);
1206 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1207 (*callbacks_p)->callback = callback;
1208 (*callbacks_p)->priv = priv;
1209 (*callbacks_p)->next = NULL;
1214 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
1216 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1219 if (callback == NULL)
1220 return ERROR_COMMAND_SYNTAX_ERROR;
1223 while ((*callbacks_p)->next)
1224 callbacks_p = &((*callbacks_p)->next);
1225 callbacks_p = &((*callbacks_p)->next);
1228 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1229 (*callbacks_p)->callback = callback;
1230 (*callbacks_p)->periodic = periodic;
1231 (*callbacks_p)->time_ms = time_ms;
1233 gettimeofday(&now, NULL);
1234 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
1235 time_ms -= (time_ms % 1000);
1236 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
1237 if ((*callbacks_p)->when.tv_usec > 1000000) {
1238 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
1239 (*callbacks_p)->when.tv_sec += 1;
1242 (*callbacks_p)->priv = priv;
1243 (*callbacks_p)->next = NULL;
1248 int target_unregister_event_callback(int (*callback)(struct target *target,
1249 enum target_event event, void *priv), void *priv)
1251 struct target_event_callback **p = &target_event_callbacks;
1252 struct target_event_callback *c = target_event_callbacks;
1254 if (callback == NULL)
1255 return ERROR_COMMAND_SYNTAX_ERROR;
1258 struct target_event_callback *next = c->next;
1259 if ((c->callback == callback) && (c->priv == priv)) {
1271 static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1273 struct target_timer_callback **p = &target_timer_callbacks;
1274 struct target_timer_callback *c = target_timer_callbacks;
1276 if (callback == NULL)
1277 return ERROR_COMMAND_SYNTAX_ERROR;
1280 struct target_timer_callback *next = c->next;
1281 if ((c->callback == callback) && (c->priv == priv)) {
1293 int target_call_event_callbacks(struct target *target, enum target_event event)
1295 struct target_event_callback *callback = target_event_callbacks;
1296 struct target_event_callback *next_callback;
1298 if (event == TARGET_EVENT_HALTED) {
1299 /* execute early halted first */
1300 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1303 LOG_DEBUG("target event %i (%s)", event,
1304 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1306 target_handle_event(target, event);
1309 next_callback = callback->next;
1310 callback->callback(target, event, callback->priv);
1311 callback = next_callback;
1317 static int target_timer_callback_periodic_restart(
1318 struct target_timer_callback *cb, struct timeval *now)
1320 int time_ms = cb->time_ms;
1321 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1322 time_ms -= (time_ms % 1000);
1323 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1324 if (cb->when.tv_usec > 1000000) {
1325 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1326 cb->when.tv_sec += 1;
1331 static int target_call_timer_callback(struct target_timer_callback *cb,
1332 struct timeval *now)
1334 cb->callback(cb->priv);
1337 return target_timer_callback_periodic_restart(cb, now);
1339 return target_unregister_timer_callback(cb->callback, cb->priv);
1342 static int target_call_timer_callbacks_check_time(int checktime)
1347 gettimeofday(&now, NULL);
1349 struct target_timer_callback *callback = target_timer_callbacks;
1351 /* cleaning up may unregister and free this callback */
1352 struct target_timer_callback *next_callback = callback->next;
1354 bool call_it = callback->callback &&
1355 ((!checktime && callback->periodic) ||
1356 now.tv_sec > callback->when.tv_sec ||
1357 (now.tv_sec == callback->when.tv_sec &&
1358 now.tv_usec >= callback->when.tv_usec));
1361 int retval = target_call_timer_callback(callback, &now);
1362 if (retval != ERROR_OK)
1366 callback = next_callback;
1372 int target_call_timer_callbacks(void)
1374 return target_call_timer_callbacks_check_time(1);
1377 /* invoke periodic callbacks immediately */
1378 int target_call_timer_callbacks_now(void)
1380 return target_call_timer_callbacks_check_time(0);
1383 /* Prints the working area layout for debug purposes */
1384 static void print_wa_layout(struct target *target)
1386 struct working_area *c = target->working_areas;
1389 LOG_DEBUG("%c%c 0x%08"PRIx32"-0x%08"PRIx32" (%"PRIu32" bytes)",
1390 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1391 c->address, c->address + c->size - 1, c->size);
1396 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1397 static void target_split_working_area(struct working_area *area, uint32_t size)
1399 assert(area->free); /* Shouldn't split an allocated area */
1400 assert(size <= area->size); /* Caller should guarantee this */
1402 /* Split only if not already the right size */
1403 if (size < area->size) {
1404 struct working_area *new_wa = malloc(sizeof(*new_wa));
1409 new_wa->next = area->next;
1410 new_wa->size = area->size - size;
1411 new_wa->address = area->address + size;
1412 new_wa->backup = NULL;
1413 new_wa->user = NULL;
1414 new_wa->free = true;
1416 area->next = new_wa;
1419 /* If backup memory was allocated to this area, it has the wrong size
1420 * now so free it and it will be reallocated if/when needed */
1423 area->backup = NULL;
1428 /* Merge all adjacent free areas into one */
1429 static void target_merge_working_areas(struct target *target)
1431 struct working_area *c = target->working_areas;
1433 while (c && c->next) {
1434 assert(c->next->address == c->address + c->size); /* This is an invariant */
1436 /* Find two adjacent free areas */
1437 if (c->free && c->next->free) {
1438 /* Merge the last into the first */
1439 c->size += c->next->size;
1441 /* Remove the last */
1442 struct working_area *to_be_freed = c->next;
1443 c->next = c->next->next;
1444 if (to_be_freed->backup)
1445 free(to_be_freed->backup);
1448 /* If backup memory was allocated to the remaining area, it's has
1449 * the wrong size now */
1460 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1462 /* Reevaluate working area address based on MMU state*/
1463 if (target->working_areas == NULL) {
1467 retval = target->type->mmu(target, &enabled);
1468 if (retval != ERROR_OK)
1472 if (target->working_area_phys_spec) {
1473 LOG_DEBUG("MMU disabled, using physical "
1474 "address for working memory 0x%08"PRIx32,
1475 target->working_area_phys);
1476 target->working_area = target->working_area_phys;
1478 LOG_ERROR("No working memory available. "
1479 "Specify -work-area-phys to target.");
1480 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1483 if (target->working_area_virt_spec) {
1484 LOG_DEBUG("MMU enabled, using virtual "
1485 "address for working memory 0x%08"PRIx32,
1486 target->working_area_virt);
1487 target->working_area = target->working_area_virt;
1489 LOG_ERROR("No working memory available. "
1490 "Specify -work-area-virt to target.");
1491 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1495 /* Set up initial working area on first call */
1496 struct working_area *new_wa = malloc(sizeof(*new_wa));
1498 new_wa->next = NULL;
1499 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1500 new_wa->address = target->working_area;
1501 new_wa->backup = NULL;
1502 new_wa->user = NULL;
1503 new_wa->free = true;
1506 target->working_areas = new_wa;
1509 /* only allocate multiples of 4 byte */
1511 size = (size + 3) & (~3UL);
1513 struct working_area *c = target->working_areas;
1515 /* Find the first large enough working area */
1517 if (c->free && c->size >= size)
1523 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1525 /* Split the working area into the requested size */
1526 target_split_working_area(c, size);
1528 LOG_DEBUG("allocated new working area of %"PRIu32" bytes at address 0x%08"PRIx32, size, c->address);
1530 if (target->backup_working_area) {
1531 if (c->backup == NULL) {
1532 c->backup = malloc(c->size);
1533 if (c->backup == NULL)
1537 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1538 if (retval != ERROR_OK)
1542 /* mark as used, and return the new (reused) area */
1549 print_wa_layout(target);
1554 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1558 retval = target_alloc_working_area_try(target, size, area);
1559 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1560 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1565 static int target_restore_working_area(struct target *target, struct working_area *area)
1567 int retval = ERROR_OK;
1569 if (target->backup_working_area && area->backup != NULL) {
1570 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1571 if (retval != ERROR_OK)
1572 LOG_ERROR("failed to restore %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1573 area->size, area->address);
1579 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1580 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1582 int retval = ERROR_OK;
1588 retval = target_restore_working_area(target, area);
1589 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1590 if (retval != ERROR_OK)
1596 LOG_DEBUG("freed %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1597 area->size, area->address);
1599 /* mark user pointer invalid */
1600 /* TODO: Is this really safe? It points to some previous caller's memory.
1601 * How could we know that the area pointer is still in that place and not
1602 * some other vital data? What's the purpose of this, anyway? */
1606 target_merge_working_areas(target);
1608 print_wa_layout(target);
1613 int target_free_working_area(struct target *target, struct working_area *area)
1615 return target_free_working_area_restore(target, area, 1);
1618 /* free resources and restore memory, if restoring memory fails,
1619 * free up resources anyway
1621 static void target_free_all_working_areas_restore(struct target *target, int restore)
1623 struct working_area *c = target->working_areas;
1625 LOG_DEBUG("freeing all working areas");
1627 /* Loop through all areas, restoring the allocated ones and marking them as free */
1631 target_restore_working_area(target, c);
1633 *c->user = NULL; /* Same as above */
1639 /* Run a merge pass to combine all areas into one */
1640 target_merge_working_areas(target);
1642 print_wa_layout(target);
1645 void target_free_all_working_areas(struct target *target)
1647 target_free_all_working_areas_restore(target, 1);
1650 /* Find the largest number of bytes that can be allocated */
1651 uint32_t target_get_working_area_avail(struct target *target)
1653 struct working_area *c = target->working_areas;
1654 uint32_t max_size = 0;
1657 return target->working_area_size;
1660 if (c->free && max_size < c->size)
1669 int target_arch_state(struct target *target)
1672 if (target == NULL) {
1673 LOG_USER("No target has been configured");
1677 LOG_USER("target state: %s", target_state_name(target));
1679 if (target->state != TARGET_HALTED)
1682 retval = target->type->arch_state(target);
1686 /* Single aligned words are guaranteed to use 16 or 32 bit access
1687 * mode respectively, otherwise data is handled as quickly as
1690 int target_write_buffer(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1692 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x",
1693 (int)size, (unsigned)address);
1695 if (!target_was_examined(target)) {
1696 LOG_ERROR("Target not examined yet");
1703 if ((address + size - 1) < address) {
1704 /* GDB can request this when e.g. PC is 0xfffffffc*/
1705 LOG_ERROR("address + size wrapped(0x%08x, 0x%08x)",
1711 return target->type->write_buffer(target, address, size, buffer);
1714 static int target_write_buffer_default(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1716 int retval = ERROR_OK;
1718 if (((address % 2) == 0) && (size == 2))
1719 return target_write_memory(target, address, 2, 1, buffer);
1721 /* handle unaligned head bytes */
1723 uint32_t unaligned = 4 - (address % 4);
1725 if (unaligned > size)
1728 retval = target_write_memory(target, address, 1, unaligned, buffer);
1729 if (retval != ERROR_OK)
1732 buffer += unaligned;
1733 address += unaligned;
1737 /* handle aligned words */
1739 int aligned = size - (size % 4);
1741 /* use bulk writes above a certain limit. This may have to be changed */
1742 if (aligned > 128) {
1743 retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer);
1744 if (retval != ERROR_OK)
1747 retval = target_write_memory(target, address, 4, aligned / 4, buffer);
1748 if (retval != ERROR_OK)
1757 /* handle tail writes of less than 4 bytes */
1759 retval = target_write_memory(target, address, 1, size, buffer);
1760 if (retval != ERROR_OK)
1767 /* Single aligned words are guaranteed to use 16 or 32 bit access
1768 * mode respectively, otherwise data is handled as quickly as
1771 int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1773 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
1774 (int)size, (unsigned)address);
1776 if (!target_was_examined(target)) {
1777 LOG_ERROR("Target not examined yet");
1784 if ((address + size - 1) < address) {
1785 /* GDB can request this when e.g. PC is 0xfffffffc*/
1786 LOG_ERROR("address + size wrapped(0x%08" PRIx32 ", 0x%08" PRIx32 ")",
1792 return target->type->read_buffer(target, address, size, buffer);
1795 static int target_read_buffer_default(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1797 int retval = ERROR_OK;
1799 if (((address % 2) == 0) && (size == 2))
1800 return target_read_memory(target, address, 2, 1, buffer);
1802 /* handle unaligned head bytes */
1804 uint32_t unaligned = 4 - (address % 4);
1806 if (unaligned > size)
1809 retval = target_read_memory(target, address, 1, unaligned, buffer);
1810 if (retval != ERROR_OK)
1813 buffer += unaligned;
1814 address += unaligned;
1818 /* handle aligned words */
1820 int aligned = size - (size % 4);
1822 retval = target_read_memory(target, address, 4, aligned / 4, buffer);
1823 if (retval != ERROR_OK)
1831 /*prevent byte access when possible (avoid AHB access limitations in some cases)*/
1833 int aligned = size - (size % 2);
1834 retval = target_read_memory(target, address, 2, aligned / 2, buffer);
1835 if (retval != ERROR_OK)
1842 /* handle tail writes of less than 4 bytes */
1844 retval = target_read_memory(target, address, 1, size, buffer);
1845 if (retval != ERROR_OK)
1852 int target_checksum_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* crc)
1857 uint32_t checksum = 0;
1858 if (!target_was_examined(target)) {
1859 LOG_ERROR("Target not examined yet");
1863 retval = target->type->checksum_memory(target, address, size, &checksum);
1864 if (retval != ERROR_OK) {
1865 buffer = malloc(size);
1866 if (buffer == NULL) {
1867 LOG_ERROR("error allocating buffer for section (%d bytes)", (int)size);
1868 return ERROR_COMMAND_SYNTAX_ERROR;
1870 retval = target_read_buffer(target, address, size, buffer);
1871 if (retval != ERROR_OK) {
1876 /* convert to target endianness */
1877 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
1878 uint32_t target_data;
1879 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
1880 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
1883 retval = image_calculate_checksum(buffer, size, &checksum);
1892 int target_blank_check_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* blank)
1895 if (!target_was_examined(target)) {
1896 LOG_ERROR("Target not examined yet");
1900 if (target->type->blank_check_memory == 0)
1901 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1903 retval = target->type->blank_check_memory(target, address, size, blank);
1908 int target_read_u32(struct target *target, uint32_t address, uint32_t *value)
1910 uint8_t value_buf[4];
1911 if (!target_was_examined(target)) {
1912 LOG_ERROR("Target not examined yet");
1916 int retval = target_read_memory(target, address, 4, 1, value_buf);
1918 if (retval == ERROR_OK) {
1919 *value = target_buffer_get_u32(target, value_buf);
1920 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1925 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1932 int target_read_u16(struct target *target, uint32_t address, uint16_t *value)
1934 uint8_t value_buf[2];
1935 if (!target_was_examined(target)) {
1936 LOG_ERROR("Target not examined yet");
1940 int retval = target_read_memory(target, address, 2, 1, value_buf);
1942 if (retval == ERROR_OK) {
1943 *value = target_buffer_get_u16(target, value_buf);
1944 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4x",
1949 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1956 int target_read_u8(struct target *target, uint32_t address, uint8_t *value)
1958 int retval = target_read_memory(target, address, 1, 1, value);
1959 if (!target_was_examined(target)) {
1960 LOG_ERROR("Target not examined yet");
1964 if (retval == ERROR_OK) {
1965 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
1970 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1977 int target_write_u32(struct target *target, uint32_t address, uint32_t value)
1980 uint8_t value_buf[4];
1981 if (!target_was_examined(target)) {
1982 LOG_ERROR("Target not examined yet");
1986 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1990 target_buffer_set_u32(target, value_buf, value);
1991 retval = target_write_memory(target, address, 4, 1, value_buf);
1992 if (retval != ERROR_OK)
1993 LOG_DEBUG("failed: %i", retval);
1998 int target_write_u16(struct target *target, uint32_t address, uint16_t value)
2001 uint8_t value_buf[2];
2002 if (!target_was_examined(target)) {
2003 LOG_ERROR("Target not examined yet");
2007 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8x",
2011 target_buffer_set_u16(target, value_buf, value);
2012 retval = target_write_memory(target, address, 2, 1, value_buf);
2013 if (retval != ERROR_OK)
2014 LOG_DEBUG("failed: %i", retval);
2019 int target_write_u8(struct target *target, uint32_t address, uint8_t value)
2022 if (!target_was_examined(target)) {
2023 LOG_ERROR("Target not examined yet");
2027 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
2030 retval = target_write_memory(target, address, 1, 1, &value);
2031 if (retval != ERROR_OK)
2032 LOG_DEBUG("failed: %i", retval);
2037 static int find_target(struct command_context *cmd_ctx, const char *name)
2039 struct target *target = get_target(name);
2040 if (target == NULL) {
2041 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2044 if (!target->tap->enabled) {
2045 LOG_USER("Target: TAP %s is disabled, "
2046 "can't be the current target\n",
2047 target->tap->dotted_name);
2051 cmd_ctx->current_target = target->target_number;
2056 COMMAND_HANDLER(handle_targets_command)
2058 int retval = ERROR_OK;
2059 if (CMD_ARGC == 1) {
2060 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2061 if (retval == ERROR_OK) {
2067 struct target *target = all_targets;
2068 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2069 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2074 if (target->tap->enabled)
2075 state = target_state_name(target);
2077 state = "tap-disabled";
2079 if (CMD_CTX->current_target == target->target_number)
2082 /* keep columns lined up to match the headers above */
2083 command_print(CMD_CTX,
2084 "%2d%c %-18s %-10s %-6s %-18s %s",
2085 target->target_number,
2087 target_name(target),
2088 target_type_name(target),
2089 Jim_Nvp_value2name_simple(nvp_target_endian,
2090 target->endianness)->name,
2091 target->tap->dotted_name,
2093 target = target->next;
2099 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2101 static int powerDropout;
2102 static int srstAsserted;
2104 static int runPowerRestore;
2105 static int runPowerDropout;
2106 static int runSrstAsserted;
2107 static int runSrstDeasserted;
2109 static int sense_handler(void)
2111 static int prevSrstAsserted;
2112 static int prevPowerdropout;
2114 int retval = jtag_power_dropout(&powerDropout);
2115 if (retval != ERROR_OK)
2119 powerRestored = prevPowerdropout && !powerDropout;
2121 runPowerRestore = 1;
2123 long long current = timeval_ms();
2124 static long long lastPower;
2125 int waitMore = lastPower + 2000 > current;
2126 if (powerDropout && !waitMore) {
2127 runPowerDropout = 1;
2128 lastPower = current;
2131 retval = jtag_srst_asserted(&srstAsserted);
2132 if (retval != ERROR_OK)
2136 srstDeasserted = prevSrstAsserted && !srstAsserted;
2138 static long long lastSrst;
2139 waitMore = lastSrst + 2000 > current;
2140 if (srstDeasserted && !waitMore) {
2141 runSrstDeasserted = 1;
2145 if (!prevSrstAsserted && srstAsserted)
2146 runSrstAsserted = 1;
2148 prevSrstAsserted = srstAsserted;
2149 prevPowerdropout = powerDropout;
2151 if (srstDeasserted || powerRestored) {
2152 /* Other than logging the event we can't do anything here.
2153 * Issuing a reset is a particularly bad idea as we might
2154 * be inside a reset already.
2161 /* process target state changes */
2162 static int handle_target(void *priv)
2164 Jim_Interp *interp = (Jim_Interp *)priv;
2165 int retval = ERROR_OK;
2167 if (!is_jtag_poll_safe()) {
2168 /* polling is disabled currently */
2172 /* we do not want to recurse here... */
2173 static int recursive;
2177 /* danger! running these procedures can trigger srst assertions and power dropouts.
2178 * We need to avoid an infinite loop/recursion here and we do that by
2179 * clearing the flags after running these events.
2181 int did_something = 0;
2182 if (runSrstAsserted) {
2183 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2184 Jim_Eval(interp, "srst_asserted");
2187 if (runSrstDeasserted) {
2188 Jim_Eval(interp, "srst_deasserted");
2191 if (runPowerDropout) {
2192 LOG_INFO("Power dropout detected, running power_dropout proc.");
2193 Jim_Eval(interp, "power_dropout");
2196 if (runPowerRestore) {
2197 Jim_Eval(interp, "power_restore");
2201 if (did_something) {
2202 /* clear detect flags */
2206 /* clear action flags */
2208 runSrstAsserted = 0;
2209 runSrstDeasserted = 0;
2210 runPowerRestore = 0;
2211 runPowerDropout = 0;
2216 /* Poll targets for state changes unless that's globally disabled.
2217 * Skip targets that are currently disabled.
2219 for (struct target *target = all_targets;
2220 is_jtag_poll_safe() && target;
2221 target = target->next) {
2222 if (!target->tap->enabled)
2225 if (target->backoff.times > target->backoff.count) {
2226 /* do not poll this time as we failed previously */
2227 target->backoff.count++;
2230 target->backoff.count = 0;
2232 /* only poll target if we've got power and srst isn't asserted */
2233 if (!powerDropout && !srstAsserted) {
2234 /* polling may fail silently until the target has been examined */
2235 retval = target_poll(target);
2236 if (retval != ERROR_OK) {
2237 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2238 if (target->backoff.times * polling_interval < 5000) {
2239 target->backoff.times *= 2;
2240 target->backoff.times++;
2242 LOG_USER("Polling target %s failed, GDB will be halted. Polling again in %dms",
2243 target_name(target),
2244 target->backoff.times * polling_interval);
2246 /* Tell GDB to halt the debugger. This allows the user to
2247 * run monitor commands to handle the situation.
2249 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2252 /* Since we succeeded, we reset backoff count */
2253 if (target->backoff.times > 0)
2254 LOG_USER("Polling target %s succeeded again", target_name(target));
2255 target->backoff.times = 0;
2262 COMMAND_HANDLER(handle_reg_command)
2264 struct target *target;
2265 struct reg *reg = NULL;
2271 target = get_current_target(CMD_CTX);
2273 /* list all available registers for the current target */
2274 if (CMD_ARGC == 0) {
2275 struct reg_cache *cache = target->reg_cache;
2281 command_print(CMD_CTX, "===== %s", cache->name);
2283 for (i = 0, reg = cache->reg_list;
2284 i < cache->num_regs;
2285 i++, reg++, count++) {
2286 /* only print cached values if they are valid */
2288 value = buf_to_str(reg->value,
2290 command_print(CMD_CTX,
2291 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2299 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2304 cache = cache->next;
2310 /* access a single register by its ordinal number */
2311 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2313 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2315 struct reg_cache *cache = target->reg_cache;
2319 for (i = 0; i < cache->num_regs; i++) {
2320 if (count++ == num) {
2321 reg = &cache->reg_list[i];
2327 cache = cache->next;
2331 command_print(CMD_CTX, "%i is out of bounds, the current target "
2332 "has only %i registers (0 - %i)", num, count, count - 1);
2336 /* access a single register by its name */
2337 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2340 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2345 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2347 /* display a register */
2348 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2349 && (CMD_ARGV[1][0] <= '9')))) {
2350 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2353 if (reg->valid == 0)
2354 reg->type->get(reg);
2355 value = buf_to_str(reg->value, reg->size, 16);
2356 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2361 /* set register value */
2362 if (CMD_ARGC == 2) {
2363 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2366 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2368 reg->type->set(reg, buf);
2370 value = buf_to_str(reg->value, reg->size, 16);
2371 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2379 return ERROR_COMMAND_SYNTAX_ERROR;
2382 COMMAND_HANDLER(handle_poll_command)
2384 int retval = ERROR_OK;
2385 struct target *target = get_current_target(CMD_CTX);
2387 if (CMD_ARGC == 0) {
2388 command_print(CMD_CTX, "background polling: %s",
2389 jtag_poll_get_enabled() ? "on" : "off");
2390 command_print(CMD_CTX, "TAP: %s (%s)",
2391 target->tap->dotted_name,
2392 target->tap->enabled ? "enabled" : "disabled");
2393 if (!target->tap->enabled)
2395 retval = target_poll(target);
2396 if (retval != ERROR_OK)
2398 retval = target_arch_state(target);
2399 if (retval != ERROR_OK)
2401 } else if (CMD_ARGC == 1) {
2403 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2404 jtag_poll_set_enabled(enable);
2406 return ERROR_COMMAND_SYNTAX_ERROR;
2411 COMMAND_HANDLER(handle_wait_halt_command)
2414 return ERROR_COMMAND_SYNTAX_ERROR;
2416 unsigned ms = DEFAULT_HALT_TIMEOUT;
2417 if (1 == CMD_ARGC) {
2418 int retval = parse_uint(CMD_ARGV[0], &ms);
2419 if (ERROR_OK != retval)
2420 return ERROR_COMMAND_SYNTAX_ERROR;
2423 struct target *target = get_current_target(CMD_CTX);
2424 return target_wait_state(target, TARGET_HALTED, ms);
2427 /* wait for target state to change. The trick here is to have a low
2428 * latency for short waits and not to suck up all the CPU time
2431 * After 500ms, keep_alive() is invoked
2433 int target_wait_state(struct target *target, enum target_state state, int ms)
2436 long long then = 0, cur;
2440 retval = target_poll(target);
2441 if (retval != ERROR_OK)
2443 if (target->state == state)
2448 then = timeval_ms();
2449 LOG_DEBUG("waiting for target %s...",
2450 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2456 if ((cur-then) > ms) {
2457 LOG_ERROR("timed out while waiting for target %s",
2458 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2466 COMMAND_HANDLER(handle_halt_command)
2470 struct target *target = get_current_target(CMD_CTX);
2471 int retval = target_halt(target);
2472 if (ERROR_OK != retval)
2475 if (CMD_ARGC == 1) {
2476 unsigned wait_local;
2477 retval = parse_uint(CMD_ARGV[0], &wait_local);
2478 if (ERROR_OK != retval)
2479 return ERROR_COMMAND_SYNTAX_ERROR;
2484 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
2487 COMMAND_HANDLER(handle_soft_reset_halt_command)
2489 struct target *target = get_current_target(CMD_CTX);
2491 LOG_USER("requesting target halt and executing a soft reset");
2493 target_soft_reset_halt(target);
2498 COMMAND_HANDLER(handle_reset_command)
2501 return ERROR_COMMAND_SYNTAX_ERROR;
2503 enum target_reset_mode reset_mode = RESET_RUN;
2504 if (CMD_ARGC == 1) {
2506 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
2507 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
2508 return ERROR_COMMAND_SYNTAX_ERROR;
2509 reset_mode = n->value;
2512 /* reset *all* targets */
2513 return target_process_reset(CMD_CTX, reset_mode);
2517 COMMAND_HANDLER(handle_resume_command)
2521 return ERROR_COMMAND_SYNTAX_ERROR;
2523 struct target *target = get_current_target(CMD_CTX);
2525 /* with no CMD_ARGV, resume from current pc, addr = 0,
2526 * with one arguments, addr = CMD_ARGV[0],
2527 * handle breakpoints, not debugging */
2529 if (CMD_ARGC == 1) {
2530 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2534 return target_resume(target, current, addr, 1, 0);
2537 COMMAND_HANDLER(handle_step_command)
2540 return ERROR_COMMAND_SYNTAX_ERROR;
2544 /* with no CMD_ARGV, step from current pc, addr = 0,
2545 * with one argument addr = CMD_ARGV[0],
2546 * handle breakpoints, debugging */
2549 if (CMD_ARGC == 1) {
2550 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2554 struct target *target = get_current_target(CMD_CTX);
2556 return target->type->step(target, current_pc, addr, 1);
2559 static void handle_md_output(struct command_context *cmd_ctx,
2560 struct target *target, uint32_t address, unsigned size,
2561 unsigned count, const uint8_t *buffer)
2563 const unsigned line_bytecnt = 32;
2564 unsigned line_modulo = line_bytecnt / size;
2566 char output[line_bytecnt * 4 + 1];
2567 unsigned output_len = 0;
2569 const char *value_fmt;
2572 value_fmt = "%8.8x ";
2575 value_fmt = "%4.4x ";
2578 value_fmt = "%2.2x ";
2581 /* "can't happen", caller checked */
2582 LOG_ERROR("invalid memory read size: %u", size);
2586 for (unsigned i = 0; i < count; i++) {
2587 if (i % line_modulo == 0) {
2588 output_len += snprintf(output + output_len,
2589 sizeof(output) - output_len,
2591 (unsigned)(address + (i*size)));
2595 const uint8_t *value_ptr = buffer + i * size;
2598 value = target_buffer_get_u32(target, value_ptr);
2601 value = target_buffer_get_u16(target, value_ptr);
2606 output_len += snprintf(output + output_len,
2607 sizeof(output) - output_len,
2610 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
2611 command_print(cmd_ctx, "%s", output);
2617 COMMAND_HANDLER(handle_md_command)
2620 return ERROR_COMMAND_SYNTAX_ERROR;
2623 switch (CMD_NAME[2]) {
2634 return ERROR_COMMAND_SYNTAX_ERROR;
2637 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2638 int (*fn)(struct target *target,
2639 uint32_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
2643 fn = target_read_phys_memory;
2645 fn = target_read_memory;
2646 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
2647 return ERROR_COMMAND_SYNTAX_ERROR;
2650 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2654 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
2656 uint8_t *buffer = calloc(count, size);
2658 struct target *target = get_current_target(CMD_CTX);
2659 int retval = fn(target, address, size, count, buffer);
2660 if (ERROR_OK == retval)
2661 handle_md_output(CMD_CTX, target, address, size, count, buffer);
2668 typedef int (*target_write_fn)(struct target *target,
2669 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
2671 static int target_write_memory_fast(struct target *target,
2672 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
2674 return target_write_buffer(target, address, size * count, buffer);
2677 static int target_fill_mem(struct target *target,
2686 /* We have to write in reasonably large chunks to be able
2687 * to fill large memory areas with any sane speed */
2688 const unsigned chunk_size = 16384;
2689 uint8_t *target_buf = malloc(chunk_size * data_size);
2690 if (target_buf == NULL) {
2691 LOG_ERROR("Out of memory");
2695 for (unsigned i = 0; i < chunk_size; i++) {
2696 switch (data_size) {
2698 target_buffer_set_u32(target, target_buf + i * data_size, b);
2701 target_buffer_set_u16(target, target_buf + i * data_size, b);
2704 target_buffer_set_u8(target, target_buf + i * data_size, b);
2711 int retval = ERROR_OK;
2713 for (unsigned x = 0; x < c; x += chunk_size) {
2716 if (current > chunk_size)
2717 current = chunk_size;
2718 retval = fn(target, address + x * data_size, data_size, current, target_buf);
2719 if (retval != ERROR_OK)
2721 /* avoid GDB timeouts */
2730 COMMAND_HANDLER(handle_mw_command)
2733 return ERROR_COMMAND_SYNTAX_ERROR;
2734 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2739 fn = target_write_phys_memory;
2741 fn = target_write_memory_fast;
2742 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
2743 return ERROR_COMMAND_SYNTAX_ERROR;
2746 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2749 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2753 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
2755 struct target *target = get_current_target(CMD_CTX);
2757 switch (CMD_NAME[2]) {
2768 return ERROR_COMMAND_SYNTAX_ERROR;
2771 return target_fill_mem(target, address, fn, wordsize, value, count);
2774 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
2775 uint32_t *min_address, uint32_t *max_address)
2777 if (CMD_ARGC < 1 || CMD_ARGC > 5)
2778 return ERROR_COMMAND_SYNTAX_ERROR;
2780 /* a base address isn't always necessary,
2781 * default to 0x0 (i.e. don't relocate) */
2782 if (CMD_ARGC >= 2) {
2784 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2785 image->base_address = addr;
2786 image->base_address_set = 1;
2788 image->base_address_set = 0;
2790 image->start_address_set = 0;
2793 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], *min_address);
2794 if (CMD_ARGC == 5) {
2795 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], *max_address);
2796 /* use size (given) to find max (required) */
2797 *max_address += *min_address;
2800 if (*min_address > *max_address)
2801 return ERROR_COMMAND_SYNTAX_ERROR;
2806 COMMAND_HANDLER(handle_load_image_command)
2810 uint32_t image_size;
2811 uint32_t min_address = 0;
2812 uint32_t max_address = 0xffffffff;
2816 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
2817 &image, &min_address, &max_address);
2818 if (ERROR_OK != retval)
2821 struct target *target = get_current_target(CMD_CTX);
2823 struct duration bench;
2824 duration_start(&bench);
2826 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
2831 for (i = 0; i < image.num_sections; i++) {
2832 buffer = malloc(image.sections[i].size);
2833 if (buffer == NULL) {
2834 command_print(CMD_CTX,
2835 "error allocating buffer for section (%d bytes)",
2836 (int)(image.sections[i].size));
2840 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
2841 if (retval != ERROR_OK) {
2846 uint32_t offset = 0;
2847 uint32_t length = buf_cnt;
2849 /* DANGER!!! beware of unsigned comparision here!!! */
2851 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
2852 (image.sections[i].base_address < max_address)) {
2854 if (image.sections[i].base_address < min_address) {
2855 /* clip addresses below */
2856 offset += min_address-image.sections[i].base_address;
2860 if (image.sections[i].base_address + buf_cnt > max_address)
2861 length -= (image.sections[i].base_address + buf_cnt)-max_address;
2863 retval = target_write_buffer(target,
2864 image.sections[i].base_address + offset, length, buffer + offset);
2865 if (retval != ERROR_OK) {
2869 image_size += length;
2870 command_print(CMD_CTX, "%u bytes written at address 0x%8.8" PRIx32 "",
2871 (unsigned int)length,
2872 image.sections[i].base_address + offset);
2878 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2879 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
2880 "in %fs (%0.3f KiB/s)", image_size,
2881 duration_elapsed(&bench), duration_kbps(&bench, image_size));
2884 image_close(&image);
2890 COMMAND_HANDLER(handle_dump_image_command)
2892 struct fileio fileio;
2894 int retval, retvaltemp;
2895 uint32_t address, size;
2896 struct duration bench;
2897 struct target *target = get_current_target(CMD_CTX);
2900 return ERROR_COMMAND_SYNTAX_ERROR;
2902 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], address);
2903 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], size);
2905 uint32_t buf_size = (size > 4096) ? 4096 : size;
2906 buffer = malloc(buf_size);
2910 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
2911 if (retval != ERROR_OK) {
2916 duration_start(&bench);
2919 size_t size_written;
2920 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
2921 retval = target_read_buffer(target, address, this_run_size, buffer);
2922 if (retval != ERROR_OK)
2925 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2926 if (retval != ERROR_OK)
2929 size -= this_run_size;
2930 address += this_run_size;
2935 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2937 retval = fileio_size(&fileio, &filesize);
2938 if (retval != ERROR_OK)
2940 command_print(CMD_CTX,
2941 "dumped %ld bytes in %fs (%0.3f KiB/s)", (long)filesize,
2942 duration_elapsed(&bench), duration_kbps(&bench, filesize));
2945 retvaltemp = fileio_close(&fileio);
2946 if (retvaltemp != ERROR_OK)
2952 static COMMAND_HELPER(handle_verify_image_command_internal, int verify)
2956 uint32_t image_size;
2959 uint32_t checksum = 0;
2960 uint32_t mem_checksum = 0;
2964 struct target *target = get_current_target(CMD_CTX);
2967 return ERROR_COMMAND_SYNTAX_ERROR;
2970 LOG_ERROR("no target selected");
2974 struct duration bench;
2975 duration_start(&bench);
2977 if (CMD_ARGC >= 2) {
2979 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2980 image.base_address = addr;
2981 image.base_address_set = 1;
2983 image.base_address_set = 0;
2984 image.base_address = 0x0;
2987 image.start_address_set = 0;
2989 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
2990 if (retval != ERROR_OK)
2996 for (i = 0; i < image.num_sections; i++) {
2997 buffer = malloc(image.sections[i].size);
2998 if (buffer == NULL) {
2999 command_print(CMD_CTX,
3000 "error allocating buffer for section (%d bytes)",
3001 (int)(image.sections[i].size));
3004 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3005 if (retval != ERROR_OK) {
3011 /* calculate checksum of image */
3012 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3013 if (retval != ERROR_OK) {
3018 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3019 if (retval != ERROR_OK) {
3024 if (checksum != mem_checksum) {
3025 /* failed crc checksum, fall back to a binary compare */
3029 LOG_ERROR("checksum mismatch - attempting binary compare");
3031 data = (uint8_t *)malloc(buf_cnt);
3033 /* Can we use 32bit word accesses? */
3035 int count = buf_cnt;
3036 if ((count % 4) == 0) {
3040 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3041 if (retval == ERROR_OK) {
3043 for (t = 0; t < buf_cnt; t++) {
3044 if (data[t] != buffer[t]) {
3045 command_print(CMD_CTX,
3046 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3048 (unsigned)(t + image.sections[i].base_address),
3051 if (diffs++ >= 127) {
3052 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3064 command_print(CMD_CTX, "address 0x%08" PRIx32 " length 0x%08zx",
3065 image.sections[i].base_address,
3070 image_size += buf_cnt;
3073 command_print(CMD_CTX, "No more differences found.");
3076 retval = ERROR_FAIL;
3077 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3078 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3079 "in %fs (%0.3f KiB/s)", image_size,
3080 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3083 image_close(&image);
3088 COMMAND_HANDLER(handle_verify_image_command)
3090 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 1);
3093 COMMAND_HANDLER(handle_test_image_command)
3095 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 0);
3098 static int handle_bp_command_list(struct command_context *cmd_ctx)
3100 struct target *target = get_current_target(cmd_ctx);
3101 struct breakpoint *breakpoint = target->breakpoints;
3102 while (breakpoint) {
3103 if (breakpoint->type == BKPT_SOFT) {
3104 char *buf = buf_to_str(breakpoint->orig_instr,
3105 breakpoint->length, 16);
3106 command_print(cmd_ctx, "IVA breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i, 0x%s",
3107 breakpoint->address,
3109 breakpoint->set, buf);
3112 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3113 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3115 breakpoint->length, breakpoint->set);
3116 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3117 command_print(cmd_ctx, "Hybrid breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3118 breakpoint->address,
3119 breakpoint->length, breakpoint->set);
3120 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3123 command_print(cmd_ctx, "Breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3124 breakpoint->address,
3125 breakpoint->length, breakpoint->set);
3128 breakpoint = breakpoint->next;
3133 static int handle_bp_command_set(struct command_context *cmd_ctx,
3134 uint32_t addr, uint32_t asid, uint32_t length, int hw)
3136 struct target *target = get_current_target(cmd_ctx);
3139 int retval = breakpoint_add(target, addr, length, hw);
3140 if (ERROR_OK == retval)
3141 command_print(cmd_ctx, "breakpoint set at 0x%8.8" PRIx32 "", addr);
3143 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3146 } else if (addr == 0) {
3147 int retval = context_breakpoint_add(target, asid, length, hw);
3148 if (ERROR_OK == retval)
3149 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3151 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3155 int retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3156 if (ERROR_OK == retval)
3157 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3159 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3166 COMMAND_HANDLER(handle_bp_command)
3175 return handle_bp_command_list(CMD_CTX);
3179 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3180 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3181 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3184 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3186 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3188 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3191 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3192 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3194 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3195 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3197 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3202 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3203 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3204 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3205 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3208 return ERROR_COMMAND_SYNTAX_ERROR;
3212 COMMAND_HANDLER(handle_rbp_command)
3215 return ERROR_COMMAND_SYNTAX_ERROR;
3218 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3220 struct target *target = get_current_target(CMD_CTX);
3221 breakpoint_remove(target, addr);
3226 COMMAND_HANDLER(handle_wp_command)
3228 struct target *target = get_current_target(CMD_CTX);
3230 if (CMD_ARGC == 0) {
3231 struct watchpoint *watchpoint = target->watchpoints;
3233 while (watchpoint) {
3234 command_print(CMD_CTX, "address: 0x%8.8" PRIx32
3235 ", len: 0x%8.8" PRIx32
3236 ", r/w/a: %i, value: 0x%8.8" PRIx32
3237 ", mask: 0x%8.8" PRIx32,
3238 watchpoint->address,
3240 (int)watchpoint->rw,
3243 watchpoint = watchpoint->next;
3248 enum watchpoint_rw type = WPT_ACCESS;
3250 uint32_t length = 0;
3251 uint32_t data_value = 0x0;
3252 uint32_t data_mask = 0xffffffff;
3256 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3259 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3262 switch (CMD_ARGV[2][0]) {
3273 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3274 return ERROR_COMMAND_SYNTAX_ERROR;
3278 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3279 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3283 return ERROR_COMMAND_SYNTAX_ERROR;
3286 int retval = watchpoint_add(target, addr, length, type,
3287 data_value, data_mask);
3288 if (ERROR_OK != retval)
3289 LOG_ERROR("Failure setting watchpoints");
3294 COMMAND_HANDLER(handle_rwp_command)
3297 return ERROR_COMMAND_SYNTAX_ERROR;
3300 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3302 struct target *target = get_current_target(CMD_CTX);
3303 watchpoint_remove(target, addr);
3309 * Translate a virtual address to a physical address.
3311 * The low-level target implementation must have logged a detailed error
3312 * which is forwarded to telnet/GDB session.
3314 COMMAND_HANDLER(handle_virt2phys_command)
3317 return ERROR_COMMAND_SYNTAX_ERROR;
3320 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], va);
3323 struct target *target = get_current_target(CMD_CTX);
3324 int retval = target->type->virt2phys(target, va, &pa);
3325 if (retval == ERROR_OK)
3326 command_print(CMD_CTX, "Physical address 0x%08" PRIx32 "", pa);
3331 static void writeData(FILE *f, const void *data, size_t len)
3333 size_t written = fwrite(data, 1, len, f);
3335 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3338 static void writeLong(FILE *f, int l)
3341 for (i = 0; i < 4; i++) {
3342 char c = (l >> (i*8))&0xff;
3343 writeData(f, &c, 1);
3348 static void writeString(FILE *f, char *s)
3350 writeData(f, s, strlen(s));
3353 /* Dump a gmon.out histogram file. */
3354 static void writeGmon(uint32_t *samples, uint32_t sampleNum, const char *filename)
3357 FILE *f = fopen(filename, "w");
3360 writeString(f, "gmon");
3361 writeLong(f, 0x00000001); /* Version */
3362 writeLong(f, 0); /* padding */
3363 writeLong(f, 0); /* padding */
3364 writeLong(f, 0); /* padding */
3366 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3367 writeData(f, &zero, 1);
3369 /* figure out bucket size */
3370 uint32_t min = samples[0];
3371 uint32_t max = samples[0];
3372 for (i = 0; i < sampleNum; i++) {
3373 if (min > samples[i])
3375 if (max < samples[i])
3379 int addressSpace = (max - min + 1);
3380 assert(addressSpace >= 2);
3382 static const uint32_t maxBuckets = 16 * 1024; /* maximum buckets. */
3383 uint32_t length = addressSpace;
3384 if (length > maxBuckets)
3385 length = maxBuckets;
3386 int *buckets = malloc(sizeof(int)*length);
3387 if (buckets == NULL) {
3391 memset(buckets, 0, sizeof(int) * length);
3392 for (i = 0; i < sampleNum; i++) {
3393 uint32_t address = samples[i];
3394 long long a = address - min;
3395 long long b = length - 1;
3396 long long c = addressSpace - 1;
3397 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
3401 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3402 writeLong(f, min); /* low_pc */
3403 writeLong(f, max); /* high_pc */
3404 writeLong(f, length); /* # of samples */
3405 writeLong(f, 100); /* KLUDGE! We lie, ca. 100Hz best case. */
3406 writeString(f, "seconds");
3407 for (i = 0; i < (15-strlen("seconds")); i++)
3408 writeData(f, &zero, 1);
3409 writeString(f, "s");
3411 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3413 char *data = malloc(2 * length);
3415 for (i = 0; i < length; i++) {
3420 data[i * 2] = val&0xff;
3421 data[i * 2 + 1] = (val >> 8) & 0xff;
3424 writeData(f, data, length * 2);
3432 /* profiling samples the CPU PC as quickly as OpenOCD is able,
3433 * which will be used as a random sampling of PC */
3434 COMMAND_HANDLER(handle_profile_command)
3436 struct target *target = get_current_target(CMD_CTX);
3437 struct timeval timeout, now;
3439 gettimeofday(&timeout, NULL);
3441 return ERROR_COMMAND_SYNTAX_ERROR;
3443 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], offset);
3445 timeval_add_time(&timeout, offset, 0);
3448 * @todo: Some cores let us sample the PC without the
3449 * annoying halt/resume step; for example, ARMv7 PCSR.
3450 * Provide a way to use that more efficient mechanism.
3453 command_print(CMD_CTX, "Starting profiling. Halting and resuming the target as often as we can...");
3455 static const int maxSample = 10000;
3456 uint32_t *samples = malloc(sizeof(uint32_t)*maxSample);
3457 if (samples == NULL)
3461 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
3462 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
3464 int retval = ERROR_OK;
3466 target_poll(target);
3467 if (target->state == TARGET_HALTED) {
3468 uint32_t t = *((uint32_t *)reg->value);
3469 samples[numSamples++] = t;
3470 /* current pc, addr = 0, do not handle breakpoints, not debugging */
3471 retval = target_resume(target, 1, 0, 0, 0);
3472 target_poll(target);
3473 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
3474 } else if (target->state == TARGET_RUNNING) {
3475 /* We want to quickly sample the PC. */
3476 retval = target_halt(target);
3477 if (retval != ERROR_OK) {
3482 command_print(CMD_CTX, "Target not halted or running");
3486 if (retval != ERROR_OK)
3489 gettimeofday(&now, NULL);
3490 if ((numSamples >= maxSample) || ((now.tv_sec >= timeout.tv_sec)
3491 && (now.tv_usec >= timeout.tv_usec))) {
3492 command_print(CMD_CTX, "Profiling completed. %d samples.", numSamples);
3493 retval = target_poll(target);
3494 if (retval != ERROR_OK) {
3498 if (target->state == TARGET_HALTED) {
3499 /* current pc, addr = 0, do not handle
3500 * breakpoints, not debugging */
3501 target_resume(target, 1, 0, 0, 0);
3503 retval = target_poll(target);
3504 if (retval != ERROR_OK) {
3508 writeGmon(samples, numSamples, CMD_ARGV[1]);
3509 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
3518 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
3521 Jim_Obj *nameObjPtr, *valObjPtr;
3524 namebuf = alloc_printf("%s(%d)", varname, idx);
3528 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3529 valObjPtr = Jim_NewIntObj(interp, val);
3530 if (!nameObjPtr || !valObjPtr) {
3535 Jim_IncrRefCount(nameObjPtr);
3536 Jim_IncrRefCount(valObjPtr);
3537 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3538 Jim_DecrRefCount(interp, nameObjPtr);
3539 Jim_DecrRefCount(interp, valObjPtr);
3541 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
3545 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3547 struct command_context *context;
3548 struct target *target;
3550 context = current_command_context(interp);
3551 assert(context != NULL);
3553 target = get_current_target(context);
3554 if (target == NULL) {
3555 LOG_ERROR("mem2array: no current target");
3559 return target_mem2array(interp, target, argc - 1, argv + 1);
3562 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
3570 const char *varname;
3574 /* argv[1] = name of array to receive the data
3575 * argv[2] = desired width
3576 * argv[3] = memory address
3577 * argv[4] = count of times to read
3580 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
3583 varname = Jim_GetString(argv[0], &len);
3584 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3586 e = Jim_GetLong(interp, argv[1], &l);
3591 e = Jim_GetLong(interp, argv[2], &l);
3595 e = Jim_GetLong(interp, argv[3], &l);
3610 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3611 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3615 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3616 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
3619 if ((addr + (len * width)) < addr) {
3620 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3621 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
3624 /* absurd transfer size? */
3626 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3627 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
3632 ((width == 2) && ((addr & 1) == 0)) ||
3633 ((width == 4) && ((addr & 3) == 0))) {
3637 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3638 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
3641 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3650 size_t buffersize = 4096;
3651 uint8_t *buffer = malloc(buffersize);
3658 /* Slurp... in buffer size chunks */
3660 count = len; /* in objects.. */
3661 if (count > (buffersize / width))
3662 count = (buffersize / width);
3664 retval = target_read_memory(target, addr, width, count, buffer);
3665 if (retval != ERROR_OK) {
3667 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed",
3671 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3672 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
3676 v = 0; /* shut up gcc */
3677 for (i = 0; i < count ; i++, n++) {
3680 v = target_buffer_get_u32(target, &buffer[i*width]);
3683 v = target_buffer_get_u16(target, &buffer[i*width]);
3686 v = buffer[i] & 0x0ff;
3689 new_int_array_element(interp, varname, n, v);
3697 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3702 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
3705 Jim_Obj *nameObjPtr, *valObjPtr;
3709 namebuf = alloc_printf("%s(%d)", varname, idx);
3713 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3719 Jim_IncrRefCount(nameObjPtr);
3720 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
3721 Jim_DecrRefCount(interp, nameObjPtr);
3723 if (valObjPtr == NULL)
3726 result = Jim_GetLong(interp, valObjPtr, &l);
3727 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
3732 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3734 struct command_context *context;
3735 struct target *target;
3737 context = current_command_context(interp);
3738 assert(context != NULL);
3740 target = get_current_target(context);
3741 if (target == NULL) {
3742 LOG_ERROR("array2mem: no current target");
3746 return target_array2mem(interp, target, argc-1, argv + 1);
3749 static int target_array2mem(Jim_Interp *interp, struct target *target,
3750 int argc, Jim_Obj *const *argv)
3758 const char *varname;
3762 /* argv[1] = name of array to get the data
3763 * argv[2] = desired width
3764 * argv[3] = memory address
3765 * argv[4] = count to write
3768 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems");
3771 varname = Jim_GetString(argv[0], &len);
3772 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3774 e = Jim_GetLong(interp, argv[1], &l);
3779 e = Jim_GetLong(interp, argv[2], &l);
3783 e = Jim_GetLong(interp, argv[3], &l);
3798 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3799 Jim_AppendStrings(interp, Jim_GetResult(interp),
3800 "Invalid width param, must be 8/16/32", NULL);
3804 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3805 Jim_AppendStrings(interp, Jim_GetResult(interp),
3806 "array2mem: zero width read?", NULL);
3809 if ((addr + (len * width)) < addr) {
3810 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3811 Jim_AppendStrings(interp, Jim_GetResult(interp),
3812 "array2mem: addr + len - wraps to zero?", NULL);
3815 /* absurd transfer size? */
3817 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3818 Jim_AppendStrings(interp, Jim_GetResult(interp),
3819 "array2mem: absurd > 64K item request", NULL);
3824 ((width == 2) && ((addr & 1) == 0)) ||
3825 ((width == 4) && ((addr & 3) == 0))) {
3829 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3830 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads",
3833 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3844 size_t buffersize = 4096;
3845 uint8_t *buffer = malloc(buffersize);
3850 /* Slurp... in buffer size chunks */
3852 count = len; /* in objects.. */
3853 if (count > (buffersize / width))
3854 count = (buffersize / width);
3856 v = 0; /* shut up gcc */
3857 for (i = 0; i < count; i++, n++) {
3858 get_int_array_element(interp, varname, n, &v);
3861 target_buffer_set_u32(target, &buffer[i * width], v);
3864 target_buffer_set_u16(target, &buffer[i * width], v);
3867 buffer[i] = v & 0x0ff;
3873 retval = target_write_memory(target, addr, width, count, buffer);
3874 if (retval != ERROR_OK) {
3876 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed",
3880 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3881 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
3889 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3894 /* FIX? should we propagate errors here rather than printing them
3897 void target_handle_event(struct target *target, enum target_event e)
3899 struct target_event_action *teap;
3901 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3902 if (teap->event == e) {
3903 LOG_DEBUG("target: (%d) %s (%s) event: %d (%s) action: %s",
3904 target->target_number,
3905 target_name(target),
3906 target_type_name(target),
3908 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
3909 Jim_GetString(teap->body, NULL));
3910 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
3911 Jim_MakeErrorMessage(teap->interp);
3912 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
3919 * Returns true only if the target has a handler for the specified event.
3921 bool target_has_event_action(struct target *target, enum target_event event)
3923 struct target_event_action *teap;
3925 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3926 if (teap->event == event)
3932 enum target_cfg_param {
3935 TCFG_WORK_AREA_VIRT,
3936 TCFG_WORK_AREA_PHYS,
3937 TCFG_WORK_AREA_SIZE,
3938 TCFG_WORK_AREA_BACKUP,
3942 TCFG_CHAIN_POSITION,
3947 static Jim_Nvp nvp_config_opts[] = {
3948 { .name = "-type", .value = TCFG_TYPE },
3949 { .name = "-event", .value = TCFG_EVENT },
3950 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
3951 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
3952 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
3953 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
3954 { .name = "-endian" , .value = TCFG_ENDIAN },
3955 { .name = "-variant", .value = TCFG_VARIANT },
3956 { .name = "-coreid", .value = TCFG_COREID },
3957 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
3958 { .name = "-dbgbase", .value = TCFG_DBGBASE },
3959 { .name = "-rtos", .value = TCFG_RTOS },
3960 { .name = NULL, .value = -1 }
3963 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
3971 /* parse config or cget options ... */
3972 while (goi->argc > 0) {
3973 Jim_SetEmptyResult(goi->interp);
3974 /* Jim_GetOpt_Debug(goi); */
3976 if (target->type->target_jim_configure) {
3977 /* target defines a configure function */
3978 /* target gets first dibs on parameters */
3979 e = (*(target->type->target_jim_configure))(target, goi);
3988 /* otherwise we 'continue' below */
3990 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
3992 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
3998 if (goi->isconfigure) {
3999 Jim_SetResultFormatted(goi->interp,
4000 "not settable: %s", n->name);
4004 if (goi->argc != 0) {
4005 Jim_WrongNumArgs(goi->interp,
4006 goi->argc, goi->argv,
4011 Jim_SetResultString(goi->interp,
4012 target_type_name(target), -1);
4016 if (goi->argc == 0) {
4017 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4021 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4023 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4027 if (goi->isconfigure) {
4028 if (goi->argc != 1) {
4029 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4033 if (goi->argc != 0) {
4034 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4040 struct target_event_action *teap;
4042 teap = target->event_action;
4043 /* replace existing? */
4045 if (teap->event == (enum target_event)n->value)
4050 if (goi->isconfigure) {
4051 bool replace = true;
4054 teap = calloc(1, sizeof(*teap));
4057 teap->event = n->value;
4058 teap->interp = goi->interp;
4059 Jim_GetOpt_Obj(goi, &o);
4061 Jim_DecrRefCount(teap->interp, teap->body);
4062 teap->body = Jim_DuplicateObj(goi->interp, o);
4065 * Tcl/TK - "tk events" have a nice feature.
4066 * See the "BIND" command.
4067 * We should support that here.
4068 * You can specify %X and %Y in the event code.
4069 * The idea is: %T - target name.
4070 * The idea is: %N - target number
4071 * The idea is: %E - event name.
4073 Jim_IncrRefCount(teap->body);
4076 /* add to head of event list */
4077 teap->next = target->event_action;
4078 target->event_action = teap;
4080 Jim_SetEmptyResult(goi->interp);
4084 Jim_SetEmptyResult(goi->interp);
4086 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4092 case TCFG_WORK_AREA_VIRT:
4093 if (goi->isconfigure) {
4094 target_free_all_working_areas(target);
4095 e = Jim_GetOpt_Wide(goi, &w);
4098 target->working_area_virt = w;
4099 target->working_area_virt_spec = true;
4104 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4108 case TCFG_WORK_AREA_PHYS:
4109 if (goi->isconfigure) {
4110 target_free_all_working_areas(target);
4111 e = Jim_GetOpt_Wide(goi, &w);
4114 target->working_area_phys = w;
4115 target->working_area_phys_spec = true;
4120 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4124 case TCFG_WORK_AREA_SIZE:
4125 if (goi->isconfigure) {
4126 target_free_all_working_areas(target);
4127 e = Jim_GetOpt_Wide(goi, &w);
4130 target->working_area_size = w;
4135 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4139 case TCFG_WORK_AREA_BACKUP:
4140 if (goi->isconfigure) {
4141 target_free_all_working_areas(target);
4142 e = Jim_GetOpt_Wide(goi, &w);
4145 /* make this exactly 1 or 0 */
4146 target->backup_working_area = (!!w);
4151 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4152 /* loop for more e*/
4157 if (goi->isconfigure) {
4158 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4160 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4163 target->endianness = n->value;
4168 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4169 if (n->name == NULL) {
4170 target->endianness = TARGET_LITTLE_ENDIAN;
4171 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4173 Jim_SetResultString(goi->interp, n->name, -1);
4178 if (goi->isconfigure) {
4179 if (goi->argc < 1) {
4180 Jim_SetResultFormatted(goi->interp,
4185 if (target->variant)
4186 free((void *)(target->variant));
4187 e = Jim_GetOpt_String(goi, &cp, NULL);
4190 target->variant = strdup(cp);
4195 Jim_SetResultString(goi->interp, target->variant, -1);
4200 if (goi->isconfigure) {
4201 e = Jim_GetOpt_Wide(goi, &w);
4204 target->coreid = (int32_t)w;
4209 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4213 case TCFG_CHAIN_POSITION:
4214 if (goi->isconfigure) {
4216 struct jtag_tap *tap;
4217 target_free_all_working_areas(target);
4218 e = Jim_GetOpt_Obj(goi, &o_t);
4221 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4224 /* make this exactly 1 or 0 */
4230 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4231 /* loop for more e*/
4234 if (goi->isconfigure) {
4235 e = Jim_GetOpt_Wide(goi, &w);
4238 target->dbgbase = (uint32_t)w;
4239 target->dbgbase_set = true;
4244 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4251 int result = rtos_create(goi, target);
4252 if (result != JIM_OK)
4258 } /* while (goi->argc) */
4261 /* done - we return */
4265 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4269 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4270 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4271 int need_args = 1 + goi.isconfigure;
4272 if (goi.argc < need_args) {
4273 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4275 ? "missing: -option VALUE ..."
4276 : "missing: -option ...");
4279 struct target *target = Jim_CmdPrivData(goi.interp);
4280 return target_configure(&goi, target);
4283 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4285 const char *cmd_name = Jim_GetString(argv[0], NULL);
4288 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4290 if (goi.argc < 2 || goi.argc > 4) {
4291 Jim_SetResultFormatted(goi.interp,
4292 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4297 fn = target_write_memory_fast;
4300 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4302 struct Jim_Obj *obj;
4303 e = Jim_GetOpt_Obj(&goi, &obj);
4307 fn = target_write_phys_memory;
4311 e = Jim_GetOpt_Wide(&goi, &a);
4316 e = Jim_GetOpt_Wide(&goi, &b);
4321 if (goi.argc == 1) {
4322 e = Jim_GetOpt_Wide(&goi, &c);
4327 /* all args must be consumed */
4331 struct target *target = Jim_CmdPrivData(goi.interp);
4333 if (strcasecmp(cmd_name, "mww") == 0)
4335 else if (strcasecmp(cmd_name, "mwh") == 0)
4337 else if (strcasecmp(cmd_name, "mwb") == 0)
4340 LOG_ERROR("command '%s' unknown: ", cmd_name);
4344 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4348 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4350 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4351 * mdh [phys] <address> [<count>] - for 16 bit reads
4352 * mdb [phys] <address> [<count>] - for 8 bit reads
4354 * Count defaults to 1.
4356 * Calls target_read_memory or target_read_phys_memory depending on
4357 * the presence of the "phys" argument
4358 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4359 * to int representation in base16.
4360 * Also outputs read data in a human readable form using command_print
4362 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4363 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4364 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4365 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4366 * on success, with [<count>] number of elements.
4368 * In case of little endian target:
4369 * Example1: "mdw 0x00000000" returns "10123456"
4370 * Exmaple2: "mdh 0x00000000 1" returns "3456"
4371 * Example3: "mdb 0x00000000" returns "56"
4372 * Example4: "mdh 0x00000000 2" returns "3456 1012"
4373 * Example5: "mdb 0x00000000 3" returns "56 34 12"
4375 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4377 const char *cmd_name = Jim_GetString(argv[0], NULL);
4380 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4382 if ((goi.argc < 1) || (goi.argc > 3)) {
4383 Jim_SetResultFormatted(goi.interp,
4384 "usage: %s [phys] <address> [<count>]", cmd_name);
4388 int (*fn)(struct target *target,
4389 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
4390 fn = target_read_memory;
4393 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4395 struct Jim_Obj *obj;
4396 e = Jim_GetOpt_Obj(&goi, &obj);
4400 fn = target_read_phys_memory;
4403 /* Read address parameter */
4405 e = Jim_GetOpt_Wide(&goi, &addr);
4409 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
4411 if (goi.argc == 1) {
4412 e = Jim_GetOpt_Wide(&goi, &count);
4418 /* all args must be consumed */
4422 jim_wide dwidth = 1; /* shut up gcc */
4423 if (strcasecmp(cmd_name, "mdw") == 0)
4425 else if (strcasecmp(cmd_name, "mdh") == 0)
4427 else if (strcasecmp(cmd_name, "mdb") == 0)
4430 LOG_ERROR("command '%s' unknown: ", cmd_name);
4434 /* convert count to "bytes" */
4435 int bytes = count * dwidth;
4437 struct target *target = Jim_CmdPrivData(goi.interp);
4438 uint8_t target_buf[32];
4441 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
4443 /* Try to read out next block */
4444 e = fn(target, addr, dwidth, y / dwidth, target_buf);
4446 if (e != ERROR_OK) {
4447 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
4451 command_print_sameline(NULL, "0x%08x ", (int)(addr));
4454 for (x = 0; x < 16 && x < y; x += 4) {
4455 z = target_buffer_get_u32(target, &(target_buf[x]));
4456 command_print_sameline(NULL, "%08x ", (int)(z));
4458 for (; (x < 16) ; x += 4)
4459 command_print_sameline(NULL, " ");
4462 for (x = 0; x < 16 && x < y; x += 2) {
4463 z = target_buffer_get_u16(target, &(target_buf[x]));
4464 command_print_sameline(NULL, "%04x ", (int)(z));
4466 for (; (x < 16) ; x += 2)
4467 command_print_sameline(NULL, " ");
4471 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
4472 z = target_buffer_get_u8(target, &(target_buf[x]));
4473 command_print_sameline(NULL, "%02x ", (int)(z));
4475 for (; (x < 16) ; x += 1)
4476 command_print_sameline(NULL, " ");
4479 /* ascii-ify the bytes */
4480 for (x = 0 ; x < y ; x++) {
4481 if ((target_buf[x] >= 0x20) &&
4482 (target_buf[x] <= 0x7e)) {
4486 target_buf[x] = '.';
4491 target_buf[x] = ' ';
4496 /* print - with a newline */
4497 command_print_sameline(NULL, "%s\n", target_buf);
4505 static int jim_target_mem2array(Jim_Interp *interp,
4506 int argc, Jim_Obj *const *argv)
4508 struct target *target = Jim_CmdPrivData(interp);
4509 return target_mem2array(interp, target, argc - 1, argv + 1);
4512 static int jim_target_array2mem(Jim_Interp *interp,
4513 int argc, Jim_Obj *const *argv)
4515 struct target *target = Jim_CmdPrivData(interp);
4516 return target_array2mem(interp, target, argc - 1, argv + 1);
4519 static int jim_target_tap_disabled(Jim_Interp *interp)
4521 Jim_SetResultFormatted(interp, "[TAP is disabled]");
4525 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4528 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4531 struct target *target = Jim_CmdPrivData(interp);
4532 if (!target->tap->enabled)
4533 return jim_target_tap_disabled(interp);
4535 int e = target->type->examine(target);
4541 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4544 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4547 struct target *target = Jim_CmdPrivData(interp);
4549 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
4555 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4558 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4561 struct target *target = Jim_CmdPrivData(interp);
4562 if (!target->tap->enabled)
4563 return jim_target_tap_disabled(interp);
4566 if (!(target_was_examined(target)))
4567 e = ERROR_TARGET_NOT_EXAMINED;
4569 e = target->type->poll(target);
4575 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4578 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4580 if (goi.argc != 2) {
4581 Jim_WrongNumArgs(interp, 0, argv,
4582 "([tT]|[fF]|assert|deassert) BOOL");
4587 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
4589 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
4592 /* the halt or not param */
4594 e = Jim_GetOpt_Wide(&goi, &a);
4598 struct target *target = Jim_CmdPrivData(goi.interp);
4599 if (!target->tap->enabled)
4600 return jim_target_tap_disabled(interp);
4601 if (!(target_was_examined(target))) {
4602 LOG_ERROR("Target not examined yet");
4603 return ERROR_TARGET_NOT_EXAMINED;
4605 if (!target->type->assert_reset || !target->type->deassert_reset) {
4606 Jim_SetResultFormatted(interp,
4607 "No target-specific reset for %s",
4608 target_name(target));
4611 /* determine if we should halt or not. */
4612 target->reset_halt = !!a;
4613 /* When this happens - all workareas are invalid. */
4614 target_free_all_working_areas_restore(target, 0);
4617 if (n->value == NVP_ASSERT)
4618 e = target->type->assert_reset(target);
4620 e = target->type->deassert_reset(target);
4621 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4624 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4627 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4630 struct target *target = Jim_CmdPrivData(interp);
4631 if (!target->tap->enabled)
4632 return jim_target_tap_disabled(interp);
4633 int e = target->type->halt(target);
4634 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4637 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4640 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4642 /* params: <name> statename timeoutmsecs */
4643 if (goi.argc != 2) {
4644 const char *cmd_name = Jim_GetString(argv[0], NULL);
4645 Jim_SetResultFormatted(goi.interp,
4646 "%s <state_name> <timeout_in_msec>", cmd_name);
4651 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
4653 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
4657 e = Jim_GetOpt_Wide(&goi, &a);
4660 struct target *target = Jim_CmdPrivData(interp);
4661 if (!target->tap->enabled)
4662 return jim_target_tap_disabled(interp);
4664 e = target_wait_state(target, n->value, a);
4665 if (e != ERROR_OK) {
4666 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
4667 Jim_SetResultFormatted(goi.interp,
4668 "target: %s wait %s fails (%#s) %s",
4669 target_name(target), n->name,
4670 eObj, target_strerror_safe(e));
4671 Jim_FreeNewObj(interp, eObj);
4676 /* List for human, Events defined for this target.
4677 * scripts/programs should use 'name cget -event NAME'
4679 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4681 struct command_context *cmd_ctx = current_command_context(interp);
4682 assert(cmd_ctx != NULL);
4684 struct target *target = Jim_CmdPrivData(interp);
4685 struct target_event_action *teap = target->event_action;
4686 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
4687 target->target_number,
4688 target_name(target));
4689 command_print(cmd_ctx, "%-25s | Body", "Event");
4690 command_print(cmd_ctx, "------------------------- | "
4691 "----------------------------------------");
4693 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
4694 command_print(cmd_ctx, "%-25s | %s",
4695 opt->name, Jim_GetString(teap->body, NULL));
4698 command_print(cmd_ctx, "***END***");
4701 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4704 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4707 struct target *target = Jim_CmdPrivData(interp);
4708 Jim_SetResultString(interp, target_state_name(target), -1);
4711 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4714 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4715 if (goi.argc != 1) {
4716 const char *cmd_name = Jim_GetString(argv[0], NULL);
4717 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
4721 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
4723 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
4726 struct target *target = Jim_CmdPrivData(interp);
4727 target_handle_event(target, n->value);
4731 static const struct command_registration target_instance_command_handlers[] = {
4733 .name = "configure",
4734 .mode = COMMAND_CONFIG,
4735 .jim_handler = jim_target_configure,
4736 .help = "configure a new target for use",
4737 .usage = "[target_attribute ...]",
4741 .mode = COMMAND_ANY,
4742 .jim_handler = jim_target_configure,
4743 .help = "returns the specified target attribute",
4744 .usage = "target_attribute",
4748 .mode = COMMAND_EXEC,
4749 .jim_handler = jim_target_mw,
4750 .help = "Write 32-bit word(s) to target memory",
4751 .usage = "address data [count]",
4755 .mode = COMMAND_EXEC,
4756 .jim_handler = jim_target_mw,
4757 .help = "Write 16-bit half-word(s) to target memory",
4758 .usage = "address data [count]",
4762 .mode = COMMAND_EXEC,
4763 .jim_handler = jim_target_mw,
4764 .help = "Write byte(s) to target memory",
4765 .usage = "address data [count]",
4769 .mode = COMMAND_EXEC,
4770 .jim_handler = jim_target_md,
4771 .help = "Display target memory as 32-bit words",
4772 .usage = "address [count]",
4776 .mode = COMMAND_EXEC,
4777 .jim_handler = jim_target_md,
4778 .help = "Display target memory as 16-bit half-words",
4779 .usage = "address [count]",
4783 .mode = COMMAND_EXEC,
4784 .jim_handler = jim_target_md,
4785 .help = "Display target memory as 8-bit bytes",
4786 .usage = "address [count]",
4789 .name = "array2mem",
4790 .mode = COMMAND_EXEC,
4791 .jim_handler = jim_target_array2mem,
4792 .help = "Writes Tcl array of 8/16/32 bit numbers "
4794 .usage = "arrayname bitwidth address count",
4797 .name = "mem2array",
4798 .mode = COMMAND_EXEC,
4799 .jim_handler = jim_target_mem2array,
4800 .help = "Loads Tcl array of 8/16/32 bit numbers "
4801 "from target memory",
4802 .usage = "arrayname bitwidth address count",
4805 .name = "eventlist",
4806 .mode = COMMAND_EXEC,
4807 .jim_handler = jim_target_event_list,
4808 .help = "displays a table of events defined for this target",
4812 .mode = COMMAND_EXEC,
4813 .jim_handler = jim_target_current_state,
4814 .help = "displays the current state of this target",
4817 .name = "arp_examine",
4818 .mode = COMMAND_EXEC,
4819 .jim_handler = jim_target_examine,
4820 .help = "used internally for reset processing",
4823 .name = "arp_halt_gdb",
4824 .mode = COMMAND_EXEC,
4825 .jim_handler = jim_target_halt_gdb,
4826 .help = "used internally for reset processing to halt GDB",
4830 .mode = COMMAND_EXEC,
4831 .jim_handler = jim_target_poll,
4832 .help = "used internally for reset processing",
4835 .name = "arp_reset",
4836 .mode = COMMAND_EXEC,
4837 .jim_handler = jim_target_reset,
4838 .help = "used internally for reset processing",
4842 .mode = COMMAND_EXEC,
4843 .jim_handler = jim_target_halt,
4844 .help = "used internally for reset processing",
4847 .name = "arp_waitstate",
4848 .mode = COMMAND_EXEC,
4849 .jim_handler = jim_target_wait_state,
4850 .help = "used internally for reset processing",
4853 .name = "invoke-event",
4854 .mode = COMMAND_EXEC,
4855 .jim_handler = jim_target_invoke_event,
4856 .help = "invoke handler for specified event",
4857 .usage = "event_name",
4859 COMMAND_REGISTRATION_DONE
4862 static int target_create(Jim_GetOptInfo *goi)
4870 struct target *target;
4871 struct command_context *cmd_ctx;
4873 cmd_ctx = current_command_context(goi->interp);
4874 assert(cmd_ctx != NULL);
4876 if (goi->argc < 3) {
4877 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
4882 Jim_GetOpt_Obj(goi, &new_cmd);
4883 /* does this command exist? */
4884 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
4886 cp = Jim_GetString(new_cmd, NULL);
4887 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
4892 e = Jim_GetOpt_String(goi, &cp2, NULL);
4896 /* now does target type exist */
4897 for (x = 0 ; target_types[x] ; x++) {
4898 if (0 == strcmp(cp, target_types[x]->name)) {
4903 /* check for deprecated name */
4904 if (target_types[x]->deprecated_name) {
4905 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
4907 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
4912 if (target_types[x] == NULL) {
4913 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
4914 for (x = 0 ; target_types[x] ; x++) {
4915 if (target_types[x + 1]) {
4916 Jim_AppendStrings(goi->interp,
4917 Jim_GetResult(goi->interp),
4918 target_types[x]->name,
4921 Jim_AppendStrings(goi->interp,
4922 Jim_GetResult(goi->interp),
4924 target_types[x]->name, NULL);
4931 target = calloc(1, sizeof(struct target));
4932 /* set target number */
4933 target->target_number = new_target_number();
4935 /* allocate memory for each unique target type */
4936 target->type = (struct target_type *)calloc(1, sizeof(struct target_type));
4938 memcpy(target->type, target_types[x], sizeof(struct target_type));
4940 /* will be set by "-endian" */
4941 target->endianness = TARGET_ENDIAN_UNKNOWN;
4943 /* default to first core, override with -coreid */
4946 target->working_area = 0x0;
4947 target->working_area_size = 0x0;
4948 target->working_areas = NULL;
4949 target->backup_working_area = 0;
4951 target->state = TARGET_UNKNOWN;
4952 target->debug_reason = DBG_REASON_UNDEFINED;
4953 target->reg_cache = NULL;
4954 target->breakpoints = NULL;
4955 target->watchpoints = NULL;
4956 target->next = NULL;
4957 target->arch_info = NULL;
4959 target->display = 1;
4961 target->halt_issued = false;
4963 /* initialize trace information */
4964 target->trace_info = malloc(sizeof(struct trace));
4965 target->trace_info->num_trace_points = 0;
4966 target->trace_info->trace_points_size = 0;
4967 target->trace_info->trace_points = NULL;
4968 target->trace_info->trace_history_size = 0;
4969 target->trace_info->trace_history = NULL;
4970 target->trace_info->trace_history_pos = 0;
4971 target->trace_info->trace_history_overflowed = 0;
4973 target->dbgmsg = NULL;
4974 target->dbg_msg_enabled = 0;
4976 target->endianness = TARGET_ENDIAN_UNKNOWN;
4978 target->rtos = NULL;
4979 target->rtos_auto_detect = false;
4981 /* Do the rest as "configure" options */
4982 goi->isconfigure = 1;
4983 e = target_configure(goi, target);
4985 if (target->tap == NULL) {
4986 Jim_SetResultString(goi->interp, "-chain-position required when creating target", -1);
4996 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
4997 /* default endian to little if not specified */
4998 target->endianness = TARGET_LITTLE_ENDIAN;
5001 /* incase variant is not set */
5002 if (!target->variant)
5003 target->variant = strdup("");
5005 cp = Jim_GetString(new_cmd, NULL);
5006 target->cmd_name = strdup(cp);
5008 /* create the target specific commands */
5009 if (target->type->commands) {
5010 e = register_commands(cmd_ctx, NULL, target->type->commands);
5012 LOG_ERROR("unable to register '%s' commands", cp);
5014 if (target->type->target_create)
5015 (*(target->type->target_create))(target, goi->interp);
5017 /* append to end of list */
5019 struct target **tpp;
5020 tpp = &(all_targets);
5022 tpp = &((*tpp)->next);
5026 /* now - create the new target name command */
5027 const struct command_registration target_subcommands[] = {
5029 .chain = target_instance_command_handlers,
5032 .chain = target->type->commands,
5034 COMMAND_REGISTRATION_DONE
5036 const struct command_registration target_commands[] = {
5039 .mode = COMMAND_ANY,
5040 .help = "target command group",
5042 .chain = target_subcommands,
5044 COMMAND_REGISTRATION_DONE
5046 e = register_commands(cmd_ctx, NULL, target_commands);
5050 struct command *c = command_find_in_context(cmd_ctx, cp);
5052 command_set_handler_data(c, target);
5054 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5057 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5060 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5063 struct command_context *cmd_ctx = current_command_context(interp);
5064 assert(cmd_ctx != NULL);
5066 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5070 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5073 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5076 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5077 for (unsigned x = 0; NULL != target_types[x]; x++) {
5078 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5079 Jim_NewStringObj(interp, target_types[x]->name, -1));
5084 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5087 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5090 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5091 struct target *target = all_targets;
5093 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5094 Jim_NewStringObj(interp, target_name(target), -1));
5095 target = target->next;
5100 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5103 const char *targetname;
5105 struct target *target = (struct target *) NULL;
5106 struct target_list *head, *curr, *new;
5107 curr = (struct target_list *) NULL;
5108 head = (struct target_list *) NULL;
5111 LOG_DEBUG("%d", argc);
5112 /* argv[1] = target to associate in smp
5113 * argv[2] = target to assoicate in smp
5117 for (i = 1; i < argc; i++) {
5119 targetname = Jim_GetString(argv[i], &len);
5120 target = get_target(targetname);
5121 LOG_DEBUG("%s ", targetname);
5123 new = malloc(sizeof(struct target_list));
5124 new->target = target;
5125 new->next = (struct target_list *)NULL;
5126 if (head == (struct target_list *)NULL) {
5135 /* now parse the list of cpu and put the target in smp mode*/
5138 while (curr != (struct target_list *)NULL) {
5139 target = curr->target;
5141 target->head = head;
5145 if (target && target->rtos)
5146 retval = rtos_smp_init(head->target);
5152 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5155 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5157 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5158 "<name> <target_type> [<target_options> ...]");
5161 return target_create(&goi);
5164 static int jim_target_number(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5167 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5169 /* It's OK to remove this mechanism sometime after August 2010 or so */
5170 LOG_WARNING("don't use numbers as target identifiers; use names");
5171 if (goi.argc != 1) {
5172 Jim_SetResultFormatted(goi.interp, "usage: target number <number>");
5176 int e = Jim_GetOpt_Wide(&goi, &w);
5180 struct target *target;
5181 for (target = all_targets; NULL != target; target = target->next) {
5182 if (target->target_number != w)
5185 Jim_SetResultString(goi.interp, target_name(target), -1);
5189 Jim_Obj *wObj = Jim_NewIntObj(goi.interp, w);
5190 Jim_SetResultFormatted(goi.interp,
5191 "Target: number %#s does not exist", wObj);
5192 Jim_FreeNewObj(interp, wObj);
5197 static int jim_target_count(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5200 Jim_WrongNumArgs(interp, 1, argv, "<no parameters>");
5204 struct target *target = all_targets;
5205 while (NULL != target) {
5206 target = target->next;
5209 Jim_SetResult(interp, Jim_NewIntObj(interp, count));
5213 static const struct command_registration target_subcommand_handlers[] = {
5216 .mode = COMMAND_CONFIG,
5217 .handler = handle_target_init_command,
5218 .help = "initialize targets",
5222 /* REVISIT this should be COMMAND_CONFIG ... */
5223 .mode = COMMAND_ANY,
5224 .jim_handler = jim_target_create,
5225 .usage = "name type '-chain-position' name [options ...]",
5226 .help = "Creates and selects a new target",
5230 .mode = COMMAND_ANY,
5231 .jim_handler = jim_target_current,
5232 .help = "Returns the currently selected target",
5236 .mode = COMMAND_ANY,
5237 .jim_handler = jim_target_types,
5238 .help = "Returns the available target types as "
5239 "a list of strings",
5243 .mode = COMMAND_ANY,
5244 .jim_handler = jim_target_names,
5245 .help = "Returns the names of all targets as a list of strings",
5249 .mode = COMMAND_ANY,
5250 .jim_handler = jim_target_number,
5252 .help = "Returns the name of the numbered target "
5257 .mode = COMMAND_ANY,
5258 .jim_handler = jim_target_count,
5259 .help = "Returns the number of targets as an integer "
5264 .mode = COMMAND_ANY,
5265 .jim_handler = jim_target_smp,
5266 .usage = "targetname1 targetname2 ...",
5267 .help = "gather several target in a smp list"
5270 COMMAND_REGISTRATION_DONE
5280 static int fastload_num;
5281 static struct FastLoad *fastload;
5283 static void free_fastload(void)
5285 if (fastload != NULL) {
5287 for (i = 0; i < fastload_num; i++) {
5288 if (fastload[i].data)
5289 free(fastload[i].data);
5296 COMMAND_HANDLER(handle_fast_load_image_command)
5300 uint32_t image_size;
5301 uint32_t min_address = 0;
5302 uint32_t max_address = 0xffffffff;
5307 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5308 &image, &min_address, &max_address);
5309 if (ERROR_OK != retval)
5312 struct duration bench;
5313 duration_start(&bench);
5315 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5316 if (retval != ERROR_OK)
5321 fastload_num = image.num_sections;
5322 fastload = (struct FastLoad *)malloc(sizeof(struct FastLoad)*image.num_sections);
5323 if (fastload == NULL) {
5324 command_print(CMD_CTX, "out of memory");
5325 image_close(&image);
5328 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5329 for (i = 0; i < image.num_sections; i++) {
5330 buffer = malloc(image.sections[i].size);
5331 if (buffer == NULL) {
5332 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5333 (int)(image.sections[i].size));
5334 retval = ERROR_FAIL;
5338 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5339 if (retval != ERROR_OK) {
5344 uint32_t offset = 0;
5345 uint32_t length = buf_cnt;
5347 /* DANGER!!! beware of unsigned comparision here!!! */
5349 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5350 (image.sections[i].base_address < max_address)) {
5351 if (image.sections[i].base_address < min_address) {
5352 /* clip addresses below */
5353 offset += min_address-image.sections[i].base_address;
5357 if (image.sections[i].base_address + buf_cnt > max_address)
5358 length -= (image.sections[i].base_address + buf_cnt)-max_address;
5360 fastload[i].address = image.sections[i].base_address + offset;
5361 fastload[i].data = malloc(length);
5362 if (fastload[i].data == NULL) {
5364 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5366 retval = ERROR_FAIL;
5369 memcpy(fastload[i].data, buffer + offset, length);
5370 fastload[i].length = length;
5372 image_size += length;
5373 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
5374 (unsigned int)length,
5375 ((unsigned int)(image.sections[i].base_address + offset)));
5381 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
5382 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
5383 "in %fs (%0.3f KiB/s)", image_size,
5384 duration_elapsed(&bench), duration_kbps(&bench, image_size));
5386 command_print(CMD_CTX,
5387 "WARNING: image has not been loaded to target!"
5388 "You can issue a 'fast_load' to finish loading.");
5391 image_close(&image);
5393 if (retval != ERROR_OK)
5399 COMMAND_HANDLER(handle_fast_load_command)
5402 return ERROR_COMMAND_SYNTAX_ERROR;
5403 if (fastload == NULL) {
5404 LOG_ERROR("No image in memory");
5408 int ms = timeval_ms();
5410 int retval = ERROR_OK;
5411 for (i = 0; i < fastload_num; i++) {
5412 struct target *target = get_current_target(CMD_CTX);
5413 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
5414 (unsigned int)(fastload[i].address),
5415 (unsigned int)(fastload[i].length));
5416 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
5417 if (retval != ERROR_OK)
5419 size += fastload[i].length;
5421 if (retval == ERROR_OK) {
5422 int after = timeval_ms();
5423 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
5428 static const struct command_registration target_command_handlers[] = {
5431 .handler = handle_targets_command,
5432 .mode = COMMAND_ANY,
5433 .help = "change current default target (one parameter) "
5434 "or prints table of all targets (no parameters)",
5435 .usage = "[target]",
5439 .mode = COMMAND_CONFIG,
5440 .help = "configure target",
5442 .chain = target_subcommand_handlers,
5444 COMMAND_REGISTRATION_DONE
5447 int target_register_commands(struct command_context *cmd_ctx)
5449 return register_commands(cmd_ctx, NULL, target_command_handlers);
5452 static bool target_reset_nag = true;
5454 bool get_target_reset_nag(void)
5456 return target_reset_nag;
5459 COMMAND_HANDLER(handle_target_reset_nag)
5461 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
5462 &target_reset_nag, "Nag after each reset about options to improve "
5466 COMMAND_HANDLER(handle_ps_command)
5468 struct target *target = get_current_target(CMD_CTX);
5470 if (target->state != TARGET_HALTED) {
5471 LOG_INFO("target not halted !!");
5475 if ((target->rtos) && (target->rtos->type)
5476 && (target->rtos->type->ps_command)) {
5477 display = target->rtos->type->ps_command(target);
5478 command_print(CMD_CTX, "%s", display);
5483 return ERROR_TARGET_FAILURE;
5487 static const struct command_registration target_exec_command_handlers[] = {
5489 .name = "fast_load_image",
5490 .handler = handle_fast_load_image_command,
5491 .mode = COMMAND_ANY,
5492 .help = "Load image into server memory for later use by "
5493 "fast_load; primarily for profiling",
5494 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5495 "[min_address [max_length]]",
5498 .name = "fast_load",
5499 .handler = handle_fast_load_command,
5500 .mode = COMMAND_EXEC,
5501 .help = "loads active fast load image to current target "
5502 "- mainly for profiling purposes",
5507 .handler = handle_profile_command,
5508 .mode = COMMAND_EXEC,
5509 .usage = "seconds filename",
5510 .help = "profiling samples the CPU PC",
5512 /** @todo don't register virt2phys() unless target supports it */
5514 .name = "virt2phys",
5515 .handler = handle_virt2phys_command,
5516 .mode = COMMAND_ANY,
5517 .help = "translate a virtual address into a physical address",
5518 .usage = "virtual_address",
5522 .handler = handle_reg_command,
5523 .mode = COMMAND_EXEC,
5524 .help = "display or set a register; with no arguments, "
5525 "displays all registers and their values",
5526 .usage = "[(register_name|register_number) [value]]",
5530 .handler = handle_poll_command,
5531 .mode = COMMAND_EXEC,
5532 .help = "poll target state; or reconfigure background polling",
5533 .usage = "['on'|'off']",
5536 .name = "wait_halt",
5537 .handler = handle_wait_halt_command,
5538 .mode = COMMAND_EXEC,
5539 .help = "wait up to the specified number of milliseconds "
5540 "(default 5000) for a previously requested halt",
5541 .usage = "[milliseconds]",
5545 .handler = handle_halt_command,
5546 .mode = COMMAND_EXEC,
5547 .help = "request target to halt, then wait up to the specified"
5548 "number of milliseconds (default 5000) for it to complete",
5549 .usage = "[milliseconds]",
5553 .handler = handle_resume_command,
5554 .mode = COMMAND_EXEC,
5555 .help = "resume target execution from current PC or address",
5556 .usage = "[address]",
5560 .handler = handle_reset_command,
5561 .mode = COMMAND_EXEC,
5562 .usage = "[run|halt|init]",
5563 .help = "Reset all targets into the specified mode."
5564 "Default reset mode is run, if not given.",
5567 .name = "soft_reset_halt",
5568 .handler = handle_soft_reset_halt_command,
5569 .mode = COMMAND_EXEC,
5571 .help = "halt the target and do a soft reset",
5575 .handler = handle_step_command,
5576 .mode = COMMAND_EXEC,
5577 .help = "step one instruction from current PC or address",
5578 .usage = "[address]",
5582 .handler = handle_md_command,
5583 .mode = COMMAND_EXEC,
5584 .help = "display memory words",
5585 .usage = "['phys'] address [count]",
5589 .handler = handle_md_command,
5590 .mode = COMMAND_EXEC,
5591 .help = "display memory half-words",
5592 .usage = "['phys'] address [count]",
5596 .handler = handle_md_command,
5597 .mode = COMMAND_EXEC,
5598 .help = "display memory bytes",
5599 .usage = "['phys'] address [count]",
5603 .handler = handle_mw_command,
5604 .mode = COMMAND_EXEC,
5605 .help = "write memory word",
5606 .usage = "['phys'] address value [count]",
5610 .handler = handle_mw_command,
5611 .mode = COMMAND_EXEC,
5612 .help = "write memory half-word",
5613 .usage = "['phys'] address value [count]",
5617 .handler = handle_mw_command,
5618 .mode = COMMAND_EXEC,
5619 .help = "write memory byte",
5620 .usage = "['phys'] address value [count]",
5624 .handler = handle_bp_command,
5625 .mode = COMMAND_EXEC,
5626 .help = "list or set hardware or software breakpoint",
5627 .usage = "<address> [<asid>]<length> ['hw'|'hw_ctx']",
5631 .handler = handle_rbp_command,
5632 .mode = COMMAND_EXEC,
5633 .help = "remove breakpoint",
5638 .handler = handle_wp_command,
5639 .mode = COMMAND_EXEC,
5640 .help = "list (no params) or create watchpoints",
5641 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
5645 .handler = handle_rwp_command,
5646 .mode = COMMAND_EXEC,
5647 .help = "remove watchpoint",
5651 .name = "load_image",
5652 .handler = handle_load_image_command,
5653 .mode = COMMAND_EXEC,
5654 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5655 "[min_address] [max_length]",
5658 .name = "dump_image",
5659 .handler = handle_dump_image_command,
5660 .mode = COMMAND_EXEC,
5661 .usage = "filename address size",
5664 .name = "verify_image",
5665 .handler = handle_verify_image_command,
5666 .mode = COMMAND_EXEC,
5667 .usage = "filename [offset [type]]",
5670 .name = "test_image",
5671 .handler = handle_test_image_command,
5672 .mode = COMMAND_EXEC,
5673 .usage = "filename [offset [type]]",
5676 .name = "mem2array",
5677 .mode = COMMAND_EXEC,
5678 .jim_handler = jim_mem2array,
5679 .help = "read 8/16/32 bit memory and return as a TCL array "
5680 "for script processing",
5681 .usage = "arrayname bitwidth address count",
5684 .name = "array2mem",
5685 .mode = COMMAND_EXEC,
5686 .jim_handler = jim_array2mem,
5687 .help = "convert a TCL array to memory locations "
5688 "and write the 8/16/32 bit values",
5689 .usage = "arrayname bitwidth address count",
5692 .name = "reset_nag",
5693 .handler = handle_target_reset_nag,
5694 .mode = COMMAND_ANY,
5695 .help = "Nag after each reset about options that could have been "
5696 "enabled to improve performance. ",
5697 .usage = "['enable'|'disable']",
5701 .handler = handle_ps_command,
5702 .mode = COMMAND_EXEC,
5703 .help = "list all tasks ",
5707 COMMAND_REGISTRATION_DONE
5709 static int target_register_user_commands(struct command_context *cmd_ctx)
5711 int retval = ERROR_OK;
5712 retval = target_request_register_commands(cmd_ctx);
5713 if (retval != ERROR_OK)
5716 retval = trace_register_commands(cmd_ctx);
5717 if (retval != ERROR_OK)
5721 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);