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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 static int target_read_buffer_default(struct target *target, uint32_t address,
60 uint32_t size, uint8_t *buffer);
61 static int target_write_buffer_default(struct target *target, uint32_t address,
62 uint32_t size, const uint8_t *buffer);
63 static int target_array2mem(Jim_Interp *interp, struct target *target,
64 int argc, Jim_Obj * const *argv);
65 static int target_mem2array(Jim_Interp *interp, struct target *target,
66 int argc, Jim_Obj * const *argv);
67 static int target_register_user_commands(struct command_context *cmd_ctx);
70 extern struct target_type arm7tdmi_target;
71 extern struct target_type arm720t_target;
72 extern struct target_type arm9tdmi_target;
73 extern struct target_type arm920t_target;
74 extern struct target_type arm966e_target;
75 extern struct target_type arm946e_target;
76 extern struct target_type arm926ejs_target;
77 extern struct target_type fa526_target;
78 extern struct target_type feroceon_target;
79 extern struct target_type dragonite_target;
80 extern struct target_type xscale_target;
81 extern struct target_type cortexm3_target;
82 extern struct target_type cortexa8_target;
83 extern struct target_type arm11_target;
84 extern struct target_type mips_m4k_target;
85 extern struct target_type avr_target;
86 extern struct target_type dsp563xx_target;
87 extern struct target_type dsp5680xx_target;
88 extern struct target_type testee_target;
89 extern struct target_type avr32_ap7k_target;
90 extern struct target_type hla_target;
92 static struct target_type *target_types[] = {
117 struct target *all_targets;
118 static struct target_event_callback *target_event_callbacks;
119 static struct target_timer_callback *target_timer_callbacks;
120 static const int polling_interval = 100;
122 static const Jim_Nvp nvp_assert[] = {
123 { .name = "assert", NVP_ASSERT },
124 { .name = "deassert", NVP_DEASSERT },
125 { .name = "T", NVP_ASSERT },
126 { .name = "F", NVP_DEASSERT },
127 { .name = "t", NVP_ASSERT },
128 { .name = "f", NVP_DEASSERT },
129 { .name = NULL, .value = -1 }
132 static const Jim_Nvp nvp_error_target[] = {
133 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
134 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
135 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
136 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
137 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
138 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
139 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
140 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
141 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
142 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
143 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
144 { .value = -1, .name = NULL }
147 static const char *target_strerror_safe(int err)
151 n = Jim_Nvp_value2name_simple(nvp_error_target, err);
158 static const Jim_Nvp nvp_target_event[] = {
160 { .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
161 { .value = TARGET_EVENT_HALTED, .name = "halted" },
162 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
163 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
164 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
166 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
167 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
169 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
170 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
171 { .value = TARGET_EVENT_RESET_ASSERT, .name = "reset-assert" },
172 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
173 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
174 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
175 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
176 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
177 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
178 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
179 { .value = TARGET_EVENT_RESET_INIT, .name = "reset-init" },
180 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
182 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
183 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
185 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
186 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
188 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
189 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
191 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
192 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
194 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
195 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
197 { .name = NULL, .value = -1 }
200 static const Jim_Nvp nvp_target_state[] = {
201 { .name = "unknown", .value = TARGET_UNKNOWN },
202 { .name = "running", .value = TARGET_RUNNING },
203 { .name = "halted", .value = TARGET_HALTED },
204 { .name = "reset", .value = TARGET_RESET },
205 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
206 { .name = NULL, .value = -1 },
209 static const Jim_Nvp nvp_target_debug_reason[] = {
210 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
211 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
212 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
213 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
214 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
215 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
216 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
217 { .name = NULL, .value = -1 },
220 static const Jim_Nvp nvp_target_endian[] = {
221 { .name = "big", .value = TARGET_BIG_ENDIAN },
222 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
223 { .name = "be", .value = TARGET_BIG_ENDIAN },
224 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
225 { .name = NULL, .value = -1 },
228 static const Jim_Nvp nvp_reset_modes[] = {
229 { .name = "unknown", .value = RESET_UNKNOWN },
230 { .name = "run" , .value = RESET_RUN },
231 { .name = "halt" , .value = RESET_HALT },
232 { .name = "init" , .value = RESET_INIT },
233 { .name = NULL , .value = -1 },
236 const char *debug_reason_name(struct target *t)
240 cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
241 t->debug_reason)->name;
243 LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
244 cp = "(*BUG*unknown*BUG*)";
249 const char *target_state_name(struct target *t)
252 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
254 LOG_ERROR("Invalid target state: %d", (int)(t->state));
255 cp = "(*BUG*unknown*BUG*)";
260 /* determine the number of the new target */
261 static int new_target_number(void)
266 /* number is 0 based */
270 if (x < t->target_number)
271 x = t->target_number;
277 /* read a uint32_t from a buffer in target memory endianness */
278 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
280 if (target->endianness == TARGET_LITTLE_ENDIAN)
281 return le_to_h_u32(buffer);
283 return be_to_h_u32(buffer);
286 /* read a uint24_t from a buffer in target memory endianness */
287 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
289 if (target->endianness == TARGET_LITTLE_ENDIAN)
290 return le_to_h_u24(buffer);
292 return be_to_h_u24(buffer);
295 /* read a uint16_t from a buffer in target memory endianness */
296 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
298 if (target->endianness == TARGET_LITTLE_ENDIAN)
299 return le_to_h_u16(buffer);
301 return be_to_h_u16(buffer);
304 /* read a uint8_t from a buffer in target memory endianness */
305 static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
307 return *buffer & 0x0ff;
310 /* write a uint32_t to a buffer in target memory endianness */
311 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
313 if (target->endianness == TARGET_LITTLE_ENDIAN)
314 h_u32_to_le(buffer, value);
316 h_u32_to_be(buffer, value);
319 /* write a uint24_t to a buffer in target memory endianness */
320 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
322 if (target->endianness == TARGET_LITTLE_ENDIAN)
323 h_u24_to_le(buffer, value);
325 h_u24_to_be(buffer, value);
328 /* write a uint16_t to a buffer in target memory endianness */
329 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
331 if (target->endianness == TARGET_LITTLE_ENDIAN)
332 h_u16_to_le(buffer, value);
334 h_u16_to_be(buffer, value);
337 /* write a uint8_t to a buffer in target memory endianness */
338 static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
343 /* write a uint32_t array to a buffer in target memory endianness */
344 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
347 for (i = 0; i < count; i++)
348 dstbuf[i] = target_buffer_get_u32(target, &buffer[i * 4]);
351 /* write a uint16_t array to a buffer in target memory endianness */
352 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
355 for (i = 0; i < count; i++)
356 dstbuf[i] = target_buffer_get_u16(target, &buffer[i * 2]);
359 /* write a uint32_t array to a buffer in target memory endianness */
360 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf)
363 for (i = 0; i < count; i++)
364 target_buffer_set_u32(target, &buffer[i * 4], srcbuf[i]);
367 /* write a uint16_t array to a buffer in target memory endianness */
368 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf)
371 for (i = 0; i < count; i++)
372 target_buffer_set_u16(target, &buffer[i * 2], srcbuf[i]);
375 /* return a pointer to a configured target; id is name or number */
376 struct target *get_target(const char *id)
378 struct target *target;
380 /* try as tcltarget name */
381 for (target = all_targets; target; target = target->next) {
382 if (target_name(target) == NULL)
384 if (strcmp(id, target_name(target)) == 0)
388 /* It's OK to remove this fallback sometime after August 2010 or so */
390 /* no match, try as number */
392 if (parse_uint(id, &num) != ERROR_OK)
395 for (target = all_targets; target; target = target->next) {
396 if (target->target_number == (int)num) {
397 LOG_WARNING("use '%s' as target identifier, not '%u'",
398 target_name(target), num);
406 /* returns a pointer to the n-th configured target */
407 static struct target *get_target_by_num(int num)
409 struct target *target = all_targets;
412 if (target->target_number == num)
414 target = target->next;
420 struct target *get_current_target(struct command_context *cmd_ctx)
422 struct target *target = get_target_by_num(cmd_ctx->current_target);
424 if (target == NULL) {
425 LOG_ERROR("BUG: current_target out of bounds");
432 int target_poll(struct target *target)
436 /* We can't poll until after examine */
437 if (!target_was_examined(target)) {
438 /* Fail silently lest we pollute the log */
442 retval = target->type->poll(target);
443 if (retval != ERROR_OK)
446 if (target->halt_issued) {
447 if (target->state == TARGET_HALTED)
448 target->halt_issued = false;
450 long long t = timeval_ms() - target->halt_issued_time;
452 target->halt_issued = false;
453 LOG_INFO("Halt timed out, wake up GDB.");
454 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
462 int target_halt(struct target *target)
465 /* We can't poll until after examine */
466 if (!target_was_examined(target)) {
467 LOG_ERROR("Target not examined yet");
471 retval = target->type->halt(target);
472 if (retval != ERROR_OK)
475 target->halt_issued = true;
476 target->halt_issued_time = timeval_ms();
482 * Make the target (re)start executing using its saved execution
483 * context (possibly with some modifications).
485 * @param target Which target should start executing.
486 * @param current True to use the target's saved program counter instead
487 * of the address parameter
488 * @param address Optionally used as the program counter.
489 * @param handle_breakpoints True iff breakpoints at the resumption PC
490 * should be skipped. (For example, maybe execution was stopped by
491 * such a breakpoint, in which case it would be counterprodutive to
493 * @param debug_execution False if all working areas allocated by OpenOCD
494 * should be released and/or restored to their original contents.
495 * (This would for example be true to run some downloaded "helper"
496 * algorithm code, which resides in one such working buffer and uses
497 * another for data storage.)
499 * @todo Resolve the ambiguity about what the "debug_execution" flag
500 * signifies. For example, Target implementations don't agree on how
501 * it relates to invalidation of the register cache, or to whether
502 * breakpoints and watchpoints should be enabled. (It would seem wrong
503 * to enable breakpoints when running downloaded "helper" algorithms
504 * (debug_execution true), since the breakpoints would be set to match
505 * target firmware being debugged, not the helper algorithm.... and
506 * enabling them could cause such helpers to malfunction (for example,
507 * by overwriting data with a breakpoint instruction. On the other
508 * hand the infrastructure for running such helpers might use this
509 * procedure but rely on hardware breakpoint to detect termination.)
511 int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
515 /* We can't poll until after examine */
516 if (!target_was_examined(target)) {
517 LOG_ERROR("Target not examined yet");
521 target_call_event_callbacks(target, TARGET_EVENT_RESUME_START);
523 /* note that resume *must* be asynchronous. The CPU can halt before
524 * we poll. The CPU can even halt at the current PC as a result of
525 * a software breakpoint being inserted by (a bug?) the application.
527 retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution);
528 if (retval != ERROR_OK)
531 target_call_event_callbacks(target, TARGET_EVENT_RESUME_END);
536 static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
541 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
542 if (n->name == NULL) {
543 LOG_ERROR("invalid reset mode");
547 /* disable polling during reset to make reset event scripts
548 * more predictable, i.e. dr/irscan & pathmove in events will
549 * not have JTAG operations injected into the middle of a sequence.
551 bool save_poll = jtag_poll_get_enabled();
553 jtag_poll_set_enabled(false);
555 sprintf(buf, "ocd_process_reset %s", n->name);
556 retval = Jim_Eval(cmd_ctx->interp, buf);
558 jtag_poll_set_enabled(save_poll);
560 if (retval != JIM_OK) {
561 Jim_MakeErrorMessage(cmd_ctx->interp);
562 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
566 /* We want any events to be processed before the prompt */
567 retval = target_call_timer_callbacks_now();
569 struct target *target;
570 for (target = all_targets; target; target = target->next)
571 target->type->check_reset(target);
576 static int identity_virt2phys(struct target *target,
577 uint32_t virtual, uint32_t *physical)
583 static int no_mmu(struct target *target, int *enabled)
589 static int default_examine(struct target *target)
591 target_set_examined(target);
595 /* no check by default */
596 static int default_check_reset(struct target *target)
601 int target_examine_one(struct target *target)
603 return target->type->examine(target);
606 static int jtag_enable_callback(enum jtag_event event, void *priv)
608 struct target *target = priv;
610 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
613 jtag_unregister_event_callback(jtag_enable_callback, target);
615 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
617 int retval = target_examine_one(target);
618 if (retval != ERROR_OK)
621 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
626 /* Targets that correctly implement init + examine, i.e.
627 * no communication with target during init:
631 int target_examine(void)
633 int retval = ERROR_OK;
634 struct target *target;
636 for (target = all_targets; target; target = target->next) {
637 /* defer examination, but don't skip it */
638 if (!target->tap->enabled) {
639 jtag_register_event_callback(jtag_enable_callback,
644 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
646 retval = target_examine_one(target);
647 if (retval != ERROR_OK)
650 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
655 const char *target_type_name(struct target *target)
657 return target->type->name;
660 static int target_soft_reset_halt(struct target *target)
662 if (!target_was_examined(target)) {
663 LOG_ERROR("Target not examined yet");
666 if (!target->type->soft_reset_halt) {
667 LOG_ERROR("Target %s does not support soft_reset_halt",
668 target_name(target));
671 return target->type->soft_reset_halt(target);
675 * Downloads a target-specific native code algorithm to the target,
676 * and executes it. * Note that some targets may need to set up, enable,
677 * and tear down a breakpoint (hard or * soft) to detect algorithm
678 * termination, while others may support lower overhead schemes where
679 * soft breakpoints embedded in the algorithm automatically terminate the
682 * @param target used to run the algorithm
683 * @param arch_info target-specific description of the algorithm.
685 int target_run_algorithm(struct target *target,
686 int num_mem_params, struct mem_param *mem_params,
687 int num_reg_params, struct reg_param *reg_param,
688 uint32_t entry_point, uint32_t exit_point,
689 int timeout_ms, void *arch_info)
691 int retval = ERROR_FAIL;
693 if (!target_was_examined(target)) {
694 LOG_ERROR("Target not examined yet");
697 if (!target->type->run_algorithm) {
698 LOG_ERROR("Target type '%s' does not support %s",
699 target_type_name(target), __func__);
703 target->running_alg = true;
704 retval = target->type->run_algorithm(target,
705 num_mem_params, mem_params,
706 num_reg_params, reg_param,
707 entry_point, exit_point, timeout_ms, arch_info);
708 target->running_alg = false;
715 * Downloads a target-specific native code algorithm to the target,
716 * executes and leaves it running.
718 * @param target used to run the algorithm
719 * @param arch_info target-specific description of the algorithm.
721 int target_start_algorithm(struct target *target,
722 int num_mem_params, struct mem_param *mem_params,
723 int num_reg_params, struct reg_param *reg_params,
724 uint32_t entry_point, uint32_t exit_point,
727 int retval = ERROR_FAIL;
729 if (!target_was_examined(target)) {
730 LOG_ERROR("Target not examined yet");
733 if (!target->type->start_algorithm) {
734 LOG_ERROR("Target type '%s' does not support %s",
735 target_type_name(target), __func__);
738 if (target->running_alg) {
739 LOG_ERROR("Target is already running an algorithm");
743 target->running_alg = true;
744 retval = target->type->start_algorithm(target,
745 num_mem_params, mem_params,
746 num_reg_params, reg_params,
747 entry_point, exit_point, arch_info);
754 * Waits for an algorithm started with target_start_algorithm() to complete.
756 * @param target used to run the algorithm
757 * @param arch_info target-specific description of the algorithm.
759 int target_wait_algorithm(struct target *target,
760 int num_mem_params, struct mem_param *mem_params,
761 int num_reg_params, struct reg_param *reg_params,
762 uint32_t exit_point, int timeout_ms,
765 int retval = ERROR_FAIL;
767 if (!target->type->wait_algorithm) {
768 LOG_ERROR("Target type '%s' does not support %s",
769 target_type_name(target), __func__);
772 if (!target->running_alg) {
773 LOG_ERROR("Target is not running an algorithm");
777 retval = target->type->wait_algorithm(target,
778 num_mem_params, mem_params,
779 num_reg_params, reg_params,
780 exit_point, timeout_ms, arch_info);
781 if (retval != ERROR_TARGET_TIMEOUT)
782 target->running_alg = false;
789 * Executes a target-specific native code algorithm in the target.
790 * It differs from target_run_algorithm in that the algorithm is asynchronous.
791 * Because of this it requires an compliant algorithm:
792 * see contrib/loaders/flash/stm32f1x.S for example.
794 * @param target used to run the algorithm
797 int target_run_flash_async_algorithm(struct target *target,
798 uint8_t *buffer, uint32_t count, int block_size,
799 int num_mem_params, struct mem_param *mem_params,
800 int num_reg_params, struct reg_param *reg_params,
801 uint32_t buffer_start, uint32_t buffer_size,
802 uint32_t entry_point, uint32_t exit_point, void *arch_info)
807 /* Set up working area. First word is write pointer, second word is read pointer,
808 * rest is fifo data area. */
809 uint32_t wp_addr = buffer_start;
810 uint32_t rp_addr = buffer_start + 4;
811 uint32_t fifo_start_addr = buffer_start + 8;
812 uint32_t fifo_end_addr = buffer_start + buffer_size;
814 uint32_t wp = fifo_start_addr;
815 uint32_t rp = fifo_start_addr;
817 /* validate block_size is 2^n */
818 assert(!block_size || !(block_size & (block_size - 1)));
820 retval = target_write_u32(target, wp_addr, wp);
821 if (retval != ERROR_OK)
823 retval = target_write_u32(target, rp_addr, rp);
824 if (retval != ERROR_OK)
827 /* Start up algorithm on target and let it idle while writing the first chunk */
828 retval = target_start_algorithm(target, num_mem_params, mem_params,
829 num_reg_params, reg_params,
834 if (retval != ERROR_OK) {
835 LOG_ERROR("error starting target flash write algorithm");
841 retval = target_read_u32(target, rp_addr, &rp);
842 if (retval != ERROR_OK) {
843 LOG_ERROR("failed to get read pointer");
847 LOG_DEBUG("count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32, count, wp, rp);
850 LOG_ERROR("flash write algorithm aborted by target");
851 retval = ERROR_FLASH_OPERATION_FAILED;
855 if ((rp & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
856 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
860 /* Count the number of bytes available in the fifo without
861 * crossing the wrap around. Make sure to not fill it completely,
862 * because that would make wp == rp and that's the empty condition. */
863 uint32_t thisrun_bytes;
865 thisrun_bytes = rp - wp - block_size;
866 else if (rp > fifo_start_addr)
867 thisrun_bytes = fifo_end_addr - wp;
869 thisrun_bytes = fifo_end_addr - wp - block_size;
871 if (thisrun_bytes == 0) {
872 /* Throttle polling a bit if transfer is (much) faster than flash
873 * programming. The exact delay shouldn't matter as long as it's
874 * less than buffer size / flash speed. This is very unlikely to
875 * run when using high latency connections such as USB. */
878 /* to stop an infinite loop on some targets check and increment a timeout
879 * this issue was observed on a stellaris using the new ICDI interface */
880 if (timeout++ >= 500) {
881 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
882 return ERROR_FLASH_OPERATION_FAILED;
887 /* reset our timeout */
890 /* Limit to the amount of data we actually want to write */
891 if (thisrun_bytes > count * block_size)
892 thisrun_bytes = count * block_size;
894 /* Write data to fifo */
895 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
896 if (retval != ERROR_OK)
899 /* Update counters and wrap write pointer */
900 buffer += thisrun_bytes;
901 count -= thisrun_bytes / block_size;
903 if (wp >= fifo_end_addr)
904 wp = fifo_start_addr;
906 /* Store updated write pointer to target */
907 retval = target_write_u32(target, wp_addr, wp);
908 if (retval != ERROR_OK)
912 if (retval != ERROR_OK) {
913 /* abort flash write algorithm on target */
914 target_write_u32(target, wp_addr, 0);
917 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
918 num_reg_params, reg_params,
923 if (retval2 != ERROR_OK) {
924 LOG_ERROR("error waiting for target flash write algorithm");
931 int target_read_memory(struct target *target,
932 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
934 if (!target_was_examined(target)) {
935 LOG_ERROR("Target not examined yet");
938 return target->type->read_memory(target, address, size, count, buffer);
941 int target_read_phys_memory(struct target *target,
942 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
944 if (!target_was_examined(target)) {
945 LOG_ERROR("Target not examined yet");
948 return target->type->read_phys_memory(target, address, size, count, buffer);
951 int target_write_memory(struct target *target,
952 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
954 if (!target_was_examined(target)) {
955 LOG_ERROR("Target not examined yet");
958 return target->type->write_memory(target, address, size, count, buffer);
961 int target_write_phys_memory(struct target *target,
962 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
964 if (!target_was_examined(target)) {
965 LOG_ERROR("Target not examined yet");
968 return target->type->write_phys_memory(target, address, size, count, buffer);
971 int target_bulk_write_memory(struct target *target,
972 uint32_t address, uint32_t count, const uint8_t *buffer)
974 return target->type->bulk_write_memory(target, address, count, buffer);
977 int target_add_breakpoint(struct target *target,
978 struct breakpoint *breakpoint)
980 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
981 LOG_WARNING("target %s is not halted", target_name(target));
982 return ERROR_TARGET_NOT_HALTED;
984 return target->type->add_breakpoint(target, breakpoint);
987 int target_add_context_breakpoint(struct target *target,
988 struct breakpoint *breakpoint)
990 if (target->state != TARGET_HALTED) {
991 LOG_WARNING("target %s is not halted", target_name(target));
992 return ERROR_TARGET_NOT_HALTED;
994 return target->type->add_context_breakpoint(target, breakpoint);
997 int target_add_hybrid_breakpoint(struct target *target,
998 struct breakpoint *breakpoint)
1000 if (target->state != TARGET_HALTED) {
1001 LOG_WARNING("target %s is not halted", target_name(target));
1002 return ERROR_TARGET_NOT_HALTED;
1004 return target->type->add_hybrid_breakpoint(target, breakpoint);
1007 int target_remove_breakpoint(struct target *target,
1008 struct breakpoint *breakpoint)
1010 return target->type->remove_breakpoint(target, breakpoint);
1013 int target_add_watchpoint(struct target *target,
1014 struct watchpoint *watchpoint)
1016 if (target->state != TARGET_HALTED) {
1017 LOG_WARNING("target %s is not halted", target_name(target));
1018 return ERROR_TARGET_NOT_HALTED;
1020 return target->type->add_watchpoint(target, watchpoint);
1022 int target_remove_watchpoint(struct target *target,
1023 struct watchpoint *watchpoint)
1025 return target->type->remove_watchpoint(target, watchpoint);
1028 int target_get_gdb_reg_list(struct target *target,
1029 struct reg **reg_list[], int *reg_list_size)
1031 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
1033 int target_step(struct target *target,
1034 int current, uint32_t address, int handle_breakpoints)
1036 return target->type->step(target, current, address, handle_breakpoints);
1040 * Reset the @c examined flag for the given target.
1041 * Pure paranoia -- targets are zeroed on allocation.
1043 static void target_reset_examined(struct target *target)
1045 target->examined = false;
1048 static int err_read_phys_memory(struct target *target, uint32_t address,
1049 uint32_t size, uint32_t count, uint8_t *buffer)
1051 LOG_ERROR("Not implemented: %s", __func__);
1055 static int err_write_phys_memory(struct target *target, uint32_t address,
1056 uint32_t size, uint32_t count, const uint8_t *buffer)
1058 LOG_ERROR("Not implemented: %s", __func__);
1062 static int handle_target(void *priv);
1064 static int target_init_one(struct command_context *cmd_ctx,
1065 struct target *target)
1067 target_reset_examined(target);
1069 struct target_type *type = target->type;
1070 if (type->examine == NULL)
1071 type->examine = default_examine;
1073 if (type->check_reset == NULL)
1074 type->check_reset = default_check_reset;
1076 assert(type->init_target != NULL);
1078 int retval = type->init_target(cmd_ctx, target);
1079 if (ERROR_OK != retval) {
1080 LOG_ERROR("target '%s' init failed", target_name(target));
1084 /* Sanity-check MMU support ... stub in what we must, to help
1085 * implement it in stages, but warn if we need to do so.
1088 if (type->write_phys_memory == NULL) {
1089 LOG_ERROR("type '%s' is missing write_phys_memory",
1091 type->write_phys_memory = err_write_phys_memory;
1093 if (type->read_phys_memory == NULL) {
1094 LOG_ERROR("type '%s' is missing read_phys_memory",
1096 type->read_phys_memory = err_read_phys_memory;
1098 if (type->virt2phys == NULL) {
1099 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1100 type->virt2phys = identity_virt2phys;
1103 /* Make sure no-MMU targets all behave the same: make no
1104 * distinction between physical and virtual addresses, and
1105 * ensure that virt2phys() is always an identity mapping.
1107 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1108 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1111 type->write_phys_memory = type->write_memory;
1112 type->read_phys_memory = type->read_memory;
1113 type->virt2phys = identity_virt2phys;
1116 if (target->type->read_buffer == NULL)
1117 target->type->read_buffer = target_read_buffer_default;
1119 if (target->type->write_buffer == NULL)
1120 target->type->write_buffer = target_write_buffer_default;
1125 static int target_init(struct command_context *cmd_ctx)
1127 struct target *target;
1130 for (target = all_targets; target; target = target->next) {
1131 retval = target_init_one(cmd_ctx, target);
1132 if (ERROR_OK != retval)
1139 retval = target_register_user_commands(cmd_ctx);
1140 if (ERROR_OK != retval)
1143 retval = target_register_timer_callback(&handle_target,
1144 polling_interval, 1, cmd_ctx->interp);
1145 if (ERROR_OK != retval)
1151 COMMAND_HANDLER(handle_target_init_command)
1156 return ERROR_COMMAND_SYNTAX_ERROR;
1158 static bool target_initialized;
1159 if (target_initialized) {
1160 LOG_INFO("'target init' has already been called");
1163 target_initialized = true;
1165 retval = command_run_line(CMD_CTX, "init_targets");
1166 if (ERROR_OK != retval)
1169 retval = command_run_line(CMD_CTX, "init_board");
1170 if (ERROR_OK != retval)
1173 LOG_DEBUG("Initializing targets...");
1174 return target_init(CMD_CTX);
1177 int target_register_event_callback(int (*callback)(struct target *target,
1178 enum target_event event, void *priv), void *priv)
1180 struct target_event_callback **callbacks_p = &target_event_callbacks;
1182 if (callback == NULL)
1183 return ERROR_COMMAND_SYNTAX_ERROR;
1186 while ((*callbacks_p)->next)
1187 callbacks_p = &((*callbacks_p)->next);
1188 callbacks_p = &((*callbacks_p)->next);
1191 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1192 (*callbacks_p)->callback = callback;
1193 (*callbacks_p)->priv = priv;
1194 (*callbacks_p)->next = NULL;
1199 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
1201 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1204 if (callback == NULL)
1205 return ERROR_COMMAND_SYNTAX_ERROR;
1208 while ((*callbacks_p)->next)
1209 callbacks_p = &((*callbacks_p)->next);
1210 callbacks_p = &((*callbacks_p)->next);
1213 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1214 (*callbacks_p)->callback = callback;
1215 (*callbacks_p)->periodic = periodic;
1216 (*callbacks_p)->time_ms = time_ms;
1218 gettimeofday(&now, NULL);
1219 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
1220 time_ms -= (time_ms % 1000);
1221 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
1222 if ((*callbacks_p)->when.tv_usec > 1000000) {
1223 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
1224 (*callbacks_p)->when.tv_sec += 1;
1227 (*callbacks_p)->priv = priv;
1228 (*callbacks_p)->next = NULL;
1233 int target_unregister_event_callback(int (*callback)(struct target *target,
1234 enum target_event event, void *priv), void *priv)
1236 struct target_event_callback **p = &target_event_callbacks;
1237 struct target_event_callback *c = target_event_callbacks;
1239 if (callback == NULL)
1240 return ERROR_COMMAND_SYNTAX_ERROR;
1243 struct target_event_callback *next = c->next;
1244 if ((c->callback == callback) && (c->priv == priv)) {
1256 static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1258 struct target_timer_callback **p = &target_timer_callbacks;
1259 struct target_timer_callback *c = target_timer_callbacks;
1261 if (callback == NULL)
1262 return ERROR_COMMAND_SYNTAX_ERROR;
1265 struct target_timer_callback *next = c->next;
1266 if ((c->callback == callback) && (c->priv == priv)) {
1278 int target_call_event_callbacks(struct target *target, enum target_event event)
1280 struct target_event_callback *callback = target_event_callbacks;
1281 struct target_event_callback *next_callback;
1283 if (event == TARGET_EVENT_HALTED) {
1284 /* execute early halted first */
1285 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1288 LOG_DEBUG("target event %i (%s)", event,
1289 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1291 target_handle_event(target, event);
1294 next_callback = callback->next;
1295 callback->callback(target, event, callback->priv);
1296 callback = next_callback;
1302 static int target_timer_callback_periodic_restart(
1303 struct target_timer_callback *cb, struct timeval *now)
1305 int time_ms = cb->time_ms;
1306 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1307 time_ms -= (time_ms % 1000);
1308 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1309 if (cb->when.tv_usec > 1000000) {
1310 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1311 cb->when.tv_sec += 1;
1316 static int target_call_timer_callback(struct target_timer_callback *cb,
1317 struct timeval *now)
1319 cb->callback(cb->priv);
1322 return target_timer_callback_periodic_restart(cb, now);
1324 return target_unregister_timer_callback(cb->callback, cb->priv);
1327 static int target_call_timer_callbacks_check_time(int checktime)
1332 gettimeofday(&now, NULL);
1334 struct target_timer_callback *callback = target_timer_callbacks;
1336 /* cleaning up may unregister and free this callback */
1337 struct target_timer_callback *next_callback = callback->next;
1339 bool call_it = callback->callback &&
1340 ((!checktime && callback->periodic) ||
1341 now.tv_sec > callback->when.tv_sec ||
1342 (now.tv_sec == callback->when.tv_sec &&
1343 now.tv_usec >= callback->when.tv_usec));
1346 int retval = target_call_timer_callback(callback, &now);
1347 if (retval != ERROR_OK)
1351 callback = next_callback;
1357 int target_call_timer_callbacks(void)
1359 return target_call_timer_callbacks_check_time(1);
1362 /* invoke periodic callbacks immediately */
1363 int target_call_timer_callbacks_now(void)
1365 return target_call_timer_callbacks_check_time(0);
1368 /* Prints the working area layout for debug purposes */
1369 static void print_wa_layout(struct target *target)
1371 struct working_area *c = target->working_areas;
1374 LOG_DEBUG("%c%c 0x%08"PRIx32"-0x%08"PRIx32" (%"PRIu32" bytes)",
1375 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1376 c->address, c->address + c->size - 1, c->size);
1381 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1382 static void target_split_working_area(struct working_area *area, uint32_t size)
1384 assert(area->free); /* Shouldn't split an allocated area */
1385 assert(size <= area->size); /* Caller should guarantee this */
1387 /* Split only if not already the right size */
1388 if (size < area->size) {
1389 struct working_area *new_wa = malloc(sizeof(*new_wa));
1394 new_wa->next = area->next;
1395 new_wa->size = area->size - size;
1396 new_wa->address = area->address + size;
1397 new_wa->backup = NULL;
1398 new_wa->user = NULL;
1399 new_wa->free = true;
1401 area->next = new_wa;
1404 /* If backup memory was allocated to this area, it has the wrong size
1405 * now so free it and it will be reallocated if/when needed */
1408 area->backup = NULL;
1413 /* Merge all adjacent free areas into one */
1414 static void target_merge_working_areas(struct target *target)
1416 struct working_area *c = target->working_areas;
1418 while (c && c->next) {
1419 assert(c->next->address == c->address + c->size); /* This is an invariant */
1421 /* Find two adjacent free areas */
1422 if (c->free && c->next->free) {
1423 /* Merge the last into the first */
1424 c->size += c->next->size;
1426 /* Remove the last */
1427 struct working_area *to_be_freed = c->next;
1428 c->next = c->next->next;
1429 if (to_be_freed->backup)
1430 free(to_be_freed->backup);
1433 /* If backup memory was allocated to the remaining area, it's has
1434 * the wrong size now */
1445 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1447 /* Reevaluate working area address based on MMU state*/
1448 if (target->working_areas == NULL) {
1452 retval = target->type->mmu(target, &enabled);
1453 if (retval != ERROR_OK)
1457 if (target->working_area_phys_spec) {
1458 LOG_DEBUG("MMU disabled, using physical "
1459 "address for working memory 0x%08"PRIx32,
1460 target->working_area_phys);
1461 target->working_area = target->working_area_phys;
1463 LOG_ERROR("No working memory available. "
1464 "Specify -work-area-phys to target.");
1465 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1468 if (target->working_area_virt_spec) {
1469 LOG_DEBUG("MMU enabled, using virtual "
1470 "address for working memory 0x%08"PRIx32,
1471 target->working_area_virt);
1472 target->working_area = target->working_area_virt;
1474 LOG_ERROR("No working memory available. "
1475 "Specify -work-area-virt to target.");
1476 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1480 /* Set up initial working area on first call */
1481 struct working_area *new_wa = malloc(sizeof(*new_wa));
1483 new_wa->next = NULL;
1484 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1485 new_wa->address = target->working_area;
1486 new_wa->backup = NULL;
1487 new_wa->user = NULL;
1488 new_wa->free = true;
1491 target->working_areas = new_wa;
1494 /* only allocate multiples of 4 byte */
1496 size = (size + 3) & (~3UL);
1498 struct working_area *c = target->working_areas;
1500 /* Find the first large enough working area */
1502 if (c->free && c->size >= size)
1508 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1510 /* Split the working area into the requested size */
1511 target_split_working_area(c, size);
1513 LOG_DEBUG("allocated new working area of %"PRIu32" bytes at address 0x%08"PRIx32, size, c->address);
1515 if (target->backup_working_area) {
1516 if (c->backup == NULL) {
1517 c->backup = malloc(c->size);
1518 if (c->backup == NULL)
1522 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1523 if (retval != ERROR_OK)
1527 /* mark as used, and return the new (reused) area */
1534 print_wa_layout(target);
1539 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1543 retval = target_alloc_working_area_try(target, size, area);
1544 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1545 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1550 static int target_restore_working_area(struct target *target, struct working_area *area)
1552 int retval = ERROR_OK;
1554 if (target->backup_working_area && area->backup != NULL) {
1555 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1556 if (retval != ERROR_OK)
1557 LOG_ERROR("failed to restore %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1558 area->size, area->address);
1564 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1565 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1567 int retval = ERROR_OK;
1573 retval = target_restore_working_area(target, area);
1574 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1575 if (retval != ERROR_OK)
1581 LOG_DEBUG("freed %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1582 area->size, area->address);
1584 /* mark user pointer invalid */
1585 /* TODO: Is this really safe? It points to some previous caller's memory.
1586 * How could we know that the area pointer is still in that place and not
1587 * some other vital data? What's the purpose of this, anyway? */
1591 target_merge_working_areas(target);
1593 print_wa_layout(target);
1598 int target_free_working_area(struct target *target, struct working_area *area)
1600 return target_free_working_area_restore(target, area, 1);
1603 /* free resources and restore memory, if restoring memory fails,
1604 * free up resources anyway
1606 static void target_free_all_working_areas_restore(struct target *target, int restore)
1608 struct working_area *c = target->working_areas;
1610 LOG_DEBUG("freeing all working areas");
1612 /* Loop through all areas, restoring the allocated ones and marking them as free */
1616 target_restore_working_area(target, c);
1618 *c->user = NULL; /* Same as above */
1624 /* Run a merge pass to combine all areas into one */
1625 target_merge_working_areas(target);
1627 print_wa_layout(target);
1630 void target_free_all_working_areas(struct target *target)
1632 target_free_all_working_areas_restore(target, 1);
1635 /* Find the largest number of bytes that can be allocated */
1636 uint32_t target_get_working_area_avail(struct target *target)
1638 struct working_area *c = target->working_areas;
1639 uint32_t max_size = 0;
1642 return target->working_area_size;
1645 if (c->free && max_size < c->size)
1654 int target_arch_state(struct target *target)
1657 if (target == NULL) {
1658 LOG_USER("No target has been configured");
1662 LOG_USER("target state: %s", target_state_name(target));
1664 if (target->state != TARGET_HALTED)
1667 retval = target->type->arch_state(target);
1671 /* Single aligned words are guaranteed to use 16 or 32 bit access
1672 * mode respectively, otherwise data is handled as quickly as
1675 int target_write_buffer(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1677 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x",
1678 (int)size, (unsigned)address);
1680 if (!target_was_examined(target)) {
1681 LOG_ERROR("Target not examined yet");
1688 if ((address + size - 1) < address) {
1689 /* GDB can request this when e.g. PC is 0xfffffffc*/
1690 LOG_ERROR("address + size wrapped(0x%08x, 0x%08x)",
1696 return target->type->write_buffer(target, address, size, buffer);
1699 static int target_write_buffer_default(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1701 int retval = ERROR_OK;
1703 if (((address % 2) == 0) && (size == 2))
1704 return target_write_memory(target, address, 2, 1, buffer);
1706 /* handle unaligned head bytes */
1708 uint32_t unaligned = 4 - (address % 4);
1710 if (unaligned > size)
1713 retval = target_write_memory(target, address, 1, unaligned, buffer);
1714 if (retval != ERROR_OK)
1717 buffer += unaligned;
1718 address += unaligned;
1722 /* handle aligned words */
1724 int aligned = size - (size % 4);
1726 /* use bulk writes above a certain limit. This may have to be changed */
1727 if (aligned > 128) {
1728 retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer);
1729 if (retval != ERROR_OK)
1732 retval = target_write_memory(target, address, 4, aligned / 4, buffer);
1733 if (retval != ERROR_OK)
1742 /* handle tail writes of less than 4 bytes */
1744 retval = target_write_memory(target, address, 1, size, buffer);
1745 if (retval != ERROR_OK)
1752 /* Single aligned words are guaranteed to use 16 or 32 bit access
1753 * mode respectively, otherwise data is handled as quickly as
1756 int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1758 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
1759 (int)size, (unsigned)address);
1761 if (!target_was_examined(target)) {
1762 LOG_ERROR("Target not examined yet");
1769 if ((address + size - 1) < address) {
1770 /* GDB can request this when e.g. PC is 0xfffffffc*/
1771 LOG_ERROR("address + size wrapped(0x%08" PRIx32 ", 0x%08" PRIx32 ")",
1777 return target->type->read_buffer(target, address, size, buffer);
1780 static int target_read_buffer_default(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1782 int retval = ERROR_OK;
1784 if (((address % 2) == 0) && (size == 2))
1785 return target_read_memory(target, address, 2, 1, buffer);
1787 /* handle unaligned head bytes */
1789 uint32_t unaligned = 4 - (address % 4);
1791 if (unaligned > size)
1794 retval = target_read_memory(target, address, 1, unaligned, buffer);
1795 if (retval != ERROR_OK)
1798 buffer += unaligned;
1799 address += unaligned;
1803 /* handle aligned words */
1805 int aligned = size - (size % 4);
1807 retval = target_read_memory(target, address, 4, aligned / 4, buffer);
1808 if (retval != ERROR_OK)
1816 /*prevent byte access when possible (avoid AHB access limitations in some cases)*/
1818 int aligned = size - (size % 2);
1819 retval = target_read_memory(target, address, 2, aligned / 2, buffer);
1820 if (retval != ERROR_OK)
1827 /* handle tail writes of less than 4 bytes */
1829 retval = target_read_memory(target, address, 1, size, buffer);
1830 if (retval != ERROR_OK)
1837 int target_checksum_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* crc)
1842 uint32_t checksum = 0;
1843 if (!target_was_examined(target)) {
1844 LOG_ERROR("Target not examined yet");
1848 retval = target->type->checksum_memory(target, address, size, &checksum);
1849 if (retval != ERROR_OK) {
1850 buffer = malloc(size);
1851 if (buffer == NULL) {
1852 LOG_ERROR("error allocating buffer for section (%d bytes)", (int)size);
1853 return ERROR_COMMAND_SYNTAX_ERROR;
1855 retval = target_read_buffer(target, address, size, buffer);
1856 if (retval != ERROR_OK) {
1861 /* convert to target endianness */
1862 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
1863 uint32_t target_data;
1864 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
1865 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
1868 retval = image_calculate_checksum(buffer, size, &checksum);
1877 int target_blank_check_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* blank)
1880 if (!target_was_examined(target)) {
1881 LOG_ERROR("Target not examined yet");
1885 if (target->type->blank_check_memory == 0)
1886 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1888 retval = target->type->blank_check_memory(target, address, size, blank);
1893 int target_read_u32(struct target *target, uint32_t address, uint32_t *value)
1895 uint8_t value_buf[4];
1896 if (!target_was_examined(target)) {
1897 LOG_ERROR("Target not examined yet");
1901 int retval = target_read_memory(target, address, 4, 1, value_buf);
1903 if (retval == ERROR_OK) {
1904 *value = target_buffer_get_u32(target, value_buf);
1905 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1910 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1917 int target_read_u16(struct target *target, uint32_t address, uint16_t *value)
1919 uint8_t value_buf[2];
1920 if (!target_was_examined(target)) {
1921 LOG_ERROR("Target not examined yet");
1925 int retval = target_read_memory(target, address, 2, 1, value_buf);
1927 if (retval == ERROR_OK) {
1928 *value = target_buffer_get_u16(target, value_buf);
1929 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4x",
1934 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1941 int target_read_u8(struct target *target, uint32_t address, uint8_t *value)
1943 int retval = target_read_memory(target, address, 1, 1, value);
1944 if (!target_was_examined(target)) {
1945 LOG_ERROR("Target not examined yet");
1949 if (retval == ERROR_OK) {
1950 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
1955 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1962 int target_write_u32(struct target *target, uint32_t address, uint32_t value)
1965 uint8_t value_buf[4];
1966 if (!target_was_examined(target)) {
1967 LOG_ERROR("Target not examined yet");
1971 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1975 target_buffer_set_u32(target, value_buf, value);
1976 retval = target_write_memory(target, address, 4, 1, value_buf);
1977 if (retval != ERROR_OK)
1978 LOG_DEBUG("failed: %i", retval);
1983 int target_write_u16(struct target *target, uint32_t address, uint16_t value)
1986 uint8_t value_buf[2];
1987 if (!target_was_examined(target)) {
1988 LOG_ERROR("Target not examined yet");
1992 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8x",
1996 target_buffer_set_u16(target, value_buf, value);
1997 retval = target_write_memory(target, address, 2, 1, value_buf);
1998 if (retval != ERROR_OK)
1999 LOG_DEBUG("failed: %i", retval);
2004 int target_write_u8(struct target *target, uint32_t address, uint8_t value)
2007 if (!target_was_examined(target)) {
2008 LOG_ERROR("Target not examined yet");
2012 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
2015 retval = target_write_memory(target, address, 1, 1, &value);
2016 if (retval != ERROR_OK)
2017 LOG_DEBUG("failed: %i", retval);
2022 static int find_target(struct command_context *cmd_ctx, const char *name)
2024 struct target *target = get_target(name);
2025 if (target == NULL) {
2026 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2029 if (!target->tap->enabled) {
2030 LOG_USER("Target: TAP %s is disabled, "
2031 "can't be the current target\n",
2032 target->tap->dotted_name);
2036 cmd_ctx->current_target = target->target_number;
2041 COMMAND_HANDLER(handle_targets_command)
2043 int retval = ERROR_OK;
2044 if (CMD_ARGC == 1) {
2045 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2046 if (retval == ERROR_OK) {
2052 struct target *target = all_targets;
2053 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2054 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2059 if (target->tap->enabled)
2060 state = target_state_name(target);
2062 state = "tap-disabled";
2064 if (CMD_CTX->current_target == target->target_number)
2067 /* keep columns lined up to match the headers above */
2068 command_print(CMD_CTX,
2069 "%2d%c %-18s %-10s %-6s %-18s %s",
2070 target->target_number,
2072 target_name(target),
2073 target_type_name(target),
2074 Jim_Nvp_value2name_simple(nvp_target_endian,
2075 target->endianness)->name,
2076 target->tap->dotted_name,
2078 target = target->next;
2084 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2086 static int powerDropout;
2087 static int srstAsserted;
2089 static int runPowerRestore;
2090 static int runPowerDropout;
2091 static int runSrstAsserted;
2092 static int runSrstDeasserted;
2094 static int sense_handler(void)
2096 static int prevSrstAsserted;
2097 static int prevPowerdropout;
2099 int retval = jtag_power_dropout(&powerDropout);
2100 if (retval != ERROR_OK)
2104 powerRestored = prevPowerdropout && !powerDropout;
2106 runPowerRestore = 1;
2108 long long current = timeval_ms();
2109 static long long lastPower;
2110 int waitMore = lastPower + 2000 > current;
2111 if (powerDropout && !waitMore) {
2112 runPowerDropout = 1;
2113 lastPower = current;
2116 retval = jtag_srst_asserted(&srstAsserted);
2117 if (retval != ERROR_OK)
2121 srstDeasserted = prevSrstAsserted && !srstAsserted;
2123 static long long lastSrst;
2124 waitMore = lastSrst + 2000 > current;
2125 if (srstDeasserted && !waitMore) {
2126 runSrstDeasserted = 1;
2130 if (!prevSrstAsserted && srstAsserted)
2131 runSrstAsserted = 1;
2133 prevSrstAsserted = srstAsserted;
2134 prevPowerdropout = powerDropout;
2136 if (srstDeasserted || powerRestored) {
2137 /* Other than logging the event we can't do anything here.
2138 * Issuing a reset is a particularly bad idea as we might
2139 * be inside a reset already.
2146 /* process target state changes */
2147 static int handle_target(void *priv)
2149 Jim_Interp *interp = (Jim_Interp *)priv;
2150 int retval = ERROR_OK;
2152 if (!is_jtag_poll_safe()) {
2153 /* polling is disabled currently */
2157 /* we do not want to recurse here... */
2158 static int recursive;
2162 /* danger! running these procedures can trigger srst assertions and power dropouts.
2163 * We need to avoid an infinite loop/recursion here and we do that by
2164 * clearing the flags after running these events.
2166 int did_something = 0;
2167 if (runSrstAsserted) {
2168 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2169 Jim_Eval(interp, "srst_asserted");
2172 if (runSrstDeasserted) {
2173 Jim_Eval(interp, "srst_deasserted");
2176 if (runPowerDropout) {
2177 LOG_INFO("Power dropout detected, running power_dropout proc.");
2178 Jim_Eval(interp, "power_dropout");
2181 if (runPowerRestore) {
2182 Jim_Eval(interp, "power_restore");
2186 if (did_something) {
2187 /* clear detect flags */
2191 /* clear action flags */
2193 runSrstAsserted = 0;
2194 runSrstDeasserted = 0;
2195 runPowerRestore = 0;
2196 runPowerDropout = 0;
2201 /* Poll targets for state changes unless that's globally disabled.
2202 * Skip targets that are currently disabled.
2204 for (struct target *target = all_targets;
2205 is_jtag_poll_safe() && target;
2206 target = target->next) {
2207 if (!target->tap->enabled)
2210 if (target->backoff.times > target->backoff.count) {
2211 /* do not poll this time as we failed previously */
2212 target->backoff.count++;
2215 target->backoff.count = 0;
2217 /* only poll target if we've got power and srst isn't asserted */
2218 if (!powerDropout && !srstAsserted) {
2219 /* polling may fail silently until the target has been examined */
2220 retval = target_poll(target);
2221 if (retval != ERROR_OK) {
2222 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2223 if (target->backoff.times * polling_interval < 5000) {
2224 target->backoff.times *= 2;
2225 target->backoff.times++;
2227 LOG_USER("Polling target %s failed, GDB will be halted. Polling again in %dms",
2228 target_name(target),
2229 target->backoff.times * polling_interval);
2231 /* Tell GDB to halt the debugger. This allows the user to
2232 * run monitor commands to handle the situation.
2234 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2237 /* Since we succeeded, we reset backoff count */
2238 if (target->backoff.times > 0)
2239 LOG_USER("Polling target %s succeeded again", target_name(target));
2240 target->backoff.times = 0;
2247 COMMAND_HANDLER(handle_reg_command)
2249 struct target *target;
2250 struct reg *reg = NULL;
2256 target = get_current_target(CMD_CTX);
2258 /* list all available registers for the current target */
2259 if (CMD_ARGC == 0) {
2260 struct reg_cache *cache = target->reg_cache;
2266 command_print(CMD_CTX, "===== %s", cache->name);
2268 for (i = 0, reg = cache->reg_list;
2269 i < cache->num_regs;
2270 i++, reg++, count++) {
2271 /* only print cached values if they are valid */
2273 value = buf_to_str(reg->value,
2275 command_print(CMD_CTX,
2276 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2284 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2289 cache = cache->next;
2295 /* access a single register by its ordinal number */
2296 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2298 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2300 struct reg_cache *cache = target->reg_cache;
2304 for (i = 0; i < cache->num_regs; i++) {
2305 if (count++ == num) {
2306 reg = &cache->reg_list[i];
2312 cache = cache->next;
2316 command_print(CMD_CTX, "%i is out of bounds, the current target "
2317 "has only %i registers (0 - %i)", num, count, count - 1);
2321 /* access a single register by its name */
2322 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2325 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2330 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2332 /* display a register */
2333 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2334 && (CMD_ARGV[1][0] <= '9')))) {
2335 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2338 if (reg->valid == 0)
2339 reg->type->get(reg);
2340 value = buf_to_str(reg->value, reg->size, 16);
2341 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2346 /* set register value */
2347 if (CMD_ARGC == 2) {
2348 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2351 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2353 reg->type->set(reg, buf);
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);
2364 return ERROR_COMMAND_SYNTAX_ERROR;
2367 COMMAND_HANDLER(handle_poll_command)
2369 int retval = ERROR_OK;
2370 struct target *target = get_current_target(CMD_CTX);
2372 if (CMD_ARGC == 0) {
2373 command_print(CMD_CTX, "background polling: %s",
2374 jtag_poll_get_enabled() ? "on" : "off");
2375 command_print(CMD_CTX, "TAP: %s (%s)",
2376 target->tap->dotted_name,
2377 target->tap->enabled ? "enabled" : "disabled");
2378 if (!target->tap->enabled)
2380 retval = target_poll(target);
2381 if (retval != ERROR_OK)
2383 retval = target_arch_state(target);
2384 if (retval != ERROR_OK)
2386 } else if (CMD_ARGC == 1) {
2388 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2389 jtag_poll_set_enabled(enable);
2391 return ERROR_COMMAND_SYNTAX_ERROR;
2396 COMMAND_HANDLER(handle_wait_halt_command)
2399 return ERROR_COMMAND_SYNTAX_ERROR;
2402 if (1 == CMD_ARGC) {
2403 int retval = parse_uint(CMD_ARGV[0], &ms);
2404 if (ERROR_OK != retval)
2405 return ERROR_COMMAND_SYNTAX_ERROR;
2406 /* convert seconds (given) to milliseconds (needed) */
2410 struct target *target = get_current_target(CMD_CTX);
2411 return target_wait_state(target, TARGET_HALTED, ms);
2414 /* wait for target state to change. The trick here is to have a low
2415 * latency for short waits and not to suck up all the CPU time
2418 * After 500ms, keep_alive() is invoked
2420 int target_wait_state(struct target *target, enum target_state state, int ms)
2423 long long then = 0, cur;
2427 retval = target_poll(target);
2428 if (retval != ERROR_OK)
2430 if (target->state == state)
2435 then = timeval_ms();
2436 LOG_DEBUG("waiting for target %s...",
2437 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2443 if ((cur-then) > ms) {
2444 LOG_ERROR("timed out while waiting for target %s",
2445 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2453 COMMAND_HANDLER(handle_halt_command)
2457 struct target *target = get_current_target(CMD_CTX);
2458 int retval = target_halt(target);
2459 if (ERROR_OK != retval)
2462 if (CMD_ARGC == 1) {
2463 unsigned wait_local;
2464 retval = parse_uint(CMD_ARGV[0], &wait_local);
2465 if (ERROR_OK != retval)
2466 return ERROR_COMMAND_SYNTAX_ERROR;
2471 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
2474 COMMAND_HANDLER(handle_soft_reset_halt_command)
2476 struct target *target = get_current_target(CMD_CTX);
2478 LOG_USER("requesting target halt and executing a soft reset");
2480 target_soft_reset_halt(target);
2485 COMMAND_HANDLER(handle_reset_command)
2488 return ERROR_COMMAND_SYNTAX_ERROR;
2490 enum target_reset_mode reset_mode = RESET_RUN;
2491 if (CMD_ARGC == 1) {
2493 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
2494 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
2495 return ERROR_COMMAND_SYNTAX_ERROR;
2496 reset_mode = n->value;
2499 /* reset *all* targets */
2500 return target_process_reset(CMD_CTX, reset_mode);
2504 COMMAND_HANDLER(handle_resume_command)
2508 return ERROR_COMMAND_SYNTAX_ERROR;
2510 struct target *target = get_current_target(CMD_CTX);
2512 /* with no CMD_ARGV, resume from current pc, addr = 0,
2513 * with one arguments, addr = CMD_ARGV[0],
2514 * handle breakpoints, not debugging */
2516 if (CMD_ARGC == 1) {
2517 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2521 return target_resume(target, current, addr, 1, 0);
2524 COMMAND_HANDLER(handle_step_command)
2527 return ERROR_COMMAND_SYNTAX_ERROR;
2531 /* with no CMD_ARGV, step from current pc, addr = 0,
2532 * with one argument addr = CMD_ARGV[0],
2533 * handle breakpoints, debugging */
2536 if (CMD_ARGC == 1) {
2537 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2541 struct target *target = get_current_target(CMD_CTX);
2543 return target->type->step(target, current_pc, addr, 1);
2546 static void handle_md_output(struct command_context *cmd_ctx,
2547 struct target *target, uint32_t address, unsigned size,
2548 unsigned count, const uint8_t *buffer)
2550 const unsigned line_bytecnt = 32;
2551 unsigned line_modulo = line_bytecnt / size;
2553 char output[line_bytecnt * 4 + 1];
2554 unsigned output_len = 0;
2556 const char *value_fmt;
2559 value_fmt = "%8.8x ";
2562 value_fmt = "%4.4x ";
2565 value_fmt = "%2.2x ";
2568 /* "can't happen", caller checked */
2569 LOG_ERROR("invalid memory read size: %u", size);
2573 for (unsigned i = 0; i < count; i++) {
2574 if (i % line_modulo == 0) {
2575 output_len += snprintf(output + output_len,
2576 sizeof(output) - output_len,
2578 (unsigned)(address + (i*size)));
2582 const uint8_t *value_ptr = buffer + i * size;
2585 value = target_buffer_get_u32(target, value_ptr);
2588 value = target_buffer_get_u16(target, value_ptr);
2593 output_len += snprintf(output + output_len,
2594 sizeof(output) - output_len,
2597 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
2598 command_print(cmd_ctx, "%s", output);
2604 COMMAND_HANDLER(handle_md_command)
2607 return ERROR_COMMAND_SYNTAX_ERROR;
2610 switch (CMD_NAME[2]) {
2621 return ERROR_COMMAND_SYNTAX_ERROR;
2624 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2625 int (*fn)(struct target *target,
2626 uint32_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
2630 fn = target_read_phys_memory;
2632 fn = target_read_memory;
2633 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
2634 return ERROR_COMMAND_SYNTAX_ERROR;
2637 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2641 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
2643 uint8_t *buffer = calloc(count, size);
2645 struct target *target = get_current_target(CMD_CTX);
2646 int retval = fn(target, address, size, count, buffer);
2647 if (ERROR_OK == retval)
2648 handle_md_output(CMD_CTX, target, address, size, count, buffer);
2655 typedef int (*target_write_fn)(struct target *target,
2656 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
2658 static int target_write_memory_fast(struct target *target,
2659 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
2661 return target_write_buffer(target, address, size * count, buffer);
2664 static int target_fill_mem(struct target *target,
2673 /* We have to write in reasonably large chunks to be able
2674 * to fill large memory areas with any sane speed */
2675 const unsigned chunk_size = 16384;
2676 uint8_t *target_buf = malloc(chunk_size * data_size);
2677 if (target_buf == NULL) {
2678 LOG_ERROR("Out of memory");
2682 for (unsigned i = 0; i < chunk_size; i++) {
2683 switch (data_size) {
2685 target_buffer_set_u32(target, target_buf + i * data_size, b);
2688 target_buffer_set_u16(target, target_buf + i * data_size, b);
2691 target_buffer_set_u8(target, target_buf + i * data_size, b);
2698 int retval = ERROR_OK;
2700 for (unsigned x = 0; x < c; x += chunk_size) {
2703 if (current > chunk_size)
2704 current = chunk_size;
2705 retval = fn(target, address + x * data_size, data_size, current, target_buf);
2706 if (retval != ERROR_OK)
2708 /* avoid GDB timeouts */
2717 COMMAND_HANDLER(handle_mw_command)
2720 return ERROR_COMMAND_SYNTAX_ERROR;
2721 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2726 fn = target_write_phys_memory;
2728 fn = target_write_memory_fast;
2729 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
2730 return ERROR_COMMAND_SYNTAX_ERROR;
2733 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2736 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2740 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
2742 struct target *target = get_current_target(CMD_CTX);
2744 switch (CMD_NAME[2]) {
2755 return ERROR_COMMAND_SYNTAX_ERROR;
2758 return target_fill_mem(target, address, fn, wordsize, value, count);
2761 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
2762 uint32_t *min_address, uint32_t *max_address)
2764 if (CMD_ARGC < 1 || CMD_ARGC > 5)
2765 return ERROR_COMMAND_SYNTAX_ERROR;
2767 /* a base address isn't always necessary,
2768 * default to 0x0 (i.e. don't relocate) */
2769 if (CMD_ARGC >= 2) {
2771 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2772 image->base_address = addr;
2773 image->base_address_set = 1;
2775 image->base_address_set = 0;
2777 image->start_address_set = 0;
2780 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], *min_address);
2781 if (CMD_ARGC == 5) {
2782 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], *max_address);
2783 /* use size (given) to find max (required) */
2784 *max_address += *min_address;
2787 if (*min_address > *max_address)
2788 return ERROR_COMMAND_SYNTAX_ERROR;
2793 COMMAND_HANDLER(handle_load_image_command)
2797 uint32_t image_size;
2798 uint32_t min_address = 0;
2799 uint32_t max_address = 0xffffffff;
2803 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
2804 &image, &min_address, &max_address);
2805 if (ERROR_OK != retval)
2808 struct target *target = get_current_target(CMD_CTX);
2810 struct duration bench;
2811 duration_start(&bench);
2813 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
2818 for (i = 0; i < image.num_sections; i++) {
2819 buffer = malloc(image.sections[i].size);
2820 if (buffer == NULL) {
2821 command_print(CMD_CTX,
2822 "error allocating buffer for section (%d bytes)",
2823 (int)(image.sections[i].size));
2827 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
2828 if (retval != ERROR_OK) {
2833 uint32_t offset = 0;
2834 uint32_t length = buf_cnt;
2836 /* DANGER!!! beware of unsigned comparision here!!! */
2838 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
2839 (image.sections[i].base_address < max_address)) {
2841 if (image.sections[i].base_address < min_address) {
2842 /* clip addresses below */
2843 offset += min_address-image.sections[i].base_address;
2847 if (image.sections[i].base_address + buf_cnt > max_address)
2848 length -= (image.sections[i].base_address + buf_cnt)-max_address;
2850 retval = target_write_buffer(target,
2851 image.sections[i].base_address + offset, length, buffer + offset);
2852 if (retval != ERROR_OK) {
2856 image_size += length;
2857 command_print(CMD_CTX, "%u bytes written at address 0x%8.8" PRIx32 "",
2858 (unsigned int)length,
2859 image.sections[i].base_address + offset);
2865 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2866 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
2867 "in %fs (%0.3f KiB/s)", image_size,
2868 duration_elapsed(&bench), duration_kbps(&bench, image_size));
2871 image_close(&image);
2877 COMMAND_HANDLER(handle_dump_image_command)
2879 struct fileio fileio;
2881 int retval, retvaltemp;
2882 uint32_t address, size;
2883 struct duration bench;
2884 struct target *target = get_current_target(CMD_CTX);
2887 return ERROR_COMMAND_SYNTAX_ERROR;
2889 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], address);
2890 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], size);
2892 uint32_t buf_size = (size > 4096) ? 4096 : size;
2893 buffer = malloc(buf_size);
2897 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
2898 if (retval != ERROR_OK) {
2903 duration_start(&bench);
2906 size_t size_written;
2907 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
2908 retval = target_read_buffer(target, address, this_run_size, buffer);
2909 if (retval != ERROR_OK)
2912 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2913 if (retval != ERROR_OK)
2916 size -= this_run_size;
2917 address += this_run_size;
2922 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2924 retval = fileio_size(&fileio, &filesize);
2925 if (retval != ERROR_OK)
2927 command_print(CMD_CTX,
2928 "dumped %ld bytes in %fs (%0.3f KiB/s)", (long)filesize,
2929 duration_elapsed(&bench), duration_kbps(&bench, filesize));
2932 retvaltemp = fileio_close(&fileio);
2933 if (retvaltemp != ERROR_OK)
2939 static COMMAND_HELPER(handle_verify_image_command_internal, int verify)
2943 uint32_t image_size;
2946 uint32_t checksum = 0;
2947 uint32_t mem_checksum = 0;
2951 struct target *target = get_current_target(CMD_CTX);
2954 return ERROR_COMMAND_SYNTAX_ERROR;
2957 LOG_ERROR("no target selected");
2961 struct duration bench;
2962 duration_start(&bench);
2964 if (CMD_ARGC >= 2) {
2966 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2967 image.base_address = addr;
2968 image.base_address_set = 1;
2970 image.base_address_set = 0;
2971 image.base_address = 0x0;
2974 image.start_address_set = 0;
2976 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
2977 if (retval != ERROR_OK)
2983 for (i = 0; i < image.num_sections; i++) {
2984 buffer = malloc(image.sections[i].size);
2985 if (buffer == NULL) {
2986 command_print(CMD_CTX,
2987 "error allocating buffer for section (%d bytes)",
2988 (int)(image.sections[i].size));
2991 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
2992 if (retval != ERROR_OK) {
2998 /* calculate checksum of image */
2999 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3000 if (retval != ERROR_OK) {
3005 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3006 if (retval != ERROR_OK) {
3011 if (checksum != mem_checksum) {
3012 /* failed crc checksum, fall back to a binary compare */
3016 LOG_ERROR("checksum mismatch - attempting binary compare");
3018 data = (uint8_t *)malloc(buf_cnt);
3020 /* Can we use 32bit word accesses? */
3022 int count = buf_cnt;
3023 if ((count % 4) == 0) {
3027 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3028 if (retval == ERROR_OK) {
3030 for (t = 0; t < buf_cnt; t++) {
3031 if (data[t] != buffer[t]) {
3032 command_print(CMD_CTX,
3033 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3035 (unsigned)(t + image.sections[i].base_address),
3038 if (diffs++ >= 127) {
3039 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3051 command_print(CMD_CTX, "address 0x%08" PRIx32 " length 0x%08zx",
3052 image.sections[i].base_address,
3057 image_size += buf_cnt;
3060 command_print(CMD_CTX, "No more differences found.");
3063 retval = ERROR_FAIL;
3064 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3065 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3066 "in %fs (%0.3f KiB/s)", image_size,
3067 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3070 image_close(&image);
3075 COMMAND_HANDLER(handle_verify_image_command)
3077 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 1);
3080 COMMAND_HANDLER(handle_test_image_command)
3082 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 0);
3085 static int handle_bp_command_list(struct command_context *cmd_ctx)
3087 struct target *target = get_current_target(cmd_ctx);
3088 struct breakpoint *breakpoint = target->breakpoints;
3089 while (breakpoint) {
3090 if (breakpoint->type == BKPT_SOFT) {
3091 char *buf = buf_to_str(breakpoint->orig_instr,
3092 breakpoint->length, 16);
3093 command_print(cmd_ctx, "IVA breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i, 0x%s",
3094 breakpoint->address,
3096 breakpoint->set, buf);
3099 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3100 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3102 breakpoint->length, breakpoint->set);
3103 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3104 command_print(cmd_ctx, "Hybrid breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3105 breakpoint->address,
3106 breakpoint->length, breakpoint->set);
3107 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3110 command_print(cmd_ctx, "Breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3111 breakpoint->address,
3112 breakpoint->length, breakpoint->set);
3115 breakpoint = breakpoint->next;
3120 static int handle_bp_command_set(struct command_context *cmd_ctx,
3121 uint32_t addr, uint32_t asid, uint32_t length, int hw)
3123 struct target *target = get_current_target(cmd_ctx);
3126 int retval = breakpoint_add(target, addr, length, hw);
3127 if (ERROR_OK == retval)
3128 command_print(cmd_ctx, "breakpoint set at 0x%8.8" PRIx32 "", addr);
3130 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3133 } else if (addr == 0) {
3134 int retval = context_breakpoint_add(target, asid, length, hw);
3135 if (ERROR_OK == retval)
3136 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3138 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3142 int retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3143 if (ERROR_OK == retval)
3144 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3146 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3153 COMMAND_HANDLER(handle_bp_command)
3162 return handle_bp_command_list(CMD_CTX);
3166 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3167 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3168 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3171 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3173 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3175 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3178 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3179 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3181 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3182 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3184 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3189 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3190 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3191 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3192 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3195 return ERROR_COMMAND_SYNTAX_ERROR;
3199 COMMAND_HANDLER(handle_rbp_command)
3202 return ERROR_COMMAND_SYNTAX_ERROR;
3205 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3207 struct target *target = get_current_target(CMD_CTX);
3208 breakpoint_remove(target, addr);
3213 COMMAND_HANDLER(handle_wp_command)
3215 struct target *target = get_current_target(CMD_CTX);
3217 if (CMD_ARGC == 0) {
3218 struct watchpoint *watchpoint = target->watchpoints;
3220 while (watchpoint) {
3221 command_print(CMD_CTX, "address: 0x%8.8" PRIx32
3222 ", len: 0x%8.8" PRIx32
3223 ", r/w/a: %i, value: 0x%8.8" PRIx32
3224 ", mask: 0x%8.8" PRIx32,
3225 watchpoint->address,
3227 (int)watchpoint->rw,
3230 watchpoint = watchpoint->next;
3235 enum watchpoint_rw type = WPT_ACCESS;
3237 uint32_t length = 0;
3238 uint32_t data_value = 0x0;
3239 uint32_t data_mask = 0xffffffff;
3243 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3246 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3249 switch (CMD_ARGV[2][0]) {
3260 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3261 return ERROR_COMMAND_SYNTAX_ERROR;
3265 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3266 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3270 return ERROR_COMMAND_SYNTAX_ERROR;
3273 int retval = watchpoint_add(target, addr, length, type,
3274 data_value, data_mask);
3275 if (ERROR_OK != retval)
3276 LOG_ERROR("Failure setting watchpoints");
3281 COMMAND_HANDLER(handle_rwp_command)
3284 return ERROR_COMMAND_SYNTAX_ERROR;
3287 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3289 struct target *target = get_current_target(CMD_CTX);
3290 watchpoint_remove(target, addr);
3296 * Translate a virtual address to a physical address.
3298 * The low-level target implementation must have logged a detailed error
3299 * which is forwarded to telnet/GDB session.
3301 COMMAND_HANDLER(handle_virt2phys_command)
3304 return ERROR_COMMAND_SYNTAX_ERROR;
3307 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], va);
3310 struct target *target = get_current_target(CMD_CTX);
3311 int retval = target->type->virt2phys(target, va, &pa);
3312 if (retval == ERROR_OK)
3313 command_print(CMD_CTX, "Physical address 0x%08" PRIx32 "", pa);
3318 static void writeData(FILE *f, const void *data, size_t len)
3320 size_t written = fwrite(data, 1, len, f);
3322 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3325 static void writeLong(FILE *f, int l)
3328 for (i = 0; i < 4; i++) {
3329 char c = (l >> (i*8))&0xff;
3330 writeData(f, &c, 1);
3335 static void writeString(FILE *f, char *s)
3337 writeData(f, s, strlen(s));
3340 /* Dump a gmon.out histogram file. */
3341 static void writeGmon(uint32_t *samples, uint32_t sampleNum, const char *filename)
3344 FILE *f = fopen(filename, "w");
3347 writeString(f, "gmon");
3348 writeLong(f, 0x00000001); /* Version */
3349 writeLong(f, 0); /* padding */
3350 writeLong(f, 0); /* padding */
3351 writeLong(f, 0); /* padding */
3353 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3354 writeData(f, &zero, 1);
3356 /* figure out bucket size */
3357 uint32_t min = samples[0];
3358 uint32_t max = samples[0];
3359 for (i = 0; i < sampleNum; i++) {
3360 if (min > samples[i])
3362 if (max < samples[i])
3366 int addressSpace = (max - min + 1);
3367 assert(addressSpace >= 2);
3369 static const uint32_t maxBuckets = 16 * 1024; /* maximum buckets. */
3370 uint32_t length = addressSpace;
3371 if (length > maxBuckets)
3372 length = maxBuckets;
3373 int *buckets = malloc(sizeof(int)*length);
3374 if (buckets == NULL) {
3378 memset(buckets, 0, sizeof(int) * length);
3379 for (i = 0; i < sampleNum; i++) {
3380 uint32_t address = samples[i];
3381 long long a = address - min;
3382 long long b = length - 1;
3383 long long c = addressSpace - 1;
3384 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
3388 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3389 writeLong(f, min); /* low_pc */
3390 writeLong(f, max); /* high_pc */
3391 writeLong(f, length); /* # of samples */
3392 writeLong(f, 100); /* KLUDGE! We lie, ca. 100Hz best case. */
3393 writeString(f, "seconds");
3394 for (i = 0; i < (15-strlen("seconds")); i++)
3395 writeData(f, &zero, 1);
3396 writeString(f, "s");
3398 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3400 char *data = malloc(2 * length);
3402 for (i = 0; i < length; i++) {
3407 data[i * 2] = val&0xff;
3408 data[i * 2 + 1] = (val >> 8) & 0xff;
3411 writeData(f, data, length * 2);
3419 /* profiling samples the CPU PC as quickly as OpenOCD is able,
3420 * which will be used as a random sampling of PC */
3421 COMMAND_HANDLER(handle_profile_command)
3423 struct target *target = get_current_target(CMD_CTX);
3424 struct timeval timeout, now;
3426 gettimeofday(&timeout, NULL);
3428 return ERROR_COMMAND_SYNTAX_ERROR;
3430 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], offset);
3432 timeval_add_time(&timeout, offset, 0);
3435 * @todo: Some cores let us sample the PC without the
3436 * annoying halt/resume step; for example, ARMv7 PCSR.
3437 * Provide a way to use that more efficient mechanism.
3440 command_print(CMD_CTX, "Starting profiling. Halting and resuming the target as often as we can...");
3442 static const int maxSample = 10000;
3443 uint32_t *samples = malloc(sizeof(uint32_t)*maxSample);
3444 if (samples == NULL)
3448 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
3449 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
3451 int retval = ERROR_OK;
3453 target_poll(target);
3454 if (target->state == TARGET_HALTED) {
3455 uint32_t t = *((uint32_t *)reg->value);
3456 samples[numSamples++] = t;
3457 /* current pc, addr = 0, do not handle breakpoints, not debugging */
3458 retval = target_resume(target, 1, 0, 0, 0);
3459 target_poll(target);
3460 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
3461 } else if (target->state == TARGET_RUNNING) {
3462 /* We want to quickly sample the PC. */
3463 retval = target_halt(target);
3464 if (retval != ERROR_OK) {
3469 command_print(CMD_CTX, "Target not halted or running");
3473 if (retval != ERROR_OK)
3476 gettimeofday(&now, NULL);
3477 if ((numSamples >= maxSample) || ((now.tv_sec >= timeout.tv_sec)
3478 && (now.tv_usec >= timeout.tv_usec))) {
3479 command_print(CMD_CTX, "Profiling completed. %d samples.", numSamples);
3480 retval = target_poll(target);
3481 if (retval != ERROR_OK) {
3485 if (target->state == TARGET_HALTED) {
3486 /* current pc, addr = 0, do not handle
3487 * breakpoints, not debugging */
3488 target_resume(target, 1, 0, 0, 0);
3490 retval = target_poll(target);
3491 if (retval != ERROR_OK) {
3495 writeGmon(samples, numSamples, CMD_ARGV[1]);
3496 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
3505 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
3508 Jim_Obj *nameObjPtr, *valObjPtr;
3511 namebuf = alloc_printf("%s(%d)", varname, idx);
3515 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3516 valObjPtr = Jim_NewIntObj(interp, val);
3517 if (!nameObjPtr || !valObjPtr) {
3522 Jim_IncrRefCount(nameObjPtr);
3523 Jim_IncrRefCount(valObjPtr);
3524 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3525 Jim_DecrRefCount(interp, nameObjPtr);
3526 Jim_DecrRefCount(interp, valObjPtr);
3528 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
3532 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3534 struct command_context *context;
3535 struct target *target;
3537 context = current_command_context(interp);
3538 assert(context != NULL);
3540 target = get_current_target(context);
3541 if (target == NULL) {
3542 LOG_ERROR("mem2array: no current target");
3546 return target_mem2array(interp, target, argc - 1, argv + 1);
3549 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
3557 const char *varname;
3561 /* argv[1] = name of array to receive the data
3562 * argv[2] = desired width
3563 * argv[3] = memory address
3564 * argv[4] = count of times to read
3567 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
3570 varname = Jim_GetString(argv[0], &len);
3571 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3573 e = Jim_GetLong(interp, argv[1], &l);
3578 e = Jim_GetLong(interp, argv[2], &l);
3582 e = Jim_GetLong(interp, argv[3], &l);
3597 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3598 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3602 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3603 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
3606 if ((addr + (len * width)) < addr) {
3607 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3608 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
3611 /* absurd transfer size? */
3613 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3614 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
3619 ((width == 2) && ((addr & 1) == 0)) ||
3620 ((width == 4) && ((addr & 3) == 0))) {
3624 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3625 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
3628 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3637 size_t buffersize = 4096;
3638 uint8_t *buffer = malloc(buffersize);
3645 /* Slurp... in buffer size chunks */
3647 count = len; /* in objects.. */
3648 if (count > (buffersize / width))
3649 count = (buffersize / width);
3651 retval = target_read_memory(target, addr, width, count, buffer);
3652 if (retval != ERROR_OK) {
3654 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed",
3658 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3659 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
3663 v = 0; /* shut up gcc */
3664 for (i = 0; i < count ; i++, n++) {
3667 v = target_buffer_get_u32(target, &buffer[i*width]);
3670 v = target_buffer_get_u16(target, &buffer[i*width]);
3673 v = buffer[i] & 0x0ff;
3676 new_int_array_element(interp, varname, n, v);
3684 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3689 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
3692 Jim_Obj *nameObjPtr, *valObjPtr;
3696 namebuf = alloc_printf("%s(%d)", varname, idx);
3700 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3706 Jim_IncrRefCount(nameObjPtr);
3707 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
3708 Jim_DecrRefCount(interp, nameObjPtr);
3710 if (valObjPtr == NULL)
3713 result = Jim_GetLong(interp, valObjPtr, &l);
3714 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
3719 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3721 struct command_context *context;
3722 struct target *target;
3724 context = current_command_context(interp);
3725 assert(context != NULL);
3727 target = get_current_target(context);
3728 if (target == NULL) {
3729 LOG_ERROR("array2mem: no current target");
3733 return target_array2mem(interp, target, argc-1, argv + 1);
3736 static int target_array2mem(Jim_Interp *interp, struct target *target,
3737 int argc, Jim_Obj *const *argv)
3745 const char *varname;
3749 /* argv[1] = name of array to get the data
3750 * argv[2] = desired width
3751 * argv[3] = memory address
3752 * argv[4] = count to write
3755 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems");
3758 varname = Jim_GetString(argv[0], &len);
3759 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3761 e = Jim_GetLong(interp, argv[1], &l);
3766 e = Jim_GetLong(interp, argv[2], &l);
3770 e = Jim_GetLong(interp, argv[3], &l);
3785 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3786 Jim_AppendStrings(interp, Jim_GetResult(interp),
3787 "Invalid width param, must be 8/16/32", NULL);
3791 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3792 Jim_AppendStrings(interp, Jim_GetResult(interp),
3793 "array2mem: zero width read?", NULL);
3796 if ((addr + (len * width)) < addr) {
3797 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3798 Jim_AppendStrings(interp, Jim_GetResult(interp),
3799 "array2mem: addr + len - wraps to zero?", NULL);
3802 /* absurd transfer size? */
3804 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3805 Jim_AppendStrings(interp, Jim_GetResult(interp),
3806 "array2mem: absurd > 64K item request", NULL);
3811 ((width == 2) && ((addr & 1) == 0)) ||
3812 ((width == 4) && ((addr & 3) == 0))) {
3816 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3817 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads",
3820 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3831 size_t buffersize = 4096;
3832 uint8_t *buffer = malloc(buffersize);
3837 /* Slurp... in buffer size chunks */
3839 count = len; /* in objects.. */
3840 if (count > (buffersize / width))
3841 count = (buffersize / width);
3843 v = 0; /* shut up gcc */
3844 for (i = 0; i < count; i++, n++) {
3845 get_int_array_element(interp, varname, n, &v);
3848 target_buffer_set_u32(target, &buffer[i * width], v);
3851 target_buffer_set_u16(target, &buffer[i * width], v);
3854 buffer[i] = v & 0x0ff;
3860 retval = target_write_memory(target, addr, width, count, buffer);
3861 if (retval != ERROR_OK) {
3863 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed",
3867 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3868 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
3876 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3881 /* FIX? should we propagate errors here rather than printing them
3884 void target_handle_event(struct target *target, enum target_event e)
3886 struct target_event_action *teap;
3888 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3889 if (teap->event == e) {
3890 LOG_DEBUG("target: (%d) %s (%s) event: %d (%s) action: %s",
3891 target->target_number,
3892 target_name(target),
3893 target_type_name(target),
3895 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
3896 Jim_GetString(teap->body, NULL));
3897 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
3898 Jim_MakeErrorMessage(teap->interp);
3899 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
3906 * Returns true only if the target has a handler for the specified event.
3908 bool target_has_event_action(struct target *target, enum target_event event)
3910 struct target_event_action *teap;
3912 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3913 if (teap->event == event)
3919 enum target_cfg_param {
3922 TCFG_WORK_AREA_VIRT,
3923 TCFG_WORK_AREA_PHYS,
3924 TCFG_WORK_AREA_SIZE,
3925 TCFG_WORK_AREA_BACKUP,
3929 TCFG_CHAIN_POSITION,
3934 static Jim_Nvp nvp_config_opts[] = {
3935 { .name = "-type", .value = TCFG_TYPE },
3936 { .name = "-event", .value = TCFG_EVENT },
3937 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
3938 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
3939 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
3940 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
3941 { .name = "-endian" , .value = TCFG_ENDIAN },
3942 { .name = "-variant", .value = TCFG_VARIANT },
3943 { .name = "-coreid", .value = TCFG_COREID },
3944 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
3945 { .name = "-dbgbase", .value = TCFG_DBGBASE },
3946 { .name = "-rtos", .value = TCFG_RTOS },
3947 { .name = NULL, .value = -1 }
3950 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
3958 /* parse config or cget options ... */
3959 while (goi->argc > 0) {
3960 Jim_SetEmptyResult(goi->interp);
3961 /* Jim_GetOpt_Debug(goi); */
3963 if (target->type->target_jim_configure) {
3964 /* target defines a configure function */
3965 /* target gets first dibs on parameters */
3966 e = (*(target->type->target_jim_configure))(target, goi);
3975 /* otherwise we 'continue' below */
3977 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
3979 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
3985 if (goi->isconfigure) {
3986 Jim_SetResultFormatted(goi->interp,
3987 "not settable: %s", n->name);
3991 if (goi->argc != 0) {
3992 Jim_WrongNumArgs(goi->interp,
3993 goi->argc, goi->argv,
3998 Jim_SetResultString(goi->interp,
3999 target_type_name(target), -1);
4003 if (goi->argc == 0) {
4004 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4008 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4010 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4014 if (goi->isconfigure) {
4015 if (goi->argc != 1) {
4016 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4020 if (goi->argc != 0) {
4021 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4027 struct target_event_action *teap;
4029 teap = target->event_action;
4030 /* replace existing? */
4032 if (teap->event == (enum target_event)n->value)
4037 if (goi->isconfigure) {
4038 bool replace = true;
4041 teap = calloc(1, sizeof(*teap));
4044 teap->event = n->value;
4045 teap->interp = goi->interp;
4046 Jim_GetOpt_Obj(goi, &o);
4048 Jim_DecrRefCount(teap->interp, teap->body);
4049 teap->body = Jim_DuplicateObj(goi->interp, o);
4052 * Tcl/TK - "tk events" have a nice feature.
4053 * See the "BIND" command.
4054 * We should support that here.
4055 * You can specify %X and %Y in the event code.
4056 * The idea is: %T - target name.
4057 * The idea is: %N - target number
4058 * The idea is: %E - event name.
4060 Jim_IncrRefCount(teap->body);
4063 /* add to head of event list */
4064 teap->next = target->event_action;
4065 target->event_action = teap;
4067 Jim_SetEmptyResult(goi->interp);
4071 Jim_SetEmptyResult(goi->interp);
4073 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4079 case TCFG_WORK_AREA_VIRT:
4080 if (goi->isconfigure) {
4081 target_free_all_working_areas(target);
4082 e = Jim_GetOpt_Wide(goi, &w);
4085 target->working_area_virt = w;
4086 target->working_area_virt_spec = true;
4091 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4095 case TCFG_WORK_AREA_PHYS:
4096 if (goi->isconfigure) {
4097 target_free_all_working_areas(target);
4098 e = Jim_GetOpt_Wide(goi, &w);
4101 target->working_area_phys = w;
4102 target->working_area_phys_spec = true;
4107 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4111 case TCFG_WORK_AREA_SIZE:
4112 if (goi->isconfigure) {
4113 target_free_all_working_areas(target);
4114 e = Jim_GetOpt_Wide(goi, &w);
4117 target->working_area_size = w;
4122 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4126 case TCFG_WORK_AREA_BACKUP:
4127 if (goi->isconfigure) {
4128 target_free_all_working_areas(target);
4129 e = Jim_GetOpt_Wide(goi, &w);
4132 /* make this exactly 1 or 0 */
4133 target->backup_working_area = (!!w);
4138 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4139 /* loop for more e*/
4144 if (goi->isconfigure) {
4145 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4147 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4150 target->endianness = n->value;
4155 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4156 if (n->name == NULL) {
4157 target->endianness = TARGET_LITTLE_ENDIAN;
4158 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4160 Jim_SetResultString(goi->interp, n->name, -1);
4165 if (goi->isconfigure) {
4166 if (goi->argc < 1) {
4167 Jim_SetResultFormatted(goi->interp,
4172 if (target->variant)
4173 free((void *)(target->variant));
4174 e = Jim_GetOpt_String(goi, &cp, NULL);
4177 target->variant = strdup(cp);
4182 Jim_SetResultString(goi->interp, target->variant, -1);
4187 if (goi->isconfigure) {
4188 e = Jim_GetOpt_Wide(goi, &w);
4191 target->coreid = (int32_t)w;
4196 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4200 case TCFG_CHAIN_POSITION:
4201 if (goi->isconfigure) {
4203 struct jtag_tap *tap;
4204 target_free_all_working_areas(target);
4205 e = Jim_GetOpt_Obj(goi, &o_t);
4208 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4211 /* make this exactly 1 or 0 */
4217 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4218 /* loop for more e*/
4221 if (goi->isconfigure) {
4222 e = Jim_GetOpt_Wide(goi, &w);
4225 target->dbgbase = (uint32_t)w;
4226 target->dbgbase_set = true;
4231 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4238 int result = rtos_create(goi, target);
4239 if (result != JIM_OK)
4245 } /* while (goi->argc) */
4248 /* done - we return */
4252 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4256 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4257 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4258 int need_args = 1 + goi.isconfigure;
4259 if (goi.argc < need_args) {
4260 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4262 ? "missing: -option VALUE ..."
4263 : "missing: -option ...");
4266 struct target *target = Jim_CmdPrivData(goi.interp);
4267 return target_configure(&goi, target);
4270 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4272 const char *cmd_name = Jim_GetString(argv[0], NULL);
4275 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4277 if (goi.argc < 2 || goi.argc > 4) {
4278 Jim_SetResultFormatted(goi.interp,
4279 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4284 fn = target_write_memory_fast;
4287 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4289 struct Jim_Obj *obj;
4290 e = Jim_GetOpt_Obj(&goi, &obj);
4294 fn = target_write_phys_memory;
4298 e = Jim_GetOpt_Wide(&goi, &a);
4303 e = Jim_GetOpt_Wide(&goi, &b);
4308 if (goi.argc == 1) {
4309 e = Jim_GetOpt_Wide(&goi, &c);
4314 /* all args must be consumed */
4318 struct target *target = Jim_CmdPrivData(goi.interp);
4320 if (strcasecmp(cmd_name, "mww") == 0)
4322 else if (strcasecmp(cmd_name, "mwh") == 0)
4324 else if (strcasecmp(cmd_name, "mwb") == 0)
4327 LOG_ERROR("command '%s' unknown: ", cmd_name);
4331 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4335 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4337 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4338 * mdh [phys] <address> [<count>] - for 16 bit reads
4339 * mdb [phys] <address> [<count>] - for 8 bit reads
4341 * Count defaults to 1.
4343 * Calls target_read_memory or target_read_phys_memory depending on
4344 * the presence of the "phys" argument
4345 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4346 * to int representation in base16.
4347 * Also outputs read data in a human readable form using command_print
4349 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4350 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4351 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4352 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4353 * on success, with [<count>] number of elements.
4355 * In case of little endian target:
4356 * Example1: "mdw 0x00000000" returns "10123456"
4357 * Exmaple2: "mdh 0x00000000 1" returns "3456"
4358 * Example3: "mdb 0x00000000" returns "56"
4359 * Example4: "mdh 0x00000000 2" returns "3456 1012"
4360 * Example5: "mdb 0x00000000 3" returns "56 34 12"
4362 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4364 const char *cmd_name = Jim_GetString(argv[0], NULL);
4367 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4369 if ((goi.argc < 1) || (goi.argc > 3)) {
4370 Jim_SetResultFormatted(goi.interp,
4371 "usage: %s [phys] <address> [<count>]", cmd_name);
4375 int (*fn)(struct target *target,
4376 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
4377 fn = target_read_memory;
4380 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4382 struct Jim_Obj *obj;
4383 e = Jim_GetOpt_Obj(&goi, &obj);
4387 fn = target_read_phys_memory;
4390 /* Read address parameter */
4392 e = Jim_GetOpt_Wide(&goi, &addr);
4396 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
4398 if (goi.argc == 1) {
4399 e = Jim_GetOpt_Wide(&goi, &count);
4405 /* all args must be consumed */
4409 jim_wide dwidth = 1; /* shut up gcc */
4410 if (strcasecmp(cmd_name, "mdw") == 0)
4412 else if (strcasecmp(cmd_name, "mdh") == 0)
4414 else if (strcasecmp(cmd_name, "mdb") == 0)
4417 LOG_ERROR("command '%s' unknown: ", cmd_name);
4421 /* convert count to "bytes" */
4422 int bytes = count * dwidth;
4424 struct target *target = Jim_CmdPrivData(goi.interp);
4425 uint8_t target_buf[32];
4428 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
4430 /* Try to read out next block */
4431 e = fn(target, addr, dwidth, y / dwidth, target_buf);
4433 if (e != ERROR_OK) {
4434 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
4438 command_print_sameline(NULL, "0x%08x ", (int)(addr));
4441 for (x = 0; x < 16 && x < y; x += 4) {
4442 z = target_buffer_get_u32(target, &(target_buf[x]));
4443 command_print_sameline(NULL, "%08x ", (int)(z));
4445 for (; (x < 16) ; x += 4)
4446 command_print_sameline(NULL, " ");
4449 for (x = 0; x < 16 && x < y; x += 2) {
4450 z = target_buffer_get_u16(target, &(target_buf[x]));
4451 command_print_sameline(NULL, "%04x ", (int)(z));
4453 for (; (x < 16) ; x += 2)
4454 command_print_sameline(NULL, " ");
4458 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
4459 z = target_buffer_get_u8(target, &(target_buf[x]));
4460 command_print_sameline(NULL, "%02x ", (int)(z));
4462 for (; (x < 16) ; x += 1)
4463 command_print_sameline(NULL, " ");
4466 /* ascii-ify the bytes */
4467 for (x = 0 ; x < y ; x++) {
4468 if ((target_buf[x] >= 0x20) &&
4469 (target_buf[x] <= 0x7e)) {
4473 target_buf[x] = '.';
4478 target_buf[x] = ' ';
4483 /* print - with a newline */
4484 command_print_sameline(NULL, "%s\n", target_buf);
4492 static int jim_target_mem2array(Jim_Interp *interp,
4493 int argc, Jim_Obj *const *argv)
4495 struct target *target = Jim_CmdPrivData(interp);
4496 return target_mem2array(interp, target, argc - 1, argv + 1);
4499 static int jim_target_array2mem(Jim_Interp *interp,
4500 int argc, Jim_Obj *const *argv)
4502 struct target *target = Jim_CmdPrivData(interp);
4503 return target_array2mem(interp, target, argc - 1, argv + 1);
4506 static int jim_target_tap_disabled(Jim_Interp *interp)
4508 Jim_SetResultFormatted(interp, "[TAP is disabled]");
4512 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4515 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4518 struct target *target = Jim_CmdPrivData(interp);
4519 if (!target->tap->enabled)
4520 return jim_target_tap_disabled(interp);
4522 int e = target->type->examine(target);
4528 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4531 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4534 struct target *target = Jim_CmdPrivData(interp);
4536 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
4542 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4545 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4548 struct target *target = Jim_CmdPrivData(interp);
4549 if (!target->tap->enabled)
4550 return jim_target_tap_disabled(interp);
4553 if (!(target_was_examined(target)))
4554 e = ERROR_TARGET_NOT_EXAMINED;
4556 e = target->type->poll(target);
4562 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4565 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4567 if (goi.argc != 2) {
4568 Jim_WrongNumArgs(interp, 0, argv,
4569 "([tT]|[fF]|assert|deassert) BOOL");
4574 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
4576 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
4579 /* the halt or not param */
4581 e = Jim_GetOpt_Wide(&goi, &a);
4585 struct target *target = Jim_CmdPrivData(goi.interp);
4586 if (!target->tap->enabled)
4587 return jim_target_tap_disabled(interp);
4588 if (!(target_was_examined(target))) {
4589 LOG_ERROR("Target not examined yet");
4590 return ERROR_TARGET_NOT_EXAMINED;
4592 if (!target->type->assert_reset || !target->type->deassert_reset) {
4593 Jim_SetResultFormatted(interp,
4594 "No target-specific reset for %s",
4595 target_name(target));
4598 /* determine if we should halt or not. */
4599 target->reset_halt = !!a;
4600 /* When this happens - all workareas are invalid. */
4601 target_free_all_working_areas_restore(target, 0);
4604 if (n->value == NVP_ASSERT)
4605 e = target->type->assert_reset(target);
4607 e = target->type->deassert_reset(target);
4608 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4611 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4614 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4617 struct target *target = Jim_CmdPrivData(interp);
4618 if (!target->tap->enabled)
4619 return jim_target_tap_disabled(interp);
4620 int e = target->type->halt(target);
4621 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4624 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4627 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4629 /* params: <name> statename timeoutmsecs */
4630 if (goi.argc != 2) {
4631 const char *cmd_name = Jim_GetString(argv[0], NULL);
4632 Jim_SetResultFormatted(goi.interp,
4633 "%s <state_name> <timeout_in_msec>", cmd_name);
4638 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
4640 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
4644 e = Jim_GetOpt_Wide(&goi, &a);
4647 struct target *target = Jim_CmdPrivData(interp);
4648 if (!target->tap->enabled)
4649 return jim_target_tap_disabled(interp);
4651 e = target_wait_state(target, n->value, a);
4652 if (e != ERROR_OK) {
4653 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
4654 Jim_SetResultFormatted(goi.interp,
4655 "target: %s wait %s fails (%#s) %s",
4656 target_name(target), n->name,
4657 eObj, target_strerror_safe(e));
4658 Jim_FreeNewObj(interp, eObj);
4663 /* List for human, Events defined for this target.
4664 * scripts/programs should use 'name cget -event NAME'
4666 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4668 struct command_context *cmd_ctx = current_command_context(interp);
4669 assert(cmd_ctx != NULL);
4671 struct target *target = Jim_CmdPrivData(interp);
4672 struct target_event_action *teap = target->event_action;
4673 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
4674 target->target_number,
4675 target_name(target));
4676 command_print(cmd_ctx, "%-25s | Body", "Event");
4677 command_print(cmd_ctx, "------------------------- | "
4678 "----------------------------------------");
4680 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
4681 command_print(cmd_ctx, "%-25s | %s",
4682 opt->name, Jim_GetString(teap->body, NULL));
4685 command_print(cmd_ctx, "***END***");
4688 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4691 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4694 struct target *target = Jim_CmdPrivData(interp);
4695 Jim_SetResultString(interp, target_state_name(target), -1);
4698 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4701 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4702 if (goi.argc != 1) {
4703 const char *cmd_name = Jim_GetString(argv[0], NULL);
4704 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
4708 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
4710 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
4713 struct target *target = Jim_CmdPrivData(interp);
4714 target_handle_event(target, n->value);
4718 static const struct command_registration target_instance_command_handlers[] = {
4720 .name = "configure",
4721 .mode = COMMAND_CONFIG,
4722 .jim_handler = jim_target_configure,
4723 .help = "configure a new target for use",
4724 .usage = "[target_attribute ...]",
4728 .mode = COMMAND_ANY,
4729 .jim_handler = jim_target_configure,
4730 .help = "returns the specified target attribute",
4731 .usage = "target_attribute",
4735 .mode = COMMAND_EXEC,
4736 .jim_handler = jim_target_mw,
4737 .help = "Write 32-bit word(s) to target memory",
4738 .usage = "address data [count]",
4742 .mode = COMMAND_EXEC,
4743 .jim_handler = jim_target_mw,
4744 .help = "Write 16-bit half-word(s) to target memory",
4745 .usage = "address data [count]",
4749 .mode = COMMAND_EXEC,
4750 .jim_handler = jim_target_mw,
4751 .help = "Write byte(s) to target memory",
4752 .usage = "address data [count]",
4756 .mode = COMMAND_EXEC,
4757 .jim_handler = jim_target_md,
4758 .help = "Display target memory as 32-bit words",
4759 .usage = "address [count]",
4763 .mode = COMMAND_EXEC,
4764 .jim_handler = jim_target_md,
4765 .help = "Display target memory as 16-bit half-words",
4766 .usage = "address [count]",
4770 .mode = COMMAND_EXEC,
4771 .jim_handler = jim_target_md,
4772 .help = "Display target memory as 8-bit bytes",
4773 .usage = "address [count]",
4776 .name = "array2mem",
4777 .mode = COMMAND_EXEC,
4778 .jim_handler = jim_target_array2mem,
4779 .help = "Writes Tcl array of 8/16/32 bit numbers "
4781 .usage = "arrayname bitwidth address count",
4784 .name = "mem2array",
4785 .mode = COMMAND_EXEC,
4786 .jim_handler = jim_target_mem2array,
4787 .help = "Loads Tcl array of 8/16/32 bit numbers "
4788 "from target memory",
4789 .usage = "arrayname bitwidth address count",
4792 .name = "eventlist",
4793 .mode = COMMAND_EXEC,
4794 .jim_handler = jim_target_event_list,
4795 .help = "displays a table of events defined for this target",
4799 .mode = COMMAND_EXEC,
4800 .jim_handler = jim_target_current_state,
4801 .help = "displays the current state of this target",
4804 .name = "arp_examine",
4805 .mode = COMMAND_EXEC,
4806 .jim_handler = jim_target_examine,
4807 .help = "used internally for reset processing",
4810 .name = "arp_halt_gdb",
4811 .mode = COMMAND_EXEC,
4812 .jim_handler = jim_target_halt_gdb,
4813 .help = "used internally for reset processing to halt GDB",
4817 .mode = COMMAND_EXEC,
4818 .jim_handler = jim_target_poll,
4819 .help = "used internally for reset processing",
4822 .name = "arp_reset",
4823 .mode = COMMAND_EXEC,
4824 .jim_handler = jim_target_reset,
4825 .help = "used internally for reset processing",
4829 .mode = COMMAND_EXEC,
4830 .jim_handler = jim_target_halt,
4831 .help = "used internally for reset processing",
4834 .name = "arp_waitstate",
4835 .mode = COMMAND_EXEC,
4836 .jim_handler = jim_target_wait_state,
4837 .help = "used internally for reset processing",
4840 .name = "invoke-event",
4841 .mode = COMMAND_EXEC,
4842 .jim_handler = jim_target_invoke_event,
4843 .help = "invoke handler for specified event",
4844 .usage = "event_name",
4846 COMMAND_REGISTRATION_DONE
4849 static int target_create(Jim_GetOptInfo *goi)
4857 struct target *target;
4858 struct command_context *cmd_ctx;
4860 cmd_ctx = current_command_context(goi->interp);
4861 assert(cmd_ctx != NULL);
4863 if (goi->argc < 3) {
4864 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
4869 Jim_GetOpt_Obj(goi, &new_cmd);
4870 /* does this command exist? */
4871 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
4873 cp = Jim_GetString(new_cmd, NULL);
4874 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
4879 e = Jim_GetOpt_String(goi, &cp2, NULL);
4883 /* now does target type exist */
4884 for (x = 0 ; target_types[x] ; x++) {
4885 if (0 == strcmp(cp, target_types[x]->name)) {
4890 /* check for deprecated name */
4891 if (target_types[x]->deprecated_name) {
4892 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
4894 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
4899 if (target_types[x] == NULL) {
4900 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
4901 for (x = 0 ; target_types[x] ; x++) {
4902 if (target_types[x + 1]) {
4903 Jim_AppendStrings(goi->interp,
4904 Jim_GetResult(goi->interp),
4905 target_types[x]->name,
4908 Jim_AppendStrings(goi->interp,
4909 Jim_GetResult(goi->interp),
4911 target_types[x]->name, NULL);
4918 target = calloc(1, sizeof(struct target));
4919 /* set target number */
4920 target->target_number = new_target_number();
4922 /* allocate memory for each unique target type */
4923 target->type = (struct target_type *)calloc(1, sizeof(struct target_type));
4925 memcpy(target->type, target_types[x], sizeof(struct target_type));
4927 /* will be set by "-endian" */
4928 target->endianness = TARGET_ENDIAN_UNKNOWN;
4930 /* default to first core, override with -coreid */
4933 target->working_area = 0x0;
4934 target->working_area_size = 0x0;
4935 target->working_areas = NULL;
4936 target->backup_working_area = 0;
4938 target->state = TARGET_UNKNOWN;
4939 target->debug_reason = DBG_REASON_UNDEFINED;
4940 target->reg_cache = NULL;
4941 target->breakpoints = NULL;
4942 target->watchpoints = NULL;
4943 target->next = NULL;
4944 target->arch_info = NULL;
4946 target->display = 1;
4948 target->halt_issued = false;
4950 /* initialize trace information */
4951 target->trace_info = malloc(sizeof(struct trace));
4952 target->trace_info->num_trace_points = 0;
4953 target->trace_info->trace_points_size = 0;
4954 target->trace_info->trace_points = NULL;
4955 target->trace_info->trace_history_size = 0;
4956 target->trace_info->trace_history = NULL;
4957 target->trace_info->trace_history_pos = 0;
4958 target->trace_info->trace_history_overflowed = 0;
4960 target->dbgmsg = NULL;
4961 target->dbg_msg_enabled = 0;
4963 target->endianness = TARGET_ENDIAN_UNKNOWN;
4965 target->rtos = NULL;
4966 target->rtos_auto_detect = false;
4968 /* Do the rest as "configure" options */
4969 goi->isconfigure = 1;
4970 e = target_configure(goi, target);
4972 if (target->tap == NULL) {
4973 Jim_SetResultString(goi->interp, "-chain-position required when creating target", -1);
4983 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
4984 /* default endian to little if not specified */
4985 target->endianness = TARGET_LITTLE_ENDIAN;
4988 /* incase variant is not set */
4989 if (!target->variant)
4990 target->variant = strdup("");
4992 cp = Jim_GetString(new_cmd, NULL);
4993 target->cmd_name = strdup(cp);
4995 /* create the target specific commands */
4996 if (target->type->commands) {
4997 e = register_commands(cmd_ctx, NULL, target->type->commands);
4999 LOG_ERROR("unable to register '%s' commands", cp);
5001 if (target->type->target_create)
5002 (*(target->type->target_create))(target, goi->interp);
5004 /* append to end of list */
5006 struct target **tpp;
5007 tpp = &(all_targets);
5009 tpp = &((*tpp)->next);
5013 /* now - create the new target name command */
5014 const const struct command_registration target_subcommands[] = {
5016 .chain = target_instance_command_handlers,
5019 .chain = target->type->commands,
5021 COMMAND_REGISTRATION_DONE
5023 const const struct command_registration target_commands[] = {
5026 .mode = COMMAND_ANY,
5027 .help = "target command group",
5029 .chain = target_subcommands,
5031 COMMAND_REGISTRATION_DONE
5033 e = register_commands(cmd_ctx, NULL, target_commands);
5037 struct command *c = command_find_in_context(cmd_ctx, cp);
5039 command_set_handler_data(c, target);
5041 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5044 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5047 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5050 struct command_context *cmd_ctx = current_command_context(interp);
5051 assert(cmd_ctx != NULL);
5053 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5057 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5060 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5063 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5064 for (unsigned x = 0; NULL != target_types[x]; x++) {
5065 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5066 Jim_NewStringObj(interp, target_types[x]->name, -1));
5071 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5074 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5077 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5078 struct target *target = all_targets;
5080 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5081 Jim_NewStringObj(interp, target_name(target), -1));
5082 target = target->next;
5087 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5090 const char *targetname;
5092 struct target *target = (struct target *) NULL;
5093 struct target_list *head, *curr, *new;
5094 curr = (struct target_list *) NULL;
5095 head = (struct target_list *) NULL;
5098 LOG_DEBUG("%d", argc);
5099 /* argv[1] = target to associate in smp
5100 * argv[2] = target to assoicate in smp
5104 for (i = 1; i < argc; i++) {
5106 targetname = Jim_GetString(argv[i], &len);
5107 target = get_target(targetname);
5108 LOG_DEBUG("%s ", targetname);
5110 new = malloc(sizeof(struct target_list));
5111 new->target = target;
5112 new->next = (struct target_list *)NULL;
5113 if (head == (struct target_list *)NULL) {
5122 /* now parse the list of cpu and put the target in smp mode*/
5125 while (curr != (struct target_list *)NULL) {
5126 target = curr->target;
5128 target->head = head;
5132 if (target && target->rtos)
5133 retval = rtos_smp_init(head->target);
5139 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5142 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5144 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5145 "<name> <target_type> [<target_options> ...]");
5148 return target_create(&goi);
5151 static int jim_target_number(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5154 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5156 /* It's OK to remove this mechanism sometime after August 2010 or so */
5157 LOG_WARNING("don't use numbers as target identifiers; use names");
5158 if (goi.argc != 1) {
5159 Jim_SetResultFormatted(goi.interp, "usage: target number <number>");
5163 int e = Jim_GetOpt_Wide(&goi, &w);
5167 struct target *target;
5168 for (target = all_targets; NULL != target; target = target->next) {
5169 if (target->target_number != w)
5172 Jim_SetResultString(goi.interp, target_name(target), -1);
5176 Jim_Obj *wObj = Jim_NewIntObj(goi.interp, w);
5177 Jim_SetResultFormatted(goi.interp,
5178 "Target: number %#s does not exist", wObj);
5179 Jim_FreeNewObj(interp, wObj);
5184 static int jim_target_count(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5187 Jim_WrongNumArgs(interp, 1, argv, "<no parameters>");
5191 struct target *target = all_targets;
5192 while (NULL != target) {
5193 target = target->next;
5196 Jim_SetResult(interp, Jim_NewIntObj(interp, count));
5200 static const struct command_registration target_subcommand_handlers[] = {
5203 .mode = COMMAND_CONFIG,
5204 .handler = handle_target_init_command,
5205 .help = "initialize targets",
5209 /* REVISIT this should be COMMAND_CONFIG ... */
5210 .mode = COMMAND_ANY,
5211 .jim_handler = jim_target_create,
5212 .usage = "name type '-chain-position' name [options ...]",
5213 .help = "Creates and selects a new target",
5217 .mode = COMMAND_ANY,
5218 .jim_handler = jim_target_current,
5219 .help = "Returns the currently selected target",
5223 .mode = COMMAND_ANY,
5224 .jim_handler = jim_target_types,
5225 .help = "Returns the available target types as "
5226 "a list of strings",
5230 .mode = COMMAND_ANY,
5231 .jim_handler = jim_target_names,
5232 .help = "Returns the names of all targets as a list of strings",
5236 .mode = COMMAND_ANY,
5237 .jim_handler = jim_target_number,
5239 .help = "Returns the name of the numbered target "
5244 .mode = COMMAND_ANY,
5245 .jim_handler = jim_target_count,
5246 .help = "Returns the number of targets as an integer "
5251 .mode = COMMAND_ANY,
5252 .jim_handler = jim_target_smp,
5253 .usage = "targetname1 targetname2 ...",
5254 .help = "gather several target in a smp list"
5257 COMMAND_REGISTRATION_DONE
5267 static int fastload_num;
5268 static struct FastLoad *fastload;
5270 static void free_fastload(void)
5272 if (fastload != NULL) {
5274 for (i = 0; i < fastload_num; i++) {
5275 if (fastload[i].data)
5276 free(fastload[i].data);
5283 COMMAND_HANDLER(handle_fast_load_image_command)
5287 uint32_t image_size;
5288 uint32_t min_address = 0;
5289 uint32_t max_address = 0xffffffff;
5294 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5295 &image, &min_address, &max_address);
5296 if (ERROR_OK != retval)
5299 struct duration bench;
5300 duration_start(&bench);
5302 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5303 if (retval != ERROR_OK)
5308 fastload_num = image.num_sections;
5309 fastload = (struct FastLoad *)malloc(sizeof(struct FastLoad)*image.num_sections);
5310 if (fastload == NULL) {
5311 command_print(CMD_CTX, "out of memory");
5312 image_close(&image);
5315 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5316 for (i = 0; i < image.num_sections; i++) {
5317 buffer = malloc(image.sections[i].size);
5318 if (buffer == NULL) {
5319 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5320 (int)(image.sections[i].size));
5321 retval = ERROR_FAIL;
5325 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5326 if (retval != ERROR_OK) {
5331 uint32_t offset = 0;
5332 uint32_t length = buf_cnt;
5334 /* DANGER!!! beware of unsigned comparision here!!! */
5336 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5337 (image.sections[i].base_address < max_address)) {
5338 if (image.sections[i].base_address < min_address) {
5339 /* clip addresses below */
5340 offset += min_address-image.sections[i].base_address;
5344 if (image.sections[i].base_address + buf_cnt > max_address)
5345 length -= (image.sections[i].base_address + buf_cnt)-max_address;
5347 fastload[i].address = image.sections[i].base_address + offset;
5348 fastload[i].data = malloc(length);
5349 if (fastload[i].data == NULL) {
5351 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5353 retval = ERROR_FAIL;
5356 memcpy(fastload[i].data, buffer + offset, length);
5357 fastload[i].length = length;
5359 image_size += length;
5360 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
5361 (unsigned int)length,
5362 ((unsigned int)(image.sections[i].base_address + offset)));
5368 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
5369 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
5370 "in %fs (%0.3f KiB/s)", image_size,
5371 duration_elapsed(&bench), duration_kbps(&bench, image_size));
5373 command_print(CMD_CTX,
5374 "WARNING: image has not been loaded to target!"
5375 "You can issue a 'fast_load' to finish loading.");
5378 image_close(&image);
5380 if (retval != ERROR_OK)
5386 COMMAND_HANDLER(handle_fast_load_command)
5389 return ERROR_COMMAND_SYNTAX_ERROR;
5390 if (fastload == NULL) {
5391 LOG_ERROR("No image in memory");
5395 int ms = timeval_ms();
5397 int retval = ERROR_OK;
5398 for (i = 0; i < fastload_num; i++) {
5399 struct target *target = get_current_target(CMD_CTX);
5400 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
5401 (unsigned int)(fastload[i].address),
5402 (unsigned int)(fastload[i].length));
5403 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
5404 if (retval != ERROR_OK)
5406 size += fastload[i].length;
5408 if (retval == ERROR_OK) {
5409 int after = timeval_ms();
5410 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
5415 static const struct command_registration target_command_handlers[] = {
5418 .handler = handle_targets_command,
5419 .mode = COMMAND_ANY,
5420 .help = "change current default target (one parameter) "
5421 "or prints table of all targets (no parameters)",
5422 .usage = "[target]",
5426 .mode = COMMAND_CONFIG,
5427 .help = "configure target",
5429 .chain = target_subcommand_handlers,
5431 COMMAND_REGISTRATION_DONE
5434 int target_register_commands(struct command_context *cmd_ctx)
5436 return register_commands(cmd_ctx, NULL, target_command_handlers);
5439 static bool target_reset_nag = true;
5441 bool get_target_reset_nag(void)
5443 return target_reset_nag;
5446 COMMAND_HANDLER(handle_target_reset_nag)
5448 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
5449 &target_reset_nag, "Nag after each reset about options to improve "
5453 COMMAND_HANDLER(handle_ps_command)
5455 struct target *target = get_current_target(CMD_CTX);
5457 if (target->state != TARGET_HALTED) {
5458 LOG_INFO("target not halted !!");
5462 if ((target->rtos) && (target->rtos->type)
5463 && (target->rtos->type->ps_command)) {
5464 display = target->rtos->type->ps_command(target);
5465 command_print(CMD_CTX, "%s", display);
5470 return ERROR_TARGET_FAILURE;
5474 static const struct command_registration target_exec_command_handlers[] = {
5476 .name = "fast_load_image",
5477 .handler = handle_fast_load_image_command,
5478 .mode = COMMAND_ANY,
5479 .help = "Load image into server memory for later use by "
5480 "fast_load; primarily for profiling",
5481 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5482 "[min_address [max_length]]",
5485 .name = "fast_load",
5486 .handler = handle_fast_load_command,
5487 .mode = COMMAND_EXEC,
5488 .help = "loads active fast load image to current target "
5489 "- mainly for profiling purposes",
5494 .handler = handle_profile_command,
5495 .mode = COMMAND_EXEC,
5496 .usage = "seconds filename",
5497 .help = "profiling samples the CPU PC",
5499 /** @todo don't register virt2phys() unless target supports it */
5501 .name = "virt2phys",
5502 .handler = handle_virt2phys_command,
5503 .mode = COMMAND_ANY,
5504 .help = "translate a virtual address into a physical address",
5505 .usage = "virtual_address",
5509 .handler = handle_reg_command,
5510 .mode = COMMAND_EXEC,
5511 .help = "display or set a register; with no arguments, "
5512 "displays all registers and their values",
5513 .usage = "[(register_name|register_number) [value]]",
5517 .handler = handle_poll_command,
5518 .mode = COMMAND_EXEC,
5519 .help = "poll target state; or reconfigure background polling",
5520 .usage = "['on'|'off']",
5523 .name = "wait_halt",
5524 .handler = handle_wait_halt_command,
5525 .mode = COMMAND_EXEC,
5526 .help = "wait up to the specified number of milliseconds "
5527 "(default 5) for a previously requested halt",
5528 .usage = "[milliseconds]",
5532 .handler = handle_halt_command,
5533 .mode = COMMAND_EXEC,
5534 .help = "request target to halt, then wait up to the specified"
5535 "number of milliseconds (default 5) for it to complete",
5536 .usage = "[milliseconds]",
5540 .handler = handle_resume_command,
5541 .mode = COMMAND_EXEC,
5542 .help = "resume target execution from current PC or address",
5543 .usage = "[address]",
5547 .handler = handle_reset_command,
5548 .mode = COMMAND_EXEC,
5549 .usage = "[run|halt|init]",
5550 .help = "Reset all targets into the specified mode."
5551 "Default reset mode is run, if not given.",
5554 .name = "soft_reset_halt",
5555 .handler = handle_soft_reset_halt_command,
5556 .mode = COMMAND_EXEC,
5558 .help = "halt the target and do a soft reset",
5562 .handler = handle_step_command,
5563 .mode = COMMAND_EXEC,
5564 .help = "step one instruction from current PC or address",
5565 .usage = "[address]",
5569 .handler = handle_md_command,
5570 .mode = COMMAND_EXEC,
5571 .help = "display memory words",
5572 .usage = "['phys'] address [count]",
5576 .handler = handle_md_command,
5577 .mode = COMMAND_EXEC,
5578 .help = "display memory half-words",
5579 .usage = "['phys'] address [count]",
5583 .handler = handle_md_command,
5584 .mode = COMMAND_EXEC,
5585 .help = "display memory bytes",
5586 .usage = "['phys'] address [count]",
5590 .handler = handle_mw_command,
5591 .mode = COMMAND_EXEC,
5592 .help = "write memory word",
5593 .usage = "['phys'] address value [count]",
5597 .handler = handle_mw_command,
5598 .mode = COMMAND_EXEC,
5599 .help = "write memory half-word",
5600 .usage = "['phys'] address value [count]",
5604 .handler = handle_mw_command,
5605 .mode = COMMAND_EXEC,
5606 .help = "write memory byte",
5607 .usage = "['phys'] address value [count]",
5611 .handler = handle_bp_command,
5612 .mode = COMMAND_EXEC,
5613 .help = "list or set hardware or software breakpoint",
5614 .usage = "<address> [<asid>]<length> ['hw'|'hw_ctx']",
5618 .handler = handle_rbp_command,
5619 .mode = COMMAND_EXEC,
5620 .help = "remove breakpoint",
5625 .handler = handle_wp_command,
5626 .mode = COMMAND_EXEC,
5627 .help = "list (no params) or create watchpoints",
5628 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
5632 .handler = handle_rwp_command,
5633 .mode = COMMAND_EXEC,
5634 .help = "remove watchpoint",
5638 .name = "load_image",
5639 .handler = handle_load_image_command,
5640 .mode = COMMAND_EXEC,
5641 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5642 "[min_address] [max_length]",
5645 .name = "dump_image",
5646 .handler = handle_dump_image_command,
5647 .mode = COMMAND_EXEC,
5648 .usage = "filename address size",
5651 .name = "verify_image",
5652 .handler = handle_verify_image_command,
5653 .mode = COMMAND_EXEC,
5654 .usage = "filename [offset [type]]",
5657 .name = "test_image",
5658 .handler = handle_test_image_command,
5659 .mode = COMMAND_EXEC,
5660 .usage = "filename [offset [type]]",
5663 .name = "mem2array",
5664 .mode = COMMAND_EXEC,
5665 .jim_handler = jim_mem2array,
5666 .help = "read 8/16/32 bit memory and return as a TCL array "
5667 "for script processing",
5668 .usage = "arrayname bitwidth address count",
5671 .name = "array2mem",
5672 .mode = COMMAND_EXEC,
5673 .jim_handler = jim_array2mem,
5674 .help = "convert a TCL array to memory locations "
5675 "and write the 8/16/32 bit values",
5676 .usage = "arrayname bitwidth address count",
5679 .name = "reset_nag",
5680 .handler = handle_target_reset_nag,
5681 .mode = COMMAND_ANY,
5682 .help = "Nag after each reset about options that could have been "
5683 "enabled to improve performance. ",
5684 .usage = "['enable'|'disable']",
5688 .handler = handle_ps_command,
5689 .mode = COMMAND_EXEC,
5690 .help = "list all tasks ",
5694 COMMAND_REGISTRATION_DONE
5696 static int target_register_user_commands(struct command_context *cmd_ctx)
5698 int retval = ERROR_OK;
5699 retval = target_request_register_commands(cmd_ctx);
5700 if (retval != ERROR_OK)
5703 retval = trace_register_commands(cmd_ctx);
5704 if (retval != ERROR_OK)
5708 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);