1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * Copyright (C) 2008 by Spencer Oliver *
12 * spen@spen-soft.co.uk *
14 * Copyright (C) 2008 by Rick Altherr *
15 * kc8apf@kc8apf.net> *
17 * Copyright (C) 2011 by Broadcom Corporation *
18 * Evan Hunter - ehunter@broadcom.com *
20 * Copyright (C) ST-Ericsson SA 2011 *
21 * michel.jaouen@stericsson.com : smp minimum support *
23 * Copyright (C) 2011 Andreas Fritiofson *
24 * andreas.fritiofson@gmail.com *
26 * This program is free software; you can redistribute it and/or modify *
27 * it under the terms of the GNU General Public License as published by *
28 * the Free Software Foundation; either version 2 of the License, or *
29 * (at your option) any later version. *
31 * This program is distributed in the hope that it will be useful, *
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
34 * GNU General Public License for more details. *
36 * You should have received a copy of the GNU General Public License *
37 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
38 ***************************************************************************/
44 #include <helper/time_support.h>
45 #include <jtag/jtag.h>
46 #include <flash/nor/core.h>
49 #include "target_type.h"
50 #include "target_request.h"
51 #include "breakpoints.h"
55 #include "rtos/rtos.h"
56 #include "transport/transport.h"
58 /* default halt wait timeout (ms) */
59 #define DEFAULT_HALT_TIMEOUT 5000
61 static int target_read_buffer_default(struct target *target, uint32_t address,
62 uint32_t count, uint8_t *buffer);
63 static int target_write_buffer_default(struct target *target, uint32_t address,
64 uint32_t count, const uint8_t *buffer);
65 static int target_array2mem(Jim_Interp *interp, struct target *target,
66 int argc, Jim_Obj * const *argv);
67 static int target_mem2array(Jim_Interp *interp, struct target *target,
68 int argc, Jim_Obj * const *argv);
69 static int target_register_user_commands(struct command_context *cmd_ctx);
70 static int target_get_gdb_fileio_info_default(struct target *target,
71 struct gdb_fileio_info *fileio_info);
72 static int target_gdb_fileio_end_default(struct target *target, int retcode,
73 int fileio_errno, bool ctrl_c);
74 static int target_profiling_default(struct target *target, uint32_t *samples,
75 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds);
78 extern struct target_type arm7tdmi_target;
79 extern struct target_type arm720t_target;
80 extern struct target_type arm9tdmi_target;
81 extern struct target_type arm920t_target;
82 extern struct target_type arm966e_target;
83 extern struct target_type arm946e_target;
84 extern struct target_type arm926ejs_target;
85 extern struct target_type fa526_target;
86 extern struct target_type feroceon_target;
87 extern struct target_type dragonite_target;
88 extern struct target_type xscale_target;
89 extern struct target_type cortexm_target;
90 extern struct target_type cortexa_target;
91 extern struct target_type cortexr4_target;
92 extern struct target_type arm11_target;
93 extern struct target_type ls1_sap_target;
94 extern struct target_type mips_m4k_target;
95 extern struct target_type avr_target;
96 extern struct target_type dsp563xx_target;
97 extern struct target_type dsp5680xx_target;
98 extern struct target_type testee_target;
99 extern struct target_type avr32_ap7k_target;
100 extern struct target_type hla_target;
101 extern struct target_type nds32_v2_target;
102 extern struct target_type nds32_v3_target;
103 extern struct target_type nds32_v3m_target;
104 extern struct target_type or1k_target;
105 extern struct target_type quark_x10xx_target;
106 extern struct target_type quark_d20xx_target;
108 static struct target_type *target_types[] = {
141 struct target *all_targets;
142 static struct target_event_callback *target_event_callbacks;
143 static struct target_timer_callback *target_timer_callbacks;
144 LIST_HEAD(target_reset_callback_list);
145 LIST_HEAD(target_trace_callback_list);
146 static const int polling_interval = 100;
148 static const Jim_Nvp nvp_assert[] = {
149 { .name = "assert", NVP_ASSERT },
150 { .name = "deassert", NVP_DEASSERT },
151 { .name = "T", NVP_ASSERT },
152 { .name = "F", NVP_DEASSERT },
153 { .name = "t", NVP_ASSERT },
154 { .name = "f", NVP_DEASSERT },
155 { .name = NULL, .value = -1 }
158 static const Jim_Nvp nvp_error_target[] = {
159 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
160 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
161 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
162 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
163 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
164 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
165 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
166 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
167 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
168 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
169 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
170 { .value = -1, .name = NULL }
173 static const char *target_strerror_safe(int err)
177 n = Jim_Nvp_value2name_simple(nvp_error_target, err);
184 static const Jim_Nvp nvp_target_event[] = {
186 { .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
187 { .value = TARGET_EVENT_HALTED, .name = "halted" },
188 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
189 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
190 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
192 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
193 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
195 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
196 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
197 { .value = TARGET_EVENT_RESET_ASSERT, .name = "reset-assert" },
198 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
199 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
200 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
201 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
202 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
203 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
204 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
205 { .value = TARGET_EVENT_RESET_INIT, .name = "reset-init" },
206 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
208 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
209 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
211 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
212 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
214 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
215 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
217 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
218 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
220 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
221 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
223 { .value = TARGET_EVENT_TRACE_CONFIG, .name = "trace-config" },
225 { .name = NULL, .value = -1 }
228 static const Jim_Nvp nvp_target_state[] = {
229 { .name = "unknown", .value = TARGET_UNKNOWN },
230 { .name = "running", .value = TARGET_RUNNING },
231 { .name = "halted", .value = TARGET_HALTED },
232 { .name = "reset", .value = TARGET_RESET },
233 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
234 { .name = NULL, .value = -1 },
237 static const Jim_Nvp nvp_target_debug_reason[] = {
238 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
239 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
240 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
241 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
242 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
243 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
244 { .name = "program-exit" , .value = DBG_REASON_EXIT },
245 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
246 { .name = NULL, .value = -1 },
249 static const Jim_Nvp nvp_target_endian[] = {
250 { .name = "big", .value = TARGET_BIG_ENDIAN },
251 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
252 { .name = "be", .value = TARGET_BIG_ENDIAN },
253 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
254 { .name = NULL, .value = -1 },
257 static const Jim_Nvp nvp_reset_modes[] = {
258 { .name = "unknown", .value = RESET_UNKNOWN },
259 { .name = "run" , .value = RESET_RUN },
260 { .name = "halt" , .value = RESET_HALT },
261 { .name = "init" , .value = RESET_INIT },
262 { .name = NULL , .value = -1 },
265 const char *debug_reason_name(struct target *t)
269 cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
270 t->debug_reason)->name;
272 LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
273 cp = "(*BUG*unknown*BUG*)";
278 const char *target_state_name(struct target *t)
281 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
283 LOG_ERROR("Invalid target state: %d", (int)(t->state));
284 cp = "(*BUG*unknown*BUG*)";
289 const char *target_event_name(enum target_event event)
292 cp = Jim_Nvp_value2name_simple(nvp_target_event, event)->name;
294 LOG_ERROR("Invalid target event: %d", (int)(event));
295 cp = "(*BUG*unknown*BUG*)";
300 const char *target_reset_mode_name(enum target_reset_mode reset_mode)
303 cp = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode)->name;
305 LOG_ERROR("Invalid target reset mode: %d", (int)(reset_mode));
306 cp = "(*BUG*unknown*BUG*)";
311 /* determine the number of the new target */
312 static int new_target_number(void)
317 /* number is 0 based */
321 if (x < t->target_number)
322 x = t->target_number;
328 /* read a uint64_t from a buffer in target memory endianness */
329 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer)
331 if (target->endianness == TARGET_LITTLE_ENDIAN)
332 return le_to_h_u64(buffer);
334 return be_to_h_u64(buffer);
337 /* read a uint32_t from a buffer in target memory endianness */
338 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
340 if (target->endianness == TARGET_LITTLE_ENDIAN)
341 return le_to_h_u32(buffer);
343 return be_to_h_u32(buffer);
346 /* read a uint24_t from a buffer in target memory endianness */
347 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
349 if (target->endianness == TARGET_LITTLE_ENDIAN)
350 return le_to_h_u24(buffer);
352 return be_to_h_u24(buffer);
355 /* read a uint16_t from a buffer in target memory endianness */
356 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
358 if (target->endianness == TARGET_LITTLE_ENDIAN)
359 return le_to_h_u16(buffer);
361 return be_to_h_u16(buffer);
364 /* read a uint8_t from a buffer in target memory endianness */
365 static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
367 return *buffer & 0x0ff;
370 /* write a uint64_t to a buffer in target memory endianness */
371 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value)
373 if (target->endianness == TARGET_LITTLE_ENDIAN)
374 h_u64_to_le(buffer, value);
376 h_u64_to_be(buffer, value);
379 /* write a uint32_t to a buffer in target memory endianness */
380 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
382 if (target->endianness == TARGET_LITTLE_ENDIAN)
383 h_u32_to_le(buffer, value);
385 h_u32_to_be(buffer, value);
388 /* write a uint24_t to a buffer in target memory endianness */
389 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
391 if (target->endianness == TARGET_LITTLE_ENDIAN)
392 h_u24_to_le(buffer, value);
394 h_u24_to_be(buffer, value);
397 /* write a uint16_t to a buffer in target memory endianness */
398 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
400 if (target->endianness == TARGET_LITTLE_ENDIAN)
401 h_u16_to_le(buffer, value);
403 h_u16_to_be(buffer, value);
406 /* write a uint8_t to a buffer in target memory endianness */
407 static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
412 /* write a uint64_t array to a buffer in target memory endianness */
413 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf)
416 for (i = 0; i < count; i++)
417 dstbuf[i] = target_buffer_get_u64(target, &buffer[i * 8]);
420 /* write a uint32_t array to a buffer in target memory endianness */
421 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
424 for (i = 0; i < count; i++)
425 dstbuf[i] = target_buffer_get_u32(target, &buffer[i * 4]);
428 /* write a uint16_t array to a buffer in target memory endianness */
429 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
432 for (i = 0; i < count; i++)
433 dstbuf[i] = target_buffer_get_u16(target, &buffer[i * 2]);
436 /* write a uint64_t array to a buffer in target memory endianness */
437 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf)
440 for (i = 0; i < count; i++)
441 target_buffer_set_u64(target, &buffer[i * 8], srcbuf[i]);
444 /* write a uint32_t array to a buffer in target memory endianness */
445 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf)
448 for (i = 0; i < count; i++)
449 target_buffer_set_u32(target, &buffer[i * 4], srcbuf[i]);
452 /* write a uint16_t array to a buffer in target memory endianness */
453 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf)
456 for (i = 0; i < count; i++)
457 target_buffer_set_u16(target, &buffer[i * 2], srcbuf[i]);
460 /* return a pointer to a configured target; id is name or number */
461 struct target *get_target(const char *id)
463 struct target *target;
465 /* try as tcltarget name */
466 for (target = all_targets; target; target = target->next) {
467 if (target_name(target) == NULL)
469 if (strcmp(id, target_name(target)) == 0)
473 /* It's OK to remove this fallback sometime after August 2010 or so */
475 /* no match, try as number */
477 if (parse_uint(id, &num) != ERROR_OK)
480 for (target = all_targets; target; target = target->next) {
481 if (target->target_number == (int)num) {
482 LOG_WARNING("use '%s' as target identifier, not '%u'",
483 target_name(target), num);
491 /* returns a pointer to the n-th configured target */
492 struct target *get_target_by_num(int num)
494 struct target *target = all_targets;
497 if (target->target_number == num)
499 target = target->next;
505 struct target *get_current_target(struct command_context *cmd_ctx)
507 struct target *target = get_target_by_num(cmd_ctx->current_target);
509 if (target == NULL) {
510 LOG_ERROR("BUG: current_target out of bounds");
517 int target_poll(struct target *target)
521 /* We can't poll until after examine */
522 if (!target_was_examined(target)) {
523 /* Fail silently lest we pollute the log */
527 retval = target->type->poll(target);
528 if (retval != ERROR_OK)
531 if (target->halt_issued) {
532 if (target->state == TARGET_HALTED)
533 target->halt_issued = false;
535 int64_t t = timeval_ms() - target->halt_issued_time;
536 if (t > DEFAULT_HALT_TIMEOUT) {
537 target->halt_issued = false;
538 LOG_INFO("Halt timed out, wake up GDB.");
539 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
547 int target_halt(struct target *target)
550 /* We can't poll until after examine */
551 if (!target_was_examined(target)) {
552 LOG_ERROR("Target not examined yet");
556 retval = target->type->halt(target);
557 if (retval != ERROR_OK)
560 target->halt_issued = true;
561 target->halt_issued_time = timeval_ms();
567 * Make the target (re)start executing using its saved execution
568 * context (possibly with some modifications).
570 * @param target Which target should start executing.
571 * @param current True to use the target's saved program counter instead
572 * of the address parameter
573 * @param address Optionally used as the program counter.
574 * @param handle_breakpoints True iff breakpoints at the resumption PC
575 * should be skipped. (For example, maybe execution was stopped by
576 * such a breakpoint, in which case it would be counterprodutive to
578 * @param debug_execution False if all working areas allocated by OpenOCD
579 * should be released and/or restored to their original contents.
580 * (This would for example be true to run some downloaded "helper"
581 * algorithm code, which resides in one such working buffer and uses
582 * another for data storage.)
584 * @todo Resolve the ambiguity about what the "debug_execution" flag
585 * signifies. For example, Target implementations don't agree on how
586 * it relates to invalidation of the register cache, or to whether
587 * breakpoints and watchpoints should be enabled. (It would seem wrong
588 * to enable breakpoints when running downloaded "helper" algorithms
589 * (debug_execution true), since the breakpoints would be set to match
590 * target firmware being debugged, not the helper algorithm.... and
591 * enabling them could cause such helpers to malfunction (for example,
592 * by overwriting data with a breakpoint instruction. On the other
593 * hand the infrastructure for running such helpers might use this
594 * procedure but rely on hardware breakpoint to detect termination.)
596 int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
600 /* We can't poll until after examine */
601 if (!target_was_examined(target)) {
602 LOG_ERROR("Target not examined yet");
606 target_call_event_callbacks(target, TARGET_EVENT_RESUME_START);
608 /* note that resume *must* be asynchronous. The CPU can halt before
609 * we poll. The CPU can even halt at the current PC as a result of
610 * a software breakpoint being inserted by (a bug?) the application.
612 retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution);
613 if (retval != ERROR_OK)
616 target_call_event_callbacks(target, TARGET_EVENT_RESUME_END);
621 static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
626 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
627 if (n->name == NULL) {
628 LOG_ERROR("invalid reset mode");
632 struct target *target;
633 for (target = all_targets; target; target = target->next)
634 target_call_reset_callbacks(target, reset_mode);
636 /* disable polling during reset to make reset event scripts
637 * more predictable, i.e. dr/irscan & pathmove in events will
638 * not have JTAG operations injected into the middle of a sequence.
640 bool save_poll = jtag_poll_get_enabled();
642 jtag_poll_set_enabled(false);
644 sprintf(buf, "ocd_process_reset %s", n->name);
645 retval = Jim_Eval(cmd_ctx->interp, buf);
647 jtag_poll_set_enabled(save_poll);
649 if (retval != JIM_OK) {
650 Jim_MakeErrorMessage(cmd_ctx->interp);
651 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
655 /* We want any events to be processed before the prompt */
656 retval = target_call_timer_callbacks_now();
658 for (target = all_targets; target; target = target->next) {
659 target->type->check_reset(target);
660 target->running_alg = false;
666 static int identity_virt2phys(struct target *target,
667 uint32_t virtual, uint32_t *physical)
673 static int no_mmu(struct target *target, int *enabled)
679 static int default_examine(struct target *target)
681 target_set_examined(target);
685 /* no check by default */
686 static int default_check_reset(struct target *target)
691 int target_examine_one(struct target *target)
693 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
695 int retval = target->type->examine(target);
696 if (retval != ERROR_OK)
699 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
704 static int jtag_enable_callback(enum jtag_event event, void *priv)
706 struct target *target = priv;
708 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
711 jtag_unregister_event_callback(jtag_enable_callback, target);
713 return target_examine_one(target);
716 /* Targets that correctly implement init + examine, i.e.
717 * no communication with target during init:
721 int target_examine(void)
723 int retval = ERROR_OK;
724 struct target *target;
726 for (target = all_targets; target; target = target->next) {
727 /* defer examination, but don't skip it */
728 if (!target->tap->enabled) {
729 jtag_register_event_callback(jtag_enable_callback,
734 retval = target_examine_one(target);
735 if (retval != ERROR_OK)
741 const char *target_type_name(struct target *target)
743 return target->type->name;
746 static int target_soft_reset_halt(struct target *target)
748 if (!target_was_examined(target)) {
749 LOG_ERROR("Target not examined yet");
752 if (!target->type->soft_reset_halt) {
753 LOG_ERROR("Target %s does not support soft_reset_halt",
754 target_name(target));
757 return target->type->soft_reset_halt(target);
761 * Downloads a target-specific native code algorithm to the target,
762 * and executes it. * Note that some targets may need to set up, enable,
763 * and tear down a breakpoint (hard or * soft) to detect algorithm
764 * termination, while others may support lower overhead schemes where
765 * soft breakpoints embedded in the algorithm automatically terminate the
768 * @param target used to run the algorithm
769 * @param arch_info target-specific description of the algorithm.
771 int target_run_algorithm(struct target *target,
772 int num_mem_params, struct mem_param *mem_params,
773 int num_reg_params, struct reg_param *reg_param,
774 uint32_t entry_point, uint32_t exit_point,
775 int timeout_ms, void *arch_info)
777 int retval = ERROR_FAIL;
779 if (!target_was_examined(target)) {
780 LOG_ERROR("Target not examined yet");
783 if (!target->type->run_algorithm) {
784 LOG_ERROR("Target type '%s' does not support %s",
785 target_type_name(target), __func__);
789 target->running_alg = true;
790 retval = target->type->run_algorithm(target,
791 num_mem_params, mem_params,
792 num_reg_params, reg_param,
793 entry_point, exit_point, timeout_ms, arch_info);
794 target->running_alg = false;
801 * Downloads a target-specific native code algorithm to the target,
802 * executes and leaves it running.
804 * @param target used to run the algorithm
805 * @param arch_info target-specific description of the algorithm.
807 int target_start_algorithm(struct target *target,
808 int num_mem_params, struct mem_param *mem_params,
809 int num_reg_params, struct reg_param *reg_params,
810 uint32_t entry_point, uint32_t exit_point,
813 int retval = ERROR_FAIL;
815 if (!target_was_examined(target)) {
816 LOG_ERROR("Target not examined yet");
819 if (!target->type->start_algorithm) {
820 LOG_ERROR("Target type '%s' does not support %s",
821 target_type_name(target), __func__);
824 if (target->running_alg) {
825 LOG_ERROR("Target is already running an algorithm");
829 target->running_alg = true;
830 retval = target->type->start_algorithm(target,
831 num_mem_params, mem_params,
832 num_reg_params, reg_params,
833 entry_point, exit_point, arch_info);
840 * Waits for an algorithm started with target_start_algorithm() to complete.
842 * @param target used to run the algorithm
843 * @param arch_info target-specific description of the algorithm.
845 int target_wait_algorithm(struct target *target,
846 int num_mem_params, struct mem_param *mem_params,
847 int num_reg_params, struct reg_param *reg_params,
848 uint32_t exit_point, int timeout_ms,
851 int retval = ERROR_FAIL;
853 if (!target->type->wait_algorithm) {
854 LOG_ERROR("Target type '%s' does not support %s",
855 target_type_name(target), __func__);
858 if (!target->running_alg) {
859 LOG_ERROR("Target is not running an algorithm");
863 retval = target->type->wait_algorithm(target,
864 num_mem_params, mem_params,
865 num_reg_params, reg_params,
866 exit_point, timeout_ms, arch_info);
867 if (retval != ERROR_TARGET_TIMEOUT)
868 target->running_alg = false;
875 * Executes a target-specific native code algorithm in the target.
876 * It differs from target_run_algorithm in that the algorithm is asynchronous.
877 * Because of this it requires an compliant algorithm:
878 * see contrib/loaders/flash/stm32f1x.S for example.
880 * @param target used to run the algorithm
883 int target_run_flash_async_algorithm(struct target *target,
884 const uint8_t *buffer, uint32_t count, int block_size,
885 int num_mem_params, struct mem_param *mem_params,
886 int num_reg_params, struct reg_param *reg_params,
887 uint32_t buffer_start, uint32_t buffer_size,
888 uint32_t entry_point, uint32_t exit_point, void *arch_info)
893 const uint8_t *buffer_orig = buffer;
895 /* Set up working area. First word is write pointer, second word is read pointer,
896 * rest is fifo data area. */
897 uint32_t wp_addr = buffer_start;
898 uint32_t rp_addr = buffer_start + 4;
899 uint32_t fifo_start_addr = buffer_start + 8;
900 uint32_t fifo_end_addr = buffer_start + buffer_size;
902 uint32_t wp = fifo_start_addr;
903 uint32_t rp = fifo_start_addr;
905 /* validate block_size is 2^n */
906 assert(!block_size || !(block_size & (block_size - 1)));
908 retval = target_write_u32(target, wp_addr, wp);
909 if (retval != ERROR_OK)
911 retval = target_write_u32(target, rp_addr, rp);
912 if (retval != ERROR_OK)
915 /* Start up algorithm on target and let it idle while writing the first chunk */
916 retval = target_start_algorithm(target, num_mem_params, mem_params,
917 num_reg_params, reg_params,
922 if (retval != ERROR_OK) {
923 LOG_ERROR("error starting target flash write algorithm");
929 retval = target_read_u32(target, rp_addr, &rp);
930 if (retval != ERROR_OK) {
931 LOG_ERROR("failed to get read pointer");
935 LOG_DEBUG("offs 0x%zx count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32,
936 (size_t) (buffer - buffer_orig), count, wp, rp);
939 LOG_ERROR("flash write algorithm aborted by target");
940 retval = ERROR_FLASH_OPERATION_FAILED;
944 if (((rp - fifo_start_addr) & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
945 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
949 /* Count the number of bytes available in the fifo without
950 * crossing the wrap around. Make sure to not fill it completely,
951 * because that would make wp == rp and that's the empty condition. */
952 uint32_t thisrun_bytes;
954 thisrun_bytes = rp - wp - block_size;
955 else if (rp > fifo_start_addr)
956 thisrun_bytes = fifo_end_addr - wp;
958 thisrun_bytes = fifo_end_addr - wp - block_size;
960 if (thisrun_bytes == 0) {
961 /* Throttle polling a bit if transfer is (much) faster than flash
962 * programming. The exact delay shouldn't matter as long as it's
963 * less than buffer size / flash speed. This is very unlikely to
964 * run when using high latency connections such as USB. */
967 /* to stop an infinite loop on some targets check and increment a timeout
968 * this issue was observed on a stellaris using the new ICDI interface */
969 if (timeout++ >= 500) {
970 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
971 return ERROR_FLASH_OPERATION_FAILED;
976 /* reset our timeout */
979 /* Limit to the amount of data we actually want to write */
980 if (thisrun_bytes > count * block_size)
981 thisrun_bytes = count * block_size;
983 /* Write data to fifo */
984 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
985 if (retval != ERROR_OK)
988 /* Update counters and wrap write pointer */
989 buffer += thisrun_bytes;
990 count -= thisrun_bytes / block_size;
992 if (wp >= fifo_end_addr)
993 wp = fifo_start_addr;
995 /* Store updated write pointer to target */
996 retval = target_write_u32(target, wp_addr, wp);
997 if (retval != ERROR_OK)
1001 if (retval != ERROR_OK) {
1002 /* abort flash write algorithm on target */
1003 target_write_u32(target, wp_addr, 0);
1006 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
1007 num_reg_params, reg_params,
1012 if (retval2 != ERROR_OK) {
1013 LOG_ERROR("error waiting for target flash write algorithm");
1017 if (retval == ERROR_OK) {
1018 /* check if algorithm set rp = 0 after fifo writer loop finished */
1019 retval = target_read_u32(target, rp_addr, &rp);
1020 if (retval == ERROR_OK && rp == 0) {
1021 LOG_ERROR("flash write algorithm aborted by target");
1022 retval = ERROR_FLASH_OPERATION_FAILED;
1029 int target_read_memory(struct target *target,
1030 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
1032 if (!target_was_examined(target)) {
1033 LOG_ERROR("Target not examined yet");
1036 if (!target->type->read_memory) {
1037 LOG_ERROR("Target %s doesn't support read_memory", target_name(target));
1040 return target->type->read_memory(target, address, size, count, buffer);
1043 int target_read_phys_memory(struct target *target,
1044 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
1046 if (!target_was_examined(target)) {
1047 LOG_ERROR("Target not examined yet");
1050 if (!target->type->read_phys_memory) {
1051 LOG_ERROR("Target %s doesn't support read_phys_memory", target_name(target));
1054 return target->type->read_phys_memory(target, address, size, count, buffer);
1057 int target_write_memory(struct target *target,
1058 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
1060 if (!target_was_examined(target)) {
1061 LOG_ERROR("Target not examined yet");
1064 if (!target->type->write_memory) {
1065 LOG_ERROR("Target %s doesn't support write_memory", target_name(target));
1068 return target->type->write_memory(target, address, size, count, buffer);
1071 int target_write_phys_memory(struct target *target,
1072 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
1074 if (!target_was_examined(target)) {
1075 LOG_ERROR("Target not examined yet");
1078 if (!target->type->write_phys_memory) {
1079 LOG_ERROR("Target %s doesn't support write_phys_memory", target_name(target));
1082 return target->type->write_phys_memory(target, address, size, count, buffer);
1085 int target_add_breakpoint(struct target *target,
1086 struct breakpoint *breakpoint)
1088 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
1089 LOG_WARNING("target %s is not halted", target_name(target));
1090 return ERROR_TARGET_NOT_HALTED;
1092 return target->type->add_breakpoint(target, breakpoint);
1095 int target_add_context_breakpoint(struct target *target,
1096 struct breakpoint *breakpoint)
1098 if (target->state != TARGET_HALTED) {
1099 LOG_WARNING("target %s is not halted", target_name(target));
1100 return ERROR_TARGET_NOT_HALTED;
1102 return target->type->add_context_breakpoint(target, breakpoint);
1105 int target_add_hybrid_breakpoint(struct target *target,
1106 struct breakpoint *breakpoint)
1108 if (target->state != TARGET_HALTED) {
1109 LOG_WARNING("target %s is not halted", target_name(target));
1110 return ERROR_TARGET_NOT_HALTED;
1112 return target->type->add_hybrid_breakpoint(target, breakpoint);
1115 int target_remove_breakpoint(struct target *target,
1116 struct breakpoint *breakpoint)
1118 return target->type->remove_breakpoint(target, breakpoint);
1121 int target_add_watchpoint(struct target *target,
1122 struct watchpoint *watchpoint)
1124 if (target->state != TARGET_HALTED) {
1125 LOG_WARNING("target %s is not halted", target_name(target));
1126 return ERROR_TARGET_NOT_HALTED;
1128 return target->type->add_watchpoint(target, watchpoint);
1130 int target_remove_watchpoint(struct target *target,
1131 struct watchpoint *watchpoint)
1133 return target->type->remove_watchpoint(target, watchpoint);
1135 int target_hit_watchpoint(struct target *target,
1136 struct watchpoint **hit_watchpoint)
1138 if (target->state != TARGET_HALTED) {
1139 LOG_WARNING("target %s is not halted", target->cmd_name);
1140 return ERROR_TARGET_NOT_HALTED;
1143 if (target->type->hit_watchpoint == NULL) {
1144 /* For backward compatible, if hit_watchpoint is not implemented,
1145 * return ERROR_FAIL such that gdb_server will not take the nonsense
1150 return target->type->hit_watchpoint(target, hit_watchpoint);
1153 int target_get_gdb_reg_list(struct target *target,
1154 struct reg **reg_list[], int *reg_list_size,
1155 enum target_register_class reg_class)
1157 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size, reg_class);
1159 int target_step(struct target *target,
1160 int current, uint32_t address, int handle_breakpoints)
1162 return target->type->step(target, current, address, handle_breakpoints);
1165 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info)
1167 if (target->state != TARGET_HALTED) {
1168 LOG_WARNING("target %s is not halted", target->cmd_name);
1169 return ERROR_TARGET_NOT_HALTED;
1171 return target->type->get_gdb_fileio_info(target, fileio_info);
1174 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c)
1176 if (target->state != TARGET_HALTED) {
1177 LOG_WARNING("target %s is not halted", target->cmd_name);
1178 return ERROR_TARGET_NOT_HALTED;
1180 return target->type->gdb_fileio_end(target, retcode, fileio_errno, ctrl_c);
1183 int target_profiling(struct target *target, uint32_t *samples,
1184 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
1186 if (target->state != TARGET_HALTED) {
1187 LOG_WARNING("target %s is not halted", target->cmd_name);
1188 return ERROR_TARGET_NOT_HALTED;
1190 return target->type->profiling(target, samples, max_num_samples,
1191 num_samples, seconds);
1195 * Reset the @c examined flag for the given target.
1196 * Pure paranoia -- targets are zeroed on allocation.
1198 static void target_reset_examined(struct target *target)
1200 target->examined = false;
1203 static int handle_target(void *priv);
1205 static int target_init_one(struct command_context *cmd_ctx,
1206 struct target *target)
1208 target_reset_examined(target);
1210 struct target_type *type = target->type;
1211 if (type->examine == NULL)
1212 type->examine = default_examine;
1214 if (type->check_reset == NULL)
1215 type->check_reset = default_check_reset;
1217 assert(type->init_target != NULL);
1219 int retval = type->init_target(cmd_ctx, target);
1220 if (ERROR_OK != retval) {
1221 LOG_ERROR("target '%s' init failed", target_name(target));
1225 /* Sanity-check MMU support ... stub in what we must, to help
1226 * implement it in stages, but warn if we need to do so.
1229 if (type->virt2phys == NULL) {
1230 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1231 type->virt2phys = identity_virt2phys;
1234 /* Make sure no-MMU targets all behave the same: make no
1235 * distinction between physical and virtual addresses, and
1236 * ensure that virt2phys() is always an identity mapping.
1238 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1239 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1242 type->write_phys_memory = type->write_memory;
1243 type->read_phys_memory = type->read_memory;
1244 type->virt2phys = identity_virt2phys;
1247 if (target->type->read_buffer == NULL)
1248 target->type->read_buffer = target_read_buffer_default;
1250 if (target->type->write_buffer == NULL)
1251 target->type->write_buffer = target_write_buffer_default;
1253 if (target->type->get_gdb_fileio_info == NULL)
1254 target->type->get_gdb_fileio_info = target_get_gdb_fileio_info_default;
1256 if (target->type->gdb_fileio_end == NULL)
1257 target->type->gdb_fileio_end = target_gdb_fileio_end_default;
1259 if (target->type->profiling == NULL)
1260 target->type->profiling = target_profiling_default;
1265 static int target_init(struct command_context *cmd_ctx)
1267 struct target *target;
1270 for (target = all_targets; target; target = target->next) {
1271 retval = target_init_one(cmd_ctx, target);
1272 if (ERROR_OK != retval)
1279 retval = target_register_user_commands(cmd_ctx);
1280 if (ERROR_OK != retval)
1283 retval = target_register_timer_callback(&handle_target,
1284 polling_interval, 1, cmd_ctx->interp);
1285 if (ERROR_OK != retval)
1291 COMMAND_HANDLER(handle_target_init_command)
1296 return ERROR_COMMAND_SYNTAX_ERROR;
1298 static bool target_initialized;
1299 if (target_initialized) {
1300 LOG_INFO("'target init' has already been called");
1303 target_initialized = true;
1305 retval = command_run_line(CMD_CTX, "init_targets");
1306 if (ERROR_OK != retval)
1309 retval = command_run_line(CMD_CTX, "init_target_events");
1310 if (ERROR_OK != retval)
1313 retval = command_run_line(CMD_CTX, "init_board");
1314 if (ERROR_OK != retval)
1317 LOG_DEBUG("Initializing targets...");
1318 return target_init(CMD_CTX);
1321 int target_register_event_callback(int (*callback)(struct target *target,
1322 enum target_event event, void *priv), void *priv)
1324 struct target_event_callback **callbacks_p = &target_event_callbacks;
1326 if (callback == NULL)
1327 return ERROR_COMMAND_SYNTAX_ERROR;
1330 while ((*callbacks_p)->next)
1331 callbacks_p = &((*callbacks_p)->next);
1332 callbacks_p = &((*callbacks_p)->next);
1335 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1336 (*callbacks_p)->callback = callback;
1337 (*callbacks_p)->priv = priv;
1338 (*callbacks_p)->next = NULL;
1343 int target_register_reset_callback(int (*callback)(struct target *target,
1344 enum target_reset_mode reset_mode, void *priv), void *priv)
1346 struct target_reset_callback *entry;
1348 if (callback == NULL)
1349 return ERROR_COMMAND_SYNTAX_ERROR;
1351 entry = malloc(sizeof(struct target_reset_callback));
1352 if (entry == NULL) {
1353 LOG_ERROR("error allocating buffer for reset callback entry");
1354 return ERROR_COMMAND_SYNTAX_ERROR;
1357 entry->callback = callback;
1359 list_add(&entry->list, &target_reset_callback_list);
1365 int target_register_trace_callback(int (*callback)(struct target *target,
1366 size_t len, uint8_t *data, void *priv), void *priv)
1368 struct target_trace_callback *entry;
1370 if (callback == NULL)
1371 return ERROR_COMMAND_SYNTAX_ERROR;
1373 entry = malloc(sizeof(struct target_trace_callback));
1374 if (entry == NULL) {
1375 LOG_ERROR("error allocating buffer for trace callback entry");
1376 return ERROR_COMMAND_SYNTAX_ERROR;
1379 entry->callback = callback;
1381 list_add(&entry->list, &target_trace_callback_list);
1387 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
1389 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1392 if (callback == NULL)
1393 return ERROR_COMMAND_SYNTAX_ERROR;
1396 while ((*callbacks_p)->next)
1397 callbacks_p = &((*callbacks_p)->next);
1398 callbacks_p = &((*callbacks_p)->next);
1401 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1402 (*callbacks_p)->callback = callback;
1403 (*callbacks_p)->periodic = periodic;
1404 (*callbacks_p)->time_ms = time_ms;
1405 (*callbacks_p)->removed = false;
1407 gettimeofday(&now, NULL);
1408 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
1409 time_ms -= (time_ms % 1000);
1410 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
1411 if ((*callbacks_p)->when.tv_usec > 1000000) {
1412 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
1413 (*callbacks_p)->when.tv_sec += 1;
1416 (*callbacks_p)->priv = priv;
1417 (*callbacks_p)->next = NULL;
1422 int target_unregister_event_callback(int (*callback)(struct target *target,
1423 enum target_event event, void *priv), void *priv)
1425 struct target_event_callback **p = &target_event_callbacks;
1426 struct target_event_callback *c = target_event_callbacks;
1428 if (callback == NULL)
1429 return ERROR_COMMAND_SYNTAX_ERROR;
1432 struct target_event_callback *next = c->next;
1433 if ((c->callback == callback) && (c->priv == priv)) {
1445 int target_unregister_reset_callback(int (*callback)(struct target *target,
1446 enum target_reset_mode reset_mode, void *priv), void *priv)
1448 struct target_reset_callback *entry;
1450 if (callback == NULL)
1451 return ERROR_COMMAND_SYNTAX_ERROR;
1453 list_for_each_entry(entry, &target_reset_callback_list, list) {
1454 if (entry->callback == callback && entry->priv == priv) {
1455 list_del(&entry->list);
1464 int target_unregister_trace_callback(int (*callback)(struct target *target,
1465 size_t len, uint8_t *data, void *priv), void *priv)
1467 struct target_trace_callback *entry;
1469 if (callback == NULL)
1470 return ERROR_COMMAND_SYNTAX_ERROR;
1472 list_for_each_entry(entry, &target_trace_callback_list, list) {
1473 if (entry->callback == callback && entry->priv == priv) {
1474 list_del(&entry->list);
1483 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1485 if (callback == NULL)
1486 return ERROR_COMMAND_SYNTAX_ERROR;
1488 for (struct target_timer_callback *c = target_timer_callbacks;
1490 if ((c->callback == callback) && (c->priv == priv)) {
1499 int target_call_event_callbacks(struct target *target, enum target_event event)
1501 struct target_event_callback *callback = target_event_callbacks;
1502 struct target_event_callback *next_callback;
1504 if (event == TARGET_EVENT_HALTED) {
1505 /* execute early halted first */
1506 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1509 LOG_DEBUG("target event %i (%s)", event,
1510 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1512 target_handle_event(target, event);
1515 next_callback = callback->next;
1516 callback->callback(target, event, callback->priv);
1517 callback = next_callback;
1523 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode)
1525 struct target_reset_callback *callback;
1527 LOG_DEBUG("target reset %i (%s)", reset_mode,
1528 Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode)->name);
1530 list_for_each_entry(callback, &target_reset_callback_list, list)
1531 callback->callback(target, reset_mode, callback->priv);
1536 int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data)
1538 struct target_trace_callback *callback;
1540 list_for_each_entry(callback, &target_trace_callback_list, list)
1541 callback->callback(target, len, data, callback->priv);
1546 static int target_timer_callback_periodic_restart(
1547 struct target_timer_callback *cb, struct timeval *now)
1549 int time_ms = cb->time_ms;
1550 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1551 time_ms -= (time_ms % 1000);
1552 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1553 if (cb->when.tv_usec > 1000000) {
1554 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1555 cb->when.tv_sec += 1;
1560 static int target_call_timer_callback(struct target_timer_callback *cb,
1561 struct timeval *now)
1563 cb->callback(cb->priv);
1566 return target_timer_callback_periodic_restart(cb, now);
1568 return target_unregister_timer_callback(cb->callback, cb->priv);
1571 static int target_call_timer_callbacks_check_time(int checktime)
1573 static bool callback_processing;
1575 /* Do not allow nesting */
1576 if (callback_processing)
1579 callback_processing = true;
1584 gettimeofday(&now, NULL);
1586 /* Store an address of the place containing a pointer to the
1587 * next item; initially, that's a standalone "root of the
1588 * list" variable. */
1589 struct target_timer_callback **callback = &target_timer_callbacks;
1591 if ((*callback)->removed) {
1592 struct target_timer_callback *p = *callback;
1593 *callback = (*callback)->next;
1598 bool call_it = (*callback)->callback &&
1599 ((!checktime && (*callback)->periodic) ||
1600 now.tv_sec > (*callback)->when.tv_sec ||
1601 (now.tv_sec == (*callback)->when.tv_sec &&
1602 now.tv_usec >= (*callback)->when.tv_usec));
1605 target_call_timer_callback(*callback, &now);
1607 callback = &(*callback)->next;
1610 callback_processing = false;
1614 int target_call_timer_callbacks(void)
1616 return target_call_timer_callbacks_check_time(1);
1619 /* invoke periodic callbacks immediately */
1620 int target_call_timer_callbacks_now(void)
1622 return target_call_timer_callbacks_check_time(0);
1625 /* Prints the working area layout for debug purposes */
1626 static void print_wa_layout(struct target *target)
1628 struct working_area *c = target->working_areas;
1631 LOG_DEBUG("%c%c 0x%08"PRIx32"-0x%08"PRIx32" (%"PRIu32" bytes)",
1632 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1633 c->address, c->address + c->size - 1, c->size);
1638 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1639 static void target_split_working_area(struct working_area *area, uint32_t size)
1641 assert(area->free); /* Shouldn't split an allocated area */
1642 assert(size <= area->size); /* Caller should guarantee this */
1644 /* Split only if not already the right size */
1645 if (size < area->size) {
1646 struct working_area *new_wa = malloc(sizeof(*new_wa));
1651 new_wa->next = area->next;
1652 new_wa->size = area->size - size;
1653 new_wa->address = area->address + size;
1654 new_wa->backup = NULL;
1655 new_wa->user = NULL;
1656 new_wa->free = true;
1658 area->next = new_wa;
1661 /* If backup memory was allocated to this area, it has the wrong size
1662 * now so free it and it will be reallocated if/when needed */
1665 area->backup = NULL;
1670 /* Merge all adjacent free areas into one */
1671 static void target_merge_working_areas(struct target *target)
1673 struct working_area *c = target->working_areas;
1675 while (c && c->next) {
1676 assert(c->next->address == c->address + c->size); /* This is an invariant */
1678 /* Find two adjacent free areas */
1679 if (c->free && c->next->free) {
1680 /* Merge the last into the first */
1681 c->size += c->next->size;
1683 /* Remove the last */
1684 struct working_area *to_be_freed = c->next;
1685 c->next = c->next->next;
1686 if (to_be_freed->backup)
1687 free(to_be_freed->backup);
1690 /* If backup memory was allocated to the remaining area, it's has
1691 * the wrong size now */
1702 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1704 /* Reevaluate working area address based on MMU state*/
1705 if (target->working_areas == NULL) {
1709 retval = target->type->mmu(target, &enabled);
1710 if (retval != ERROR_OK)
1714 if (target->working_area_phys_spec) {
1715 LOG_DEBUG("MMU disabled, using physical "
1716 "address for working memory 0x%08"PRIx32,
1717 target->working_area_phys);
1718 target->working_area = target->working_area_phys;
1720 LOG_ERROR("No working memory available. "
1721 "Specify -work-area-phys to target.");
1722 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1725 if (target->working_area_virt_spec) {
1726 LOG_DEBUG("MMU enabled, using virtual "
1727 "address for working memory 0x%08"PRIx32,
1728 target->working_area_virt);
1729 target->working_area = target->working_area_virt;
1731 LOG_ERROR("No working memory available. "
1732 "Specify -work-area-virt to target.");
1733 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1737 /* Set up initial working area on first call */
1738 struct working_area *new_wa = malloc(sizeof(*new_wa));
1740 new_wa->next = NULL;
1741 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1742 new_wa->address = target->working_area;
1743 new_wa->backup = NULL;
1744 new_wa->user = NULL;
1745 new_wa->free = true;
1748 target->working_areas = new_wa;
1751 /* only allocate multiples of 4 byte */
1753 size = (size + 3) & (~3UL);
1755 struct working_area *c = target->working_areas;
1757 /* Find the first large enough working area */
1759 if (c->free && c->size >= size)
1765 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1767 /* Split the working area into the requested size */
1768 target_split_working_area(c, size);
1770 LOG_DEBUG("allocated new working area of %"PRIu32" bytes at address 0x%08"PRIx32, size, c->address);
1772 if (target->backup_working_area) {
1773 if (c->backup == NULL) {
1774 c->backup = malloc(c->size);
1775 if (c->backup == NULL)
1779 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1780 if (retval != ERROR_OK)
1784 /* mark as used, and return the new (reused) area */
1791 print_wa_layout(target);
1796 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1800 retval = target_alloc_working_area_try(target, size, area);
1801 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1802 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1807 static int target_restore_working_area(struct target *target, struct working_area *area)
1809 int retval = ERROR_OK;
1811 if (target->backup_working_area && area->backup != NULL) {
1812 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1813 if (retval != ERROR_OK)
1814 LOG_ERROR("failed to restore %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1815 area->size, area->address);
1821 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1822 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1824 int retval = ERROR_OK;
1830 retval = target_restore_working_area(target, area);
1831 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1832 if (retval != ERROR_OK)
1838 LOG_DEBUG("freed %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1839 area->size, area->address);
1841 /* mark user pointer invalid */
1842 /* TODO: Is this really safe? It points to some previous caller's memory.
1843 * How could we know that the area pointer is still in that place and not
1844 * some other vital data? What's the purpose of this, anyway? */
1848 target_merge_working_areas(target);
1850 print_wa_layout(target);
1855 int target_free_working_area(struct target *target, struct working_area *area)
1857 return target_free_working_area_restore(target, area, 1);
1860 void target_quit(void)
1862 struct target_event_callback *pe = target_event_callbacks;
1864 struct target_event_callback *t = pe->next;
1868 target_event_callbacks = NULL;
1870 struct target_timer_callback *pt = target_timer_callbacks;
1872 struct target_timer_callback *t = pt->next;
1876 target_timer_callbacks = NULL;
1878 for (struct target *target = all_targets;
1879 target; target = target->next) {
1880 if (target->type->deinit_target)
1881 target->type->deinit_target(target);
1885 /* free resources and restore memory, if restoring memory fails,
1886 * free up resources anyway
1888 static void target_free_all_working_areas_restore(struct target *target, int restore)
1890 struct working_area *c = target->working_areas;
1892 LOG_DEBUG("freeing all working areas");
1894 /* Loop through all areas, restoring the allocated ones and marking them as free */
1898 target_restore_working_area(target, c);
1900 *c->user = NULL; /* Same as above */
1906 /* Run a merge pass to combine all areas into one */
1907 target_merge_working_areas(target);
1909 print_wa_layout(target);
1912 void target_free_all_working_areas(struct target *target)
1914 target_free_all_working_areas_restore(target, 1);
1917 /* Find the largest number of bytes that can be allocated */
1918 uint32_t target_get_working_area_avail(struct target *target)
1920 struct working_area *c = target->working_areas;
1921 uint32_t max_size = 0;
1924 return target->working_area_size;
1927 if (c->free && max_size < c->size)
1936 int target_arch_state(struct target *target)
1939 if (target == NULL) {
1940 LOG_USER("No target has been configured");
1944 LOG_USER("%s: target state: %s", target_name(target),
1945 target_state_name(target));
1947 if (target->state != TARGET_HALTED)
1950 retval = target->type->arch_state(target);
1954 static int target_get_gdb_fileio_info_default(struct target *target,
1955 struct gdb_fileio_info *fileio_info)
1957 /* If target does not support semi-hosting function, target
1958 has no need to provide .get_gdb_fileio_info callback.
1959 It just return ERROR_FAIL and gdb_server will return "Txx"
1960 as target halted every time. */
1964 static int target_gdb_fileio_end_default(struct target *target,
1965 int retcode, int fileio_errno, bool ctrl_c)
1970 static int target_profiling_default(struct target *target, uint32_t *samples,
1971 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
1973 struct timeval timeout, now;
1975 gettimeofday(&timeout, NULL);
1976 timeval_add_time(&timeout, seconds, 0);
1978 LOG_INFO("Starting profiling. Halting and resuming the"
1979 " target as often as we can...");
1981 uint32_t sample_count = 0;
1982 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
1983 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
1985 int retval = ERROR_OK;
1987 target_poll(target);
1988 if (target->state == TARGET_HALTED) {
1989 uint32_t t = buf_get_u32(reg->value, 0, 32);
1990 samples[sample_count++] = t;
1991 /* current pc, addr = 0, do not handle breakpoints, not debugging */
1992 retval = target_resume(target, 1, 0, 0, 0);
1993 target_poll(target);
1994 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
1995 } else if (target->state == TARGET_RUNNING) {
1996 /* We want to quickly sample the PC. */
1997 retval = target_halt(target);
1999 LOG_INFO("Target not halted or running");
2004 if (retval != ERROR_OK)
2007 gettimeofday(&now, NULL);
2008 if ((sample_count >= max_num_samples) ||
2009 ((now.tv_sec >= timeout.tv_sec) && (now.tv_usec >= timeout.tv_usec))) {
2010 LOG_INFO("Profiling completed. %" PRIu32 " samples.", sample_count);
2015 *num_samples = sample_count;
2019 /* Single aligned words are guaranteed to use 16 or 32 bit access
2020 * mode respectively, otherwise data is handled as quickly as
2023 int target_write_buffer(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
2025 LOG_DEBUG("writing buffer of %" PRIi32 " byte at 0x%8.8" PRIx32,
2028 if (!target_was_examined(target)) {
2029 LOG_ERROR("Target not examined yet");
2036 if ((address + size - 1) < address) {
2037 /* GDB can request this when e.g. PC is 0xfffffffc */
2038 LOG_ERROR("address + size wrapped (0x%08" PRIx32 ", 0x%08" PRIx32 ")",
2044 return target->type->write_buffer(target, address, size, buffer);
2047 static int target_write_buffer_default(struct target *target, uint32_t address, uint32_t count, const uint8_t *buffer)
2051 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2052 * will have something to do with the size we leave to it. */
2053 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2054 if (address & size) {
2055 int retval = target_write_memory(target, address, size, 1, buffer);
2056 if (retval != ERROR_OK)
2064 /* Write the data with as large access size as possible. */
2065 for (; size > 0; size /= 2) {
2066 uint32_t aligned = count - count % size;
2068 int retval = target_write_memory(target, address, size, aligned / size, buffer);
2069 if (retval != ERROR_OK)
2080 /* Single aligned words are guaranteed to use 16 or 32 bit access
2081 * mode respectively, otherwise data is handled as quickly as
2084 int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
2086 LOG_DEBUG("reading buffer of %" PRIi32 " byte at 0x%8.8" PRIx32,
2089 if (!target_was_examined(target)) {
2090 LOG_ERROR("Target not examined yet");
2097 if ((address + size - 1) < address) {
2098 /* GDB can request this when e.g. PC is 0xfffffffc */
2099 LOG_ERROR("address + size wrapped (0x%08" PRIx32 ", 0x%08" PRIx32 ")",
2105 return target->type->read_buffer(target, address, size, buffer);
2108 static int target_read_buffer_default(struct target *target, uint32_t address, uint32_t count, uint8_t *buffer)
2112 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2113 * will have something to do with the size we leave to it. */
2114 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
2115 if (address & size) {
2116 int retval = target_read_memory(target, address, size, 1, buffer);
2117 if (retval != ERROR_OK)
2125 /* Read the data with as large access size as possible. */
2126 for (; size > 0; size /= 2) {
2127 uint32_t aligned = count - count % size;
2129 int retval = target_read_memory(target, address, size, aligned / size, buffer);
2130 if (retval != ERROR_OK)
2141 int target_checksum_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* crc)
2146 uint32_t checksum = 0;
2147 if (!target_was_examined(target)) {
2148 LOG_ERROR("Target not examined yet");
2152 retval = target->type->checksum_memory(target, address, size, &checksum);
2153 if (retval != ERROR_OK) {
2154 buffer = malloc(size);
2155 if (buffer == NULL) {
2156 LOG_ERROR("error allocating buffer for section (%" PRId32 " bytes)", size);
2157 return ERROR_COMMAND_SYNTAX_ERROR;
2159 retval = target_read_buffer(target, address, size, buffer);
2160 if (retval != ERROR_OK) {
2165 /* convert to target endianness */
2166 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
2167 uint32_t target_data;
2168 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
2169 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
2172 retval = image_calculate_checksum(buffer, size, &checksum);
2181 int target_blank_check_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* blank,
2182 uint8_t erased_value)
2185 if (!target_was_examined(target)) {
2186 LOG_ERROR("Target not examined yet");
2190 if (target->type->blank_check_memory == 0)
2191 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
2193 retval = target->type->blank_check_memory(target, address, size, blank, erased_value);
2198 int target_read_u64(struct target *target, uint64_t address, uint64_t *value)
2200 uint8_t value_buf[8];
2201 if (!target_was_examined(target)) {
2202 LOG_ERROR("Target not examined yet");
2206 int retval = target_read_memory(target, address, 8, 1, value_buf);
2208 if (retval == ERROR_OK) {
2209 *value = target_buffer_get_u64(target, value_buf);
2210 LOG_DEBUG("address: 0x%" PRIx64 ", value: 0x%16.16" PRIx64 "",
2215 LOG_DEBUG("address: 0x%" PRIx64 " failed",
2222 int target_read_u32(struct target *target, uint32_t address, uint32_t *value)
2224 uint8_t value_buf[4];
2225 if (!target_was_examined(target)) {
2226 LOG_ERROR("Target not examined yet");
2230 int retval = target_read_memory(target, address, 4, 1, value_buf);
2232 if (retval == ERROR_OK) {
2233 *value = target_buffer_get_u32(target, value_buf);
2234 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
2239 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2246 int target_read_u16(struct target *target, uint32_t address, uint16_t *value)
2248 uint8_t value_buf[2];
2249 if (!target_was_examined(target)) {
2250 LOG_ERROR("Target not examined yet");
2254 int retval = target_read_memory(target, address, 2, 1, value_buf);
2256 if (retval == ERROR_OK) {
2257 *value = target_buffer_get_u16(target, value_buf);
2258 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4" PRIx16,
2263 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2270 int target_read_u8(struct target *target, uint32_t address, uint8_t *value)
2272 if (!target_was_examined(target)) {
2273 LOG_ERROR("Target not examined yet");
2277 int retval = target_read_memory(target, address, 1, 1, value);
2279 if (retval == ERROR_OK) {
2280 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2" PRIx8,
2285 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2292 int target_write_u64(struct target *target, uint64_t address, uint64_t value)
2295 uint8_t value_buf[8];
2296 if (!target_was_examined(target)) {
2297 LOG_ERROR("Target not examined yet");
2301 LOG_DEBUG("address: 0x%" PRIx64 ", value: 0x%16.16" PRIx64 "",
2305 target_buffer_set_u64(target, value_buf, value);
2306 retval = target_write_memory(target, address, 8, 1, value_buf);
2307 if (retval != ERROR_OK)
2308 LOG_DEBUG("failed: %i", retval);
2313 int target_write_u32(struct target *target, uint32_t address, uint32_t value)
2316 uint8_t value_buf[4];
2317 if (!target_was_examined(target)) {
2318 LOG_ERROR("Target not examined yet");
2322 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
2326 target_buffer_set_u32(target, value_buf, value);
2327 retval = target_write_memory(target, address, 4, 1, value_buf);
2328 if (retval != ERROR_OK)
2329 LOG_DEBUG("failed: %i", retval);
2334 int target_write_u16(struct target *target, uint32_t address, uint16_t value)
2337 uint8_t value_buf[2];
2338 if (!target_was_examined(target)) {
2339 LOG_ERROR("Target not examined yet");
2343 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx16,
2347 target_buffer_set_u16(target, value_buf, value);
2348 retval = target_write_memory(target, address, 2, 1, value_buf);
2349 if (retval != ERROR_OK)
2350 LOG_DEBUG("failed: %i", retval);
2355 int target_write_u8(struct target *target, uint32_t address, uint8_t value)
2358 if (!target_was_examined(target)) {
2359 LOG_ERROR("Target not examined yet");
2363 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2" PRIx8,
2366 retval = target_write_memory(target, address, 1, 1, &value);
2367 if (retval != ERROR_OK)
2368 LOG_DEBUG("failed: %i", retval);
2373 static int find_target(struct command_context *cmd_ctx, const char *name)
2375 struct target *target = get_target(name);
2376 if (target == NULL) {
2377 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2380 if (!target->tap->enabled) {
2381 LOG_USER("Target: TAP %s is disabled, "
2382 "can't be the current target\n",
2383 target->tap->dotted_name);
2387 cmd_ctx->current_target = target->target_number;
2392 COMMAND_HANDLER(handle_targets_command)
2394 int retval = ERROR_OK;
2395 if (CMD_ARGC == 1) {
2396 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2397 if (retval == ERROR_OK) {
2403 struct target *target = all_targets;
2404 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2405 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2410 if (target->tap->enabled)
2411 state = target_state_name(target);
2413 state = "tap-disabled";
2415 if (CMD_CTX->current_target == target->target_number)
2418 /* keep columns lined up to match the headers above */
2419 command_print(CMD_CTX,
2420 "%2d%c %-18s %-10s %-6s %-18s %s",
2421 target->target_number,
2423 target_name(target),
2424 target_type_name(target),
2425 Jim_Nvp_value2name_simple(nvp_target_endian,
2426 target->endianness)->name,
2427 target->tap->dotted_name,
2429 target = target->next;
2435 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2437 static int powerDropout;
2438 static int srstAsserted;
2440 static int runPowerRestore;
2441 static int runPowerDropout;
2442 static int runSrstAsserted;
2443 static int runSrstDeasserted;
2445 static int sense_handler(void)
2447 static int prevSrstAsserted;
2448 static int prevPowerdropout;
2450 int retval = jtag_power_dropout(&powerDropout);
2451 if (retval != ERROR_OK)
2455 powerRestored = prevPowerdropout && !powerDropout;
2457 runPowerRestore = 1;
2459 int64_t current = timeval_ms();
2460 static int64_t lastPower;
2461 bool waitMore = lastPower + 2000 > current;
2462 if (powerDropout && !waitMore) {
2463 runPowerDropout = 1;
2464 lastPower = current;
2467 retval = jtag_srst_asserted(&srstAsserted);
2468 if (retval != ERROR_OK)
2472 srstDeasserted = prevSrstAsserted && !srstAsserted;
2474 static int64_t lastSrst;
2475 waitMore = lastSrst + 2000 > current;
2476 if (srstDeasserted && !waitMore) {
2477 runSrstDeasserted = 1;
2481 if (!prevSrstAsserted && srstAsserted)
2482 runSrstAsserted = 1;
2484 prevSrstAsserted = srstAsserted;
2485 prevPowerdropout = powerDropout;
2487 if (srstDeasserted || powerRestored) {
2488 /* Other than logging the event we can't do anything here.
2489 * Issuing a reset is a particularly bad idea as we might
2490 * be inside a reset already.
2497 /* process target state changes */
2498 static int handle_target(void *priv)
2500 Jim_Interp *interp = (Jim_Interp *)priv;
2501 int retval = ERROR_OK;
2503 if (!is_jtag_poll_safe()) {
2504 /* polling is disabled currently */
2508 /* we do not want to recurse here... */
2509 static int recursive;
2513 /* danger! running these procedures can trigger srst assertions and power dropouts.
2514 * We need to avoid an infinite loop/recursion here and we do that by
2515 * clearing the flags after running these events.
2517 int did_something = 0;
2518 if (runSrstAsserted) {
2519 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2520 Jim_Eval(interp, "srst_asserted");
2523 if (runSrstDeasserted) {
2524 Jim_Eval(interp, "srst_deasserted");
2527 if (runPowerDropout) {
2528 LOG_INFO("Power dropout detected, running power_dropout proc.");
2529 Jim_Eval(interp, "power_dropout");
2532 if (runPowerRestore) {
2533 Jim_Eval(interp, "power_restore");
2537 if (did_something) {
2538 /* clear detect flags */
2542 /* clear action flags */
2544 runSrstAsserted = 0;
2545 runSrstDeasserted = 0;
2546 runPowerRestore = 0;
2547 runPowerDropout = 0;
2552 /* Poll targets for state changes unless that's globally disabled.
2553 * Skip targets that are currently disabled.
2555 for (struct target *target = all_targets;
2556 is_jtag_poll_safe() && target;
2557 target = target->next) {
2559 if (!target_was_examined(target))
2562 if (!target->tap->enabled)
2565 if (target->backoff.times > target->backoff.count) {
2566 /* do not poll this time as we failed previously */
2567 target->backoff.count++;
2570 target->backoff.count = 0;
2572 /* only poll target if we've got power and srst isn't asserted */
2573 if (!powerDropout && !srstAsserted) {
2574 /* polling may fail silently until the target has been examined */
2575 retval = target_poll(target);
2576 if (retval != ERROR_OK) {
2577 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2578 if (target->backoff.times * polling_interval < 5000) {
2579 target->backoff.times *= 2;
2580 target->backoff.times++;
2583 /* Tell GDB to halt the debugger. This allows the user to
2584 * run monitor commands to handle the situation.
2586 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2588 if (target->backoff.times > 0) {
2589 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target));
2590 target_reset_examined(target);
2591 retval = target_examine_one(target);
2592 /* Target examination could have failed due to unstable connection,
2593 * but we set the examined flag anyway to repoll it later */
2594 if (retval != ERROR_OK) {
2595 target->examined = true;
2596 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2597 target->backoff.times * polling_interval);
2602 /* Since we succeeded, we reset backoff count */
2603 target->backoff.times = 0;
2610 COMMAND_HANDLER(handle_reg_command)
2612 struct target *target;
2613 struct reg *reg = NULL;
2619 target = get_current_target(CMD_CTX);
2621 /* list all available registers for the current target */
2622 if (CMD_ARGC == 0) {
2623 struct reg_cache *cache = target->reg_cache;
2629 command_print(CMD_CTX, "===== %s", cache->name);
2631 for (i = 0, reg = cache->reg_list;
2632 i < cache->num_regs;
2633 i++, reg++, count++) {
2634 /* only print cached values if they are valid */
2636 value = buf_to_str(reg->value,
2638 command_print(CMD_CTX,
2639 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2647 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2652 cache = cache->next;
2658 /* access a single register by its ordinal number */
2659 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2661 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2663 struct reg_cache *cache = target->reg_cache;
2667 for (i = 0; i < cache->num_regs; i++) {
2668 if (count++ == num) {
2669 reg = &cache->reg_list[i];
2675 cache = cache->next;
2679 command_print(CMD_CTX, "%i is out of bounds, the current target "
2680 "has only %i registers (0 - %i)", num, count, count - 1);
2684 /* access a single register by its name */
2685 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2688 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2693 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2695 /* display a register */
2696 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2697 && (CMD_ARGV[1][0] <= '9')))) {
2698 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2701 if (reg->valid == 0)
2702 reg->type->get(reg);
2703 value = buf_to_str(reg->value, reg->size, 16);
2704 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2709 /* set register value */
2710 if (CMD_ARGC == 2) {
2711 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2714 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2716 reg->type->set(reg, buf);
2718 value = buf_to_str(reg->value, reg->size, 16);
2719 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2727 return ERROR_COMMAND_SYNTAX_ERROR;
2730 COMMAND_HANDLER(handle_poll_command)
2732 int retval = ERROR_OK;
2733 struct target *target = get_current_target(CMD_CTX);
2735 if (CMD_ARGC == 0) {
2736 command_print(CMD_CTX, "background polling: %s",
2737 jtag_poll_get_enabled() ? "on" : "off");
2738 command_print(CMD_CTX, "TAP: %s (%s)",
2739 target->tap->dotted_name,
2740 target->tap->enabled ? "enabled" : "disabled");
2741 if (!target->tap->enabled)
2743 retval = target_poll(target);
2744 if (retval != ERROR_OK)
2746 retval = target_arch_state(target);
2747 if (retval != ERROR_OK)
2749 } else if (CMD_ARGC == 1) {
2751 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2752 jtag_poll_set_enabled(enable);
2754 return ERROR_COMMAND_SYNTAX_ERROR;
2759 COMMAND_HANDLER(handle_wait_halt_command)
2762 return ERROR_COMMAND_SYNTAX_ERROR;
2764 unsigned ms = DEFAULT_HALT_TIMEOUT;
2765 if (1 == CMD_ARGC) {
2766 int retval = parse_uint(CMD_ARGV[0], &ms);
2767 if (ERROR_OK != retval)
2768 return ERROR_COMMAND_SYNTAX_ERROR;
2771 struct target *target = get_current_target(CMD_CTX);
2772 return target_wait_state(target, TARGET_HALTED, ms);
2775 /* wait for target state to change. The trick here is to have a low
2776 * latency for short waits and not to suck up all the CPU time
2779 * After 500ms, keep_alive() is invoked
2781 int target_wait_state(struct target *target, enum target_state state, int ms)
2784 int64_t then = 0, cur;
2788 retval = target_poll(target);
2789 if (retval != ERROR_OK)
2791 if (target->state == state)
2796 then = timeval_ms();
2797 LOG_DEBUG("waiting for target %s...",
2798 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2804 if ((cur-then) > ms) {
2805 LOG_ERROR("timed out while waiting for target %s",
2806 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2814 COMMAND_HANDLER(handle_halt_command)
2818 struct target *target = get_current_target(CMD_CTX);
2819 int retval = target_halt(target);
2820 if (ERROR_OK != retval)
2823 if (CMD_ARGC == 1) {
2824 unsigned wait_local;
2825 retval = parse_uint(CMD_ARGV[0], &wait_local);
2826 if (ERROR_OK != retval)
2827 return ERROR_COMMAND_SYNTAX_ERROR;
2832 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
2835 COMMAND_HANDLER(handle_soft_reset_halt_command)
2837 struct target *target = get_current_target(CMD_CTX);
2839 LOG_USER("requesting target halt and executing a soft reset");
2841 target_soft_reset_halt(target);
2846 COMMAND_HANDLER(handle_reset_command)
2849 return ERROR_COMMAND_SYNTAX_ERROR;
2851 enum target_reset_mode reset_mode = RESET_RUN;
2852 if (CMD_ARGC == 1) {
2854 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
2855 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
2856 return ERROR_COMMAND_SYNTAX_ERROR;
2857 reset_mode = n->value;
2860 /* reset *all* targets */
2861 return target_process_reset(CMD_CTX, reset_mode);
2865 COMMAND_HANDLER(handle_resume_command)
2869 return ERROR_COMMAND_SYNTAX_ERROR;
2871 struct target *target = get_current_target(CMD_CTX);
2873 /* with no CMD_ARGV, resume from current pc, addr = 0,
2874 * with one arguments, addr = CMD_ARGV[0],
2875 * handle breakpoints, not debugging */
2877 if (CMD_ARGC == 1) {
2878 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2882 return target_resume(target, current, addr, 1, 0);
2885 COMMAND_HANDLER(handle_step_command)
2888 return ERROR_COMMAND_SYNTAX_ERROR;
2892 /* with no CMD_ARGV, step from current pc, addr = 0,
2893 * with one argument addr = CMD_ARGV[0],
2894 * handle breakpoints, debugging */
2897 if (CMD_ARGC == 1) {
2898 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2902 struct target *target = get_current_target(CMD_CTX);
2904 return target->type->step(target, current_pc, addr, 1);
2907 static void handle_md_output(struct command_context *cmd_ctx,
2908 struct target *target, uint32_t address, unsigned size,
2909 unsigned count, const uint8_t *buffer)
2911 const unsigned line_bytecnt = 32;
2912 unsigned line_modulo = line_bytecnt / size;
2914 char output[line_bytecnt * 4 + 1];
2915 unsigned output_len = 0;
2917 const char *value_fmt;
2920 value_fmt = "%8.8x ";
2923 value_fmt = "%4.4x ";
2926 value_fmt = "%2.2x ";
2929 /* "can't happen", caller checked */
2930 LOG_ERROR("invalid memory read size: %u", size);
2934 for (unsigned i = 0; i < count; i++) {
2935 if (i % line_modulo == 0) {
2936 output_len += snprintf(output + output_len,
2937 sizeof(output) - output_len,
2939 (unsigned)(address + (i*size)));
2943 const uint8_t *value_ptr = buffer + i * size;
2946 value = target_buffer_get_u32(target, value_ptr);
2949 value = target_buffer_get_u16(target, value_ptr);
2954 output_len += snprintf(output + output_len,
2955 sizeof(output) - output_len,
2958 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
2959 command_print(cmd_ctx, "%s", output);
2965 COMMAND_HANDLER(handle_md_command)
2968 return ERROR_COMMAND_SYNTAX_ERROR;
2971 switch (CMD_NAME[2]) {
2982 return ERROR_COMMAND_SYNTAX_ERROR;
2985 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2986 int (*fn)(struct target *target,
2987 uint32_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
2991 fn = target_read_phys_memory;
2993 fn = target_read_memory;
2994 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
2995 return ERROR_COMMAND_SYNTAX_ERROR;
2998 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
3002 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
3004 uint8_t *buffer = calloc(count, size);
3006 struct target *target = get_current_target(CMD_CTX);
3007 int retval = fn(target, address, size, count, buffer);
3008 if (ERROR_OK == retval)
3009 handle_md_output(CMD_CTX, target, address, size, count, buffer);
3016 typedef int (*target_write_fn)(struct target *target,
3017 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
3019 static int target_fill_mem(struct target *target,
3028 /* We have to write in reasonably large chunks to be able
3029 * to fill large memory areas with any sane speed */
3030 const unsigned chunk_size = 16384;
3031 uint8_t *target_buf = malloc(chunk_size * data_size);
3032 if (target_buf == NULL) {
3033 LOG_ERROR("Out of memory");
3037 for (unsigned i = 0; i < chunk_size; i++) {
3038 switch (data_size) {
3040 target_buffer_set_u32(target, target_buf + i * data_size, b);
3043 target_buffer_set_u16(target, target_buf + i * data_size, b);
3046 target_buffer_set_u8(target, target_buf + i * data_size, b);
3053 int retval = ERROR_OK;
3055 for (unsigned x = 0; x < c; x += chunk_size) {
3058 if (current > chunk_size)
3059 current = chunk_size;
3060 retval = fn(target, address + x * data_size, data_size, current, target_buf);
3061 if (retval != ERROR_OK)
3063 /* avoid GDB timeouts */
3072 COMMAND_HANDLER(handle_mw_command)
3075 return ERROR_COMMAND_SYNTAX_ERROR;
3076 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
3081 fn = target_write_phys_memory;
3083 fn = target_write_memory;
3084 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
3085 return ERROR_COMMAND_SYNTAX_ERROR;
3088 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
3091 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
3095 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
3097 struct target *target = get_current_target(CMD_CTX);
3099 switch (CMD_NAME[2]) {
3110 return ERROR_COMMAND_SYNTAX_ERROR;
3113 return target_fill_mem(target, address, fn, wordsize, value, count);
3116 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
3117 uint32_t *min_address, uint32_t *max_address)
3119 if (CMD_ARGC < 1 || CMD_ARGC > 5)
3120 return ERROR_COMMAND_SYNTAX_ERROR;
3122 /* a base address isn't always necessary,
3123 * default to 0x0 (i.e. don't relocate) */
3124 if (CMD_ARGC >= 2) {
3126 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
3127 image->base_address = addr;
3128 image->base_address_set = 1;
3130 image->base_address_set = 0;
3132 image->start_address_set = 0;
3135 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], *min_address);
3136 if (CMD_ARGC == 5) {
3137 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], *max_address);
3138 /* use size (given) to find max (required) */
3139 *max_address += *min_address;
3142 if (*min_address > *max_address)
3143 return ERROR_COMMAND_SYNTAX_ERROR;
3148 COMMAND_HANDLER(handle_load_image_command)
3152 uint32_t image_size;
3153 uint32_t min_address = 0;
3154 uint32_t max_address = 0xffffffff;
3158 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
3159 &image, &min_address, &max_address);
3160 if (ERROR_OK != retval)
3163 struct target *target = get_current_target(CMD_CTX);
3165 struct duration bench;
3166 duration_start(&bench);
3168 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
3173 for (i = 0; i < image.num_sections; i++) {
3174 buffer = malloc(image.sections[i].size);
3175 if (buffer == NULL) {
3176 command_print(CMD_CTX,
3177 "error allocating buffer for section (%d bytes)",
3178 (int)(image.sections[i].size));
3182 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3183 if (retval != ERROR_OK) {
3188 uint32_t offset = 0;
3189 uint32_t length = buf_cnt;
3191 /* DANGER!!! beware of unsigned comparision here!!! */
3193 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
3194 (image.sections[i].base_address < max_address)) {
3196 if (image.sections[i].base_address < min_address) {
3197 /* clip addresses below */
3198 offset += min_address-image.sections[i].base_address;
3202 if (image.sections[i].base_address + buf_cnt > max_address)
3203 length -= (image.sections[i].base_address + buf_cnt)-max_address;
3205 retval = target_write_buffer(target,
3206 image.sections[i].base_address + offset, length, buffer + offset);
3207 if (retval != ERROR_OK) {
3211 image_size += length;
3212 command_print(CMD_CTX, "%u bytes written at address 0x%8.8" PRIx32 "",
3213 (unsigned int)length,
3214 image.sections[i].base_address + offset);
3220 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3221 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
3222 "in %fs (%0.3f KiB/s)", image_size,
3223 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3226 image_close(&image);
3232 COMMAND_HANDLER(handle_dump_image_command)
3234 struct fileio *fileio;
3236 int retval, retvaltemp;
3237 uint32_t address, size;
3238 struct duration bench;
3239 struct target *target = get_current_target(CMD_CTX);
3242 return ERROR_COMMAND_SYNTAX_ERROR;
3244 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], address);
3245 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], size);
3247 uint32_t buf_size = (size > 4096) ? 4096 : size;
3248 buffer = malloc(buf_size);
3252 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
3253 if (retval != ERROR_OK) {
3258 duration_start(&bench);
3261 size_t size_written;
3262 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
3263 retval = target_read_buffer(target, address, this_run_size, buffer);
3264 if (retval != ERROR_OK)
3267 retval = fileio_write(fileio, this_run_size, buffer, &size_written);
3268 if (retval != ERROR_OK)
3271 size -= this_run_size;
3272 address += this_run_size;
3277 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3279 retval = fileio_size(fileio, &filesize);
3280 if (retval != ERROR_OK)
3282 command_print(CMD_CTX,
3283 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize,
3284 duration_elapsed(&bench), duration_kbps(&bench, filesize));
3287 retvaltemp = fileio_close(fileio);
3288 if (retvaltemp != ERROR_OK)
3294 static COMMAND_HELPER(handle_verify_image_command_internal, int verify)
3298 uint32_t image_size;
3301 uint32_t checksum = 0;
3302 uint32_t mem_checksum = 0;
3306 struct target *target = get_current_target(CMD_CTX);
3309 return ERROR_COMMAND_SYNTAX_ERROR;
3312 LOG_ERROR("no target selected");
3316 struct duration bench;
3317 duration_start(&bench);
3319 if (CMD_ARGC >= 2) {
3321 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
3322 image.base_address = addr;
3323 image.base_address_set = 1;
3325 image.base_address_set = 0;
3326 image.base_address = 0x0;
3329 image.start_address_set = 0;
3331 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
3332 if (retval != ERROR_OK)
3338 for (i = 0; i < image.num_sections; i++) {
3339 buffer = malloc(image.sections[i].size);
3340 if (buffer == NULL) {
3341 command_print(CMD_CTX,
3342 "error allocating buffer for section (%d bytes)",
3343 (int)(image.sections[i].size));
3346 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3347 if (retval != ERROR_OK) {
3353 /* calculate checksum of image */
3354 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3355 if (retval != ERROR_OK) {
3360 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3361 if (retval != ERROR_OK) {
3366 if (checksum != mem_checksum) {
3367 /* failed crc checksum, fall back to a binary compare */
3371 LOG_ERROR("checksum mismatch - attempting binary compare");
3373 data = malloc(buf_cnt);
3375 /* Can we use 32bit word accesses? */
3377 int count = buf_cnt;
3378 if ((count % 4) == 0) {
3382 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3383 if (retval == ERROR_OK) {
3385 for (t = 0; t < buf_cnt; t++) {
3386 if (data[t] != buffer[t]) {
3387 command_print(CMD_CTX,
3388 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3390 (unsigned)(t + image.sections[i].base_address),
3393 if (diffs++ >= 127) {
3394 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3406 command_print(CMD_CTX, "address 0x%08" PRIx32 " length 0x%08zx",
3407 image.sections[i].base_address,
3412 image_size += buf_cnt;
3415 command_print(CMD_CTX, "No more differences found.");
3418 retval = ERROR_FAIL;
3419 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3420 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3421 "in %fs (%0.3f KiB/s)", image_size,
3422 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3425 image_close(&image);
3430 COMMAND_HANDLER(handle_verify_image_command)
3432 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 1);
3435 COMMAND_HANDLER(handle_test_image_command)
3437 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 0);
3440 static int handle_bp_command_list(struct command_context *cmd_ctx)
3442 struct target *target = get_current_target(cmd_ctx);
3443 struct breakpoint *breakpoint = target->breakpoints;
3444 while (breakpoint) {
3445 if (breakpoint->type == BKPT_SOFT) {
3446 char *buf = buf_to_str(breakpoint->orig_instr,
3447 breakpoint->length, 16);
3448 command_print(cmd_ctx, "IVA breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i, 0x%s",
3449 breakpoint->address,
3451 breakpoint->set, buf);
3454 if ((breakpoint->address == 0) && (breakpoint->asid != 0))
3455 command_print(cmd_ctx, "Context breakpoint: 0x%8.8" PRIx32 ", 0x%x, %i",
3457 breakpoint->length, breakpoint->set);
3458 else if ((breakpoint->address != 0) && (breakpoint->asid != 0)) {
3459 command_print(cmd_ctx, "Hybrid breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3460 breakpoint->address,
3461 breakpoint->length, breakpoint->set);
3462 command_print(cmd_ctx, "\t|--->linked with ContextID: 0x%8.8" PRIx32,
3465 command_print(cmd_ctx, "Breakpoint(IVA): 0x%8.8" PRIx32 ", 0x%x, %i",
3466 breakpoint->address,
3467 breakpoint->length, breakpoint->set);
3470 breakpoint = breakpoint->next;
3475 static int handle_bp_command_set(struct command_context *cmd_ctx,
3476 uint32_t addr, uint32_t asid, uint32_t length, int hw)
3478 struct target *target = get_current_target(cmd_ctx);
3482 retval = breakpoint_add(target, addr, length, hw);
3483 if (ERROR_OK == retval)
3484 command_print(cmd_ctx, "breakpoint set at 0x%8.8" PRIx32 "", addr);
3486 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3489 } else if (addr == 0) {
3490 if (target->type->add_context_breakpoint == NULL) {
3491 LOG_WARNING("Context breakpoint not available");
3494 retval = context_breakpoint_add(target, asid, length, hw);
3495 if (ERROR_OK == retval)
3496 command_print(cmd_ctx, "Context breakpoint set at 0x%8.8" PRIx32 "", asid);
3498 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3502 if (target->type->add_hybrid_breakpoint == NULL) {
3503 LOG_WARNING("Hybrid breakpoint not available");
3506 retval = hybrid_breakpoint_add(target, addr, asid, length, hw);
3507 if (ERROR_OK == retval)
3508 command_print(cmd_ctx, "Hybrid breakpoint set at 0x%8.8" PRIx32 "", asid);
3510 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3517 COMMAND_HANDLER(handle_bp_command)
3526 return handle_bp_command_list(CMD_CTX);
3530 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3531 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3532 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3535 if (strcmp(CMD_ARGV[2], "hw") == 0) {
3537 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3539 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3542 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3543 } else if (strcmp(CMD_ARGV[2], "hw_ctx") == 0) {
3545 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], asid);
3546 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3548 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3553 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3554 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], asid);
3555 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], length);
3556 return handle_bp_command_set(CMD_CTX, addr, asid, length, hw);
3559 return ERROR_COMMAND_SYNTAX_ERROR;
3563 COMMAND_HANDLER(handle_rbp_command)
3566 return ERROR_COMMAND_SYNTAX_ERROR;
3569 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3571 struct target *target = get_current_target(CMD_CTX);
3572 breakpoint_remove(target, addr);
3577 COMMAND_HANDLER(handle_wp_command)
3579 struct target *target = get_current_target(CMD_CTX);
3581 if (CMD_ARGC == 0) {
3582 struct watchpoint *watchpoint = target->watchpoints;
3584 while (watchpoint) {
3585 command_print(CMD_CTX, "address: 0x%8.8" PRIx32
3586 ", len: 0x%8.8" PRIx32
3587 ", r/w/a: %i, value: 0x%8.8" PRIx32
3588 ", mask: 0x%8.8" PRIx32,
3589 watchpoint->address,
3591 (int)watchpoint->rw,
3594 watchpoint = watchpoint->next;
3599 enum watchpoint_rw type = WPT_ACCESS;
3601 uint32_t length = 0;
3602 uint32_t data_value = 0x0;
3603 uint32_t data_mask = 0xffffffff;
3607 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], data_mask);
3610 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], data_value);
3613 switch (CMD_ARGV[2][0]) {
3624 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV[2][0]);
3625 return ERROR_COMMAND_SYNTAX_ERROR;
3629 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
3630 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3634 return ERROR_COMMAND_SYNTAX_ERROR;
3637 int retval = watchpoint_add(target, addr, length, type,
3638 data_value, data_mask);
3639 if (ERROR_OK != retval)
3640 LOG_ERROR("Failure setting watchpoints");
3645 COMMAND_HANDLER(handle_rwp_command)
3648 return ERROR_COMMAND_SYNTAX_ERROR;
3651 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
3653 struct target *target = get_current_target(CMD_CTX);
3654 watchpoint_remove(target, addr);
3660 * Translate a virtual address to a physical address.
3662 * The low-level target implementation must have logged a detailed error
3663 * which is forwarded to telnet/GDB session.
3665 COMMAND_HANDLER(handle_virt2phys_command)
3668 return ERROR_COMMAND_SYNTAX_ERROR;
3671 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], va);
3674 struct target *target = get_current_target(CMD_CTX);
3675 int retval = target->type->virt2phys(target, va, &pa);
3676 if (retval == ERROR_OK)
3677 command_print(CMD_CTX, "Physical address 0x%08" PRIx32 "", pa);
3682 static void writeData(FILE *f, const void *data, size_t len)
3684 size_t written = fwrite(data, 1, len, f);
3686 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3689 static void writeLong(FILE *f, int l, struct target *target)
3693 target_buffer_set_u32(target, val, l);
3694 writeData(f, val, 4);
3697 static void writeString(FILE *f, char *s)
3699 writeData(f, s, strlen(s));
3702 typedef unsigned char UNIT[2]; /* unit of profiling */
3704 /* Dump a gmon.out histogram file. */
3705 static void write_gmon(uint32_t *samples, uint32_t sampleNum, const char *filename, bool with_range,
3706 uint32_t start_address, uint32_t end_address, struct target *target)
3709 FILE *f = fopen(filename, "w");
3712 writeString(f, "gmon");
3713 writeLong(f, 0x00000001, target); /* Version */
3714 writeLong(f, 0, target); /* padding */
3715 writeLong(f, 0, target); /* padding */
3716 writeLong(f, 0, target); /* padding */
3718 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3719 writeData(f, &zero, 1);
3721 /* figure out bucket size */
3725 min = start_address;
3730 for (i = 0; i < sampleNum; i++) {
3731 if (min > samples[i])
3733 if (max < samples[i])
3737 /* max should be (largest sample + 1)
3738 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
3742 int addressSpace = max - min;
3743 assert(addressSpace >= 2);
3745 /* FIXME: What is the reasonable number of buckets?
3746 * The profiling result will be more accurate if there are enough buckets. */
3747 static const uint32_t maxBuckets = 128 * 1024; /* maximum buckets. */
3748 uint32_t numBuckets = addressSpace / sizeof(UNIT);
3749 if (numBuckets > maxBuckets)
3750 numBuckets = maxBuckets;
3751 int *buckets = malloc(sizeof(int) * numBuckets);
3752 if (buckets == NULL) {
3756 memset(buckets, 0, sizeof(int) * numBuckets);
3757 for (i = 0; i < sampleNum; i++) {
3758 uint32_t address = samples[i];
3760 if ((address < min) || (max <= address))
3763 long long a = address - min;
3764 long long b = numBuckets;
3765 long long c = addressSpace;
3766 int index_t = (a * b) / c; /* danger!!!! int32 overflows */
3770 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3771 writeLong(f, min, target); /* low_pc */
3772 writeLong(f, max, target); /* high_pc */
3773 writeLong(f, numBuckets, target); /* # of buckets */
3774 writeLong(f, 100, target); /* KLUDGE! We lie, ca. 100Hz best case. */
3775 writeString(f, "seconds");
3776 for (i = 0; i < (15-strlen("seconds")); i++)
3777 writeData(f, &zero, 1);
3778 writeString(f, "s");
3780 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3782 char *data = malloc(2 * numBuckets);
3784 for (i = 0; i < numBuckets; i++) {
3789 data[i * 2] = val&0xff;
3790 data[i * 2 + 1] = (val >> 8) & 0xff;
3793 writeData(f, data, numBuckets * 2);
3801 /* profiling samples the CPU PC as quickly as OpenOCD is able,
3802 * which will be used as a random sampling of PC */
3803 COMMAND_HANDLER(handle_profile_command)
3805 struct target *target = get_current_target(CMD_CTX);
3807 if ((CMD_ARGC != 2) && (CMD_ARGC != 4))
3808 return ERROR_COMMAND_SYNTAX_ERROR;
3810 const uint32_t MAX_PROFILE_SAMPLE_NUM = 10000;
3812 uint32_t num_of_samples;
3813 int retval = ERROR_OK;
3815 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], offset);
3817 uint32_t *samples = malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM);
3818 if (samples == NULL) {
3819 LOG_ERROR("No memory to store samples.");
3824 * Some cores let us sample the PC without the
3825 * annoying halt/resume step; for example, ARMv7 PCSR.
3826 * Provide a way to use that more efficient mechanism.
3828 retval = target_profiling(target, samples, MAX_PROFILE_SAMPLE_NUM,
3829 &num_of_samples, offset);
3830 if (retval != ERROR_OK) {
3835 assert(num_of_samples <= MAX_PROFILE_SAMPLE_NUM);
3837 retval = target_poll(target);
3838 if (retval != ERROR_OK) {
3842 if (target->state == TARGET_RUNNING) {
3843 retval = target_halt(target);
3844 if (retval != ERROR_OK) {
3850 retval = target_poll(target);
3851 if (retval != ERROR_OK) {
3856 uint32_t start_address = 0;
3857 uint32_t end_address = 0;
3858 bool with_range = false;
3859 if (CMD_ARGC == 4) {
3861 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], start_address);
3862 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], end_address);
3865 write_gmon(samples, num_of_samples, CMD_ARGV[1],
3866 with_range, start_address, end_address, target);
3867 command_print(CMD_CTX, "Wrote %s", CMD_ARGV[1]);
3873 static int new_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t val)
3876 Jim_Obj *nameObjPtr, *valObjPtr;
3879 namebuf = alloc_printf("%s(%d)", varname, idx);
3883 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3884 valObjPtr = Jim_NewIntObj(interp, val);
3885 if (!nameObjPtr || !valObjPtr) {
3890 Jim_IncrRefCount(nameObjPtr);
3891 Jim_IncrRefCount(valObjPtr);
3892 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3893 Jim_DecrRefCount(interp, nameObjPtr);
3894 Jim_DecrRefCount(interp, valObjPtr);
3896 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
3900 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3902 struct command_context *context;
3903 struct target *target;
3905 context = current_command_context(interp);
3906 assert(context != NULL);
3908 target = get_current_target(context);
3909 if (target == NULL) {
3910 LOG_ERROR("mem2array: no current target");
3914 return target_mem2array(interp, target, argc - 1, argv + 1);
3917 static int target_mem2array(Jim_Interp *interp, struct target *target, int argc, Jim_Obj *const *argv)
3925 const char *varname;
3931 /* argv[1] = name of array to receive the data
3932 * argv[2] = desired width
3933 * argv[3] = memory address
3934 * argv[4] = count of times to read
3936 if (argc < 4 || argc > 5) {
3937 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems [phys]");
3940 varname = Jim_GetString(argv[0], &len);
3941 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3943 e = Jim_GetLong(interp, argv[1], &l);
3948 e = Jim_GetLong(interp, argv[2], &l);
3952 e = Jim_GetLong(interp, argv[3], &l);
3958 phys = Jim_GetString(argv[4], &n);
3959 if (!strncmp(phys, "phys", n))
3975 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3976 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3980 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3981 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
3984 if ((addr + (len * width)) < addr) {
3985 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3986 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
3989 /* absurd transfer size? */
3991 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3992 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
3997 ((width == 2) && ((addr & 1) == 0)) ||
3998 ((width == 4) && ((addr & 3) == 0))) {
4002 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4003 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4006 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4015 size_t buffersize = 4096;
4016 uint8_t *buffer = malloc(buffersize);
4023 /* Slurp... in buffer size chunks */
4025 count = len; /* in objects.. */
4026 if (count > (buffersize / width))
4027 count = (buffersize / width);
4030 retval = target_read_phys_memory(target, addr, width, count, buffer);
4032 retval = target_read_memory(target, addr, width, count, buffer);
4033 if (retval != ERROR_OK) {
4035 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4039 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4040 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
4044 v = 0; /* shut up gcc */
4045 for (i = 0; i < count ; i++, n++) {
4048 v = target_buffer_get_u32(target, &buffer[i*width]);
4051 v = target_buffer_get_u16(target, &buffer[i*width]);
4054 v = buffer[i] & 0x0ff;
4057 new_int_array_element(interp, varname, n, v);
4060 addr += count * width;
4066 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4071 static int get_int_array_element(Jim_Interp *interp, const char *varname, int idx, uint32_t *val)
4074 Jim_Obj *nameObjPtr, *valObjPtr;
4078 namebuf = alloc_printf("%s(%d)", varname, idx);
4082 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
4088 Jim_IncrRefCount(nameObjPtr);
4089 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
4090 Jim_DecrRefCount(interp, nameObjPtr);
4092 if (valObjPtr == NULL)
4095 result = Jim_GetLong(interp, valObjPtr, &l);
4096 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4101 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4103 struct command_context *context;
4104 struct target *target;
4106 context = current_command_context(interp);
4107 assert(context != NULL);
4109 target = get_current_target(context);
4110 if (target == NULL) {
4111 LOG_ERROR("array2mem: no current target");
4115 return target_array2mem(interp, target, argc-1, argv + 1);
4118 static int target_array2mem(Jim_Interp *interp, struct target *target,
4119 int argc, Jim_Obj *const *argv)
4127 const char *varname;
4133 /* argv[1] = name of array to get the data
4134 * argv[2] = desired width
4135 * argv[3] = memory address
4136 * argv[4] = count to write
4138 if (argc < 4 || argc > 5) {
4139 Jim_WrongNumArgs(interp, 0, argv, "varname width addr nelems [phys]");
4142 varname = Jim_GetString(argv[0], &len);
4143 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4145 e = Jim_GetLong(interp, argv[1], &l);
4150 e = Jim_GetLong(interp, argv[2], &l);
4154 e = Jim_GetLong(interp, argv[3], &l);
4160 phys = Jim_GetString(argv[4], &n);
4161 if (!strncmp(phys, "phys", n))
4177 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4178 Jim_AppendStrings(interp, Jim_GetResult(interp),
4179 "Invalid width param, must be 8/16/32", NULL);
4183 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4184 Jim_AppendStrings(interp, Jim_GetResult(interp),
4185 "array2mem: zero width read?", NULL);
4188 if ((addr + (len * width)) < addr) {
4189 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4190 Jim_AppendStrings(interp, Jim_GetResult(interp),
4191 "array2mem: addr + len - wraps to zero?", NULL);
4194 /* absurd transfer size? */
4196 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4197 Jim_AppendStrings(interp, Jim_GetResult(interp),
4198 "array2mem: absurd > 64K item request", NULL);
4203 ((width == 2) && ((addr & 1) == 0)) ||
4204 ((width == 4) && ((addr & 3) == 0))) {
4208 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4209 sprintf(buf, "array2mem address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
4212 Jim_AppendStrings(interp, Jim_GetResult(interp), buf, NULL);
4223 size_t buffersize = 4096;
4224 uint8_t *buffer = malloc(buffersize);
4229 /* Slurp... in buffer size chunks */
4231 count = len; /* in objects.. */
4232 if (count > (buffersize / width))
4233 count = (buffersize / width);
4235 v = 0; /* shut up gcc */
4236 for (i = 0; i < count; i++, n++) {
4237 get_int_array_element(interp, varname, n, &v);
4240 target_buffer_set_u32(target, &buffer[i * width], v);
4243 target_buffer_set_u16(target, &buffer[i * width], v);
4246 buffer[i] = v & 0x0ff;
4253 retval = target_write_phys_memory(target, addr, width, count, buffer);
4255 retval = target_write_memory(target, addr, width, count, buffer);
4256 if (retval != ERROR_OK) {
4258 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32 ", w=%" PRId32 ", cnt=%" PRId32 ", failed",
4262 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4263 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
4267 addr += count * width;
4272 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4277 /* FIX? should we propagate errors here rather than printing them
4280 void target_handle_event(struct target *target, enum target_event e)
4282 struct target_event_action *teap;
4284 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4285 if (teap->event == e) {
4286 LOG_DEBUG("target: (%d) %s (%s) event: %d (%s) action: %s",
4287 target->target_number,
4288 target_name(target),
4289 target_type_name(target),
4291 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
4292 Jim_GetString(teap->body, NULL));
4293 if (Jim_EvalObj(teap->interp, teap->body) != JIM_OK) {
4294 Jim_MakeErrorMessage(teap->interp);
4295 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(teap->interp), NULL));
4302 * Returns true only if the target has a handler for the specified event.
4304 bool target_has_event_action(struct target *target, enum target_event event)
4306 struct target_event_action *teap;
4308 for (teap = target->event_action; teap != NULL; teap = teap->next) {
4309 if (teap->event == event)
4315 enum target_cfg_param {
4318 TCFG_WORK_AREA_VIRT,
4319 TCFG_WORK_AREA_PHYS,
4320 TCFG_WORK_AREA_SIZE,
4321 TCFG_WORK_AREA_BACKUP,
4324 TCFG_CHAIN_POSITION,
4329 static Jim_Nvp nvp_config_opts[] = {
4330 { .name = "-type", .value = TCFG_TYPE },
4331 { .name = "-event", .value = TCFG_EVENT },
4332 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
4333 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
4334 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
4335 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
4336 { .name = "-endian" , .value = TCFG_ENDIAN },
4337 { .name = "-coreid", .value = TCFG_COREID },
4338 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
4339 { .name = "-dbgbase", .value = TCFG_DBGBASE },
4340 { .name = "-rtos", .value = TCFG_RTOS },
4341 { .name = NULL, .value = -1 }
4344 static int target_configure(Jim_GetOptInfo *goi, struct target *target)
4351 /* parse config or cget options ... */
4352 while (goi->argc > 0) {
4353 Jim_SetEmptyResult(goi->interp);
4354 /* Jim_GetOpt_Debug(goi); */
4356 if (target->type->target_jim_configure) {
4357 /* target defines a configure function */
4358 /* target gets first dibs on parameters */
4359 e = (*(target->type->target_jim_configure))(target, goi);
4368 /* otherwise we 'continue' below */
4370 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
4372 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
4378 if (goi->isconfigure) {
4379 Jim_SetResultFormatted(goi->interp,
4380 "not settable: %s", n->name);
4384 if (goi->argc != 0) {
4385 Jim_WrongNumArgs(goi->interp,
4386 goi->argc, goi->argv,
4391 Jim_SetResultString(goi->interp,
4392 target_type_name(target), -1);
4396 if (goi->argc == 0) {
4397 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
4401 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
4403 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
4407 if (goi->isconfigure) {
4408 if (goi->argc != 1) {
4409 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
4413 if (goi->argc != 0) {
4414 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
4420 struct target_event_action *teap;
4422 teap = target->event_action;
4423 /* replace existing? */
4425 if (teap->event == (enum target_event)n->value)
4430 if (goi->isconfigure) {
4431 bool replace = true;
4434 teap = calloc(1, sizeof(*teap));
4437 teap->event = n->value;
4438 teap->interp = goi->interp;
4439 Jim_GetOpt_Obj(goi, &o);
4441 Jim_DecrRefCount(teap->interp, teap->body);
4442 teap->body = Jim_DuplicateObj(goi->interp, o);
4445 * Tcl/TK - "tk events" have a nice feature.
4446 * See the "BIND" command.
4447 * We should support that here.
4448 * You can specify %X and %Y in the event code.
4449 * The idea is: %T - target name.
4450 * The idea is: %N - target number
4451 * The idea is: %E - event name.
4453 Jim_IncrRefCount(teap->body);
4456 /* add to head of event list */
4457 teap->next = target->event_action;
4458 target->event_action = teap;
4460 Jim_SetEmptyResult(goi->interp);
4464 Jim_SetEmptyResult(goi->interp);
4466 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
4472 case TCFG_WORK_AREA_VIRT:
4473 if (goi->isconfigure) {
4474 target_free_all_working_areas(target);
4475 e = Jim_GetOpt_Wide(goi, &w);
4478 target->working_area_virt = w;
4479 target->working_area_virt_spec = true;
4484 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
4488 case TCFG_WORK_AREA_PHYS:
4489 if (goi->isconfigure) {
4490 target_free_all_working_areas(target);
4491 e = Jim_GetOpt_Wide(goi, &w);
4494 target->working_area_phys = w;
4495 target->working_area_phys_spec = true;
4500 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
4504 case TCFG_WORK_AREA_SIZE:
4505 if (goi->isconfigure) {
4506 target_free_all_working_areas(target);
4507 e = Jim_GetOpt_Wide(goi, &w);
4510 target->working_area_size = w;
4515 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4519 case TCFG_WORK_AREA_BACKUP:
4520 if (goi->isconfigure) {
4521 target_free_all_working_areas(target);
4522 e = Jim_GetOpt_Wide(goi, &w);
4525 /* make this exactly 1 or 0 */
4526 target->backup_working_area = (!!w);
4531 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
4532 /* loop for more e*/
4537 if (goi->isconfigure) {
4538 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
4540 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
4543 target->endianness = n->value;
4548 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4549 if (n->name == NULL) {
4550 target->endianness = TARGET_LITTLE_ENDIAN;
4551 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
4553 Jim_SetResultString(goi->interp, n->name, -1);
4558 if (goi->isconfigure) {
4559 e = Jim_GetOpt_Wide(goi, &w);
4562 target->coreid = (int32_t)w;
4567 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->working_area_size));
4571 case TCFG_CHAIN_POSITION:
4572 if (goi->isconfigure) {
4574 struct jtag_tap *tap;
4575 target_free_all_working_areas(target);
4576 e = Jim_GetOpt_Obj(goi, &o_t);
4579 tap = jtag_tap_by_jim_obj(goi->interp, o_t);
4582 /* make this exactly 1 or 0 */
4588 Jim_SetResultString(goi->interp, target->tap->dotted_name, -1);
4589 /* loop for more e*/
4592 if (goi->isconfigure) {
4593 e = Jim_GetOpt_Wide(goi, &w);
4596 target->dbgbase = (uint32_t)w;
4597 target->dbgbase_set = true;
4602 Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, target->dbgbase));
4609 int result = rtos_create(goi, target);
4610 if (result != JIM_OK)
4616 } /* while (goi->argc) */
4619 /* done - we return */
4623 static int jim_target_configure(Jim_Interp *interp, int argc, Jim_Obj * const *argv)
4627 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4628 goi.isconfigure = !strcmp(Jim_GetString(argv[0], NULL), "configure");
4629 int need_args = 1 + goi.isconfigure;
4630 if (goi.argc < need_args) {
4631 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
4633 ? "missing: -option VALUE ..."
4634 : "missing: -option ...");
4637 struct target *target = Jim_CmdPrivData(goi.interp);
4638 return target_configure(&goi, target);
4641 static int jim_target_mw(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4643 const char *cmd_name = Jim_GetString(argv[0], NULL);
4646 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4648 if (goi.argc < 2 || goi.argc > 4) {
4649 Jim_SetResultFormatted(goi.interp,
4650 "usage: %s [phys] <address> <data> [<count>]", cmd_name);
4655 fn = target_write_memory;
4658 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4660 struct Jim_Obj *obj;
4661 e = Jim_GetOpt_Obj(&goi, &obj);
4665 fn = target_write_phys_memory;
4669 e = Jim_GetOpt_Wide(&goi, &a);
4674 e = Jim_GetOpt_Wide(&goi, &b);
4679 if (goi.argc == 1) {
4680 e = Jim_GetOpt_Wide(&goi, &c);
4685 /* all args must be consumed */
4689 struct target *target = Jim_CmdPrivData(goi.interp);
4691 if (strcasecmp(cmd_name, "mww") == 0)
4693 else if (strcasecmp(cmd_name, "mwh") == 0)
4695 else if (strcasecmp(cmd_name, "mwb") == 0)
4698 LOG_ERROR("command '%s' unknown: ", cmd_name);
4702 return (target_fill_mem(target, a, fn, data_size, b, c) == ERROR_OK) ? JIM_OK : JIM_ERR;
4706 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4708 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4709 * mdh [phys] <address> [<count>] - for 16 bit reads
4710 * mdb [phys] <address> [<count>] - for 8 bit reads
4712 * Count defaults to 1.
4714 * Calls target_read_memory or target_read_phys_memory depending on
4715 * the presence of the "phys" argument
4716 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4717 * to int representation in base16.
4718 * Also outputs read data in a human readable form using command_print
4720 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4721 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4722 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4723 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4724 * on success, with [<count>] number of elements.
4726 * In case of little endian target:
4727 * Example1: "mdw 0x00000000" returns "10123456"
4728 * Exmaple2: "mdh 0x00000000 1" returns "3456"
4729 * Example3: "mdb 0x00000000" returns "56"
4730 * Example4: "mdh 0x00000000 2" returns "3456 1012"
4731 * Example5: "mdb 0x00000000 3" returns "56 34 12"
4733 static int jim_target_md(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4735 const char *cmd_name = Jim_GetString(argv[0], NULL);
4738 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4740 if ((goi.argc < 1) || (goi.argc > 3)) {
4741 Jim_SetResultFormatted(goi.interp,
4742 "usage: %s [phys] <address> [<count>]", cmd_name);
4746 int (*fn)(struct target *target,
4747 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
4748 fn = target_read_memory;
4751 if (strcmp(Jim_GetString(argv[1], NULL), "phys") == 0) {
4753 struct Jim_Obj *obj;
4754 e = Jim_GetOpt_Obj(&goi, &obj);
4758 fn = target_read_phys_memory;
4761 /* Read address parameter */
4763 e = Jim_GetOpt_Wide(&goi, &addr);
4767 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
4769 if (goi.argc == 1) {
4770 e = Jim_GetOpt_Wide(&goi, &count);
4776 /* all args must be consumed */
4780 jim_wide dwidth = 1; /* shut up gcc */
4781 if (strcasecmp(cmd_name, "mdw") == 0)
4783 else if (strcasecmp(cmd_name, "mdh") == 0)
4785 else if (strcasecmp(cmd_name, "mdb") == 0)
4788 LOG_ERROR("command '%s' unknown: ", cmd_name);
4792 /* convert count to "bytes" */
4793 int bytes = count * dwidth;
4795 struct target *target = Jim_CmdPrivData(goi.interp);
4796 uint8_t target_buf[32];
4799 y = (bytes < 16) ? bytes : 16; /* y = min(bytes, 16); */
4801 /* Try to read out next block */
4802 e = fn(target, addr, dwidth, y / dwidth, target_buf);
4804 if (e != ERROR_OK) {
4805 Jim_SetResultFormatted(interp, "error reading target @ 0x%08lx", (long)addr);
4809 command_print_sameline(NULL, "0x%08x ", (int)(addr));
4812 for (x = 0; x < 16 && x < y; x += 4) {
4813 z = target_buffer_get_u32(target, &(target_buf[x]));
4814 command_print_sameline(NULL, "%08x ", (int)(z));
4816 for (; (x < 16) ; x += 4)
4817 command_print_sameline(NULL, " ");
4820 for (x = 0; x < 16 && x < y; x += 2) {
4821 z = target_buffer_get_u16(target, &(target_buf[x]));
4822 command_print_sameline(NULL, "%04x ", (int)(z));
4824 for (; (x < 16) ; x += 2)
4825 command_print_sameline(NULL, " ");
4829 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
4830 z = target_buffer_get_u8(target, &(target_buf[x]));
4831 command_print_sameline(NULL, "%02x ", (int)(z));
4833 for (; (x < 16) ; x += 1)
4834 command_print_sameline(NULL, " ");
4837 /* ascii-ify the bytes */
4838 for (x = 0 ; x < y ; x++) {
4839 if ((target_buf[x] >= 0x20) &&
4840 (target_buf[x] <= 0x7e)) {
4844 target_buf[x] = '.';
4849 target_buf[x] = ' ';
4854 /* print - with a newline */
4855 command_print_sameline(NULL, "%s\n", target_buf);
4863 static int jim_target_mem2array(Jim_Interp *interp,
4864 int argc, Jim_Obj *const *argv)
4866 struct target *target = Jim_CmdPrivData(interp);
4867 return target_mem2array(interp, target, argc - 1, argv + 1);
4870 static int jim_target_array2mem(Jim_Interp *interp,
4871 int argc, Jim_Obj *const *argv)
4873 struct target *target = Jim_CmdPrivData(interp);
4874 return target_array2mem(interp, target, argc - 1, argv + 1);
4877 static int jim_target_tap_disabled(Jim_Interp *interp)
4879 Jim_SetResultFormatted(interp, "[TAP is disabled]");
4883 static int jim_target_examine(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4886 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4889 struct target *target = Jim_CmdPrivData(interp);
4890 if (!target->tap->enabled)
4891 return jim_target_tap_disabled(interp);
4893 int e = target->type->examine(target);
4899 static int jim_target_halt_gdb(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4902 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4905 struct target *target = Jim_CmdPrivData(interp);
4907 if (target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT) != ERROR_OK)
4913 static int jim_target_poll(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4916 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4919 struct target *target = Jim_CmdPrivData(interp);
4920 if (!target->tap->enabled)
4921 return jim_target_tap_disabled(interp);
4924 if (!(target_was_examined(target)))
4925 e = ERROR_TARGET_NOT_EXAMINED;
4927 e = target->type->poll(target);
4933 static int jim_target_reset(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4936 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4938 if (goi.argc != 2) {
4939 Jim_WrongNumArgs(interp, 0, argv,
4940 "([tT]|[fF]|assert|deassert) BOOL");
4945 int e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
4947 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
4950 /* the halt or not param */
4952 e = Jim_GetOpt_Wide(&goi, &a);
4956 struct target *target = Jim_CmdPrivData(goi.interp);
4957 if (!target->tap->enabled)
4958 return jim_target_tap_disabled(interp);
4960 if (!target->type->assert_reset || !target->type->deassert_reset) {
4961 Jim_SetResultFormatted(interp,
4962 "No target-specific reset for %s",
4963 target_name(target));
4966 /* determine if we should halt or not. */
4967 target->reset_halt = !!a;
4968 /* When this happens - all workareas are invalid. */
4969 target_free_all_working_areas_restore(target, 0);
4972 if (n->value == NVP_ASSERT)
4973 e = target->type->assert_reset(target);
4975 e = target->type->deassert_reset(target);
4976 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4979 static int jim_target_halt(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4982 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
4985 struct target *target = Jim_CmdPrivData(interp);
4986 if (!target->tap->enabled)
4987 return jim_target_tap_disabled(interp);
4988 int e = target->type->halt(target);
4989 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4992 static int jim_target_wait_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4995 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
4997 /* params: <name> statename timeoutmsecs */
4998 if (goi.argc != 2) {
4999 const char *cmd_name = Jim_GetString(argv[0], NULL);
5000 Jim_SetResultFormatted(goi.interp,
5001 "%s <state_name> <timeout_in_msec>", cmd_name);
5006 int e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
5008 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state, 1);
5012 e = Jim_GetOpt_Wide(&goi, &a);
5015 struct target *target = Jim_CmdPrivData(interp);
5016 if (!target->tap->enabled)
5017 return jim_target_tap_disabled(interp);
5019 e = target_wait_state(target, n->value, a);
5020 if (e != ERROR_OK) {
5021 Jim_Obj *eObj = Jim_NewIntObj(interp, e);
5022 Jim_SetResultFormatted(goi.interp,
5023 "target: %s wait %s fails (%#s) %s",
5024 target_name(target), n->name,
5025 eObj, target_strerror_safe(e));
5026 Jim_FreeNewObj(interp, eObj);
5031 /* List for human, Events defined for this target.
5032 * scripts/programs should use 'name cget -event NAME'
5034 static int jim_target_event_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5036 struct command_context *cmd_ctx = current_command_context(interp);
5037 assert(cmd_ctx != NULL);
5039 struct target *target = Jim_CmdPrivData(interp);
5040 struct target_event_action *teap = target->event_action;
5041 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
5042 target->target_number,
5043 target_name(target));
5044 command_print(cmd_ctx, "%-25s | Body", "Event");
5045 command_print(cmd_ctx, "------------------------- | "
5046 "----------------------------------------");
5048 Jim_Nvp *opt = Jim_Nvp_value2name_simple(nvp_target_event, teap->event);
5049 command_print(cmd_ctx, "%-25s | %s",
5050 opt->name, Jim_GetString(teap->body, NULL));
5053 command_print(cmd_ctx, "***END***");
5056 static int jim_target_current_state(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5059 Jim_WrongNumArgs(interp, 1, argv, "[no parameters]");
5062 struct target *target = Jim_CmdPrivData(interp);
5063 Jim_SetResultString(interp, target_state_name(target), -1);
5066 static int jim_target_invoke_event(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5069 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5070 if (goi.argc != 1) {
5071 const char *cmd_name = Jim_GetString(argv[0], NULL);
5072 Jim_SetResultFormatted(goi.interp, "%s <eventname>", cmd_name);
5076 int e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
5078 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
5081 struct target *target = Jim_CmdPrivData(interp);
5082 target_handle_event(target, n->value);
5086 static const struct command_registration target_instance_command_handlers[] = {
5088 .name = "configure",
5089 .mode = COMMAND_CONFIG,
5090 .jim_handler = jim_target_configure,
5091 .help = "configure a new target for use",
5092 .usage = "[target_attribute ...]",
5096 .mode = COMMAND_ANY,
5097 .jim_handler = jim_target_configure,
5098 .help = "returns the specified target attribute",
5099 .usage = "target_attribute",
5103 .mode = COMMAND_EXEC,
5104 .jim_handler = jim_target_mw,
5105 .help = "Write 32-bit word(s) to target memory",
5106 .usage = "address data [count]",
5110 .mode = COMMAND_EXEC,
5111 .jim_handler = jim_target_mw,
5112 .help = "Write 16-bit half-word(s) to target memory",
5113 .usage = "address data [count]",
5117 .mode = COMMAND_EXEC,
5118 .jim_handler = jim_target_mw,
5119 .help = "Write byte(s) to target memory",
5120 .usage = "address data [count]",
5124 .mode = COMMAND_EXEC,
5125 .jim_handler = jim_target_md,
5126 .help = "Display target memory as 32-bit words",
5127 .usage = "address [count]",
5131 .mode = COMMAND_EXEC,
5132 .jim_handler = jim_target_md,
5133 .help = "Display target memory as 16-bit half-words",
5134 .usage = "address [count]",
5138 .mode = COMMAND_EXEC,
5139 .jim_handler = jim_target_md,
5140 .help = "Display target memory as 8-bit bytes",
5141 .usage = "address [count]",
5144 .name = "array2mem",
5145 .mode = COMMAND_EXEC,
5146 .jim_handler = jim_target_array2mem,
5147 .help = "Writes Tcl array of 8/16/32 bit numbers "
5149 .usage = "arrayname bitwidth address count",
5152 .name = "mem2array",
5153 .mode = COMMAND_EXEC,
5154 .jim_handler = jim_target_mem2array,
5155 .help = "Loads Tcl array of 8/16/32 bit numbers "
5156 "from target memory",
5157 .usage = "arrayname bitwidth address count",
5160 .name = "eventlist",
5161 .mode = COMMAND_EXEC,
5162 .jim_handler = jim_target_event_list,
5163 .help = "displays a table of events defined for this target",
5167 .mode = COMMAND_EXEC,
5168 .jim_handler = jim_target_current_state,
5169 .help = "displays the current state of this target",
5172 .name = "arp_examine",
5173 .mode = COMMAND_EXEC,
5174 .jim_handler = jim_target_examine,
5175 .help = "used internally for reset processing",
5178 .name = "arp_halt_gdb",
5179 .mode = COMMAND_EXEC,
5180 .jim_handler = jim_target_halt_gdb,
5181 .help = "used internally for reset processing to halt GDB",
5185 .mode = COMMAND_EXEC,
5186 .jim_handler = jim_target_poll,
5187 .help = "used internally for reset processing",
5190 .name = "arp_reset",
5191 .mode = COMMAND_EXEC,
5192 .jim_handler = jim_target_reset,
5193 .help = "used internally for reset processing",
5197 .mode = COMMAND_EXEC,
5198 .jim_handler = jim_target_halt,
5199 .help = "used internally for reset processing",
5202 .name = "arp_waitstate",
5203 .mode = COMMAND_EXEC,
5204 .jim_handler = jim_target_wait_state,
5205 .help = "used internally for reset processing",
5208 .name = "invoke-event",
5209 .mode = COMMAND_EXEC,
5210 .jim_handler = jim_target_invoke_event,
5211 .help = "invoke handler for specified event",
5212 .usage = "event_name",
5214 COMMAND_REGISTRATION_DONE
5217 static int target_create(Jim_GetOptInfo *goi)
5224 struct target *target;
5225 struct command_context *cmd_ctx;
5227 cmd_ctx = current_command_context(goi->interp);
5228 assert(cmd_ctx != NULL);
5230 if (goi->argc < 3) {
5231 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
5236 Jim_GetOpt_Obj(goi, &new_cmd);
5237 /* does this command exist? */
5238 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
5240 cp = Jim_GetString(new_cmd, NULL);
5241 Jim_SetResultFormatted(goi->interp, "Command/target: %s Exists", cp);
5246 e = Jim_GetOpt_String(goi, &cp, NULL);
5249 struct transport *tr = get_current_transport();
5250 if (tr->override_target) {
5251 e = tr->override_target(&cp);
5252 if (e != ERROR_OK) {
5253 LOG_ERROR("The selected transport doesn't support this target");
5256 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5258 /* now does target type exist */
5259 for (x = 0 ; target_types[x] ; x++) {
5260 if (0 == strcmp(cp, target_types[x]->name)) {
5265 /* check for deprecated name */
5266 if (target_types[x]->deprecated_name) {
5267 if (0 == strcmp(cp, target_types[x]->deprecated_name)) {
5269 LOG_WARNING("target name is deprecated use: \'%s\'", target_types[x]->name);
5274 if (target_types[x] == NULL) {
5275 Jim_SetResultFormatted(goi->interp, "Unknown target type %s, try one of ", cp);
5276 for (x = 0 ; target_types[x] ; x++) {
5277 if (target_types[x + 1]) {
5278 Jim_AppendStrings(goi->interp,
5279 Jim_GetResult(goi->interp),
5280 target_types[x]->name,
5283 Jim_AppendStrings(goi->interp,
5284 Jim_GetResult(goi->interp),
5286 target_types[x]->name, NULL);
5293 target = calloc(1, sizeof(struct target));
5294 /* set target number */
5295 target->target_number = new_target_number();
5296 cmd_ctx->current_target = target->target_number;
5298 /* allocate memory for each unique target type */
5299 target->type = calloc(1, sizeof(struct target_type));
5301 memcpy(target->type, target_types[x], sizeof(struct target_type));
5303 /* will be set by "-endian" */
5304 target->endianness = TARGET_ENDIAN_UNKNOWN;
5306 /* default to first core, override with -coreid */
5309 target->working_area = 0x0;
5310 target->working_area_size = 0x0;
5311 target->working_areas = NULL;
5312 target->backup_working_area = 0;
5314 target->state = TARGET_UNKNOWN;
5315 target->debug_reason = DBG_REASON_UNDEFINED;
5316 target->reg_cache = NULL;
5317 target->breakpoints = NULL;
5318 target->watchpoints = NULL;
5319 target->next = NULL;
5320 target->arch_info = NULL;
5322 target->display = 1;
5324 target->halt_issued = false;
5326 /* initialize trace information */
5327 target->trace_info = malloc(sizeof(struct trace));
5328 target->trace_info->num_trace_points = 0;
5329 target->trace_info->trace_points_size = 0;
5330 target->trace_info->trace_points = NULL;
5331 target->trace_info->trace_history_size = 0;
5332 target->trace_info->trace_history = NULL;
5333 target->trace_info->trace_history_pos = 0;
5334 target->trace_info->trace_history_overflowed = 0;
5336 target->dbgmsg = NULL;
5337 target->dbg_msg_enabled = 0;
5339 target->endianness = TARGET_ENDIAN_UNKNOWN;
5341 target->rtos = NULL;
5342 target->rtos_auto_detect = false;
5344 /* Do the rest as "configure" options */
5345 goi->isconfigure = 1;
5346 e = target_configure(goi, target);
5348 if (target->tap == NULL) {
5349 Jim_SetResultString(goi->interp, "-chain-position required when creating target", -1);
5359 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
5360 /* default endian to little if not specified */
5361 target->endianness = TARGET_LITTLE_ENDIAN;
5364 cp = Jim_GetString(new_cmd, NULL);
5365 target->cmd_name = strdup(cp);
5367 /* create the target specific commands */
5368 if (target->type->commands) {
5369 e = register_commands(cmd_ctx, NULL, target->type->commands);
5371 LOG_ERROR("unable to register '%s' commands", cp);
5373 if (target->type->target_create)
5374 (*(target->type->target_create))(target, goi->interp);
5376 /* append to end of list */
5378 struct target **tpp;
5379 tpp = &(all_targets);
5381 tpp = &((*tpp)->next);
5385 /* now - create the new target name command */
5386 const struct command_registration target_subcommands[] = {
5388 .chain = target_instance_command_handlers,
5391 .chain = target->type->commands,
5393 COMMAND_REGISTRATION_DONE
5395 const struct command_registration target_commands[] = {
5398 .mode = COMMAND_ANY,
5399 .help = "target command group",
5401 .chain = target_subcommands,
5403 COMMAND_REGISTRATION_DONE
5405 e = register_commands(cmd_ctx, NULL, target_commands);
5409 struct command *c = command_find_in_context(cmd_ctx, cp);
5411 command_set_handler_data(c, target);
5413 return (ERROR_OK == e) ? JIM_OK : JIM_ERR;
5416 static int jim_target_current(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5419 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5422 struct command_context *cmd_ctx = current_command_context(interp);
5423 assert(cmd_ctx != NULL);
5425 Jim_SetResultString(interp, target_name(get_current_target(cmd_ctx)), -1);
5429 static int jim_target_types(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5432 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5435 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5436 for (unsigned x = 0; NULL != target_types[x]; x++) {
5437 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5438 Jim_NewStringObj(interp, target_types[x]->name, -1));
5443 static int jim_target_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5446 Jim_WrongNumArgs(interp, 1, argv, "Too many parameters");
5449 Jim_SetResult(interp, Jim_NewListObj(interp, NULL, 0));
5450 struct target *target = all_targets;
5452 Jim_ListAppendElement(interp, Jim_GetResult(interp),
5453 Jim_NewStringObj(interp, target_name(target), -1));
5454 target = target->next;
5459 static int jim_target_smp(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5462 const char *targetname;
5464 struct target *target = (struct target *) NULL;
5465 struct target_list *head, *curr, *new;
5466 curr = (struct target_list *) NULL;
5467 head = (struct target_list *) NULL;
5470 LOG_DEBUG("%d", argc);
5471 /* argv[1] = target to associate in smp
5472 * argv[2] = target to assoicate in smp
5476 for (i = 1; i < argc; i++) {
5478 targetname = Jim_GetString(argv[i], &len);
5479 target = get_target(targetname);
5480 LOG_DEBUG("%s ", targetname);
5482 new = malloc(sizeof(struct target_list));
5483 new->target = target;
5484 new->next = (struct target_list *)NULL;
5485 if (head == (struct target_list *)NULL) {
5494 /* now parse the list of cpu and put the target in smp mode*/
5497 while (curr != (struct target_list *)NULL) {
5498 target = curr->target;
5500 target->head = head;
5504 if (target && target->rtos)
5505 retval = rtos_smp_init(head->target);
5511 static int jim_target_create(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
5514 Jim_GetOpt_Setup(&goi, interp, argc - 1, argv + 1);
5516 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv,
5517 "<name> <target_type> [<target_options> ...]");
5520 return target_create(&goi);
5523 static const struct command_registration target_subcommand_handlers[] = {
5526 .mode = COMMAND_CONFIG,
5527 .handler = handle_target_init_command,
5528 .help = "initialize targets",
5532 /* REVISIT this should be COMMAND_CONFIG ... */
5533 .mode = COMMAND_ANY,
5534 .jim_handler = jim_target_create,
5535 .usage = "name type '-chain-position' name [options ...]",
5536 .help = "Creates and selects a new target",
5540 .mode = COMMAND_ANY,
5541 .jim_handler = jim_target_current,
5542 .help = "Returns the currently selected target",
5546 .mode = COMMAND_ANY,
5547 .jim_handler = jim_target_types,
5548 .help = "Returns the available target types as "
5549 "a list of strings",
5553 .mode = COMMAND_ANY,
5554 .jim_handler = jim_target_names,
5555 .help = "Returns the names of all targets as a list of strings",
5559 .mode = COMMAND_ANY,
5560 .jim_handler = jim_target_smp,
5561 .usage = "targetname1 targetname2 ...",
5562 .help = "gather several target in a smp list"
5565 COMMAND_REGISTRATION_DONE
5575 static int fastload_num;
5576 static struct FastLoad *fastload;
5578 static void free_fastload(void)
5580 if (fastload != NULL) {
5582 for (i = 0; i < fastload_num; i++) {
5583 if (fastload[i].data)
5584 free(fastload[i].data);
5591 COMMAND_HANDLER(handle_fast_load_image_command)
5595 uint32_t image_size;
5596 uint32_t min_address = 0;
5597 uint32_t max_address = 0xffffffff;
5602 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
5603 &image, &min_address, &max_address);
5604 if (ERROR_OK != retval)
5607 struct duration bench;
5608 duration_start(&bench);
5610 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL);
5611 if (retval != ERROR_OK)
5616 fastload_num = image.num_sections;
5617 fastload = malloc(sizeof(struct FastLoad)*image.num_sections);
5618 if (fastload == NULL) {
5619 command_print(CMD_CTX, "out of memory");
5620 image_close(&image);
5623 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
5624 for (i = 0; i < image.num_sections; i++) {
5625 buffer = malloc(image.sections[i].size);
5626 if (buffer == NULL) {
5627 command_print(CMD_CTX, "error allocating buffer for section (%d bytes)",
5628 (int)(image.sections[i].size));
5629 retval = ERROR_FAIL;
5633 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
5634 if (retval != ERROR_OK) {
5639 uint32_t offset = 0;
5640 uint32_t length = buf_cnt;
5642 /* DANGER!!! beware of unsigned comparision here!!! */
5644 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
5645 (image.sections[i].base_address < max_address)) {
5646 if (image.sections[i].base_address < min_address) {
5647 /* clip addresses below */
5648 offset += min_address-image.sections[i].base_address;
5652 if (image.sections[i].base_address + buf_cnt > max_address)
5653 length -= (image.sections[i].base_address + buf_cnt)-max_address;
5655 fastload[i].address = image.sections[i].base_address + offset;
5656 fastload[i].data = malloc(length);
5657 if (fastload[i].data == NULL) {
5659 command_print(CMD_CTX, "error allocating buffer for section (%" PRIu32 " bytes)",
5661 retval = ERROR_FAIL;
5664 memcpy(fastload[i].data, buffer + offset, length);
5665 fastload[i].length = length;
5667 image_size += length;
5668 command_print(CMD_CTX, "%u bytes written at address 0x%8.8x",
5669 (unsigned int)length,
5670 ((unsigned int)(image.sections[i].base_address + offset)));
5676 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
5677 command_print(CMD_CTX, "Loaded %" PRIu32 " bytes "
5678 "in %fs (%0.3f KiB/s)", image_size,
5679 duration_elapsed(&bench), duration_kbps(&bench, image_size));
5681 command_print(CMD_CTX,
5682 "WARNING: image has not been loaded to target!"
5683 "You can issue a 'fast_load' to finish loading.");
5686 image_close(&image);
5688 if (retval != ERROR_OK)
5694 COMMAND_HANDLER(handle_fast_load_command)
5697 return ERROR_COMMAND_SYNTAX_ERROR;
5698 if (fastload == NULL) {
5699 LOG_ERROR("No image in memory");
5703 int64_t ms = timeval_ms();
5705 int retval = ERROR_OK;
5706 for (i = 0; i < fastload_num; i++) {
5707 struct target *target = get_current_target(CMD_CTX);
5708 command_print(CMD_CTX, "Write to 0x%08x, length 0x%08x",
5709 (unsigned int)(fastload[i].address),
5710 (unsigned int)(fastload[i].length));
5711 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
5712 if (retval != ERROR_OK)
5714 size += fastload[i].length;
5716 if (retval == ERROR_OK) {
5717 int64_t after = timeval_ms();
5718 command_print(CMD_CTX, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
5723 static const struct command_registration target_command_handlers[] = {
5726 .handler = handle_targets_command,
5727 .mode = COMMAND_ANY,
5728 .help = "change current default target (one parameter) "
5729 "or prints table of all targets (no parameters)",
5730 .usage = "[target]",
5734 .mode = COMMAND_CONFIG,
5735 .help = "configure target",
5737 .chain = target_subcommand_handlers,
5739 COMMAND_REGISTRATION_DONE
5742 int target_register_commands(struct command_context *cmd_ctx)
5744 return register_commands(cmd_ctx, NULL, target_command_handlers);
5747 static bool target_reset_nag = true;
5749 bool get_target_reset_nag(void)
5751 return target_reset_nag;
5754 COMMAND_HANDLER(handle_target_reset_nag)
5756 return CALL_COMMAND_HANDLER(handle_command_parse_bool,
5757 &target_reset_nag, "Nag after each reset about options to improve "
5761 COMMAND_HANDLER(handle_ps_command)
5763 struct target *target = get_current_target(CMD_CTX);
5765 if (target->state != TARGET_HALTED) {
5766 LOG_INFO("target not halted !!");
5770 if ((target->rtos) && (target->rtos->type)
5771 && (target->rtos->type->ps_command)) {
5772 display = target->rtos->type->ps_command(target);
5773 command_print(CMD_CTX, "%s", display);
5778 return ERROR_TARGET_FAILURE;
5782 static void binprint(struct command_context *cmd_ctx, const char *text, const uint8_t *buf, int size)
5785 command_print_sameline(cmd_ctx, "%s", text);
5786 for (int i = 0; i < size; i++)
5787 command_print_sameline(cmd_ctx, " %02x", buf[i]);
5788 command_print(cmd_ctx, " ");
5791 COMMAND_HANDLER(handle_test_mem_access_command)
5793 struct target *target = get_current_target(CMD_CTX);
5795 int retval = ERROR_OK;
5797 if (target->state != TARGET_HALTED) {
5798 LOG_INFO("target not halted !!");
5803 return ERROR_COMMAND_SYNTAX_ERROR;
5805 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], test_size);
5808 size_t num_bytes = test_size + 4;
5810 struct working_area *wa = NULL;
5811 retval = target_alloc_working_area(target, num_bytes, &wa);
5812 if (retval != ERROR_OK) {
5813 LOG_ERROR("Not enough working area");
5817 uint8_t *test_pattern = malloc(num_bytes);
5819 for (size_t i = 0; i < num_bytes; i++)
5820 test_pattern[i] = rand();
5822 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
5823 if (retval != ERROR_OK) {
5824 LOG_ERROR("Test pattern write failed");
5828 for (int host_offset = 0; host_offset <= 1; host_offset++) {
5829 for (int size = 1; size <= 4; size *= 2) {
5830 for (int offset = 0; offset < 4; offset++) {
5831 uint32_t count = test_size / size;
5832 size_t host_bufsiz = (count + 2) * size + host_offset;
5833 uint8_t *read_ref = malloc(host_bufsiz);
5834 uint8_t *read_buf = malloc(host_bufsiz);
5836 for (size_t i = 0; i < host_bufsiz; i++) {
5837 read_ref[i] = rand();
5838 read_buf[i] = read_ref[i];
5840 command_print_sameline(CMD_CTX,
5841 "Test read %" PRIu32 " x %d @ %d to %saligned buffer: ", count,
5842 size, offset, host_offset ? "un" : "");
5844 struct duration bench;
5845 duration_start(&bench);
5847 retval = target_read_memory(target, wa->address + offset, size, count,
5848 read_buf + size + host_offset);
5850 duration_measure(&bench);
5852 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
5853 command_print(CMD_CTX, "Unsupported alignment");
5855 } else if (retval != ERROR_OK) {
5856 command_print(CMD_CTX, "Memory read failed");
5860 /* replay on host */
5861 memcpy(read_ref + size + host_offset, test_pattern + offset, count * size);
5864 int result = memcmp(read_ref, read_buf, host_bufsiz);
5866 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
5867 duration_elapsed(&bench),
5868 duration_kbps(&bench, count * size));
5870 command_print(CMD_CTX, "Compare failed");
5871 binprint(CMD_CTX, "ref:", read_ref, host_bufsiz);
5872 binprint(CMD_CTX, "buf:", read_buf, host_bufsiz);
5885 target_free_working_area(target, wa);
5888 num_bytes = test_size + 4 + 4 + 4;
5890 retval = target_alloc_working_area(target, num_bytes, &wa);
5891 if (retval != ERROR_OK) {
5892 LOG_ERROR("Not enough working area");
5896 test_pattern = malloc(num_bytes);
5898 for (size_t i = 0; i < num_bytes; i++)
5899 test_pattern[i] = rand();
5901 for (int host_offset = 0; host_offset <= 1; host_offset++) {
5902 for (int size = 1; size <= 4; size *= 2) {
5903 for (int offset = 0; offset < 4; offset++) {
5904 uint32_t count = test_size / size;
5905 size_t host_bufsiz = count * size + host_offset;
5906 uint8_t *read_ref = malloc(num_bytes);
5907 uint8_t *read_buf = malloc(num_bytes);
5908 uint8_t *write_buf = malloc(host_bufsiz);
5910 for (size_t i = 0; i < host_bufsiz; i++)
5911 write_buf[i] = rand();
5912 command_print_sameline(CMD_CTX,
5913 "Test write %" PRIu32 " x %d @ %d from %saligned buffer: ", count,
5914 size, offset, host_offset ? "un" : "");
5916 retval = target_write_memory(target, wa->address, 1, num_bytes, test_pattern);
5917 if (retval != ERROR_OK) {
5918 command_print(CMD_CTX, "Test pattern write failed");
5922 /* replay on host */
5923 memcpy(read_ref, test_pattern, num_bytes);
5924 memcpy(read_ref + size + offset, write_buf + host_offset, count * size);
5926 struct duration bench;
5927 duration_start(&bench);
5929 retval = target_write_memory(target, wa->address + size + offset, size, count,
5930 write_buf + host_offset);
5932 duration_measure(&bench);
5934 if (retval == ERROR_TARGET_UNALIGNED_ACCESS) {
5935 command_print(CMD_CTX, "Unsupported alignment");
5937 } else if (retval != ERROR_OK) {
5938 command_print(CMD_CTX, "Memory write failed");
5943 retval = target_read_memory(target, wa->address, 1, num_bytes, read_buf);
5944 if (retval != ERROR_OK) {
5945 command_print(CMD_CTX, "Test pattern write failed");
5950 int result = memcmp(read_ref, read_buf, num_bytes);
5952 command_print(CMD_CTX, "Pass in %fs (%0.3f KiB/s)",
5953 duration_elapsed(&bench),
5954 duration_kbps(&bench, count * size));
5956 command_print(CMD_CTX, "Compare failed");
5957 binprint(CMD_CTX, "ref:", read_ref, num_bytes);
5958 binprint(CMD_CTX, "buf:", read_buf, num_bytes);
5970 target_free_working_area(target, wa);
5974 static const struct command_registration target_exec_command_handlers[] = {
5976 .name = "fast_load_image",
5977 .handler = handle_fast_load_image_command,
5978 .mode = COMMAND_ANY,
5979 .help = "Load image into server memory for later use by "
5980 "fast_load; primarily for profiling",
5981 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
5982 "[min_address [max_length]]",
5985 .name = "fast_load",
5986 .handler = handle_fast_load_command,
5987 .mode = COMMAND_EXEC,
5988 .help = "loads active fast load image to current target "
5989 "- mainly for profiling purposes",
5994 .handler = handle_profile_command,
5995 .mode = COMMAND_EXEC,
5996 .usage = "seconds filename [start end]",
5997 .help = "profiling samples the CPU PC",
5999 /** @todo don't register virt2phys() unless target supports it */
6001 .name = "virt2phys",
6002 .handler = handle_virt2phys_command,
6003 .mode = COMMAND_ANY,
6004 .help = "translate a virtual address into a physical address",
6005 .usage = "virtual_address",
6009 .handler = handle_reg_command,
6010 .mode = COMMAND_EXEC,
6011 .help = "display (reread from target with \"force\") or set a register; "
6012 "with no arguments, displays all registers and their values",
6013 .usage = "[(register_number|register_name) [(value|'force')]]",
6017 .handler = handle_poll_command,
6018 .mode = COMMAND_EXEC,
6019 .help = "poll target state; or reconfigure background polling",
6020 .usage = "['on'|'off']",
6023 .name = "wait_halt",
6024 .handler = handle_wait_halt_command,
6025 .mode = COMMAND_EXEC,
6026 .help = "wait up to the specified number of milliseconds "
6027 "(default 5000) for a previously requested halt",
6028 .usage = "[milliseconds]",
6032 .handler = handle_halt_command,
6033 .mode = COMMAND_EXEC,
6034 .help = "request target to halt, then wait up to the specified"
6035 "number of milliseconds (default 5000) for it to complete",
6036 .usage = "[milliseconds]",
6040 .handler = handle_resume_command,
6041 .mode = COMMAND_EXEC,
6042 .help = "resume target execution from current PC or address",
6043 .usage = "[address]",
6047 .handler = handle_reset_command,
6048 .mode = COMMAND_EXEC,
6049 .usage = "[run|halt|init]",
6050 .help = "Reset all targets into the specified mode."
6051 "Default reset mode is run, if not given.",
6054 .name = "soft_reset_halt",
6055 .handler = handle_soft_reset_halt_command,
6056 .mode = COMMAND_EXEC,
6058 .help = "halt the target and do a soft reset",
6062 .handler = handle_step_command,
6063 .mode = COMMAND_EXEC,
6064 .help = "step one instruction from current PC or address",
6065 .usage = "[address]",
6069 .handler = handle_md_command,
6070 .mode = COMMAND_EXEC,
6071 .help = "display memory words",
6072 .usage = "['phys'] address [count]",
6076 .handler = handle_md_command,
6077 .mode = COMMAND_EXEC,
6078 .help = "display memory half-words",
6079 .usage = "['phys'] address [count]",
6083 .handler = handle_md_command,
6084 .mode = COMMAND_EXEC,
6085 .help = "display memory bytes",
6086 .usage = "['phys'] address [count]",
6090 .handler = handle_mw_command,
6091 .mode = COMMAND_EXEC,
6092 .help = "write memory word",
6093 .usage = "['phys'] address value [count]",
6097 .handler = handle_mw_command,
6098 .mode = COMMAND_EXEC,
6099 .help = "write memory half-word",
6100 .usage = "['phys'] address value [count]",
6104 .handler = handle_mw_command,
6105 .mode = COMMAND_EXEC,
6106 .help = "write memory byte",
6107 .usage = "['phys'] address value [count]",
6111 .handler = handle_bp_command,
6112 .mode = COMMAND_EXEC,
6113 .help = "list or set hardware or software breakpoint",
6114 .usage = "<address> [<asid>]<length> ['hw'|'hw_ctx']",
6118 .handler = handle_rbp_command,
6119 .mode = COMMAND_EXEC,
6120 .help = "remove breakpoint",
6125 .handler = handle_wp_command,
6126 .mode = COMMAND_EXEC,
6127 .help = "list (no params) or create watchpoints",
6128 .usage = "[address length [('r'|'w'|'a') value [mask]]]",
6132 .handler = handle_rwp_command,
6133 .mode = COMMAND_EXEC,
6134 .help = "remove watchpoint",
6138 .name = "load_image",
6139 .handler = handle_load_image_command,
6140 .mode = COMMAND_EXEC,
6141 .usage = "filename address ['bin'|'ihex'|'elf'|'s19'] "
6142 "[min_address] [max_length]",
6145 .name = "dump_image",
6146 .handler = handle_dump_image_command,
6147 .mode = COMMAND_EXEC,
6148 .usage = "filename address size",
6151 .name = "verify_image",
6152 .handler = handle_verify_image_command,
6153 .mode = COMMAND_EXEC,
6154 .usage = "filename [offset [type]]",
6157 .name = "test_image",
6158 .handler = handle_test_image_command,
6159 .mode = COMMAND_EXEC,
6160 .usage = "filename [offset [type]]",
6163 .name = "mem2array",
6164 .mode = COMMAND_EXEC,
6165 .jim_handler = jim_mem2array,
6166 .help = "read 8/16/32 bit memory and return as a TCL array "
6167 "for script processing",
6168 .usage = "arrayname bitwidth address count",
6171 .name = "array2mem",
6172 .mode = COMMAND_EXEC,
6173 .jim_handler = jim_array2mem,
6174 .help = "convert a TCL array to memory locations "
6175 "and write the 8/16/32 bit values",
6176 .usage = "arrayname bitwidth address count",
6179 .name = "reset_nag",
6180 .handler = handle_target_reset_nag,
6181 .mode = COMMAND_ANY,
6182 .help = "Nag after each reset about options that could have been "
6183 "enabled to improve performance. ",
6184 .usage = "['enable'|'disable']",
6188 .handler = handle_ps_command,
6189 .mode = COMMAND_EXEC,
6190 .help = "list all tasks ",
6194 .name = "test_mem_access",
6195 .handler = handle_test_mem_access_command,
6196 .mode = COMMAND_EXEC,
6197 .help = "Test the target's memory access functions",
6201 COMMAND_REGISTRATION_DONE
6203 static int target_register_user_commands(struct command_context *cmd_ctx)
6205 int retval = ERROR_OK;
6206 retval = target_request_register_commands(cmd_ctx);
6207 if (retval != ERROR_OK)
6210 retval = trace_register_commands(cmd_ctx);
6211 if (retval != ERROR_OK)
6215 return register_commands(cmd_ctx, NULL, target_exec_command_handlers);