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_write_memory_imp(struct target *target, uint32_t address,
661 uint32_t size, uint32_t count, const uint8_t *buffer)
663 if (!target_was_examined(target)) {
664 LOG_ERROR("Target not examined yet");
667 return target->type->write_memory_imp(target, address, size, count, buffer);
670 static int target_read_memory_imp(struct target *target, uint32_t address,
671 uint32_t size, uint32_t count, uint8_t *buffer)
673 if (!target_was_examined(target)) {
674 LOG_ERROR("Target not examined yet");
677 return target->type->read_memory_imp(target, address, size, count, buffer);
680 static int target_soft_reset_halt(struct target *target)
682 if (!target_was_examined(target)) {
683 LOG_ERROR("Target not examined yet");
686 if (!target->type->soft_reset_halt) {
687 LOG_ERROR("Target %s does not support soft_reset_halt",
688 target_name(target));
691 return target->type->soft_reset_halt(target);
695 * Downloads a target-specific native code algorithm to the target,
696 * and executes it. * Note that some targets may need to set up, enable,
697 * and tear down a breakpoint (hard or * soft) to detect algorithm
698 * termination, while others may support lower overhead schemes where
699 * soft breakpoints embedded in the algorithm automatically terminate the
702 * @param target used to run the algorithm
703 * @param arch_info target-specific description of the algorithm.
705 int target_run_algorithm(struct target *target,
706 int num_mem_params, struct mem_param *mem_params,
707 int num_reg_params, struct reg_param *reg_param,
708 uint32_t entry_point, uint32_t exit_point,
709 int timeout_ms, void *arch_info)
711 int retval = ERROR_FAIL;
713 if (!target_was_examined(target)) {
714 LOG_ERROR("Target not examined yet");
717 if (!target->type->run_algorithm) {
718 LOG_ERROR("Target type '%s' does not support %s",
719 target_type_name(target), __func__);
723 target->running_alg = true;
724 retval = target->type->run_algorithm(target,
725 num_mem_params, mem_params,
726 num_reg_params, reg_param,
727 entry_point, exit_point, timeout_ms, arch_info);
728 target->running_alg = false;
735 * Downloads a target-specific native code algorithm to the target,
736 * executes and leaves it running.
738 * @param target used to run the algorithm
739 * @param arch_info target-specific description of the algorithm.
741 int target_start_algorithm(struct target *target,
742 int num_mem_params, struct mem_param *mem_params,
743 int num_reg_params, struct reg_param *reg_params,
744 uint32_t entry_point, uint32_t exit_point,
747 int retval = ERROR_FAIL;
749 if (!target_was_examined(target)) {
750 LOG_ERROR("Target not examined yet");
753 if (!target->type->start_algorithm) {
754 LOG_ERROR("Target type '%s' does not support %s",
755 target_type_name(target), __func__);
758 if (target->running_alg) {
759 LOG_ERROR("Target is already running an algorithm");
763 target->running_alg = true;
764 retval = target->type->start_algorithm(target,
765 num_mem_params, mem_params,
766 num_reg_params, reg_params,
767 entry_point, exit_point, arch_info);
774 * Waits for an algorithm started with target_start_algorithm() to complete.
776 * @param target used to run the algorithm
777 * @param arch_info target-specific description of the algorithm.
779 int target_wait_algorithm(struct target *target,
780 int num_mem_params, struct mem_param *mem_params,
781 int num_reg_params, struct reg_param *reg_params,
782 uint32_t exit_point, int timeout_ms,
785 int retval = ERROR_FAIL;
787 if (!target->type->wait_algorithm) {
788 LOG_ERROR("Target type '%s' does not support %s",
789 target_type_name(target), __func__);
792 if (!target->running_alg) {
793 LOG_ERROR("Target is not running an algorithm");
797 retval = target->type->wait_algorithm(target,
798 num_mem_params, mem_params,
799 num_reg_params, reg_params,
800 exit_point, timeout_ms, arch_info);
801 if (retval != ERROR_TARGET_TIMEOUT)
802 target->running_alg = false;
809 * Executes a target-specific native code algorithm in the target.
810 * It differs from target_run_algorithm in that the algorithm is asynchronous.
811 * Because of this it requires an compliant algorithm:
812 * see contrib/loaders/flash/stm32f1x.S for example.
814 * @param target used to run the algorithm
817 int target_run_flash_async_algorithm(struct target *target,
818 uint8_t *buffer, uint32_t count, int block_size,
819 int num_mem_params, struct mem_param *mem_params,
820 int num_reg_params, struct reg_param *reg_params,
821 uint32_t buffer_start, uint32_t buffer_size,
822 uint32_t entry_point, uint32_t exit_point, void *arch_info)
827 /* Set up working area. First word is write pointer, second word is read pointer,
828 * rest is fifo data area. */
829 uint32_t wp_addr = buffer_start;
830 uint32_t rp_addr = buffer_start + 4;
831 uint32_t fifo_start_addr = buffer_start + 8;
832 uint32_t fifo_end_addr = buffer_start + buffer_size;
834 uint32_t wp = fifo_start_addr;
835 uint32_t rp = fifo_start_addr;
837 /* validate block_size is 2^n */
838 assert(!block_size || !(block_size & (block_size - 1)));
840 retval = target_write_u32(target, wp_addr, wp);
841 if (retval != ERROR_OK)
843 retval = target_write_u32(target, rp_addr, rp);
844 if (retval != ERROR_OK)
847 /* Start up algorithm on target and let it idle while writing the first chunk */
848 retval = target_start_algorithm(target, num_mem_params, mem_params,
849 num_reg_params, reg_params,
854 if (retval != ERROR_OK) {
855 LOG_ERROR("error starting target flash write algorithm");
861 retval = target_read_u32(target, rp_addr, &rp);
862 if (retval != ERROR_OK) {
863 LOG_ERROR("failed to get read pointer");
867 LOG_DEBUG("count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32, count, wp, rp);
870 LOG_ERROR("flash write algorithm aborted by target");
871 retval = ERROR_FLASH_OPERATION_FAILED;
875 if ((rp & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
876 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
880 /* Count the number of bytes available in the fifo without
881 * crossing the wrap around. Make sure to not fill it completely,
882 * because that would make wp == rp and that's the empty condition. */
883 uint32_t thisrun_bytes;
885 thisrun_bytes = rp - wp - block_size;
886 else if (rp > fifo_start_addr)
887 thisrun_bytes = fifo_end_addr - wp;
889 thisrun_bytes = fifo_end_addr - wp - block_size;
891 if (thisrun_bytes == 0) {
892 /* Throttle polling a bit if transfer is (much) faster than flash
893 * programming. The exact delay shouldn't matter as long as it's
894 * less than buffer size / flash speed. This is very unlikely to
895 * run when using high latency connections such as USB. */
898 /* to stop an infinite loop on some targets check and increment a timeout
899 * this issue was observed on a stellaris using the new ICDI interface */
900 if (timeout++ >= 500) {
901 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
902 return ERROR_FLASH_OPERATION_FAILED;
907 /* reset our timeout */
910 /* Limit to the amount of data we actually want to write */
911 if (thisrun_bytes > count * block_size)
912 thisrun_bytes = count * block_size;
914 /* Write data to fifo */
915 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
916 if (retval != ERROR_OK)
919 /* Update counters and wrap write pointer */
920 buffer += thisrun_bytes;
921 count -= thisrun_bytes / block_size;
923 if (wp >= fifo_end_addr)
924 wp = fifo_start_addr;
926 /* Store updated write pointer to target */
927 retval = target_write_u32(target, wp_addr, wp);
928 if (retval != ERROR_OK)
932 if (retval != ERROR_OK) {
933 /* abort flash write algorithm on target */
934 target_write_u32(target, wp_addr, 0);
937 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
938 num_reg_params, reg_params,
943 if (retval2 != ERROR_OK) {
944 LOG_ERROR("error waiting for target flash write algorithm");
951 int target_read_memory(struct target *target,
952 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
954 return target->type->read_memory(target, address, size, count, buffer);
957 static int target_read_phys_memory(struct target *target,
958 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
960 return target->type->read_phys_memory(target, address, size, count, buffer);
963 int target_write_memory(struct target *target,
964 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
966 return target->type->write_memory(target, address, size, count, buffer);
969 static int target_write_phys_memory(struct target *target,
970 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
972 return target->type->write_phys_memory(target, address, size, count, buffer);
975 int target_bulk_write_memory(struct target *target,
976 uint32_t address, uint32_t count, const uint8_t *buffer)
978 return target->type->bulk_write_memory(target, address, count, buffer);
981 int target_add_breakpoint(struct target *target,
982 struct breakpoint *breakpoint)
984 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
985 LOG_WARNING("target %s is not halted", target_name(target));
986 return ERROR_TARGET_NOT_HALTED;
988 return target->type->add_breakpoint(target, breakpoint);
991 int target_add_context_breakpoint(struct target *target,
992 struct breakpoint *breakpoint)
994 if (target->state != TARGET_HALTED) {
995 LOG_WARNING("target %s is not halted", target_name(target));
996 return ERROR_TARGET_NOT_HALTED;
998 return target->type->add_context_breakpoint(target, breakpoint);
1001 int target_add_hybrid_breakpoint(struct target *target,
1002 struct breakpoint *breakpoint)
1004 if (target->state != TARGET_HALTED) {
1005 LOG_WARNING("target %s is not halted", target_name(target));
1006 return ERROR_TARGET_NOT_HALTED;
1008 return target->type->add_hybrid_breakpoint(target, breakpoint);
1011 int target_remove_breakpoint(struct target *target,
1012 struct breakpoint *breakpoint)
1014 return target->type->remove_breakpoint(target, breakpoint);
1017 int target_add_watchpoint(struct target *target,
1018 struct watchpoint *watchpoint)
1020 if (target->state != TARGET_HALTED) {
1021 LOG_WARNING("target %s is not halted", target_name(target));
1022 return ERROR_TARGET_NOT_HALTED;
1024 return target->type->add_watchpoint(target, watchpoint);
1026 int target_remove_watchpoint(struct target *target,
1027 struct watchpoint *watchpoint)
1029 return target->type->remove_watchpoint(target, watchpoint);
1032 int target_get_gdb_reg_list(struct target *target,
1033 struct reg **reg_list[], int *reg_list_size)
1035 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
1037 int target_step(struct target *target,
1038 int current, uint32_t address, int handle_breakpoints)
1040 return target->type->step(target, current, address, handle_breakpoints);
1044 * Reset the @c examined flag for the given target.
1045 * Pure paranoia -- targets are zeroed on allocation.
1047 static void target_reset_examined(struct target *target)
1049 target->examined = false;
1052 static int err_read_phys_memory(struct target *target, uint32_t address,
1053 uint32_t size, uint32_t count, uint8_t *buffer)
1055 LOG_ERROR("Not implemented: %s", __func__);
1059 static int err_write_phys_memory(struct target *target, uint32_t address,
1060 uint32_t size, uint32_t count, const uint8_t *buffer)
1062 LOG_ERROR("Not implemented: %s", __func__);
1066 static int handle_target(void *priv);
1068 static int target_init_one(struct command_context *cmd_ctx,
1069 struct target *target)
1071 target_reset_examined(target);
1073 struct target_type *type = target->type;
1074 if (type->examine == NULL)
1075 type->examine = default_examine;
1077 if (type->check_reset == NULL)
1078 type->check_reset = default_check_reset;
1080 assert(type->init_target != NULL);
1082 int retval = type->init_target(cmd_ctx, target);
1083 if (ERROR_OK != retval) {
1084 LOG_ERROR("target '%s' init failed", target_name(target));
1089 * @todo get rid of those *memory_imp() methods, now that all
1090 * callers are using target_*_memory() accessors ... and make
1091 * sure the "physical" paths handle the same issues.
1093 /* a non-invasive way(in terms of patches) to add some code that
1094 * runs before the type->write/read_memory implementation
1096 type->write_memory_imp = target->type->write_memory;
1097 type->write_memory = target_write_memory_imp;
1099 type->read_memory_imp = target->type->read_memory;
1100 type->read_memory = target_read_memory_imp;
1102 /* Sanity-check MMU support ... stub in what we must, to help
1103 * implement it in stages, but warn if we need to do so.
1106 if (type->write_phys_memory == NULL) {
1107 LOG_ERROR("type '%s' is missing write_phys_memory",
1109 type->write_phys_memory = err_write_phys_memory;
1111 if (type->read_phys_memory == NULL) {
1112 LOG_ERROR("type '%s' is missing read_phys_memory",
1114 type->read_phys_memory = err_read_phys_memory;
1116 if (type->virt2phys == NULL) {
1117 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1118 type->virt2phys = identity_virt2phys;
1121 /* Make sure no-MMU targets all behave the same: make no
1122 * distinction between physical and virtual addresses, and
1123 * ensure that virt2phys() is always an identity mapping.
1125 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1126 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1129 type->write_phys_memory = type->write_memory;
1130 type->read_phys_memory = type->read_memory;
1131 type->virt2phys = identity_virt2phys;
1134 if (target->type->read_buffer == NULL)
1135 target->type->read_buffer = target_read_buffer_default;
1137 if (target->type->write_buffer == NULL)
1138 target->type->write_buffer = target_write_buffer_default;
1143 static int target_init(struct command_context *cmd_ctx)
1145 struct target *target;
1148 for (target = all_targets; target; target = target->next) {
1149 retval = target_init_one(cmd_ctx, target);
1150 if (ERROR_OK != retval)
1157 retval = target_register_user_commands(cmd_ctx);
1158 if (ERROR_OK != retval)
1161 retval = target_register_timer_callback(&handle_target,
1162 polling_interval, 1, cmd_ctx->interp);
1163 if (ERROR_OK != retval)
1169 COMMAND_HANDLER(handle_target_init_command)
1174 return ERROR_COMMAND_SYNTAX_ERROR;
1176 static bool target_initialized;
1177 if (target_initialized) {
1178 LOG_INFO("'target init' has already been called");
1181 target_initialized = true;
1183 retval = command_run_line(CMD_CTX, "init_targets");
1184 if (ERROR_OK != retval)
1187 retval = command_run_line(CMD_CTX, "init_board");
1188 if (ERROR_OK != retval)
1191 LOG_DEBUG("Initializing targets...");
1192 return target_init(CMD_CTX);
1195 int target_register_event_callback(int (*callback)(struct target *target,
1196 enum target_event event, void *priv), void *priv)
1198 struct target_event_callback **callbacks_p = &target_event_callbacks;
1200 if (callback == NULL)
1201 return ERROR_COMMAND_SYNTAX_ERROR;
1204 while ((*callbacks_p)->next)
1205 callbacks_p = &((*callbacks_p)->next);
1206 callbacks_p = &((*callbacks_p)->next);
1209 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1210 (*callbacks_p)->callback = callback;
1211 (*callbacks_p)->priv = priv;
1212 (*callbacks_p)->next = NULL;
1217 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
1219 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1222 if (callback == NULL)
1223 return ERROR_COMMAND_SYNTAX_ERROR;
1226 while ((*callbacks_p)->next)
1227 callbacks_p = &((*callbacks_p)->next);
1228 callbacks_p = &((*callbacks_p)->next);
1231 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1232 (*callbacks_p)->callback = callback;
1233 (*callbacks_p)->periodic = periodic;
1234 (*callbacks_p)->time_ms = time_ms;
1236 gettimeofday(&now, NULL);
1237 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
1238 time_ms -= (time_ms % 1000);
1239 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
1240 if ((*callbacks_p)->when.tv_usec > 1000000) {
1241 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
1242 (*callbacks_p)->when.tv_sec += 1;
1245 (*callbacks_p)->priv = priv;
1246 (*callbacks_p)->next = NULL;
1251 int target_unregister_event_callback(int (*callback)(struct target *target,
1252 enum target_event event, void *priv), void *priv)
1254 struct target_event_callback **p = &target_event_callbacks;
1255 struct target_event_callback *c = target_event_callbacks;
1257 if (callback == NULL)
1258 return ERROR_COMMAND_SYNTAX_ERROR;
1261 struct target_event_callback *next = c->next;
1262 if ((c->callback == callback) && (c->priv == priv)) {
1274 static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1276 struct target_timer_callback **p = &target_timer_callbacks;
1277 struct target_timer_callback *c = target_timer_callbacks;
1279 if (callback == NULL)
1280 return ERROR_COMMAND_SYNTAX_ERROR;
1283 struct target_timer_callback *next = c->next;
1284 if ((c->callback == callback) && (c->priv == priv)) {
1296 int target_call_event_callbacks(struct target *target, enum target_event event)
1298 struct target_event_callback *callback = target_event_callbacks;
1299 struct target_event_callback *next_callback;
1301 if (event == TARGET_EVENT_HALTED) {
1302 /* execute early halted first */
1303 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1306 LOG_DEBUG("target event %i (%s)", event,
1307 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1309 target_handle_event(target, event);
1312 next_callback = callback->next;
1313 callback->callback(target, event, callback->priv);
1314 callback = next_callback;
1320 static int target_timer_callback_periodic_restart(
1321 struct target_timer_callback *cb, struct timeval *now)
1323 int time_ms = cb->time_ms;
1324 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1325 time_ms -= (time_ms % 1000);
1326 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1327 if (cb->when.tv_usec > 1000000) {
1328 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1329 cb->when.tv_sec += 1;
1334 static int target_call_timer_callback(struct target_timer_callback *cb,
1335 struct timeval *now)
1337 cb->callback(cb->priv);
1340 return target_timer_callback_periodic_restart(cb, now);
1342 return target_unregister_timer_callback(cb->callback, cb->priv);
1345 static int target_call_timer_callbacks_check_time(int checktime)
1350 gettimeofday(&now, NULL);
1352 struct target_timer_callback *callback = target_timer_callbacks;
1354 /* cleaning up may unregister and free this callback */
1355 struct target_timer_callback *next_callback = callback->next;
1357 bool call_it = callback->callback &&
1358 ((!checktime && callback->periodic) ||
1359 now.tv_sec > callback->when.tv_sec ||
1360 (now.tv_sec == callback->when.tv_sec &&
1361 now.tv_usec >= callback->when.tv_usec));
1364 int retval = target_call_timer_callback(callback, &now);
1365 if (retval != ERROR_OK)
1369 callback = next_callback;
1375 int target_call_timer_callbacks(void)
1377 return target_call_timer_callbacks_check_time(1);
1380 /* invoke periodic callbacks immediately */
1381 int target_call_timer_callbacks_now(void)
1383 return target_call_timer_callbacks_check_time(0);
1386 /* Prints the working area layout for debug purposes */
1387 static void print_wa_layout(struct target *target)
1389 struct working_area *c = target->working_areas;
1392 LOG_DEBUG("%c%c 0x%08"PRIx32"-0x%08"PRIx32" (%"PRIu32" bytes)",
1393 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1394 c->address, c->address + c->size - 1, c->size);
1399 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1400 static void target_split_working_area(struct working_area *area, uint32_t size)
1402 assert(area->free); /* Shouldn't split an allocated area */
1403 assert(size <= area->size); /* Caller should guarantee this */
1405 /* Split only if not already the right size */
1406 if (size < area->size) {
1407 struct working_area *new_wa = malloc(sizeof(*new_wa));
1412 new_wa->next = area->next;
1413 new_wa->size = area->size - size;
1414 new_wa->address = area->address + size;
1415 new_wa->backup = NULL;
1416 new_wa->user = NULL;
1417 new_wa->free = true;
1419 area->next = new_wa;
1422 /* If backup memory was allocated to this area, it has the wrong size
1423 * now so free it and it will be reallocated if/when needed */
1426 area->backup = NULL;
1431 /* Merge all adjacent free areas into one */
1432 static void target_merge_working_areas(struct target *target)
1434 struct working_area *c = target->working_areas;
1436 while (c && c->next) {
1437 assert(c->next->address == c->address + c->size); /* This is an invariant */
1439 /* Find two adjacent free areas */
1440 if (c->free && c->next->free) {
1441 /* Merge the last into the first */
1442 c->size += c->next->size;
1444 /* Remove the last */
1445 struct working_area *to_be_freed = c->next;
1446 c->next = c->next->next;
1447 if (to_be_freed->backup)
1448 free(to_be_freed->backup);
1451 /* If backup memory was allocated to the remaining area, it's has
1452 * the wrong size now */
1463 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1465 /* Reevaluate working area address based on MMU state*/
1466 if (target->working_areas == NULL) {
1470 retval = target->type->mmu(target, &enabled);
1471 if (retval != ERROR_OK)
1475 if (target->working_area_phys_spec) {
1476 LOG_DEBUG("MMU disabled, using physical "
1477 "address for working memory 0x%08"PRIx32,
1478 target->working_area_phys);
1479 target->working_area = target->working_area_phys;
1481 LOG_ERROR("No working memory available. "
1482 "Specify -work-area-phys to target.");
1483 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1486 if (target->working_area_virt_spec) {
1487 LOG_DEBUG("MMU enabled, using virtual "
1488 "address for working memory 0x%08"PRIx32,
1489 target->working_area_virt);
1490 target->working_area = target->working_area_virt;
1492 LOG_ERROR("No working memory available. "
1493 "Specify -work-area-virt to target.");
1494 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1498 /* Set up initial working area on first call */
1499 struct working_area *new_wa = malloc(sizeof(*new_wa));
1501 new_wa->next = NULL;
1502 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1503 new_wa->address = target->working_area;
1504 new_wa->backup = NULL;
1505 new_wa->user = NULL;
1506 new_wa->free = true;
1509 target->working_areas = new_wa;
1512 /* only allocate multiples of 4 byte */
1514 size = (size + 3) & (~3UL);
1516 struct working_area *c = target->working_areas;
1518 /* Find the first large enough working area */
1520 if (c->free && c->size >= size)
1526 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1528 /* Split the working area into the requested size */
1529 target_split_working_area(c, size);
1531 LOG_DEBUG("allocated new working area of %"PRIu32" bytes at address 0x%08"PRIx32, size, c->address);
1533 if (target->backup_working_area) {
1534 if (c->backup == NULL) {
1535 c->backup = malloc(c->size);
1536 if (c->backup == NULL)
1540 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1541 if (retval != ERROR_OK)
1545 /* mark as used, and return the new (reused) area */
1552 print_wa_layout(target);
1557 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1561 retval = target_alloc_working_area_try(target, size, area);
1562 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1563 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1568 static int target_restore_working_area(struct target *target, struct working_area *area)
1570 int retval = ERROR_OK;
1572 if (target->backup_working_area && area->backup != NULL) {
1573 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1574 if (retval != ERROR_OK)
1575 LOG_ERROR("failed to restore %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1576 area->size, area->address);
1582 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1583 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1585 int retval = ERROR_OK;
1591 retval = target_restore_working_area(target, area);
1592 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1593 if (retval != ERROR_OK)
1599 LOG_DEBUG("freed %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1600 area->size, area->address);
1602 /* mark user pointer invalid */
1603 /* TODO: Is this really safe? It points to some previous caller's memory.
1604 * How could we know that the area pointer is still in that place and not
1605 * some other vital data? What's the purpose of this, anyway? */
1609 target_merge_working_areas(target);
1611 print_wa_layout(target);
1616 int target_free_working_area(struct target *target, struct working_area *area)
1618 return target_free_working_area_restore(target, area, 1);
1621 /* free resources and restore memory, if restoring memory fails,
1622 * free up resources anyway
1624 static void target_free_all_working_areas_restore(struct target *target, int restore)
1626 struct working_area *c = target->working_areas;
1628 LOG_DEBUG("freeing all working areas");
1630 /* Loop through all areas, restoring the allocated ones and marking them as free */
1634 target_restore_working_area(target, c);
1636 *c->user = NULL; /* Same as above */
1642 /* Run a merge pass to combine all areas into one */
1643 target_merge_working_areas(target);
1645 print_wa_layout(target);
1648 void target_free_all_working_areas(struct target *target)
1650 target_free_all_working_areas_restore(target, 1);
1653 /* Find the largest number of bytes that can be allocated */
1654 uint32_t target_get_working_area_avail(struct target *target)
1656 struct working_area *c = target->working_areas;
1657 uint32_t max_size = 0;
1660 return target->working_area_size;
1663 if (c->free && max_size < c->size)
1672 int target_arch_state(struct target *target)
1675 if (target == NULL) {
1676 LOG_USER("No target has been configured");
1680 LOG_USER("target state: %s", target_state_name(target));
1682 if (target->state != TARGET_HALTED)
1685 retval = target->type->arch_state(target);
1689 /* Single aligned words are guaranteed to use 16 or 32 bit access
1690 * mode respectively, otherwise data is handled as quickly as
1693 int target_write_buffer(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1695 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x",
1696 (int)size, (unsigned)address);
1698 if (!target_was_examined(target)) {
1699 LOG_ERROR("Target not examined yet");
1706 if ((address + size - 1) < address) {
1707 /* GDB can request this when e.g. PC is 0xfffffffc*/
1708 LOG_ERROR("address + size wrapped(0x%08x, 0x%08x)",
1714 return target->type->write_buffer(target, address, size, buffer);
1717 static int target_write_buffer_default(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1719 int retval = ERROR_OK;
1721 if (((address % 2) == 0) && (size == 2))
1722 return target_write_memory(target, address, 2, 1, buffer);
1724 /* handle unaligned head bytes */
1726 uint32_t unaligned = 4 - (address % 4);
1728 if (unaligned > size)
1731 retval = target_write_memory(target, address, 1, unaligned, buffer);
1732 if (retval != ERROR_OK)
1735 buffer += unaligned;
1736 address += unaligned;
1740 /* handle aligned words */
1742 int aligned = size - (size % 4);
1744 /* use bulk writes above a certain limit. This may have to be changed */
1745 if (aligned > 128) {
1746 retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer);
1747 if (retval != ERROR_OK)
1750 retval = target_write_memory(target, address, 4, aligned / 4, buffer);
1751 if (retval != ERROR_OK)
1760 /* handle tail writes of less than 4 bytes */
1762 retval = target_write_memory(target, address, 1, size, buffer);
1763 if (retval != ERROR_OK)
1770 /* Single aligned words are guaranteed to use 16 or 32 bit access
1771 * mode respectively, otherwise data is handled as quickly as
1774 int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1776 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
1777 (int)size, (unsigned)address);
1779 if (!target_was_examined(target)) {
1780 LOG_ERROR("Target not examined yet");
1787 if ((address + size - 1) < address) {
1788 /* GDB can request this when e.g. PC is 0xfffffffc*/
1789 LOG_ERROR("address + size wrapped(0x%08" PRIx32 ", 0x%08" PRIx32 ")",
1795 return target->type->read_buffer(target, address, size, buffer);
1798 static int target_read_buffer_default(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1800 int retval = ERROR_OK;
1802 if (((address % 2) == 0) && (size == 2))
1803 return target_read_memory(target, address, 2, 1, buffer);
1805 /* handle unaligned head bytes */
1807 uint32_t unaligned = 4 - (address % 4);
1809 if (unaligned > size)
1812 retval = target_read_memory(target, address, 1, unaligned, buffer);
1813 if (retval != ERROR_OK)
1816 buffer += unaligned;
1817 address += unaligned;
1821 /* handle aligned words */
1823 int aligned = size - (size % 4);
1825 retval = target_read_memory(target, address, 4, aligned / 4, buffer);
1826 if (retval != ERROR_OK)
1834 /*prevent byte access when possible (avoid AHB access limitations in some cases)*/
1836 int aligned = size - (size % 2);
1837 retval = target_read_memory(target, address, 2, aligned / 2, buffer);
1838 if (retval != ERROR_OK)
1845 /* handle tail writes of less than 4 bytes */
1847 retval = target_read_memory(target, address, 1, size, buffer);
1848 if (retval != ERROR_OK)
1855 int target_checksum_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* crc)
1860 uint32_t checksum = 0;
1861 if (!target_was_examined(target)) {
1862 LOG_ERROR("Target not examined yet");
1866 retval = target->type->checksum_memory(target, address, size, &checksum);
1867 if (retval != ERROR_OK) {
1868 buffer = malloc(size);
1869 if (buffer == NULL) {
1870 LOG_ERROR("error allocating buffer for section (%d bytes)", (int)size);
1871 return ERROR_COMMAND_SYNTAX_ERROR;
1873 retval = target_read_buffer(target, address, size, buffer);
1874 if (retval != ERROR_OK) {
1879 /* convert to target endianness */
1880 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
1881 uint32_t target_data;
1882 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
1883 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
1886 retval = image_calculate_checksum(buffer, size, &checksum);
1895 int target_blank_check_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* blank)
1898 if (!target_was_examined(target)) {
1899 LOG_ERROR("Target not examined yet");
1903 if (target->type->blank_check_memory == 0)
1904 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1906 retval = target->type->blank_check_memory(target, address, size, blank);
1911 int target_read_u32(struct target *target, uint32_t address, uint32_t *value)
1913 uint8_t value_buf[4];
1914 if (!target_was_examined(target)) {
1915 LOG_ERROR("Target not examined yet");
1919 int retval = target_read_memory(target, address, 4, 1, value_buf);
1921 if (retval == ERROR_OK) {
1922 *value = target_buffer_get_u32(target, value_buf);
1923 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1928 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1935 int target_read_u16(struct target *target, uint32_t address, uint16_t *value)
1937 uint8_t value_buf[2];
1938 if (!target_was_examined(target)) {
1939 LOG_ERROR("Target not examined yet");
1943 int retval = target_read_memory(target, address, 2, 1, value_buf);
1945 if (retval == ERROR_OK) {
1946 *value = target_buffer_get_u16(target, value_buf);
1947 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4x",
1952 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1959 int target_read_u8(struct target *target, uint32_t address, uint8_t *value)
1961 int retval = target_read_memory(target, address, 1, 1, value);
1962 if (!target_was_examined(target)) {
1963 LOG_ERROR("Target not examined yet");
1967 if (retval == ERROR_OK) {
1968 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
1973 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1980 int target_write_u32(struct target *target, uint32_t address, uint32_t value)
1983 uint8_t value_buf[4];
1984 if (!target_was_examined(target)) {
1985 LOG_ERROR("Target not examined yet");
1989 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1993 target_buffer_set_u32(target, value_buf, value);
1994 retval = target_write_memory(target, address, 4, 1, value_buf);
1995 if (retval != ERROR_OK)
1996 LOG_DEBUG("failed: %i", retval);
2001 int target_write_u16(struct target *target, uint32_t address, uint16_t value)
2004 uint8_t value_buf[2];
2005 if (!target_was_examined(target)) {
2006 LOG_ERROR("Target not examined yet");
2010 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8x",
2014 target_buffer_set_u16(target, value_buf, value);
2015 retval = target_write_memory(target, address, 2, 1, value_buf);
2016 if (retval != ERROR_OK)
2017 LOG_DEBUG("failed: %i", retval);
2022 int target_write_u8(struct target *target, uint32_t address, uint8_t value)
2025 if (!target_was_examined(target)) {
2026 LOG_ERROR("Target not examined yet");
2030 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
2033 retval = target_write_memory(target, address, 1, 1, &value);
2034 if (retval != ERROR_OK)
2035 LOG_DEBUG("failed: %i", retval);
2040 static int find_target(struct command_context *cmd_ctx, const char *name)
2042 struct target *target = get_target(name);
2043 if (target == NULL) {
2044 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2047 if (!target->tap->enabled) {
2048 LOG_USER("Target: TAP %s is disabled, "
2049 "can't be the current target\n",
2050 target->tap->dotted_name);
2054 cmd_ctx->current_target = target->target_number;
2059 COMMAND_HANDLER(handle_targets_command)
2061 int retval = ERROR_OK;
2062 if (CMD_ARGC == 1) {
2063 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2064 if (retval == ERROR_OK) {
2070 struct target *target = all_targets;
2071 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2072 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2077 if (target->tap->enabled)
2078 state = target_state_name(target);
2080 state = "tap-disabled";
2082 if (CMD_CTX->current_target == target->target_number)
2085 /* keep columns lined up to match the headers above */
2086 command_print(CMD_CTX,
2087 "%2d%c %-18s %-10s %-6s %-18s %s",
2088 target->target_number,
2090 target_name(target),
2091 target_type_name(target),
2092 Jim_Nvp_value2name_simple(nvp_target_endian,
2093 target->endianness)->name,
2094 target->tap->dotted_name,
2096 target = target->next;
2102 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2104 static int powerDropout;
2105 static int srstAsserted;
2107 static int runPowerRestore;
2108 static int runPowerDropout;
2109 static int runSrstAsserted;
2110 static int runSrstDeasserted;
2112 static int sense_handler(void)
2114 static int prevSrstAsserted;
2115 static int prevPowerdropout;
2117 int retval = jtag_power_dropout(&powerDropout);
2118 if (retval != ERROR_OK)
2122 powerRestored = prevPowerdropout && !powerDropout;
2124 runPowerRestore = 1;
2126 long long current = timeval_ms();
2127 static long long lastPower;
2128 int waitMore = lastPower + 2000 > current;
2129 if (powerDropout && !waitMore) {
2130 runPowerDropout = 1;
2131 lastPower = current;
2134 retval = jtag_srst_asserted(&srstAsserted);
2135 if (retval != ERROR_OK)
2139 srstDeasserted = prevSrstAsserted && !srstAsserted;
2141 static long long lastSrst;
2142 waitMore = lastSrst + 2000 > current;
2143 if (srstDeasserted && !waitMore) {
2144 runSrstDeasserted = 1;
2148 if (!prevSrstAsserted && srstAsserted)
2149 runSrstAsserted = 1;
2151 prevSrstAsserted = srstAsserted;
2152 prevPowerdropout = powerDropout;
2154 if (srstDeasserted || powerRestored) {
2155 /* Other than logging the event we can't do anything here.
2156 * Issuing a reset is a particularly bad idea as we might
2157 * be inside a reset already.
2164 /* process target state changes */
2165 static int handle_target(void *priv)
2167 Jim_Interp *interp = (Jim_Interp *)priv;
2168 int retval = ERROR_OK;
2170 if (!is_jtag_poll_safe()) {
2171 /* polling is disabled currently */
2175 /* we do not want to recurse here... */
2176 static int recursive;
2180 /* danger! running these procedures can trigger srst assertions and power dropouts.
2181 * We need to avoid an infinite loop/recursion here and we do that by
2182 * clearing the flags after running these events.
2184 int did_something = 0;
2185 if (runSrstAsserted) {
2186 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2187 Jim_Eval(interp, "srst_asserted");
2190 if (runSrstDeasserted) {
2191 Jim_Eval(interp, "srst_deasserted");
2194 if (runPowerDropout) {
2195 LOG_INFO("Power dropout detected, running power_dropout proc.");
2196 Jim_Eval(interp, "power_dropout");
2199 if (runPowerRestore) {
2200 Jim_Eval(interp, "power_restore");
2204 if (did_something) {
2205 /* clear detect flags */
2209 /* clear action flags */
2211 runSrstAsserted = 0;
2212 runSrstDeasserted = 0;
2213 runPowerRestore = 0;
2214 runPowerDropout = 0;
2219 /* Poll targets for state changes unless that's globally disabled.
2220 * Skip targets that are currently disabled.
2222 for (struct target *target = all_targets;
2223 is_jtag_poll_safe() && target;
2224 target = target->next) {
2225 if (!target->tap->enabled)
2228 if (target->backoff.times > target->backoff.count) {
2229 /* do not poll this time as we failed previously */
2230 target->backoff.count++;
2233 target->backoff.count = 0;
2235 /* only poll target if we've got power and srst isn't asserted */
2236 if (!powerDropout && !srstAsserted) {
2237 /* polling may fail silently until the target has been examined */
2238 retval = target_poll(target);
2239 if (retval != ERROR_OK) {
2240 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2241 if (target->backoff.times * polling_interval < 5000) {
2242 target->backoff.times *= 2;
2243 target->backoff.times++;
2245 LOG_USER("Polling target %s failed, GDB will be halted. Polling again in %dms",
2246 target_name(target),
2247 target->backoff.times * polling_interval);
2249 /* Tell GDB to halt the debugger. This allows the user to
2250 * run monitor commands to handle the situation.
2252 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2255 /* Since we succeeded, we reset backoff count */
2256 if (target->backoff.times > 0)
2257 LOG_USER("Polling target %s succeeded again", target_name(target));
2258 target->backoff.times = 0;
2265 COMMAND_HANDLER(handle_reg_command)
2267 struct target *target;
2268 struct reg *reg = NULL;
2274 target = get_current_target(CMD_CTX);
2276 /* list all available registers for the current target */
2277 if (CMD_ARGC == 0) {
2278 struct reg_cache *cache = target->reg_cache;
2284 command_print(CMD_CTX, "===== %s", cache->name);
2286 for (i = 0, reg = cache->reg_list;
2287 i < cache->num_regs;
2288 i++, reg++, count++) {
2289 /* only print cached values if they are valid */
2291 value = buf_to_str(reg->value,
2293 command_print(CMD_CTX,
2294 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2302 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2307 cache = cache->next;
2313 /* access a single register by its ordinal number */
2314 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2316 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2318 struct reg_cache *cache = target->reg_cache;
2322 for (i = 0; i < cache->num_regs; i++) {
2323 if (count++ == num) {
2324 reg = &cache->reg_list[i];
2330 cache = cache->next;
2334 command_print(CMD_CTX, "%i is out of bounds, the current target "
2335 "has only %i registers (0 - %i)", num, count, count - 1);
2339 /* access a single register by its name */
2340 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2343 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2348 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2350 /* display a register */
2351 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2352 && (CMD_ARGV[1][0] <= '9')))) {
2353 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2356 if (reg->valid == 0)
2357 reg->type->get(reg);
2358 value = buf_to_str(reg->value, reg->size, 16);
2359 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2364 /* set register value */
2365 if (CMD_ARGC == 2) {
2366 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2369 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2371 reg->type->set(reg, buf);
2373 value = buf_to_str(reg->value, reg->size, 16);
2374 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2382 return ERROR_COMMAND_SYNTAX_ERROR;
2385 COMMAND_HANDLER(handle_poll_command)
2387 int retval = ERROR_OK;
2388 struct target *target = get_current_target(CMD_CTX);
2390 if (CMD_ARGC == 0) {
2391 command_print(CMD_CTX, "background polling: %s",
2392 jtag_poll_get_enabled() ? "on" : "off");
2393 command_print(CMD_CTX, "TAP: %s (%s)",
2394 target->tap->dotted_name,
2395 target->tap->enabled ? "enabled" : "disabled");
2396 if (!target->tap->enabled)
2398 retval = target_poll(target);
2399 if (retval != ERROR_OK)
2401 retval = target_arch_state(target);
2402 if (retval != ERROR_OK)
2404 } else if (CMD_ARGC == 1) {
2406 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2407 jtag_poll_set_enabled(enable);
2409 return ERROR_COMMAND_SYNTAX_ERROR;
2414 COMMAND_HANDLER(handle_wait_halt_command)
2417 return ERROR_COMMAND_SYNTAX_ERROR;
2420 if (1 == CMD_ARGC) {
2421 int retval = parse_uint(CMD_ARGV[0], &ms);
2422 if (ERROR_OK != retval)
2423 return ERROR_COMMAND_SYNTAX_ERROR;
2424 /* convert seconds (given) to milliseconds (needed) */
2428 struct target *target = get_current_target(CMD_CTX);
2429 return target_wait_state(target, TARGET_HALTED, ms);
2432 /* wait for target state to change. The trick here is to have a low
2433 * latency for short waits and not to suck up all the CPU time
2436 * After 500ms, keep_alive() is invoked
2438 int target_wait_state(struct target *target, enum target_state state, int ms)
2441 long long then = 0, cur;
2445 retval = target_poll(target);
2446 if (retval != ERROR_OK)
2448 if (target->state == state)
2453 then = timeval_ms();
2454 LOG_DEBUG("waiting for target %s...",
2455 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2461 if ((cur-then) > ms) {
2462 LOG_ERROR("timed out while waiting for target %s",
2463 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2471 COMMAND_HANDLER(handle_halt_command)
2475 struct target *target = get_current_target(CMD_CTX);
2476 int retval = target_halt(target);
2477 if (ERROR_OK != retval)
2480 if (CMD_ARGC == 1) {
2481 unsigned wait_local;
2482 retval = parse_uint(CMD_ARGV[0], &wait_local);
2483 if (ERROR_OK != retval)
2484 return ERROR_COMMAND_SYNTAX_ERROR;
2489 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
2492 COMMAND_HANDLER(handle_soft_reset_halt_command)
2494 struct target *target = get_current_target(CMD_CTX);
2496 LOG_USER("requesting target halt and executing a soft reset");
2498 target_soft_reset_halt(target);
2503 COMMAND_HANDLER(handle_reset_command)
2506 return ERROR_COMMAND_SYNTAX_ERROR;
2508 enum target_reset_mode reset_mode = RESET_RUN;
2509 if (CMD_ARGC == 1) {
2511 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
2512 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
2513 return ERROR_COMMAND_SYNTAX_ERROR;
2514 reset_mode = n->value;
2517 /* reset *all* targets */
2518 return target_process_reset(CMD_CTX, reset_mode);
2522 COMMAND_HANDLER(handle_resume_command)
2526 return ERROR_COMMAND_SYNTAX_ERROR;
2528 struct target *target = get_current_target(CMD_CTX);
2530 /* with no CMD_ARGV, resume from current pc, addr = 0,
2531 * with one arguments, addr = CMD_ARGV[0],
2532 * handle breakpoints, not debugging */
2534 if (CMD_ARGC == 1) {
2535 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2539 return target_resume(target, current, addr, 1, 0);
2542 COMMAND_HANDLER(handle_step_command)
2545 return ERROR_COMMAND_SYNTAX_ERROR;
2549 /* with no CMD_ARGV, step from current pc, addr = 0,
2550 * with one argument addr = CMD_ARGV[0],
2551 * handle breakpoints, debugging */
2554 if (CMD_ARGC == 1) {
2555 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2559 struct target *target = get_current_target(CMD_CTX);
2561 return target->type->step(target, current_pc, addr, 1);
2564 static void handle_md_output(struct command_context *cmd_ctx,
2565 struct target *target, uint32_t address, unsigned size,
2566 unsigned count, const uint8_t *buffer)
2568 const unsigned line_bytecnt = 32;
2569 unsigned line_modulo = line_bytecnt / size;
2571 char output[line_bytecnt * 4 + 1];
2572 unsigned output_len = 0;
2574 const char *value_fmt;
2577 value_fmt = "%8.8x ";
2580 value_fmt = "%4.4x ";
2583 value_fmt = "%2.2x ";
2586 /* "can't happen", caller checked */
2587 LOG_ERROR("invalid memory read size: %u", size);
2591 for (unsigned i = 0; i < count; i++) {
2592 if (i % line_modulo == 0) {
2593 output_len += snprintf(output + output_len,
2594 sizeof(output) - output_len,
2596 (unsigned)(address + (i*size)));
2600 const uint8_t *value_ptr = buffer + i * size;
2603 value = target_buffer_get_u32(target, value_ptr);
2606 value = target_buffer_get_u16(target, value_ptr);
2611 output_len += snprintf(output + output_len,
2612 sizeof(output) - output_len,
2615 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
2616 command_print(cmd_ctx, "%s", output);
2622 COMMAND_HANDLER(handle_md_command)
2625 return ERROR_COMMAND_SYNTAX_ERROR;
2628 switch (CMD_NAME[2]) {
2639 return ERROR_COMMAND_SYNTAX_ERROR;
2642 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2643 int (*fn)(struct target *target,
2644 uint32_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
2648 fn = target_read_phys_memory;
2650 fn = target_read_memory;
2651 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
2652 return ERROR_COMMAND_SYNTAX_ERROR;
2655 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2659 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
2661 uint8_t *buffer = calloc(count, size);
2663 struct target *target = get_current_target(CMD_CTX);
2664 int retval = fn(target, address, size, count, buffer);
2665 if (ERROR_OK == retval)
2666 handle_md_output(CMD_CTX, target, address, size, count, buffer);
2673 typedef int (*target_write_fn)(struct target *target,
2674 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
2676 static int target_write_memory_fast(struct target *target,
2677 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
2679 return target_write_buffer(target, address, size * count, buffer);
2682 static int target_fill_mem(struct target *target,
2691 /* We have to write in reasonably large chunks to be able
2692 * to fill large memory areas with any sane speed */
2693 const unsigned chunk_size = 16384;
2694 uint8_t *target_buf = malloc(chunk_size * data_size);
2695 if (target_buf == NULL) {
2696 LOG_ERROR("Out of memory");
2700 for (unsigned i = 0; i < chunk_size; i++) {
2701 switch (data_size) {
2703 target_buffer_set_u32(target, target_buf + i * data_size, b);
2706 target_buffer_set_u16(target, target_buf + i * data_size, b);
2709 target_buffer_set_u8(target, target_buf + i * data_size, b);
2716 int retval = ERROR_OK;
2718 for (unsigned x = 0; x < c; x += chunk_size) {
2721 if (current > chunk_size)
2722 current = chunk_size;
2723 retval = fn(target, address + x * data_size, data_size, current, target_buf);
2724 if (retval != ERROR_OK)
2726 /* avoid GDB timeouts */
2735 COMMAND_HANDLER(handle_mw_command)
2738 return ERROR_COMMAND_SYNTAX_ERROR;
2739 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2744 fn = target_write_phys_memory;
2746 fn = target_write_memory_fast;
2747 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
2748 return ERROR_COMMAND_SYNTAX_ERROR;
2751 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2754 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2758 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
2760 struct target *target = get_current_target(CMD_CTX);
2762 switch (CMD_NAME[2]) {
2773 return ERROR_COMMAND_SYNTAX_ERROR;
2776 return target_fill_mem(target, address, fn, wordsize, value, count);
2779 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
2780 uint32_t *min_address, uint32_t *max_address)
2782 if (CMD_ARGC < 1 || CMD_ARGC > 5)
2783 return ERROR_COMMAND_SYNTAX_ERROR;
2785 /* a base address isn't always necessary,
2786 * default to 0x0 (i.e. don't relocate) */
2787 if (CMD_ARGC >= 2) {
2789 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2790 image->base_address = addr;
2791 image->base_address_set = 1;
2793 image->base_address_set = 0;
2795 image->start_address_set = 0;
2798 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], *min_address);
2799 if (CMD_ARGC == 5) {
2800 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], *max_address);
2801 /* use size (given) to find max (required) */
2802 *max_address += *min_address;
2805 if (*min_address > *max_address)
2806 return ERROR_COMMAND_SYNTAX_ERROR;
2811 COMMAND_HANDLER(handle_load_image_command)
2815 uint32_t image_size;
2816 uint32_t min_address = 0;
2817 uint32_t max_address = 0xffffffff;
2821 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
2822 &image, &min_address, &max_address);
2823 if (ERROR_OK != retval)
2826 struct target *target = get_current_target(CMD_CTX);
2828 struct duration bench;
2829 duration_start(&bench);
2831 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
2836 for (i = 0; i < image.num_sections; i++) {
2837 buffer = malloc(image.sections[i].size);
2838 if (buffer == NULL) {
2839 command_print(CMD_CTX,
2840 "error allocating buffer for section (%d bytes)",
2841 (int)(image.sections[i].size));
2845 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
2846 if (retval != ERROR_OK) {
2851 uint32_t offset = 0;
2852 uint32_t length = buf_cnt;
2854 /* DANGER!!! beware of unsigned comparision here!!! */
2856 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
2857 (image.sections[i].base_address < max_address)) {
2859 if (image.sections[i].base_address < min_address) {
2860 /* clip addresses below */
2861 offset += min_address-image.sections[i].base_address;
2865 if (image.sections[i].base_address + buf_cnt > max_address)
2866 length -= (image.sections[i].base_address + buf_cnt)-max_address;
2868 retval = target_write_buffer(target,
2869 image.sections[i].base_address + offset, length, buffer + offset);
2870 if (retval != ERROR_OK) {
2874 image_size += length;
2875 command_print(CMD_CTX, "%u bytes written at address 0x%8.8" PRIx32 "",
2876 (unsigned int)length,
2877 image.sections[i].base_address + offset);
2883 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2884 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
2885 "in %fs (%0.3f KiB/s)", image_size,
2886 duration_elapsed(&bench), duration_kbps(&bench, image_size));
2889 image_close(&image);
2895 COMMAND_HANDLER(handle_dump_image_command)
2897 struct fileio fileio;
2899 int retval, retvaltemp;
2900 uint32_t address, size;
2901 struct duration bench;
2902 struct target *target = get_current_target(CMD_CTX);
2905 return ERROR_COMMAND_SYNTAX_ERROR;
2907 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], address);
2908 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], size);
2910 uint32_t buf_size = (size > 4096) ? 4096 : size;
2911 buffer = malloc(buf_size);
2915 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
2916 if (retval != ERROR_OK) {
2921 duration_start(&bench);
2924 size_t size_written;
2925 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
2926 retval = target_read_buffer(target, address, this_run_size, buffer);
2927 if (retval != ERROR_OK)
2930 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2931 if (retval != ERROR_OK)
2934 size -= this_run_size;
2935 address += this_run_size;
2940 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2942 retval = fileio_size(&fileio, &filesize);
2943 if (retval != ERROR_OK)
2945 command_print(CMD_CTX,
2946 "dumped %ld bytes in %fs (%0.3f KiB/s)", (long)filesize,
2947 duration_elapsed(&bench), duration_kbps(&bench, filesize));
2950 retvaltemp = fileio_close(&fileio);
2951 if (retvaltemp != ERROR_OK)
2957 static COMMAND_HELPER(handle_verify_image_command_internal, int verify)
2961 uint32_t image_size;
2964 uint32_t checksum = 0;
2965 uint32_t mem_checksum = 0;
2969 struct target *target = get_current_target(CMD_CTX);
2972 return ERROR_COMMAND_SYNTAX_ERROR;
2975 LOG_ERROR("no target selected");
2979 struct duration bench;
2980 duration_start(&bench);
2982 if (CMD_ARGC >= 2) {
2984 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2985 image.base_address = addr;
2986 image.base_address_set = 1;
2988 image.base_address_set = 0;
2989 image.base_address = 0x0;
2992 image.start_address_set = 0;
2994 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
2995 if (retval != ERROR_OK)
3001 for (i = 0; i < image.num_sections; i++) {
3002 buffer = malloc(image.sections[i].size);
3003 if (buffer == NULL) {
3004 command_print(CMD_CTX,
3005 "error allocating buffer for section (%d bytes)",
3006 (int)(image.sections[i].size));
3009 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3010 if (retval != ERROR_OK) {
3016 /* calculate checksum of image */
3017 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3018 if (retval != ERROR_OK) {
3023 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3024 if (retval != ERROR_OK) {
3029 if (checksum != mem_checksum) {
3030 /* failed crc checksum, fall back to a binary compare */
3034 LOG_ERROR("checksum mismatch - attempting binary compare");
3036 data = (uint8_t *)malloc(buf_cnt);
3038 /* Can we use 32bit word accesses? */
3040 int count = buf_cnt;
3041 if ((count % 4) == 0) {
3045 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3046 if (retval == ERROR_OK) {
3048 for (t = 0; t < buf_cnt; t++) {
3049 if (data[t] != buffer[t]) {
3050 command_print(CMD_CTX,
3051 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3053 (unsigned)(t + image.sections[i].base_address),
3056 if (diffs++ >= 127) {
3057 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3069 command_print(CMD_CTX, "address 0x%08" PRIx32 " length 0x%08zx",
3070 image.sections[i].base_address,
3075 image_size += buf_cnt;
3078 command_print(CMD_CTX, "No more differences found.");
3081 retval = ERROR_FAIL;
3082 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3083 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3084 "in %fs (%0.3f KiB/s)", image_size,
3085 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3088 image_close(&image);
3093 COMMAND_HANDLER(handle_verify_image_command)
3095 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 1);
3098 COMMAND_HANDLER(handle_test_image_command)
3100 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 0);
3103 static int handle_bp_command_list(struct command_context *cmd_ctx)
3105 struct target *target = get_current_target(cmd_ctx);
3106 struct breakpoint *breakpoint = target->breakpoints;
3107 while (breakpoint) {
3108 if (breakpoint->type == BKPT_SOFT) {
3109 char *buf = buf_to_str(breakpoint->orig_instr,
3110 breakpoint->length, 16);
3111 command_print(cmd_ctx, "IVA breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i, 0x%s",
3112 breakpoint->address,
3114 breakpoint->set, buf);
3117 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3118 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3120 breakpoint->length, breakpoint->set);
3121 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3122 command_print(cmd_ctx, "Hybrid breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3123 breakpoint->address,
3124 breakpoint->length, breakpoint->set);
3125 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3128 command_print(cmd_ctx, "Breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3129 breakpoint->address,
3130 breakpoint->length, breakpoint->set);
3133 breakpoint = breakpoint->next;
3138 static int handle_bp_command_set(struct command_context *cmd_ctx,
3139 uint32_t addr, uint32_t asid, uint32_t length, int hw)
3141 struct target *target = get_current_target(cmd_ctx);
3144 int retval = breakpoint_add(target, addr, length, hw);
3145 if (ERROR_OK == retval)
3146 command_print(cmd_ctx, "breakpoint set at 0x%8.8" PRIx32 "", addr);
3148 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3151 } else if (addr == 0) {
3152 int retval = context_breakpoint_add(target, asid, length, hw);
3153 if (ERROR_OK == retval)
3154 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3156 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3160 int retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3161 if (ERROR_OK == retval)
3162 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3164 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3171 COMMAND_HANDLER(handle_bp_command)
3180 return handle_bp_command_list(CMD_CTX);
3184 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3185 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3186 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3189 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3191 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3193 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3196 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3197 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3199 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3200 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3202 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3207 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3208 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3209 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3210 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3213 return ERROR_COMMAND_SYNTAX_ERROR;
3217 COMMAND_HANDLER(handle_rbp_command)
3220 return ERROR_COMMAND_SYNTAX_ERROR;
3223 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3225 struct target *target = get_current_target(CMD_CTX);
3226 breakpoint_remove(target, addr);
3231 COMMAND_HANDLER(handle_wp_command)
3233 struct target *target = get_current_target(CMD_CTX);
3235 if (CMD_ARGC == 0) {
3236 struct watchpoint *watchpoint = target->watchpoints;
3238 while (watchpoint) {
3239 command_print(CMD_CTX, "address: 0x%8.8" PRIx32
3240 ", len: 0x%8.8" PRIx32
3241 ", r/w/a: %i, value: 0x%8.8" PRIx32
3242 ", mask: 0x%8.8" PRIx32,
3243 watchpoint->address,
3245 (int)watchpoint->rw,
3248 watchpoint = watchpoint->next;
3253 enum watchpoint_rw type = WPT_ACCESS;
3255 uint32_t length = 0;
3256 uint32_t data_value = 0x0;
3257 uint32_t data_mask = 0xffffffff;
3261 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3264 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3267 switch (CMD_ARGV[2][0]) {
3278 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3279 return ERROR_COMMAND_SYNTAX_ERROR;
3283 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3284 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3288 return ERROR_COMMAND_SYNTAX_ERROR;
3291 int retval = watchpoint_add(target, addr, length, type,
3292 data_value, data_mask);
3293 if (ERROR_OK != retval)
3294 LOG_ERROR("Failure setting watchpoints");
3299 COMMAND_HANDLER(handle_rwp_command)
3302 return ERROR_COMMAND_SYNTAX_ERROR;
3305 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3307 struct target *target = get_current_target(CMD_CTX);
3308 watchpoint_remove(target, addr);
3314 * Translate a virtual address to a physical address.
3316 * The low-level target implementation must have logged a detailed error
3317 * which is forwarded to telnet/GDB session.
3319 COMMAND_HANDLER(handle_virt2phys_command)
3322 return ERROR_COMMAND_SYNTAX_ERROR;
3325 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], va);
3328 struct target *target = get_current_target(CMD_CTX);
3329 int retval = target->type->virt2phys(target, va, &pa);
3330 if (retval == ERROR_OK)
3331 command_print(CMD_CTX, "Physical address 0x%08" PRIx32 "", pa);
3336 static void writeData(FILE *f, const void *data, size_t len)
3338 size_t written = fwrite(data, 1, len, f);
3340 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3343 static void writeLong(FILE *f, int l)
3346 for (i = 0; i < 4; i++) {
3347 char c = (l >> (i*8))&0xff;
3348 writeData(f, &c, 1);
3353 static void writeString(FILE *f, char *s)
3355 writeData(f, s, strlen(s));
3358 /* Dump a gmon.out histogram file. */
3359 static void writeGmon(uint32_t *samples, uint32_t sampleNum, const char *filename)
3362 FILE *f = fopen(filename, "w");
3365 writeString(f, "gmon");
3366 writeLong(f, 0x00000001); /* Version */
3367 writeLong(f, 0); /* padding */
3368 writeLong(f, 0); /* padding */
3369 writeLong(f, 0); /* padding */
3371 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3372 writeData(f, &zero, 1);
3374 /* figure out bucket size */
3375 uint32_t min = samples[0];
3376 uint32_t max = samples[0];
3377 for (i = 0; i < sampleNum; i++) {
3378 if (min > samples[i])
3380 if (max < samples[i])
3384 int addressSpace = (max - min + 1);
3385 assert(addressSpace >= 2);
3387 static const uint32_t maxBuckets = 16 * 1024; /* maximum buckets. */
3388 uint32_t length = addressSpace;
3389 if (length > maxBuckets)
3390 length = maxBuckets;
3391 int *buckets = malloc(sizeof(int)*length);
3392 if (buckets == NULL) {
3396 memset(buckets, 0, sizeof(int) * length);
3397 for (i = 0; i < sampleNum; i++) {
3398 uint32_t address = samples[i];
3399 long long a = address - min;
3400 long long b = length - 1;
3401 long long c = addressSpace - 1;
3402 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
3406 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3407 writeLong(f, min); /* low_pc */
3408 writeLong(f, max); /* high_pc */
3409 writeLong(f, length); /* # of samples */
3410 writeLong(f, 100); /* KLUDGE! We lie, ca. 100Hz best case. */
3411 writeString(f, "seconds");
3412 for (i = 0; i < (15-strlen("seconds")); i++)
3413 writeData(f, &zero, 1);
3414 writeString(f, "s");
3416 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3418 char *data = malloc(2 * length);
3420 for (i = 0; i < length; i++) {
3425 data[i * 2] = val&0xff;
3426 data[i * 2 + 1] = (val >> 8) & 0xff;
3429 writeData(f, data, length * 2);
3437 /* profiling samples the CPU PC as quickly as OpenOCD is able,
3438 * which will be used as a random sampling of PC */
3439 COMMAND_HANDLER(handle_profile_command)
3441 struct target *target = get_current_target(CMD_CTX);
3442 struct timeval timeout, now;
3444 gettimeofday(&timeout, NULL);
3446 return ERROR_COMMAND_SYNTAX_ERROR;
3448 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], offset);
3450 timeval_add_time(&timeout, offset, 0);
3453 * @todo: Some cores let us sample the PC without the
3454 * annoying halt/resume step; for example, ARMv7 PCSR.
3455 * Provide a way to use that more efficient mechanism.
3458 command_print(CMD_CTX, "Starting profiling. Halting and resuming the target as often as we can...");
3460 static const int maxSample = 10000;
3461 uint32_t *samples = malloc(sizeof(uint32_t)*maxSample);
3462 if (samples == NULL)
3466 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
3467 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
3469 int retval = ERROR_OK;
3471 target_poll(target);
3472 if (target->state == TARGET_HALTED) {
3473 uint32_t t = *((uint32_t *)reg->value);
3474 samples[numSamples++] = t;
3475 /* current pc, addr = 0, do not handle breakpoints, not debugging */
3476 retval = target_resume(target, 1, 0, 0, 0);
3477 target_poll(target);
3478 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
3479 } else if (target->state == TARGET_RUNNING) {
3480 /* We want to quickly sample the PC. */
3481 retval = target_halt(target);
3482 if (retval != ERROR_OK) {
3487 command_print(CMD_CTX, "Target not halted or running");
3491 if (retval != ERROR_OK)
3494 gettimeofday(&now, NULL);
3495 if ((numSamples >= maxSample) || ((now.tv_sec >= timeout.tv_sec)
3496 && (now.tv_usec >= timeout.tv_usec))) {
3497 command_print(CMD_CTX, "Profiling completed. %d samples.", numSamples);
3498 retval = target_poll(target);
3499 if (retval != ERROR_OK) {
3503 if (target->state == TARGET_HALTED) {
3504 /* current pc, addr = 0, do not handle
3505 * breakpoints, not debugging */
3506 target_resume(target, 1, 0, 0, 0);
3508 retval = target_poll(target);
3509 if (retval != ERROR_OK) {
3513 writeGmon(samples, numSamples, CMD_ARGV[1]);
3514 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
3523 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
3526 Jim_Obj *nameObjPtr, *valObjPtr;
3529 namebuf = alloc_printf("%s(%d)", varname, idx);
3533 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3534 valObjPtr = Jim_NewIntObj(interp, val);
3535 if (!nameObjPtr || !valObjPtr) {
3540 Jim_IncrRefCount(nameObjPtr);
3541 Jim_IncrRefCount(valObjPtr);
3542 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3543 Jim_DecrRefCount(interp, nameObjPtr);
3544 Jim_DecrRefCount(interp, valObjPtr);
3546 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
3550 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3552 struct command_context *context;
3553 struct target *target;
3555 context = current_command_context(interp);
3556 assert(context != NULL);
3558 target = get_current_target(context);
3559 if (target == NULL) {
3560 LOG_ERROR("mem2array: no current target");
3564 return target_mem2array(interp, target, argc - 1, argv + 1);
3567 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
3575 const char *varname;
3579 /* argv[1] = name of array to receive the data
3580 * argv[2] = desired width
3581 * argv[3] = memory address
3582 * argv[4] = count of times to read
3585 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
3588 varname = Jim_GetString(argv[0], &len);
3589 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3591 e = Jim_GetLong(interp, argv[1], &l);
3596 e = Jim_GetLong(interp, argv[2], &l);
3600 e = Jim_GetLong(interp, argv[3], &l);
3615 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3616 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3620 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3621 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
3624 if ((addr + (len * width)) < addr) {
3625 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3626 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
3629 /* absurd transfer size? */
3631 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3632 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
3637 ((width == 2) && ((addr & 1) == 0)) ||
3638 ((width == 4) && ((addr & 3) == 0))) {
3642 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3643 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
3646 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3655 size_t buffersize = 4096;
3656 uint8_t *buffer = malloc(buffersize);
3663 /* Slurp... in buffer size chunks */
3665 count = len; /* in objects.. */
3666 if (count > (buffersize / width))
3667 count = (buffersize / width);
3669 retval = target_read_memory(target, addr, width, count, buffer);
3670 if (retval != ERROR_OK) {
3672 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed",
3676 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3677 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
3681 v = 0; /* shut up gcc */
3682 for (i = 0; i < count ; i++, n++) {
3685 v = target_buffer_get_u32(target, &buffer[i*width]);
3688 v = target_buffer_get_u16(target, &buffer[i*width]);
3691 v = buffer[i] & 0x0ff;
3694 new_int_array_element(interp, varname, n, v);
3702 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3707 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
3710 Jim_Obj *nameObjPtr, *valObjPtr;
3714 namebuf = alloc_printf("%s(%d)", varname, idx);
3718 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3724 Jim_IncrRefCount(nameObjPtr);
3725 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
3726 Jim_DecrRefCount(interp, nameObjPtr);
3728 if (valObjPtr == NULL)
3731 result = Jim_GetLong(interp, valObjPtr, &l);
3732 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
3737 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3739 struct command_context *context;
3740 struct target *target;
3742 context = current_command_context(interp);
3743 assert(context != NULL);
3745 target = get_current_target(context);
3746 if (target == NULL) {
3747 LOG_ERROR("array2mem: no current target");
3751 return target_array2mem(interp, target, argc-1, argv + 1);
3754 static int target_array2mem(Jim_Interp *interp, struct target *target,
3755 int argc, Jim_Obj *const *argv)
3763 const char *varname;
3767 /* argv[1] = name of array to get the data
3768 * argv[2] = desired width
3769 * argv[3] = memory address
3770 * argv[4] = count to write
3773 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems");
3776 varname = Jim_GetString(argv[0], &len);
3777 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3779 e = Jim_GetLong(interp, argv[1], &l);
3784 e = Jim_GetLong(interp, argv[2], &l);
3788 e = Jim_GetLong(interp, argv[3], &l);
3803 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3804 Jim_AppendStrings(interp, Jim_GetResult(interp),
3805 "Invalid width param, must be 8/16/32", NULL);
3809 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3810 Jim_AppendStrings(interp, Jim_GetResult(interp),
3811 "array2mem: zero width read?", NULL);
3814 if ((addr + (len * width)) < addr) {
3815 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3816 Jim_AppendStrings(interp, Jim_GetResult(interp),
3817 "array2mem: addr + len - wraps to zero?", NULL);
3820 /* absurd transfer size? */
3822 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3823 Jim_AppendStrings(interp, Jim_GetResult(interp),
3824 "array2mem: absurd > 64K item request", NULL);
3829 ((width == 2) && ((addr & 1) == 0)) ||
3830 ((width == 4) && ((addr & 3) == 0))) {
3834 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3835 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads",
3838 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3849 size_t buffersize = 4096;
3850 uint8_t *buffer = malloc(buffersize);
3855 /* Slurp... in buffer size chunks */
3857 count = len; /* in objects.. */
3858 if (count > (buffersize / width))
3859 count = (buffersize / width);
3861 v = 0; /* shut up gcc */
3862 for (i = 0; i < count; i++, n++) {
3863 get_int_array_element(interp, varname, n, &v);
3866 target_buffer_set_u32(target, &buffer[i * width], v);
3869 target_buffer_set_u16(target, &buffer[i * width], v);
3872 buffer[i] = v & 0x0ff;
3878 retval = target_write_memory(target, addr, width, count, buffer);
3879 if (retval != ERROR_OK) {
3881 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed",
3885 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3886 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
3894 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3899 /* FIX? should we propagate errors here rather than printing them
3902 void target_handle_event(struct target *target, enum target_event e)
3904 struct target_event_action *teap;
3906 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3907 if (teap->event == e) {
3908 LOG_DEBUG("target: (%d) %s (%s) event: %d (%s) action: %s",
3909 target->target_number,
3910 target_name(target),
3911 target_type_name(target),
3913 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
3914 Jim_GetString(teap->body, NULL));
3915 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
3916 Jim_MakeErrorMessage(teap->interp);
3917 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
3924 * Returns true only if the target has a handler for the specified event.
3926 bool target_has_event_action(struct target *target, enum target_event event)
3928 struct target_event_action *teap;
3930 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3931 if (teap->event == event)
3937 enum target_cfg_param {
3940 TCFG_WORK_AREA_VIRT,
3941 TCFG_WORK_AREA_PHYS,
3942 TCFG_WORK_AREA_SIZE,
3943 TCFG_WORK_AREA_BACKUP,
3947 TCFG_CHAIN_POSITION,
3952 static Jim_Nvp nvp_config_opts[] = {
3953 { .name = "-type", .value = TCFG_TYPE },
3954 { .name = "-event", .value = TCFG_EVENT },
3955 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
3956 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
3957 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
3958 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
3959 { .name = "-endian" , .value = TCFG_ENDIAN },
3960 { .name = "-variant", .value = TCFG_VARIANT },
3961 { .name = "-coreid", .value = TCFG_COREID },
3962 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
3963 { .name = "-dbgbase", .value = TCFG_DBGBASE },
3964 { .name = "-rtos", .value = TCFG_RTOS },
3965 { .name = NULL, .value = -1 }
3968 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
3976 /* parse config or cget options ... */
3977 while (goi->argc > 0) {
3978 Jim_SetEmptyResult(goi->interp);
3979 /* Jim_GetOpt_Debug(goi); */
3981 if (target->type->target_jim_configure) {
3982 /* target defines a configure function */
3983 /* target gets first dibs on parameters */
3984 e = (*(target->type->target_jim_configure))(target, goi);
3993 /* otherwise we 'continue' below */
3995 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
3997 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
4003 if (goi->isconfigure) {
4004 Jim_SetResultFormatted(goi->interp,
4005 "not settable: %s", n->name);
4009 if (goi->argc != 0) {
4010 Jim_WrongNumArgs(goi->interp,
4011 goi->argc, goi->argv,
4016 Jim_SetResultString(goi->interp,
4017 target_type_name(target), -1);
4021 if (goi->argc == 0) {
4022 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4026 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4028 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4032 if (goi->isconfigure) {
4033 if (goi->argc != 1) {
4034 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4038 if (goi->argc != 0) {
4039 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4045 struct target_event_action *teap;
4047 teap = target->event_action;
4048 /* replace existing? */
4050 if (teap->event == (enum target_event)n->value)
4055 if (goi->isconfigure) {
4056 bool replace = true;
4059 teap = calloc(1, sizeof(*teap));
4062 teap->event = n->value;
4063 teap->interp = goi->interp;
4064 Jim_GetOpt_Obj(goi, &o);
4066 Jim_DecrRefCount(teap->interp, teap->body);
4067 teap->body = Jim_DuplicateObj(goi->interp, o);
4070 * Tcl/TK - "tk events" have a nice feature.
4071 * See the "BIND" command.
4072 * We should support that here.
4073 * You can specify %X and %Y in the event code.
4074 * The idea is: %T - target name.
4075 * The idea is: %N - target number
4076 * The idea is: %E - event name.
4078 Jim_IncrRefCount(teap->body);
4081 /* add to head of event list */
4082 teap->next = target->event_action;
4083 target->event_action = teap;
4085 Jim_SetEmptyResult(goi->interp);
4089 Jim_SetEmptyResult(goi->interp);
4091 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4097 case TCFG_WORK_AREA_VIRT:
4098 if (goi->isconfigure) {
4099 target_free_all_working_areas(target);
4100 e = Jim_GetOpt_Wide(goi, &w);
4103 target->working_area_virt = w;
4104 target->working_area_virt_spec = true;
4109 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4113 case TCFG_WORK_AREA_PHYS:
4114 if (goi->isconfigure) {
4115 target_free_all_working_areas(target);
4116 e = Jim_GetOpt_Wide(goi, &w);
4119 target->working_area_phys = w;
4120 target->working_area_phys_spec = true;
4125 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4129 case TCFG_WORK_AREA_SIZE:
4130 if (goi->isconfigure) {
4131 target_free_all_working_areas(target);
4132 e = Jim_GetOpt_Wide(goi, &w);
4135 target->working_area_size = w;
4140 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4144 case TCFG_WORK_AREA_BACKUP:
4145 if (goi->isconfigure) {
4146 target_free_all_working_areas(target);
4147 e = Jim_GetOpt_Wide(goi, &w);
4150 /* make this exactly 1 or 0 */
4151 target->backup_working_area = (!!w);
4156 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4157 /* loop for more e*/
4162 if (goi->isconfigure) {
4163 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4165 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4168 target->endianness = n->value;
4173 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4174 if (n->name == NULL) {
4175 target->endianness = TARGET_LITTLE_ENDIAN;
4176 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4178 Jim_SetResultString(goi->interp, n->name, -1);
4183 if (goi->isconfigure) {
4184 if (goi->argc < 1) {
4185 Jim_SetResultFormatted(goi->interp,
4190 if (target->variant)
4191 free((void *)(target->variant));
4192 e = Jim_GetOpt_String(goi, &cp, NULL);
4195 target->variant = strdup(cp);
4200 Jim_SetResultString(goi->interp, target->variant, -1);
4205 if (goi->isconfigure) {
4206 e = Jim_GetOpt_Wide(goi, &w);
4209 target->coreid = (int32_t)w;
4214 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4218 case TCFG_CHAIN_POSITION:
4219 if (goi->isconfigure) {
4221 struct jtag_tap *tap;
4222 target_free_all_working_areas(target);
4223 e = Jim_GetOpt_Obj(goi, &o_t);
4226 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4229 /* make this exactly 1 or 0 */
4235 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4236 /* loop for more e*/
4239 if (goi->isconfigure) {
4240 e = Jim_GetOpt_Wide(goi, &w);
4243 target->dbgbase = (uint32_t)w;
4244 target->dbgbase_set = true;
4249 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4256 int result = rtos_create(goi, target);
4257 if (result != JIM_OK)
4263 } /* while (goi->argc) */
4266 /* done - we return */
4270 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4274 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4275 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4276 int need_args = 1 + goi.isconfigure;
4277 if (goi.argc < need_args) {
4278 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4280 ? "missing: -option VALUE ..."
4281 : "missing: -option ...");
4284 struct target *target = Jim_CmdPrivData(goi.interp);
4285 return target_configure(&goi, target);
4288 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4290 const char *cmd_name = Jim_GetString(argv[0], NULL);
4293 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4295 if (goi.argc < 2 || goi.argc > 4) {
4296 Jim_SetResultFormatted(goi.interp,
4297 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4302 fn = target_write_memory_fast;
4305 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4307 struct Jim_Obj *obj;
4308 e = Jim_GetOpt_Obj(&goi, &obj);
4312 fn = target_write_phys_memory;
4316 e = Jim_GetOpt_Wide(&goi, &a);
4321 e = Jim_GetOpt_Wide(&goi, &b);
4326 if (goi.argc == 1) {
4327 e = Jim_GetOpt_Wide(&goi, &c);
4332 /* all args must be consumed */
4336 struct target *target = Jim_CmdPrivData(goi.interp);
4338 if (strcasecmp(cmd_name, "mww") == 0)
4340 else if (strcasecmp(cmd_name, "mwh") == 0)
4342 else if (strcasecmp(cmd_name, "mwb") == 0)
4345 LOG_ERROR("command '%s' unknown: ", cmd_name);
4349 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4353 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4355 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4356 * mdh [phys] <address> [<count>] - for 16 bit reads
4357 * mdb [phys] <address> [<count>] - for 8 bit reads
4359 * Count defaults to 1.
4361 * Calls target_read_memory or target_read_phys_memory depending on
4362 * the presence of the "phys" argument
4363 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4364 * to int representation in base16.
4365 * Also outputs read data in a human readable form using command_print
4367 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4368 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4369 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4370 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4371 * on success, with [<count>] number of elements.
4373 * In case of little endian target:
4374 * Example1: "mdw 0x00000000" returns "10123456"
4375 * Exmaple2: "mdh 0x00000000 1" returns "3456"
4376 * Example3: "mdb 0x00000000" returns "56"
4377 * Example4: "mdh 0x00000000 2" returns "3456 1012"
4378 * Example5: "mdb 0x00000000 3" returns "56 34 12"
4380 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4382 const char *cmd_name = Jim_GetString(argv[0], NULL);
4385 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4387 if ((goi.argc < 1) || (goi.argc > 3)) {
4388 Jim_SetResultFormatted(goi.interp,
4389 "usage: %s [phys] <address> [<count>]", cmd_name);
4393 int (*fn)(struct target *target,
4394 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
4395 fn = target_read_memory;
4398 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4400 struct Jim_Obj *obj;
4401 e = Jim_GetOpt_Obj(&goi, &obj);
4405 fn = target_read_phys_memory;
4408 /* Read address parameter */
4410 e = Jim_GetOpt_Wide(&goi, &addr);
4414 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
4416 if (goi.argc == 1) {
4417 e = Jim_GetOpt_Wide(&goi, &count);
4423 /* all args must be consumed */
4427 jim_wide dwidth = 1; /* shut up gcc */
4428 if (strcasecmp(cmd_name, "mdw") == 0)
4430 else if (strcasecmp(cmd_name, "mdh") == 0)
4432 else if (strcasecmp(cmd_name, "mdb") == 0)
4435 LOG_ERROR("command '%s' unknown: ", cmd_name);
4439 /* convert count to "bytes" */
4440 int bytes = count * dwidth;
4442 struct target *target = Jim_CmdPrivData(goi.interp);
4443 uint8_t target_buf[32];
4446 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
4448 /* Try to read out next block */
4449 e = fn(target, addr, dwidth, y / dwidth, target_buf);
4451 if (e != ERROR_OK) {
4452 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
4456 command_print_sameline(NULL, "0x%08x ", (int)(addr));
4459 for (x = 0; x < 16 && x < y; x += 4) {
4460 z = target_buffer_get_u32(target, &(target_buf[x]));
4461 command_print_sameline(NULL, "%08x ", (int)(z));
4463 for (; (x < 16) ; x += 4)
4464 command_print_sameline(NULL, " ");
4467 for (x = 0; x < 16 && x < y; x += 2) {
4468 z = target_buffer_get_u16(target, &(target_buf[x]));
4469 command_print_sameline(NULL, "%04x ", (int)(z));
4471 for (; (x < 16) ; x += 2)
4472 command_print_sameline(NULL, " ");
4476 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
4477 z = target_buffer_get_u8(target, &(target_buf[x]));
4478 command_print_sameline(NULL, "%02x ", (int)(z));
4480 for (; (x < 16) ; x += 1)
4481 command_print_sameline(NULL, " ");
4484 /* ascii-ify the bytes */
4485 for (x = 0 ; x < y ; x++) {
4486 if ((target_buf[x] >= 0x20) &&
4487 (target_buf[x] <= 0x7e)) {
4491 target_buf[x] = '.';
4496 target_buf[x] = ' ';
4501 /* print - with a newline */
4502 command_print_sameline(NULL, "%s\n", target_buf);
4510 static int jim_target_mem2array(Jim_Interp *interp,
4511 int argc, Jim_Obj *const *argv)
4513 struct target *target = Jim_CmdPrivData(interp);
4514 return target_mem2array(interp, target, argc - 1, argv + 1);
4517 static int jim_target_array2mem(Jim_Interp *interp,
4518 int argc, Jim_Obj *const *argv)
4520 struct target *target = Jim_CmdPrivData(interp);
4521 return target_array2mem(interp, target, argc - 1, argv + 1);
4524 static int jim_target_tap_disabled(Jim_Interp *interp)
4526 Jim_SetResultFormatted(interp, "[TAP is disabled]");
4530 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4533 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4536 struct target *target = Jim_CmdPrivData(interp);
4537 if (!target->tap->enabled)
4538 return jim_target_tap_disabled(interp);
4540 int e = target->type->examine(target);
4546 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4549 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4552 struct target *target = Jim_CmdPrivData(interp);
4554 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
4560 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4563 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4566 struct target *target = Jim_CmdPrivData(interp);
4567 if (!target->tap->enabled)
4568 return jim_target_tap_disabled(interp);
4571 if (!(target_was_examined(target)))
4572 e = ERROR_TARGET_NOT_EXAMINED;
4574 e = target->type->poll(target);
4580 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4583 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4585 if (goi.argc != 2) {
4586 Jim_WrongNumArgs(interp, 0, argv,
4587 "([tT]|[fF]|assert|deassert) BOOL");
4592 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
4594 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
4597 /* the halt or not param */
4599 e = Jim_GetOpt_Wide(&goi, &a);
4603 struct target *target = Jim_CmdPrivData(goi.interp);
4604 if (!target->tap->enabled)
4605 return jim_target_tap_disabled(interp);
4606 if (!(target_was_examined(target))) {
4607 LOG_ERROR("Target not examined yet");
4608 return ERROR_TARGET_NOT_EXAMINED;
4610 if (!target->type->assert_reset || !target->type->deassert_reset) {
4611 Jim_SetResultFormatted(interp,
4612 "No target-specific reset for %s",
4613 target_name(target));
4616 /* determine if we should halt or not. */
4617 target->reset_halt = !!a;
4618 /* When this happens - all workareas are invalid. */
4619 target_free_all_working_areas_restore(target, 0);
4622 if (n->value == NVP_ASSERT)
4623 e = target->type->assert_reset(target);
4625 e = target->type->deassert_reset(target);
4626 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4629 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4632 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4635 struct target *target = Jim_CmdPrivData(interp);
4636 if (!target->tap->enabled)
4637 return jim_target_tap_disabled(interp);
4638 int e = target->type->halt(target);
4639 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4642 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4645 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4647 /* params: <name> statename timeoutmsecs */
4648 if (goi.argc != 2) {
4649 const char *cmd_name = Jim_GetString(argv[0], NULL);
4650 Jim_SetResultFormatted(goi.interp,
4651 "%s <state_name> <timeout_in_msec>", cmd_name);
4656 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
4658 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
4662 e = Jim_GetOpt_Wide(&goi, &a);
4665 struct target *target = Jim_CmdPrivData(interp);
4666 if (!target->tap->enabled)
4667 return jim_target_tap_disabled(interp);
4669 e = target_wait_state(target, n->value, a);
4670 if (e != ERROR_OK) {
4671 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
4672 Jim_SetResultFormatted(goi.interp,
4673 "target: %s wait %s fails (%#s) %s",
4674 target_name(target), n->name,
4675 eObj, target_strerror_safe(e));
4676 Jim_FreeNewObj(interp, eObj);
4681 /* List for human, Events defined for this target.
4682 * scripts/programs should use 'name cget -event NAME'
4684 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4686 struct command_context *cmd_ctx = current_command_context(interp);
4687 assert(cmd_ctx != NULL);
4689 struct target *target = Jim_CmdPrivData(interp);
4690 struct target_event_action *teap = target->event_action;
4691 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
4692 target->target_number,
4693 target_name(target));
4694 command_print(cmd_ctx, "%-25s | Body", "Event");
4695 command_print(cmd_ctx, "------------------------- | "
4696 "----------------------------------------");
4698 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
4699 command_print(cmd_ctx, "%-25s | %s",
4700 opt->name, Jim_GetString(teap->body, NULL));
4703 command_print(cmd_ctx, "***END***");
4706 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4709 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4712 struct target *target = Jim_CmdPrivData(interp);
4713 Jim_SetResultString(interp, target_state_name(target), -1);
4716 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4719 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4720 if (goi.argc != 1) {
4721 const char *cmd_name = Jim_GetString(argv[0], NULL);
4722 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
4726 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
4728 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
4731 struct target *target = Jim_CmdPrivData(interp);
4732 target_handle_event(target, n->value);
4736 static const struct command_registration target_instance_command_handlers[] = {
4738 .name = "configure",
4739 .mode = COMMAND_CONFIG,
4740 .jim_handler = jim_target_configure,
4741 .help = "configure a new target for use",
4742 .usage = "[target_attribute ...]",
4746 .mode = COMMAND_ANY,
4747 .jim_handler = jim_target_configure,
4748 .help = "returns the specified target attribute",
4749 .usage = "target_attribute",
4753 .mode = COMMAND_EXEC,
4754 .jim_handler = jim_target_mw,
4755 .help = "Write 32-bit word(s) to target memory",
4756 .usage = "address data [count]",
4760 .mode = COMMAND_EXEC,
4761 .jim_handler = jim_target_mw,
4762 .help = "Write 16-bit half-word(s) to target memory",
4763 .usage = "address data [count]",
4767 .mode = COMMAND_EXEC,
4768 .jim_handler = jim_target_mw,
4769 .help = "Write byte(s) to target memory",
4770 .usage = "address data [count]",
4774 .mode = COMMAND_EXEC,
4775 .jim_handler = jim_target_md,
4776 .help = "Display target memory as 32-bit words",
4777 .usage = "address [count]",
4781 .mode = COMMAND_EXEC,
4782 .jim_handler = jim_target_md,
4783 .help = "Display target memory as 16-bit half-words",
4784 .usage = "address [count]",
4788 .mode = COMMAND_EXEC,
4789 .jim_handler = jim_target_md,
4790 .help = "Display target memory as 8-bit bytes",
4791 .usage = "address [count]",
4794 .name = "array2mem",
4795 .mode = COMMAND_EXEC,
4796 .jim_handler = jim_target_array2mem,
4797 .help = "Writes Tcl array of 8/16/32 bit numbers "
4799 .usage = "arrayname bitwidth address count",
4802 .name = "mem2array",
4803 .mode = COMMAND_EXEC,
4804 .jim_handler = jim_target_mem2array,
4805 .help = "Loads Tcl array of 8/16/32 bit numbers "
4806 "from target memory",
4807 .usage = "arrayname bitwidth address count",
4810 .name = "eventlist",
4811 .mode = COMMAND_EXEC,
4812 .jim_handler = jim_target_event_list,
4813 .help = "displays a table of events defined for this target",
4817 .mode = COMMAND_EXEC,
4818 .jim_handler = jim_target_current_state,
4819 .help = "displays the current state of this target",
4822 .name = "arp_examine",
4823 .mode = COMMAND_EXEC,
4824 .jim_handler = jim_target_examine,
4825 .help = "used internally for reset processing",
4828 .name = "arp_halt_gdb",
4829 .mode = COMMAND_EXEC,
4830 .jim_handler = jim_target_halt_gdb,
4831 .help = "used internally for reset processing to halt GDB",
4835 .mode = COMMAND_EXEC,
4836 .jim_handler = jim_target_poll,
4837 .help = "used internally for reset processing",
4840 .name = "arp_reset",
4841 .mode = COMMAND_EXEC,
4842 .jim_handler = jim_target_reset,
4843 .help = "used internally for reset processing",
4847 .mode = COMMAND_EXEC,
4848 .jim_handler = jim_target_halt,
4849 .help = "used internally for reset processing",
4852 .name = "arp_waitstate",
4853 .mode = COMMAND_EXEC,
4854 .jim_handler = jim_target_wait_state,
4855 .help = "used internally for reset processing",
4858 .name = "invoke-event",
4859 .mode = COMMAND_EXEC,
4860 .jim_handler = jim_target_invoke_event,
4861 .help = "invoke handler for specified event",
4862 .usage = "event_name",
4864 COMMAND_REGISTRATION_DONE
4867 static int target_create(Jim_GetOptInfo *goi)
4875 struct target *target;
4876 struct command_context *cmd_ctx;
4878 cmd_ctx = current_command_context(goi->interp);
4879 assert(cmd_ctx != NULL);
4881 if (goi->argc < 3) {
4882 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
4887 Jim_GetOpt_Obj(goi, &new_cmd);
4888 /* does this command exist? */
4889 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
4891 cp = Jim_GetString(new_cmd, NULL);
4892 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
4897 e = Jim_GetOpt_String(goi, &cp2, NULL);
4901 /* now does target type exist */
4902 for (x = 0 ; target_types[x] ; x++) {
4903 if (0 == strcmp(cp, target_types[x]->name)) {
4908 /* check for deprecated name */
4909 if (target_types[x]->deprecated_name) {
4910 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
4912 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
4917 if (target_types[x] == NULL) {
4918 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
4919 for (x = 0 ; target_types[x] ; x++) {
4920 if (target_types[x + 1]) {
4921 Jim_AppendStrings(goi->interp,
4922 Jim_GetResult(goi->interp),
4923 target_types[x]->name,
4926 Jim_AppendStrings(goi->interp,
4927 Jim_GetResult(goi->interp),
4929 target_types[x]->name, NULL);
4936 target = calloc(1, sizeof(struct target));
4937 /* set target number */
4938 target->target_number = new_target_number();
4940 /* allocate memory for each unique target type */
4941 target->type = (struct target_type *)calloc(1, sizeof(struct target_type));
4943 memcpy(target->type, target_types[x], sizeof(struct target_type));
4945 /* will be set by "-endian" */
4946 target->endianness = TARGET_ENDIAN_UNKNOWN;
4948 /* default to first core, override with -coreid */
4951 target->working_area = 0x0;
4952 target->working_area_size = 0x0;
4953 target->working_areas = NULL;
4954 target->backup_working_area = 0;
4956 target->state = TARGET_UNKNOWN;
4957 target->debug_reason = DBG_REASON_UNDEFINED;
4958 target->reg_cache = NULL;
4959 target->breakpoints = NULL;
4960 target->watchpoints = NULL;
4961 target->next = NULL;
4962 target->arch_info = NULL;
4964 target->display = 1;
4966 target->halt_issued = false;
4968 /* initialize trace information */
4969 target->trace_info = malloc(sizeof(struct trace));
4970 target->trace_info->num_trace_points = 0;
4971 target->trace_info->trace_points_size = 0;
4972 target->trace_info->trace_points = NULL;
4973 target->trace_info->trace_history_size = 0;
4974 target->trace_info->trace_history = NULL;
4975 target->trace_info->trace_history_pos = 0;
4976 target->trace_info->trace_history_overflowed = 0;
4978 target->dbgmsg = NULL;
4979 target->dbg_msg_enabled = 0;
4981 target->endianness = TARGET_ENDIAN_UNKNOWN;
4983 target->rtos = NULL;
4984 target->rtos_auto_detect = false;
4986 /* Do the rest as "configure" options */
4987 goi->isconfigure = 1;
4988 e = target_configure(goi, target);
4990 if (target->tap == NULL) {
4991 Jim_SetResultString(goi->interp, "-chain-position required when creating target", -1);
5001 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
5002 /* default endian to little if not specified */
5003 target->endianness = TARGET_LITTLE_ENDIAN;
5006 /* incase variant is not set */
5007 if (!target->variant)
5008 target->variant = strdup("");
5010 cp = Jim_GetString(new_cmd, NULL);
5011 target->cmd_name = strdup(cp);
5013 /* create the target specific commands */
5014 if (target->type->commands) {
5015 e = register_commands(cmd_ctx, NULL, target->type->commands);
5017 LOG_ERROR("unable to register '%s' commands", cp);
5019 if (target->type->target_create)
5020 (*(target->type->target_create))(target, goi->interp);
5022 /* append to end of list */
5024 struct target **tpp;
5025 tpp = &(all_targets);
5027 tpp = &((*tpp)->next);
5031 /* now - create the new target name command */
5032 const const struct command_registration target_subcommands[] = {
5034 .chain = target_instance_command_handlers,
5037 .chain = target->type->commands,
5039 COMMAND_REGISTRATION_DONE
5041 const const struct command_registration target_commands[] = {
5044 .mode = COMMAND_ANY,
5045 .help = "target command group",
5047 .chain = target_subcommands,
5049 COMMAND_REGISTRATION_DONE
5051 e = register_commands(cmd_ctx, NULL, target_commands);
5055 struct command *c = command_find_in_context(cmd_ctx, cp);
5057 command_set_handler_data(c, target);
5059 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5062 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5065 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5068 struct command_context *cmd_ctx = current_command_context(interp);
5069 assert(cmd_ctx != NULL);
5071 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5075 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5078 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5081 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5082 for (unsigned x = 0; NULL != target_types[x]; x++) {
5083 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5084 Jim_NewStringObj(interp, target_types[x]->name, -1));
5089 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5092 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5095 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5096 struct target *target = all_targets;
5098 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5099 Jim_NewStringObj(interp, target_name(target), -1));
5100 target = target->next;
5105 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5108 const char *targetname;
5110 struct target *target = (struct target *) NULL;
5111 struct target_list *head, *curr, *new;
5112 curr = (struct target_list *) NULL;
5113 head = (struct target_list *) NULL;
5116 LOG_DEBUG("%d", argc);
5117 /* argv[1] = target to associate in smp
5118 * argv[2] = target to assoicate in smp
5122 for (i = 1; i < argc; i++) {
5124 targetname = Jim_GetString(argv[i], &len);
5125 target = get_target(targetname);
5126 LOG_DEBUG("%s ", targetname);
5128 new = malloc(sizeof(struct target_list));
5129 new->target = target;
5130 new->next = (struct target_list *)NULL;
5131 if (head == (struct target_list *)NULL) {
5140 /* now parse the list of cpu and put the target in smp mode*/
5143 while (curr != (struct target_list *)NULL) {
5144 target = curr->target;
5146 target->head = head;
5150 if (target && target->rtos)
5151 retval = rtos_smp_init(head->target);
5157 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5160 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5162 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5163 "<name> <target_type> [<target_options> ...]");
5166 return target_create(&goi);
5169 static int jim_target_number(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5172 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5174 /* It's OK to remove this mechanism sometime after August 2010 or so */
5175 LOG_WARNING("don't use numbers as target identifiers; use names");
5176 if (goi.argc != 1) {
5177 Jim_SetResultFormatted(goi.interp, "usage: target number <number>");
5181 int e = Jim_GetOpt_Wide(&goi, &w);
5185 struct target *target;
5186 for (target = all_targets; NULL != target; target = target->next) {
5187 if (target->target_number != w)
5190 Jim_SetResultString(goi.interp, target_name(target), -1);
5194 Jim_Obj *wObj = Jim_NewIntObj(goi.interp, w);
5195 Jim_SetResultFormatted(goi.interp,
5196 "Target: number %#s does not exist", wObj);
5197 Jim_FreeNewObj(interp, wObj);
5202 static int jim_target_count(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5205 Jim_WrongNumArgs(interp, 1, argv, "<no parameters>");
5209 struct target *target = all_targets;
5210 while (NULL != target) {
5211 target = target->next;
5214 Jim_SetResult(interp, Jim_NewIntObj(interp, count));
5218 static const struct command_registration target_subcommand_handlers[] = {
5221 .mode = COMMAND_CONFIG,
5222 .handler = handle_target_init_command,
5223 .help = "initialize targets",
5227 /* REVISIT this should be COMMAND_CONFIG ... */
5228 .mode = COMMAND_ANY,
5229 .jim_handler = jim_target_create,
5230 .usage = "name type '-chain-position' name [options ...]",
5231 .help = "Creates and selects a new target",
5235 .mode = COMMAND_ANY,
5236 .jim_handler = jim_target_current,
5237 .help = "Returns the currently selected target",
5241 .mode = COMMAND_ANY,
5242 .jim_handler = jim_target_types,
5243 .help = "Returns the available target types as "
5244 "a list of strings",
5248 .mode = COMMAND_ANY,
5249 .jim_handler = jim_target_names,
5250 .help = "Returns the names of all targets as a list of strings",
5254 .mode = COMMAND_ANY,
5255 .jim_handler = jim_target_number,
5257 .help = "Returns the name of the numbered target "
5262 .mode = COMMAND_ANY,
5263 .jim_handler = jim_target_count,
5264 .help = "Returns the number of targets as an integer "
5269 .mode = COMMAND_ANY,
5270 .jim_handler = jim_target_smp,
5271 .usage = "targetname1 targetname2 ...",
5272 .help = "gather several target in a smp list"
5275 COMMAND_REGISTRATION_DONE
5285 static int fastload_num;
5286 static struct FastLoad *fastload;
5288 static void free_fastload(void)
5290 if (fastload != NULL) {
5292 for (i = 0; i < fastload_num; i++) {
5293 if (fastload[i].data)
5294 free(fastload[i].data);
5301 COMMAND_HANDLER(handle_fast_load_image_command)
5305 uint32_t image_size;
5306 uint32_t min_address = 0;
5307 uint32_t max_address = 0xffffffff;
5312 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5313 &image, &min_address, &max_address);
5314 if (ERROR_OK != retval)
5317 struct duration bench;
5318 duration_start(&bench);
5320 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5321 if (retval != ERROR_OK)
5326 fastload_num = image.num_sections;
5327 fastload = (struct FastLoad *)malloc(sizeof(struct FastLoad)*image.num_sections);
5328 if (fastload == NULL) {
5329 command_print(CMD_CTX, "out of memory");
5330 image_close(&image);
5333 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5334 for (i = 0; i < image.num_sections; i++) {
5335 buffer = malloc(image.sections[i].size);
5336 if (buffer == NULL) {
5337 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5338 (int)(image.sections[i].size));
5339 retval = ERROR_FAIL;
5343 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5344 if (retval != ERROR_OK) {
5349 uint32_t offset = 0;
5350 uint32_t length = buf_cnt;
5352 /* DANGER!!! beware of unsigned comparision here!!! */
5354 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5355 (image.sections[i].base_address < max_address)) {
5356 if (image.sections[i].base_address < min_address) {
5357 /* clip addresses below */
5358 offset += min_address-image.sections[i].base_address;
5362 if (image.sections[i].base_address + buf_cnt > max_address)
5363 length -= (image.sections[i].base_address + buf_cnt)-max_address;
5365 fastload[i].address = image.sections[i].base_address + offset;
5366 fastload[i].data = malloc(length);
5367 if (fastload[i].data == NULL) {
5369 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5371 retval = ERROR_FAIL;
5374 memcpy(fastload[i].data, buffer + offset, length);
5375 fastload[i].length = length;
5377 image_size += length;
5378 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
5379 (unsigned int)length,
5380 ((unsigned int)(image.sections[i].base_address + offset)));
5386 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
5387 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
5388 "in %fs (%0.3f KiB/s)", image_size,
5389 duration_elapsed(&bench), duration_kbps(&bench, image_size));
5391 command_print(CMD_CTX,
5392 "WARNING: image has not been loaded to target!"
5393 "You can issue a 'fast_load' to finish loading.");
5396 image_close(&image);
5398 if (retval != ERROR_OK)
5404 COMMAND_HANDLER(handle_fast_load_command)
5407 return ERROR_COMMAND_SYNTAX_ERROR;
5408 if (fastload == NULL) {
5409 LOG_ERROR("No image in memory");
5413 int ms = timeval_ms();
5415 int retval = ERROR_OK;
5416 for (i = 0; i < fastload_num; i++) {
5417 struct target *target = get_current_target(CMD_CTX);
5418 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
5419 (unsigned int)(fastload[i].address),
5420 (unsigned int)(fastload[i].length));
5421 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
5422 if (retval != ERROR_OK)
5424 size += fastload[i].length;
5426 if (retval == ERROR_OK) {
5427 int after = timeval_ms();
5428 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
5433 static const struct command_registration target_command_handlers[] = {
5436 .handler = handle_targets_command,
5437 .mode = COMMAND_ANY,
5438 .help = "change current default target (one parameter) "
5439 "or prints table of all targets (no parameters)",
5440 .usage = "[target]",
5444 .mode = COMMAND_CONFIG,
5445 .help = "configure target",
5447 .chain = target_subcommand_handlers,
5449 COMMAND_REGISTRATION_DONE
5452 int target_register_commands(struct command_context *cmd_ctx)
5454 return register_commands(cmd_ctx, NULL, target_command_handlers);
5457 static bool target_reset_nag = true;
5459 bool get_target_reset_nag(void)
5461 return target_reset_nag;
5464 COMMAND_HANDLER(handle_target_reset_nag)
5466 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
5467 &target_reset_nag, "Nag after each reset about options to improve "
5471 COMMAND_HANDLER(handle_ps_command)
5473 struct target *target = get_current_target(CMD_CTX);
5475 if (target->state != TARGET_HALTED) {
5476 LOG_INFO("target not halted !!");
5480 if ((target->rtos) && (target->rtos->type)
5481 && (target->rtos->type->ps_command)) {
5482 display = target->rtos->type->ps_command(target);
5483 command_print(CMD_CTX, "%s", display);
5488 return ERROR_TARGET_FAILURE;
5492 static const struct command_registration target_exec_command_handlers[] = {
5494 .name = "fast_load_image",
5495 .handler = handle_fast_load_image_command,
5496 .mode = COMMAND_ANY,
5497 .help = "Load image into server memory for later use by "
5498 "fast_load; primarily for profiling",
5499 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5500 "[min_address [max_length]]",
5503 .name = "fast_load",
5504 .handler = handle_fast_load_command,
5505 .mode = COMMAND_EXEC,
5506 .help = "loads active fast load image to current target "
5507 "- mainly for profiling purposes",
5512 .handler = handle_profile_command,
5513 .mode = COMMAND_EXEC,
5514 .usage = "seconds filename",
5515 .help = "profiling samples the CPU PC",
5517 /** @todo don't register virt2phys() unless target supports it */
5519 .name = "virt2phys",
5520 .handler = handle_virt2phys_command,
5521 .mode = COMMAND_ANY,
5522 .help = "translate a virtual address into a physical address",
5523 .usage = "virtual_address",
5527 .handler = handle_reg_command,
5528 .mode = COMMAND_EXEC,
5529 .help = "display or set a register; with no arguments, "
5530 "displays all registers and their values",
5531 .usage = "[(register_name|register_number) [value]]",
5535 .handler = handle_poll_command,
5536 .mode = COMMAND_EXEC,
5537 .help = "poll target state; or reconfigure background polling",
5538 .usage = "['on'|'off']",
5541 .name = "wait_halt",
5542 .handler = handle_wait_halt_command,
5543 .mode = COMMAND_EXEC,
5544 .help = "wait up to the specified number of milliseconds "
5545 "(default 5) for a previously requested halt",
5546 .usage = "[milliseconds]",
5550 .handler = handle_halt_command,
5551 .mode = COMMAND_EXEC,
5552 .help = "request target to halt, then wait up to the specified"
5553 "number of milliseconds (default 5) for it to complete",
5554 .usage = "[milliseconds]",
5558 .handler = handle_resume_command,
5559 .mode = COMMAND_EXEC,
5560 .help = "resume target execution from current PC or address",
5561 .usage = "[address]",
5565 .handler = handle_reset_command,
5566 .mode = COMMAND_EXEC,
5567 .usage = "[run|halt|init]",
5568 .help = "Reset all targets into the specified mode."
5569 "Default reset mode is run, if not given.",
5572 .name = "soft_reset_halt",
5573 .handler = handle_soft_reset_halt_command,
5574 .mode = COMMAND_EXEC,
5576 .help = "halt the target and do a soft reset",
5580 .handler = handle_step_command,
5581 .mode = COMMAND_EXEC,
5582 .help = "step one instruction from current PC or address",
5583 .usage = "[address]",
5587 .handler = handle_md_command,
5588 .mode = COMMAND_EXEC,
5589 .help = "display memory words",
5590 .usage = "['phys'] address [count]",
5594 .handler = handle_md_command,
5595 .mode = COMMAND_EXEC,
5596 .help = "display memory half-words",
5597 .usage = "['phys'] address [count]",
5601 .handler = handle_md_command,
5602 .mode = COMMAND_EXEC,
5603 .help = "display memory bytes",
5604 .usage = "['phys'] address [count]",
5608 .handler = handle_mw_command,
5609 .mode = COMMAND_EXEC,
5610 .help = "write memory word",
5611 .usage = "['phys'] address value [count]",
5615 .handler = handle_mw_command,
5616 .mode = COMMAND_EXEC,
5617 .help = "write memory half-word",
5618 .usage = "['phys'] address value [count]",
5622 .handler = handle_mw_command,
5623 .mode = COMMAND_EXEC,
5624 .help = "write memory byte",
5625 .usage = "['phys'] address value [count]",
5629 .handler = handle_bp_command,
5630 .mode = COMMAND_EXEC,
5631 .help = "list or set hardware or software breakpoint",
5632 .usage = "<address> [<asid>]<length> ['hw'|'hw_ctx']",
5636 .handler = handle_rbp_command,
5637 .mode = COMMAND_EXEC,
5638 .help = "remove breakpoint",
5643 .handler = handle_wp_command,
5644 .mode = COMMAND_EXEC,
5645 .help = "list (no params) or create watchpoints",
5646 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
5650 .handler = handle_rwp_command,
5651 .mode = COMMAND_EXEC,
5652 .help = "remove watchpoint",
5656 .name = "load_image",
5657 .handler = handle_load_image_command,
5658 .mode = COMMAND_EXEC,
5659 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5660 "[min_address] [max_length]",
5663 .name = "dump_image",
5664 .handler = handle_dump_image_command,
5665 .mode = COMMAND_EXEC,
5666 .usage = "filename address size",
5669 .name = "verify_image",
5670 .handler = handle_verify_image_command,
5671 .mode = COMMAND_EXEC,
5672 .usage = "filename [offset [type]]",
5675 .name = "test_image",
5676 .handler = handle_test_image_command,
5677 .mode = COMMAND_EXEC,
5678 .usage = "filename [offset [type]]",
5681 .name = "mem2array",
5682 .mode = COMMAND_EXEC,
5683 .jim_handler = jim_mem2array,
5684 .help = "read 8/16/32 bit memory and return as a TCL array "
5685 "for script processing",
5686 .usage = "arrayname bitwidth address count",
5689 .name = "array2mem",
5690 .mode = COMMAND_EXEC,
5691 .jim_handler = jim_array2mem,
5692 .help = "convert a TCL array to memory locations "
5693 "and write the 8/16/32 bit values",
5694 .usage = "arrayname bitwidth address count",
5697 .name = "reset_nag",
5698 .handler = handle_target_reset_nag,
5699 .mode = COMMAND_ANY,
5700 .help = "Nag after each reset about options that could have been "
5701 "enabled to improve performance. ",
5702 .usage = "['enable'|'disable']",
5706 .handler = handle_ps_command,
5707 .mode = COMMAND_EXEC,
5708 .help = "list all tasks ",
5712 COMMAND_REGISTRATION_DONE
5714 static int target_register_user_commands(struct command_context *cmd_ctx)
5716 int retval = ERROR_OK;
5717 retval = target_request_register_commands(cmd_ctx);
5718 if (retval != ERROR_OK)
5721 retval = trace_register_commands(cmd_ctx);
5722 if (retval != ERROR_OK)
5726 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);