1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * Copyright (C) 2008 by Spencer Oliver *
12 * spen@spen-soft.co.uk *
14 * Copyright (C) 2008 by Rick Altherr *
15 * kc8apf@kc8apf.net> *
17 * Copyright (C) 2011 by Broadcom Corporation *
18 * Evan Hunter - ehunter@broadcom.com *
20 * Copyright (C) ST-Ericsson SA 2011 *
21 * michel.jaouen@stericsson.com : smp minimum support *
23 * Copyright (C) 2011 Andreas Fritiofson *
24 * andreas.fritiofson@gmail.com *
26 * This program is free software; you can redistribute it and/or modify *
27 * it under the terms of the GNU General Public License as published by *
28 * the Free Software Foundation; either version 2 of the License, or *
29 * (at your option) any later version. *
31 * This program is distributed in the hope that it will be useful, *
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
34 * GNU General Public License for more details. *
36 * You should have received a copy of the GNU General Public License *
37 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
38 ***************************************************************************/
44 #include <helper/time_support.h>
45 #include <jtag/jtag.h>
46 #include <flash/nor/core.h>
49 #include "target_type.h"
50 #include "target_request.h"
51 #include "breakpoints.h"
55 #include "rtos/rtos.h"
56 #include "transport/transport.h"
59 /* default halt wait timeout (ms) */
60 #define DEFAULT_HALT_TIMEOUT 5000
62 static int target_read_buffer_default(struct target
*target
, target_addr_t address
,
63 uint32_t count
, uint8_t *buffer
);
64 static int target_write_buffer_default(struct target
*target
, target_addr_t address
,
65 uint32_t count
, const uint8_t *buffer
);
66 static int target_array2mem(Jim_Interp
*interp
, struct target
*target
,
67 int argc
, Jim_Obj
* const *argv
);
68 static int target_mem2array(Jim_Interp
*interp
, struct target
*target
,
69 int argc
, Jim_Obj
* const *argv
);
70 static int target_register_user_commands(struct command_context
*cmd_ctx
);
71 static int target_get_gdb_fileio_info_default(struct target
*target
,
72 struct gdb_fileio_info
*fileio_info
);
73 static int target_gdb_fileio_end_default(struct target
*target
, int retcode
,
74 int fileio_errno
, bool ctrl_c
);
75 static int target_profiling_default(struct target
*target
, uint32_t *samples
,
76 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
);
79 extern struct target_type arm7tdmi_target
;
80 extern struct target_type arm720t_target
;
81 extern struct target_type arm9tdmi_target
;
82 extern struct target_type arm920t_target
;
83 extern struct target_type arm966e_target
;
84 extern struct target_type arm946e_target
;
85 extern struct target_type arm926ejs_target
;
86 extern struct target_type fa526_target
;
87 extern struct target_type feroceon_target
;
88 extern struct target_type dragonite_target
;
89 extern struct target_type xscale_target
;
90 extern struct target_type cortexm_target
;
91 extern struct target_type cortexa_target
;
92 extern struct target_type aarch64_target
;
93 extern struct target_type cortexr4_target
;
94 extern struct target_type arm11_target
;
95 extern struct target_type ls1_sap_target
;
96 extern struct target_type mips_m4k_target
;
97 extern struct target_type avr_target
;
98 extern struct target_type dsp563xx_target
;
99 extern struct target_type dsp5680xx_target
;
100 extern struct target_type testee_target
;
101 extern struct target_type avr32_ap7k_target
;
102 extern struct target_type hla_target
;
103 extern struct target_type nds32_v2_target
;
104 extern struct target_type nds32_v3_target
;
105 extern struct target_type nds32_v3m_target
;
106 extern struct target_type or1k_target
;
107 extern struct target_type quark_x10xx_target
;
108 extern struct target_type quark_d20xx_target
;
109 extern struct target_type stm8_target
;
110 extern struct target_type riscv_target
;
111 extern struct target_type mem_ap_target
;
113 static struct target_type
*target_types
[] = {
152 struct target
*all_targets
;
153 static struct target_event_callback
*target_event_callbacks
;
154 static struct target_timer_callback
*target_timer_callbacks
;
155 LIST_HEAD(target_reset_callback_list
);
156 LIST_HEAD(target_trace_callback_list
);
157 static const int polling_interval
= 100;
159 static const Jim_Nvp nvp_assert
[] = {
160 { .name
= "assert", NVP_ASSERT
},
161 { .name
= "deassert", NVP_DEASSERT
},
162 { .name
= "T", NVP_ASSERT
},
163 { .name
= "F", NVP_DEASSERT
},
164 { .name
= "t", NVP_ASSERT
},
165 { .name
= "f", NVP_DEASSERT
},
166 { .name
= NULL
, .value
= -1 }
169 static const Jim_Nvp nvp_error_target
[] = {
170 { .value
= ERROR_TARGET_INVALID
, .name
= "err-invalid" },
171 { .value
= ERROR_TARGET_INIT_FAILED
, .name
= "err-init-failed" },
172 { .value
= ERROR_TARGET_TIMEOUT
, .name
= "err-timeout" },
173 { .value
= ERROR_TARGET_NOT_HALTED
, .name
= "err-not-halted" },
174 { .value
= ERROR_TARGET_FAILURE
, .name
= "err-failure" },
175 { .value
= ERROR_TARGET_UNALIGNED_ACCESS
, .name
= "err-unaligned-access" },
176 { .value
= ERROR_TARGET_DATA_ABORT
, .name
= "err-data-abort" },
177 { .value
= ERROR_TARGET_RESOURCE_NOT_AVAILABLE
, .name
= "err-resource-not-available" },
178 { .value
= ERROR_TARGET_TRANSLATION_FAULT
, .name
= "err-translation-fault" },
179 { .value
= ERROR_TARGET_NOT_RUNNING
, .name
= "err-not-running" },
180 { .value
= ERROR_TARGET_NOT_EXAMINED
, .name
= "err-not-examined" },
181 { .value
= -1, .name
= NULL
}
184 static const char *target_strerror_safe(int err
)
188 n
= Jim_Nvp_value2name_simple(nvp_error_target
, err
);
195 static const Jim_Nvp nvp_target_event
[] = {
197 { .value
= TARGET_EVENT_GDB_HALT
, .name
= "gdb-halt" },
198 { .value
= TARGET_EVENT_HALTED
, .name
= "halted" },
199 { .value
= TARGET_EVENT_RESUMED
, .name
= "resumed" },
200 { .value
= TARGET_EVENT_RESUME_START
, .name
= "resume-start" },
201 { .value
= TARGET_EVENT_RESUME_END
, .name
= "resume-end" },
203 { .name
= "gdb-start", .value
= TARGET_EVENT_GDB_START
},
204 { .name
= "gdb-end", .value
= TARGET_EVENT_GDB_END
},
206 { .value
= TARGET_EVENT_RESET_START
, .name
= "reset-start" },
207 { .value
= TARGET_EVENT_RESET_ASSERT_PRE
, .name
= "reset-assert-pre" },
208 { .value
= TARGET_EVENT_RESET_ASSERT
, .name
= "reset-assert" },
209 { .value
= TARGET_EVENT_RESET_ASSERT_POST
, .name
= "reset-assert-post" },
210 { .value
= TARGET_EVENT_RESET_DEASSERT_PRE
, .name
= "reset-deassert-pre" },
211 { .value
= TARGET_EVENT_RESET_DEASSERT_POST
, .name
= "reset-deassert-post" },
212 { .value
= TARGET_EVENT_RESET_INIT
, .name
= "reset-init" },
213 { .value
= TARGET_EVENT_RESET_END
, .name
= "reset-end" },
215 { .value
= TARGET_EVENT_EXAMINE_START
, .name
= "examine-start" },
216 { .value
= TARGET_EVENT_EXAMINE_END
, .name
= "examine-end" },
218 { .value
= TARGET_EVENT_DEBUG_HALTED
, .name
= "debug-halted" },
219 { .value
= TARGET_EVENT_DEBUG_RESUMED
, .name
= "debug-resumed" },
221 { .value
= TARGET_EVENT_GDB_ATTACH
, .name
= "gdb-attach" },
222 { .value
= TARGET_EVENT_GDB_DETACH
, .name
= "gdb-detach" },
224 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_START
, .name
= "gdb-flash-write-start" },
225 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_END
, .name
= "gdb-flash-write-end" },
227 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_START
, .name
= "gdb-flash-erase-start" },
228 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_END
, .name
= "gdb-flash-erase-end" },
230 { .value
= TARGET_EVENT_TRACE_CONFIG
, .name
= "trace-config" },
232 { .name
= NULL
, .value
= -1 }
235 static const Jim_Nvp nvp_target_state
[] = {
236 { .name
= "unknown", .value
= TARGET_UNKNOWN
},
237 { .name
= "running", .value
= TARGET_RUNNING
},
238 { .name
= "halted", .value
= TARGET_HALTED
},
239 { .name
= "reset", .value
= TARGET_RESET
},
240 { .name
= "debug-running", .value
= TARGET_DEBUG_RUNNING
},
241 { .name
= NULL
, .value
= -1 },
244 static const Jim_Nvp nvp_target_debug_reason
[] = {
245 { .name
= "debug-request" , .value
= DBG_REASON_DBGRQ
},
246 { .name
= "breakpoint" , .value
= DBG_REASON_BREAKPOINT
},
247 { .name
= "watchpoint" , .value
= DBG_REASON_WATCHPOINT
},
248 { .name
= "watchpoint-and-breakpoint", .value
= DBG_REASON_WPTANDBKPT
},
249 { .name
= "single-step" , .value
= DBG_REASON_SINGLESTEP
},
250 { .name
= "target-not-halted" , .value
= DBG_REASON_NOTHALTED
},
251 { .name
= "program-exit" , .value
= DBG_REASON_EXIT
},
252 { .name
= "undefined" , .value
= DBG_REASON_UNDEFINED
},
253 { .name
= NULL
, .value
= -1 },
256 static const Jim_Nvp nvp_target_endian
[] = {
257 { .name
= "big", .value
= TARGET_BIG_ENDIAN
},
258 { .name
= "little", .value
= TARGET_LITTLE_ENDIAN
},
259 { .name
= "be", .value
= TARGET_BIG_ENDIAN
},
260 { .name
= "le", .value
= TARGET_LITTLE_ENDIAN
},
261 { .name
= NULL
, .value
= -1 },
264 static const Jim_Nvp nvp_reset_modes
[] = {
265 { .name
= "unknown", .value
= RESET_UNKNOWN
},
266 { .name
= "run" , .value
= RESET_RUN
},
267 { .name
= "halt" , .value
= RESET_HALT
},
268 { .name
= "init" , .value
= RESET_INIT
},
269 { .name
= NULL
, .value
= -1 },
272 const char *debug_reason_name(struct target
*t
)
276 cp
= Jim_Nvp_value2name_simple(nvp_target_debug_reason
,
277 t
->debug_reason
)->name
;
279 LOG_ERROR("Invalid debug reason: %d", (int)(t
->debug_reason
));
280 cp
= "(*BUG*unknown*BUG*)";
285 const char *target_state_name(struct target
*t
)
288 cp
= Jim_Nvp_value2name_simple(nvp_target_state
, t
->state
)->name
;
290 LOG_ERROR("Invalid target state: %d", (int)(t
->state
));
291 cp
= "(*BUG*unknown*BUG*)";
294 if (!target_was_examined(t
) && t
->defer_examine
)
295 cp
= "examine deferred";
300 const char *target_event_name(enum target_event event
)
303 cp
= Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
;
305 LOG_ERROR("Invalid target event: %d", (int)(event
));
306 cp
= "(*BUG*unknown*BUG*)";
311 const char *target_reset_mode_name(enum target_reset_mode reset_mode
)
314 cp
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
;
316 LOG_ERROR("Invalid target reset mode: %d", (int)(reset_mode
));
317 cp
= "(*BUG*unknown*BUG*)";
322 /* determine the number of the new target */
323 static int new_target_number(void)
328 /* number is 0 based */
332 if (x
< t
->target_number
)
333 x
= t
->target_number
;
339 /* read a uint64_t from a buffer in target memory endianness */
340 uint64_t target_buffer_get_u64(struct target
*target
, const uint8_t *buffer
)
342 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
343 return le_to_h_u64(buffer
);
345 return be_to_h_u64(buffer
);
348 /* read a uint32_t from a buffer in target memory endianness */
349 uint32_t target_buffer_get_u32(struct target
*target
, const uint8_t *buffer
)
351 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
352 return le_to_h_u32(buffer
);
354 return be_to_h_u32(buffer
);
357 /* read a uint24_t from a buffer in target memory endianness */
358 uint32_t target_buffer_get_u24(struct target
*target
, const uint8_t *buffer
)
360 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
361 return le_to_h_u24(buffer
);
363 return be_to_h_u24(buffer
);
366 /* read a uint16_t from a buffer in target memory endianness */
367 uint16_t target_buffer_get_u16(struct target
*target
, const uint8_t *buffer
)
369 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
370 return le_to_h_u16(buffer
);
372 return be_to_h_u16(buffer
);
375 /* read a uint8_t from a buffer in target memory endianness */
376 static uint8_t target_buffer_get_u8(struct target
*target
, const uint8_t *buffer
)
378 return *buffer
& 0x0ff;
381 /* write a uint64_t to a buffer in target memory endianness */
382 void target_buffer_set_u64(struct target
*target
, uint8_t *buffer
, uint64_t value
)
384 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
385 h_u64_to_le(buffer
, value
);
387 h_u64_to_be(buffer
, value
);
390 /* write a uint32_t to a buffer in target memory endianness */
391 void target_buffer_set_u32(struct target
*target
, uint8_t *buffer
, uint32_t value
)
393 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
394 h_u32_to_le(buffer
, value
);
396 h_u32_to_be(buffer
, value
);
399 /* write a uint24_t to a buffer in target memory endianness */
400 void target_buffer_set_u24(struct target
*target
, uint8_t *buffer
, uint32_t value
)
402 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
403 h_u24_to_le(buffer
, value
);
405 h_u24_to_be(buffer
, value
);
408 /* write a uint16_t to a buffer in target memory endianness */
409 void target_buffer_set_u16(struct target
*target
, uint8_t *buffer
, uint16_t value
)
411 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
412 h_u16_to_le(buffer
, value
);
414 h_u16_to_be(buffer
, value
);
417 /* write a uint8_t to a buffer in target memory endianness */
418 static void target_buffer_set_u8(struct target
*target
, uint8_t *buffer
, uint8_t value
)
423 /* write a uint64_t array to a buffer in target memory endianness */
424 void target_buffer_get_u64_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint64_t *dstbuf
)
427 for (i
= 0; i
< count
; i
++)
428 dstbuf
[i
] = target_buffer_get_u64(target
, &buffer
[i
* 8]);
431 /* write a uint32_t array to a buffer in target memory endianness */
432 void target_buffer_get_u32_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint32_t *dstbuf
)
435 for (i
= 0; i
< count
; i
++)
436 dstbuf
[i
] = target_buffer_get_u32(target
, &buffer
[i
* 4]);
439 /* write a uint16_t array to a buffer in target memory endianness */
440 void target_buffer_get_u16_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint16_t *dstbuf
)
443 for (i
= 0; i
< count
; i
++)
444 dstbuf
[i
] = target_buffer_get_u16(target
, &buffer
[i
* 2]);
447 /* write a uint64_t array to a buffer in target memory endianness */
448 void target_buffer_set_u64_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint64_t *srcbuf
)
451 for (i
= 0; i
< count
; i
++)
452 target_buffer_set_u64(target
, &buffer
[i
* 8], srcbuf
[i
]);
455 /* write a uint32_t array to a buffer in target memory endianness */
456 void target_buffer_set_u32_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint32_t *srcbuf
)
459 for (i
= 0; i
< count
; i
++)
460 target_buffer_set_u32(target
, &buffer
[i
* 4], srcbuf
[i
]);
463 /* write a uint16_t array to a buffer in target memory endianness */
464 void target_buffer_set_u16_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint16_t *srcbuf
)
467 for (i
= 0; i
< count
; i
++)
468 target_buffer_set_u16(target
, &buffer
[i
* 2], srcbuf
[i
]);
471 /* return a pointer to a configured target; id is name or number */
472 struct target
*get_target(const char *id
)
474 struct target
*target
;
476 /* try as tcltarget name */
477 for (target
= all_targets
; target
; target
= target
->next
) {
478 if (target_name(target
) == NULL
)
480 if (strcmp(id
, target_name(target
)) == 0)
484 /* It's OK to remove this fallback sometime after August 2010 or so */
486 /* no match, try as number */
488 if (parse_uint(id
, &num
) != ERROR_OK
)
491 for (target
= all_targets
; target
; target
= target
->next
) {
492 if (target
->target_number
== (int)num
) {
493 LOG_WARNING("use '%s' as target identifier, not '%u'",
494 target_name(target
), num
);
502 /* returns a pointer to the n-th configured target */
503 struct target
*get_target_by_num(int num
)
505 struct target
*target
= all_targets
;
508 if (target
->target_number
== num
)
510 target
= target
->next
;
516 struct target
*get_current_target(struct command_context
*cmd_ctx
)
518 struct target
*target
= cmd_ctx
->current_target_override
519 ? cmd_ctx
->current_target_override
520 : cmd_ctx
->current_target
;
522 if (target
== NULL
) {
523 LOG_ERROR("BUG: current_target out of bounds");
530 int target_poll(struct target
*target
)
534 /* We can't poll until after examine */
535 if (!target_was_examined(target
)) {
536 /* Fail silently lest we pollute the log */
540 retval
= target
->type
->poll(target
);
541 if (retval
!= ERROR_OK
)
544 if (target
->halt_issued
) {
545 if (target
->state
== TARGET_HALTED
)
546 target
->halt_issued
= false;
548 int64_t t
= timeval_ms() - target
->halt_issued_time
;
549 if (t
> DEFAULT_HALT_TIMEOUT
) {
550 target
->halt_issued
= false;
551 LOG_INFO("Halt timed out, wake up GDB.");
552 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
560 int target_halt(struct target
*target
)
563 /* We can't poll until after examine */
564 if (!target_was_examined(target
)) {
565 LOG_ERROR("Target not examined yet");
569 retval
= target
->type
->halt(target
);
570 if (retval
!= ERROR_OK
)
573 target
->halt_issued
= true;
574 target
->halt_issued_time
= timeval_ms();
580 * Make the target (re)start executing using its saved execution
581 * context (possibly with some modifications).
583 * @param target Which target should start executing.
584 * @param current True to use the target's saved program counter instead
585 * of the address parameter
586 * @param address Optionally used as the program counter.
587 * @param handle_breakpoints True iff breakpoints at the resumption PC
588 * should be skipped. (For example, maybe execution was stopped by
589 * such a breakpoint, in which case it would be counterprodutive to
591 * @param debug_execution False if all working areas allocated by OpenOCD
592 * should be released and/or restored to their original contents.
593 * (This would for example be true to run some downloaded "helper"
594 * algorithm code, which resides in one such working buffer and uses
595 * another for data storage.)
597 * @todo Resolve the ambiguity about what the "debug_execution" flag
598 * signifies. For example, Target implementations don't agree on how
599 * it relates to invalidation of the register cache, or to whether
600 * breakpoints and watchpoints should be enabled. (It would seem wrong
601 * to enable breakpoints when running downloaded "helper" algorithms
602 * (debug_execution true), since the breakpoints would be set to match
603 * target firmware being debugged, not the helper algorithm.... and
604 * enabling them could cause such helpers to malfunction (for example,
605 * by overwriting data with a breakpoint instruction. On the other
606 * hand the infrastructure for running such helpers might use this
607 * procedure but rely on hardware breakpoint to detect termination.)
609 int target_resume(struct target
*target
, int current
, target_addr_t address
,
610 int handle_breakpoints
, int debug_execution
)
614 /* We can't poll until after examine */
615 if (!target_was_examined(target
)) {
616 LOG_ERROR("Target not examined yet");
620 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_START
);
622 /* note that resume *must* be asynchronous. The CPU can halt before
623 * we poll. The CPU can even halt at the current PC as a result of
624 * a software breakpoint being inserted by (a bug?) the application.
626 retval
= target
->type
->resume(target
, current
, address
, handle_breakpoints
, debug_execution
);
627 if (retval
!= ERROR_OK
)
630 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_END
);
635 static int target_process_reset(struct command_context
*cmd_ctx
, enum target_reset_mode reset_mode
)
640 n
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
);
641 if (n
->name
== NULL
) {
642 LOG_ERROR("invalid reset mode");
646 struct target
*target
;
647 for (target
= all_targets
; target
; target
= target
->next
)
648 target_call_reset_callbacks(target
, reset_mode
);
650 /* disable polling during reset to make reset event scripts
651 * more predictable, i.e. dr/irscan & pathmove in events will
652 * not have JTAG operations injected into the middle of a sequence.
654 bool save_poll
= jtag_poll_get_enabled();
656 jtag_poll_set_enabled(false);
658 sprintf(buf
, "ocd_process_reset %s", n
->name
);
659 retval
= Jim_Eval(cmd_ctx
->interp
, buf
);
661 jtag_poll_set_enabled(save_poll
);
663 if (retval
!= JIM_OK
) {
664 Jim_MakeErrorMessage(cmd_ctx
->interp
);
665 command_print(NULL
, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx
->interp
), NULL
));
669 /* We want any events to be processed before the prompt */
670 retval
= target_call_timer_callbacks_now();
672 for (target
= all_targets
; target
; target
= target
->next
) {
673 target
->type
->check_reset(target
);
674 target
->running_alg
= false;
680 static int identity_virt2phys(struct target
*target
,
681 target_addr_t
virtual, target_addr_t
*physical
)
687 static int no_mmu(struct target
*target
, int *enabled
)
693 static int default_examine(struct target
*target
)
695 target_set_examined(target
);
699 /* no check by default */
700 static int default_check_reset(struct target
*target
)
705 int target_examine_one(struct target
*target
)
707 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_START
);
709 int retval
= target
->type
->examine(target
);
710 if (retval
!= ERROR_OK
)
713 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_END
);
718 static int jtag_enable_callback(enum jtag_event event
, void *priv
)
720 struct target
*target
= priv
;
722 if (event
!= JTAG_TAP_EVENT_ENABLE
|| !target
->tap
->enabled
)
725 jtag_unregister_event_callback(jtag_enable_callback
, target
);
727 return target_examine_one(target
);
730 /* Targets that correctly implement init + examine, i.e.
731 * no communication with target during init:
735 int target_examine(void)
737 int retval
= ERROR_OK
;
738 struct target
*target
;
740 for (target
= all_targets
; target
; target
= target
->next
) {
741 /* defer examination, but don't skip it */
742 if (!target
->tap
->enabled
) {
743 jtag_register_event_callback(jtag_enable_callback
,
748 if (target
->defer_examine
)
751 retval
= target_examine_one(target
);
752 if (retval
!= ERROR_OK
)
758 const char *target_type_name(struct target
*target
)
760 return target
->type
->name
;
763 static int target_soft_reset_halt(struct target
*target
)
765 if (!target_was_examined(target
)) {
766 LOG_ERROR("Target not examined yet");
769 if (!target
->type
->soft_reset_halt
) {
770 LOG_ERROR("Target %s does not support soft_reset_halt",
771 target_name(target
));
774 return target
->type
->soft_reset_halt(target
);
778 * Downloads a target-specific native code algorithm to the target,
779 * and executes it. * Note that some targets may need to set up, enable,
780 * and tear down a breakpoint (hard or * soft) to detect algorithm
781 * termination, while others may support lower overhead schemes where
782 * soft breakpoints embedded in the algorithm automatically terminate the
785 * @param target used to run the algorithm
786 * @param arch_info target-specific description of the algorithm.
788 int target_run_algorithm(struct target
*target
,
789 int num_mem_params
, struct mem_param
*mem_params
,
790 int num_reg_params
, struct reg_param
*reg_param
,
791 uint32_t entry_point
, uint32_t exit_point
,
792 int timeout_ms
, void *arch_info
)
794 int retval
= ERROR_FAIL
;
796 if (!target_was_examined(target
)) {
797 LOG_ERROR("Target not examined yet");
800 if (!target
->type
->run_algorithm
) {
801 LOG_ERROR("Target type '%s' does not support %s",
802 target_type_name(target
), __func__
);
806 target
->running_alg
= true;
807 retval
= target
->type
->run_algorithm(target
,
808 num_mem_params
, mem_params
,
809 num_reg_params
, reg_param
,
810 entry_point
, exit_point
, timeout_ms
, arch_info
);
811 target
->running_alg
= false;
818 * Executes a target-specific native code algorithm and leaves it running.
820 * @param target used to run the algorithm
821 * @param arch_info target-specific description of the algorithm.
823 int target_start_algorithm(struct target
*target
,
824 int num_mem_params
, struct mem_param
*mem_params
,
825 int num_reg_params
, struct reg_param
*reg_params
,
826 uint32_t entry_point
, uint32_t exit_point
,
829 int retval
= ERROR_FAIL
;
831 if (!target_was_examined(target
)) {
832 LOG_ERROR("Target not examined yet");
835 if (!target
->type
->start_algorithm
) {
836 LOG_ERROR("Target type '%s' does not support %s",
837 target_type_name(target
), __func__
);
840 if (target
->running_alg
) {
841 LOG_ERROR("Target is already running an algorithm");
845 target
->running_alg
= true;
846 retval
= target
->type
->start_algorithm(target
,
847 num_mem_params
, mem_params
,
848 num_reg_params
, reg_params
,
849 entry_point
, exit_point
, arch_info
);
856 * Waits for an algorithm started with target_start_algorithm() to complete.
858 * @param target used to run the algorithm
859 * @param arch_info target-specific description of the algorithm.
861 int target_wait_algorithm(struct target
*target
,
862 int num_mem_params
, struct mem_param
*mem_params
,
863 int num_reg_params
, struct reg_param
*reg_params
,
864 uint32_t exit_point
, int timeout_ms
,
867 int retval
= ERROR_FAIL
;
869 if (!target
->type
->wait_algorithm
) {
870 LOG_ERROR("Target type '%s' does not support %s",
871 target_type_name(target
), __func__
);
874 if (!target
->running_alg
) {
875 LOG_ERROR("Target is not running an algorithm");
879 retval
= target
->type
->wait_algorithm(target
,
880 num_mem_params
, mem_params
,
881 num_reg_params
, reg_params
,
882 exit_point
, timeout_ms
, arch_info
);
883 if (retval
!= ERROR_TARGET_TIMEOUT
)
884 target
->running_alg
= false;
891 * Streams data to a circular buffer on target intended for consumption by code
892 * running asynchronously on target.
894 * This is intended for applications where target-specific native code runs
895 * on the target, receives data from the circular buffer, does something with
896 * it (most likely writing it to a flash memory), and advances the circular
899 * This assumes that the helper algorithm has already been loaded to the target,
900 * but has not been started yet. Given memory and register parameters are passed
903 * The buffer is defined by (buffer_start, buffer_size) arguments and has the
906 * [buffer_start + 0, buffer_start + 4):
907 * Write Pointer address (aka head). Written and updated by this
908 * routine when new data is written to the circular buffer.
909 * [buffer_start + 4, buffer_start + 8):
910 * Read Pointer address (aka tail). Updated by code running on the
911 * target after it consumes data.
912 * [buffer_start + 8, buffer_start + buffer_size):
913 * Circular buffer contents.
915 * See contrib/loaders/flash/stm32f1x.S for an example.
917 * @param target used to run the algorithm
918 * @param buffer address on the host where data to be sent is located
919 * @param count number of blocks to send
920 * @param block_size size in bytes of each block
921 * @param num_mem_params count of memory-based params to pass to algorithm
922 * @param mem_params memory-based params to pass to algorithm
923 * @param num_reg_params count of register-based params to pass to algorithm
924 * @param reg_params memory-based params to pass to algorithm
925 * @param buffer_start address on the target of the circular buffer structure
926 * @param buffer_size size of the circular buffer structure
927 * @param entry_point address on the target to execute to start the algorithm
928 * @param exit_point address at which to set a breakpoint to catch the
929 * end of the algorithm; can be 0 if target triggers a breakpoint itself
932 int target_run_flash_async_algorithm(struct target
*target
,
933 const uint8_t *buffer
, uint32_t count
, int block_size
,
934 int num_mem_params
, struct mem_param
*mem_params
,
935 int num_reg_params
, struct reg_param
*reg_params
,
936 uint32_t buffer_start
, uint32_t buffer_size
,
937 uint32_t entry_point
, uint32_t exit_point
, void *arch_info
)
942 const uint8_t *buffer_orig
= buffer
;
944 /* Set up working area. First word is write pointer, second word is read pointer,
945 * rest is fifo data area. */
946 uint32_t wp_addr
= buffer_start
;
947 uint32_t rp_addr
= buffer_start
+ 4;
948 uint32_t fifo_start_addr
= buffer_start
+ 8;
949 uint32_t fifo_end_addr
= buffer_start
+ buffer_size
;
951 uint32_t wp
= fifo_start_addr
;
952 uint32_t rp
= fifo_start_addr
;
954 /* validate block_size is 2^n */
955 assert(!block_size
|| !(block_size
& (block_size
- 1)));
957 retval
= target_write_u32(target
, wp_addr
, wp
);
958 if (retval
!= ERROR_OK
)
960 retval
= target_write_u32(target
, rp_addr
, rp
);
961 if (retval
!= ERROR_OK
)
964 /* Start up algorithm on target and let it idle while writing the first chunk */
965 retval
= target_start_algorithm(target
, num_mem_params
, mem_params
,
966 num_reg_params
, reg_params
,
971 if (retval
!= ERROR_OK
) {
972 LOG_ERROR("error starting target flash write algorithm");
978 retval
= target_read_u32(target
, rp_addr
, &rp
);
979 if (retval
!= ERROR_OK
) {
980 LOG_ERROR("failed to get read pointer");
984 LOG_DEBUG("offs 0x%zx count 0x%" PRIx32
" wp 0x%" PRIx32
" rp 0x%" PRIx32
,
985 (size_t) (buffer
- buffer_orig
), count
, wp
, rp
);
988 LOG_ERROR("flash write algorithm aborted by target");
989 retval
= ERROR_FLASH_OPERATION_FAILED
;
993 if (((rp
- fifo_start_addr
) & (block_size
- 1)) || rp
< fifo_start_addr
|| rp
>= fifo_end_addr
) {
994 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32
, rp
);
998 /* Count the number of bytes available in the fifo without
999 * crossing the wrap around. Make sure to not fill it completely,
1000 * because that would make wp == rp and that's the empty condition. */
1001 uint32_t thisrun_bytes
;
1003 thisrun_bytes
= rp
- wp
- block_size
;
1004 else if (rp
> fifo_start_addr
)
1005 thisrun_bytes
= fifo_end_addr
- wp
;
1007 thisrun_bytes
= fifo_end_addr
- wp
- block_size
;
1009 if (thisrun_bytes
== 0) {
1010 /* Throttle polling a bit if transfer is (much) faster than flash
1011 * programming. The exact delay shouldn't matter as long as it's
1012 * less than buffer size / flash speed. This is very unlikely to
1013 * run when using high latency connections such as USB. */
1016 /* to stop an infinite loop on some targets check and increment a timeout
1017 * this issue was observed on a stellaris using the new ICDI interface */
1018 if (timeout
++ >= 500) {
1019 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
1020 return ERROR_FLASH_OPERATION_FAILED
;
1025 /* reset our timeout */
1028 /* Limit to the amount of data we actually want to write */
1029 if (thisrun_bytes
> count
* block_size
)
1030 thisrun_bytes
= count
* block_size
;
1032 /* Write data to fifo */
1033 retval
= target_write_buffer(target
, wp
, thisrun_bytes
, buffer
);
1034 if (retval
!= ERROR_OK
)
1037 /* Update counters and wrap write pointer */
1038 buffer
+= thisrun_bytes
;
1039 count
-= thisrun_bytes
/ block_size
;
1040 wp
+= thisrun_bytes
;
1041 if (wp
>= fifo_end_addr
)
1042 wp
= fifo_start_addr
;
1044 /* Store updated write pointer to target */
1045 retval
= target_write_u32(target
, wp_addr
, wp
);
1046 if (retval
!= ERROR_OK
)
1050 if (retval
!= ERROR_OK
) {
1051 /* abort flash write algorithm on target */
1052 target_write_u32(target
, wp_addr
, 0);
1055 int retval2
= target_wait_algorithm(target
, num_mem_params
, mem_params
,
1056 num_reg_params
, reg_params
,
1061 if (retval2
!= ERROR_OK
) {
1062 LOG_ERROR("error waiting for target flash write algorithm");
1066 if (retval
== ERROR_OK
) {
1067 /* check if algorithm set rp = 0 after fifo writer loop finished */
1068 retval
= target_read_u32(target
, rp_addr
, &rp
);
1069 if (retval
== ERROR_OK
&& rp
== 0) {
1070 LOG_ERROR("flash write algorithm aborted by target");
1071 retval
= ERROR_FLASH_OPERATION_FAILED
;
1078 int target_read_memory(struct target
*target
,
1079 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1081 if (!target_was_examined(target
)) {
1082 LOG_ERROR("Target not examined yet");
1085 if (!target
->type
->read_memory
) {
1086 LOG_ERROR("Target %s doesn't support read_memory", target_name(target
));
1089 return target
->type
->read_memory(target
, address
, size
, count
, buffer
);
1092 int target_read_phys_memory(struct target
*target
,
1093 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1095 if (!target_was_examined(target
)) {
1096 LOG_ERROR("Target not examined yet");
1099 if (!target
->type
->read_phys_memory
) {
1100 LOG_ERROR("Target %s doesn't support read_phys_memory", target_name(target
));
1103 return target
->type
->read_phys_memory(target
, address
, size
, count
, buffer
);
1106 int target_write_memory(struct target
*target
,
1107 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
)
1109 if (!target_was_examined(target
)) {
1110 LOG_ERROR("Target not examined yet");
1113 if (!target
->type
->write_memory
) {
1114 LOG_ERROR("Target %s doesn't support write_memory", target_name(target
));
1117 return target
->type
->write_memory(target
, address
, size
, count
, buffer
);
1120 int target_write_phys_memory(struct target
*target
,
1121 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
)
1123 if (!target_was_examined(target
)) {
1124 LOG_ERROR("Target not examined yet");
1127 if (!target
->type
->write_phys_memory
) {
1128 LOG_ERROR("Target %s doesn't support write_phys_memory", target_name(target
));
1131 return target
->type
->write_phys_memory(target
, address
, size
, count
, buffer
);
1134 int target_add_breakpoint(struct target
*target
,
1135 struct breakpoint
*breakpoint
)
1137 if ((target
->state
!= TARGET_HALTED
) && (breakpoint
->type
!= BKPT_HARD
)) {
1138 LOG_WARNING("target %s is not halted (add breakpoint)", target_name(target
));
1139 return ERROR_TARGET_NOT_HALTED
;
1141 return target
->type
->add_breakpoint(target
, breakpoint
);
1144 int target_add_context_breakpoint(struct target
*target
,
1145 struct breakpoint
*breakpoint
)
1147 if (target
->state
!= TARGET_HALTED
) {
1148 LOG_WARNING("target %s is not halted (add context breakpoint)", target_name(target
));
1149 return ERROR_TARGET_NOT_HALTED
;
1151 return target
->type
->add_context_breakpoint(target
, breakpoint
);
1154 int target_add_hybrid_breakpoint(struct target
*target
,
1155 struct breakpoint
*breakpoint
)
1157 if (target
->state
!= TARGET_HALTED
) {
1158 LOG_WARNING("target %s is not halted (add hybrid breakpoint)", target_name(target
));
1159 return ERROR_TARGET_NOT_HALTED
;
1161 return target
->type
->add_hybrid_breakpoint(target
, breakpoint
);
1164 int target_remove_breakpoint(struct target
*target
,
1165 struct breakpoint
*breakpoint
)
1167 return target
->type
->remove_breakpoint(target
, breakpoint
);
1170 int target_add_watchpoint(struct target
*target
,
1171 struct watchpoint
*watchpoint
)
1173 if (target
->state
!= TARGET_HALTED
) {
1174 LOG_WARNING("target %s is not halted (add watchpoint)", target_name(target
));
1175 return ERROR_TARGET_NOT_HALTED
;
1177 return target
->type
->add_watchpoint(target
, watchpoint
);
1179 int target_remove_watchpoint(struct target
*target
,
1180 struct watchpoint
*watchpoint
)
1182 return target
->type
->remove_watchpoint(target
, watchpoint
);
1184 int target_hit_watchpoint(struct target
*target
,
1185 struct watchpoint
**hit_watchpoint
)
1187 if (target
->state
!= TARGET_HALTED
) {
1188 LOG_WARNING("target %s is not halted (hit watchpoint)", target
->cmd_name
);
1189 return ERROR_TARGET_NOT_HALTED
;
1192 if (target
->type
->hit_watchpoint
== NULL
) {
1193 /* For backward compatible, if hit_watchpoint is not implemented,
1194 * return ERROR_FAIL such that gdb_server will not take the nonsense
1199 return target
->type
->hit_watchpoint(target
, hit_watchpoint
);
1202 int target_get_gdb_reg_list(struct target
*target
,
1203 struct reg
**reg_list
[], int *reg_list_size
,
1204 enum target_register_class reg_class
)
1206 return target
->type
->get_gdb_reg_list(target
, reg_list
, reg_list_size
, reg_class
);
1208 int target_step(struct target
*target
,
1209 int current
, target_addr_t address
, int handle_breakpoints
)
1211 return target
->type
->step(target
, current
, address
, handle_breakpoints
);
1214 int target_get_gdb_fileio_info(struct target
*target
, struct gdb_fileio_info
*fileio_info
)
1216 if (target
->state
!= TARGET_HALTED
) {
1217 LOG_WARNING("target %s is not halted (gdb fileio)", target
->cmd_name
);
1218 return ERROR_TARGET_NOT_HALTED
;
1220 return target
->type
->get_gdb_fileio_info(target
, fileio_info
);
1223 int target_gdb_fileio_end(struct target
*target
, int retcode
, int fileio_errno
, bool ctrl_c
)
1225 if (target
->state
!= TARGET_HALTED
) {
1226 LOG_WARNING("target %s is not halted (gdb fileio end)", target
->cmd_name
);
1227 return ERROR_TARGET_NOT_HALTED
;
1229 return target
->type
->gdb_fileio_end(target
, retcode
, fileio_errno
, ctrl_c
);
1232 int target_profiling(struct target
*target
, uint32_t *samples
,
1233 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
1235 if (target
->state
!= TARGET_HALTED
) {
1236 LOG_WARNING("target %s is not halted (profiling)", target
->cmd_name
);
1237 return ERROR_TARGET_NOT_HALTED
;
1239 return target
->type
->profiling(target
, samples
, max_num_samples
,
1240 num_samples
, seconds
);
1244 * Reset the @c examined flag for the given target.
1245 * Pure paranoia -- targets are zeroed on allocation.
1247 static void target_reset_examined(struct target
*target
)
1249 target
->examined
= false;
1252 static int handle_target(void *priv
);
1254 static int target_init_one(struct command_context
*cmd_ctx
,
1255 struct target
*target
)
1257 target_reset_examined(target
);
1259 struct target_type
*type
= target
->type
;
1260 if (type
->examine
== NULL
)
1261 type
->examine
= default_examine
;
1263 if (type
->check_reset
== NULL
)
1264 type
->check_reset
= default_check_reset
;
1266 assert(type
->init_target
!= NULL
);
1268 int retval
= type
->init_target(cmd_ctx
, target
);
1269 if (ERROR_OK
!= retval
) {
1270 LOG_ERROR("target '%s' init failed", target_name(target
));
1274 /* Sanity-check MMU support ... stub in what we must, to help
1275 * implement it in stages, but warn if we need to do so.
1278 if (type
->virt2phys
== NULL
) {
1279 LOG_ERROR("type '%s' is missing virt2phys", type
->name
);
1280 type
->virt2phys
= identity_virt2phys
;
1283 /* Make sure no-MMU targets all behave the same: make no
1284 * distinction between physical and virtual addresses, and
1285 * ensure that virt2phys() is always an identity mapping.
1287 if (type
->write_phys_memory
|| type
->read_phys_memory
|| type
->virt2phys
)
1288 LOG_WARNING("type '%s' has bad MMU hooks", type
->name
);
1291 type
->write_phys_memory
= type
->write_memory
;
1292 type
->read_phys_memory
= type
->read_memory
;
1293 type
->virt2phys
= identity_virt2phys
;
1296 if (target
->type
->read_buffer
== NULL
)
1297 target
->type
->read_buffer
= target_read_buffer_default
;
1299 if (target
->type
->write_buffer
== NULL
)
1300 target
->type
->write_buffer
= target_write_buffer_default
;
1302 if (target
->type
->get_gdb_fileio_info
== NULL
)
1303 target
->type
->get_gdb_fileio_info
= target_get_gdb_fileio_info_default
;
1305 if (target
->type
->gdb_fileio_end
== NULL
)
1306 target
->type
->gdb_fileio_end
= target_gdb_fileio_end_default
;
1308 if (target
->type
->profiling
== NULL
)
1309 target
->type
->profiling
= target_profiling_default
;
1314 static int target_init(struct command_context
*cmd_ctx
)
1316 struct target
*target
;
1319 for (target
= all_targets
; target
; target
= target
->next
) {
1320 retval
= target_init_one(cmd_ctx
, target
);
1321 if (ERROR_OK
!= retval
)
1328 retval
= target_register_user_commands(cmd_ctx
);
1329 if (ERROR_OK
!= retval
)
1332 retval
= target_register_timer_callback(&handle_target
,
1333 polling_interval
, 1, cmd_ctx
->interp
);
1334 if (ERROR_OK
!= retval
)
1340 COMMAND_HANDLER(handle_target_init_command
)
1345 return ERROR_COMMAND_SYNTAX_ERROR
;
1347 static bool target_initialized
;
1348 if (target_initialized
) {
1349 LOG_INFO("'target init' has already been called");
1352 target_initialized
= true;
1354 retval
= command_run_line(CMD_CTX
, "init_targets");
1355 if (ERROR_OK
!= retval
)
1358 retval
= command_run_line(CMD_CTX
, "init_target_events");
1359 if (ERROR_OK
!= retval
)
1362 retval
= command_run_line(CMD_CTX
, "init_board");
1363 if (ERROR_OK
!= retval
)
1366 LOG_DEBUG("Initializing targets...");
1367 return target_init(CMD_CTX
);
1370 int target_register_event_callback(int (*callback
)(struct target
*target
,
1371 enum target_event event
, void *priv
), void *priv
)
1373 struct target_event_callback
**callbacks_p
= &target_event_callbacks
;
1375 if (callback
== NULL
)
1376 return ERROR_COMMAND_SYNTAX_ERROR
;
1379 while ((*callbacks_p
)->next
)
1380 callbacks_p
= &((*callbacks_p
)->next
);
1381 callbacks_p
= &((*callbacks_p
)->next
);
1384 (*callbacks_p
) = malloc(sizeof(struct target_event_callback
));
1385 (*callbacks_p
)->callback
= callback
;
1386 (*callbacks_p
)->priv
= priv
;
1387 (*callbacks_p
)->next
= NULL
;
1392 int target_register_reset_callback(int (*callback
)(struct target
*target
,
1393 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1395 struct target_reset_callback
*entry
;
1397 if (callback
== NULL
)
1398 return ERROR_COMMAND_SYNTAX_ERROR
;
1400 entry
= malloc(sizeof(struct target_reset_callback
));
1401 if (entry
== NULL
) {
1402 LOG_ERROR("error allocating buffer for reset callback entry");
1403 return ERROR_COMMAND_SYNTAX_ERROR
;
1406 entry
->callback
= callback
;
1408 list_add(&entry
->list
, &target_reset_callback_list
);
1414 int target_register_trace_callback(int (*callback
)(struct target
*target
,
1415 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1417 struct target_trace_callback
*entry
;
1419 if (callback
== NULL
)
1420 return ERROR_COMMAND_SYNTAX_ERROR
;
1422 entry
= malloc(sizeof(struct target_trace_callback
));
1423 if (entry
== NULL
) {
1424 LOG_ERROR("error allocating buffer for trace callback entry");
1425 return ERROR_COMMAND_SYNTAX_ERROR
;
1428 entry
->callback
= callback
;
1430 list_add(&entry
->list
, &target_trace_callback_list
);
1436 int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
)
1438 struct target_timer_callback
**callbacks_p
= &target_timer_callbacks
;
1440 if (callback
== NULL
)
1441 return ERROR_COMMAND_SYNTAX_ERROR
;
1444 while ((*callbacks_p
)->next
)
1445 callbacks_p
= &((*callbacks_p
)->next
);
1446 callbacks_p
= &((*callbacks_p
)->next
);
1449 (*callbacks_p
) = malloc(sizeof(struct target_timer_callback
));
1450 (*callbacks_p
)->callback
= callback
;
1451 (*callbacks_p
)->periodic
= periodic
;
1452 (*callbacks_p
)->time_ms
= time_ms
;
1453 (*callbacks_p
)->removed
= false;
1455 gettimeofday(&(*callbacks_p
)->when
, NULL
);
1456 timeval_add_time(&(*callbacks_p
)->when
, 0, time_ms
* 1000);
1458 (*callbacks_p
)->priv
= priv
;
1459 (*callbacks_p
)->next
= NULL
;
1464 int target_unregister_event_callback(int (*callback
)(struct target
*target
,
1465 enum target_event event
, void *priv
), void *priv
)
1467 struct target_event_callback
**p
= &target_event_callbacks
;
1468 struct target_event_callback
*c
= target_event_callbacks
;
1470 if (callback
== NULL
)
1471 return ERROR_COMMAND_SYNTAX_ERROR
;
1474 struct target_event_callback
*next
= c
->next
;
1475 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1487 int target_unregister_reset_callback(int (*callback
)(struct target
*target
,
1488 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1490 struct target_reset_callback
*entry
;
1492 if (callback
== NULL
)
1493 return ERROR_COMMAND_SYNTAX_ERROR
;
1495 list_for_each_entry(entry
, &target_reset_callback_list
, list
) {
1496 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1497 list_del(&entry
->list
);
1506 int target_unregister_trace_callback(int (*callback
)(struct target
*target
,
1507 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1509 struct target_trace_callback
*entry
;
1511 if (callback
== NULL
)
1512 return ERROR_COMMAND_SYNTAX_ERROR
;
1514 list_for_each_entry(entry
, &target_trace_callback_list
, list
) {
1515 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1516 list_del(&entry
->list
);
1525 int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
)
1527 if (callback
== NULL
)
1528 return ERROR_COMMAND_SYNTAX_ERROR
;
1530 for (struct target_timer_callback
*c
= target_timer_callbacks
;
1532 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1541 int target_call_event_callbacks(struct target
*target
, enum target_event event
)
1543 struct target_event_callback
*callback
= target_event_callbacks
;
1544 struct target_event_callback
*next_callback
;
1546 if (event
== TARGET_EVENT_HALTED
) {
1547 /* execute early halted first */
1548 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
1551 LOG_DEBUG("target event %i (%s)", event
,
1552 Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
);
1554 target_handle_event(target
, event
);
1557 next_callback
= callback
->next
;
1558 callback
->callback(target
, event
, callback
->priv
);
1559 callback
= next_callback
;
1565 int target_call_reset_callbacks(struct target
*target
, enum target_reset_mode reset_mode
)
1567 struct target_reset_callback
*callback
;
1569 LOG_DEBUG("target reset %i (%s)", reset_mode
,
1570 Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
);
1572 list_for_each_entry(callback
, &target_reset_callback_list
, list
)
1573 callback
->callback(target
, reset_mode
, callback
->priv
);
1578 int target_call_trace_callbacks(struct target
*target
, size_t len
, uint8_t *data
)
1580 struct target_trace_callback
*callback
;
1582 list_for_each_entry(callback
, &target_trace_callback_list
, list
)
1583 callback
->callback(target
, len
, data
, callback
->priv
);
1588 static int target_timer_callback_periodic_restart(
1589 struct target_timer_callback
*cb
, struct timeval
*now
)
1592 timeval_add_time(&cb
->when
, 0, cb
->time_ms
* 1000L);
1596 static int target_call_timer_callback(struct target_timer_callback
*cb
,
1597 struct timeval
*now
)
1599 cb
->callback(cb
->priv
);
1602 return target_timer_callback_periodic_restart(cb
, now
);
1604 return target_unregister_timer_callback(cb
->callback
, cb
->priv
);
1607 static int target_call_timer_callbacks_check_time(int checktime
)
1609 static bool callback_processing
;
1611 /* Do not allow nesting */
1612 if (callback_processing
)
1615 callback_processing
= true;
1620 gettimeofday(&now
, NULL
);
1622 /* Store an address of the place containing a pointer to the
1623 * next item; initially, that's a standalone "root of the
1624 * list" variable. */
1625 struct target_timer_callback
**callback
= &target_timer_callbacks
;
1627 if ((*callback
)->removed
) {
1628 struct target_timer_callback
*p
= *callback
;
1629 *callback
= (*callback
)->next
;
1634 bool call_it
= (*callback
)->callback
&&
1635 ((!checktime
&& (*callback
)->periodic
) ||
1636 timeval_compare(&now
, &(*callback
)->when
) >= 0);
1639 target_call_timer_callback(*callback
, &now
);
1641 callback
= &(*callback
)->next
;
1644 callback_processing
= false;
1648 int target_call_timer_callbacks(void)
1650 return target_call_timer_callbacks_check_time(1);
1653 /* invoke periodic callbacks immediately */
1654 int target_call_timer_callbacks_now(void)
1656 return target_call_timer_callbacks_check_time(0);
1659 /* Prints the working area layout for debug purposes */
1660 static void print_wa_layout(struct target
*target
)
1662 struct working_area
*c
= target
->working_areas
;
1665 LOG_DEBUG("%c%c " TARGET_ADDR_FMT
"-" TARGET_ADDR_FMT
" (%" PRIu32
" bytes)",
1666 c
->backup
? 'b' : ' ', c
->free
? ' ' : '*',
1667 c
->address
, c
->address
+ c
->size
- 1, c
->size
);
1672 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1673 static void target_split_working_area(struct working_area
*area
, uint32_t size
)
1675 assert(area
->free
); /* Shouldn't split an allocated area */
1676 assert(size
<= area
->size
); /* Caller should guarantee this */
1678 /* Split only if not already the right size */
1679 if (size
< area
->size
) {
1680 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1685 new_wa
->next
= area
->next
;
1686 new_wa
->size
= area
->size
- size
;
1687 new_wa
->address
= area
->address
+ size
;
1688 new_wa
->backup
= NULL
;
1689 new_wa
->user
= NULL
;
1690 new_wa
->free
= true;
1692 area
->next
= new_wa
;
1695 /* If backup memory was allocated to this area, it has the wrong size
1696 * now so free it and it will be reallocated if/when needed */
1699 area
->backup
= NULL
;
1704 /* Merge all adjacent free areas into one */
1705 static void target_merge_working_areas(struct target
*target
)
1707 struct working_area
*c
= target
->working_areas
;
1709 while (c
&& c
->next
) {
1710 assert(c
->next
->address
== c
->address
+ c
->size
); /* This is an invariant */
1712 /* Find two adjacent free areas */
1713 if (c
->free
&& c
->next
->free
) {
1714 /* Merge the last into the first */
1715 c
->size
+= c
->next
->size
;
1717 /* Remove the last */
1718 struct working_area
*to_be_freed
= c
->next
;
1719 c
->next
= c
->next
->next
;
1720 if (to_be_freed
->backup
)
1721 free(to_be_freed
->backup
);
1724 /* If backup memory was allocated to the remaining area, it's has
1725 * the wrong size now */
1736 int target_alloc_working_area_try(struct target
*target
, uint32_t size
, struct working_area
**area
)
1738 /* Reevaluate working area address based on MMU state*/
1739 if (target
->working_areas
== NULL
) {
1743 retval
= target
->type
->mmu(target
, &enabled
);
1744 if (retval
!= ERROR_OK
)
1748 if (target
->working_area_phys_spec
) {
1749 LOG_DEBUG("MMU disabled, using physical "
1750 "address for working memory " TARGET_ADDR_FMT
,
1751 target
->working_area_phys
);
1752 target
->working_area
= target
->working_area_phys
;
1754 LOG_ERROR("No working memory available. "
1755 "Specify -work-area-phys to target.");
1756 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1759 if (target
->working_area_virt_spec
) {
1760 LOG_DEBUG("MMU enabled, using virtual "
1761 "address for working memory " TARGET_ADDR_FMT
,
1762 target
->working_area_virt
);
1763 target
->working_area
= target
->working_area_virt
;
1765 LOG_ERROR("No working memory available. "
1766 "Specify -work-area-virt to target.");
1767 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1771 /* Set up initial working area on first call */
1772 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1774 new_wa
->next
= NULL
;
1775 new_wa
->size
= target
->working_area_size
& ~3UL; /* 4-byte align */
1776 new_wa
->address
= target
->working_area
;
1777 new_wa
->backup
= NULL
;
1778 new_wa
->user
= NULL
;
1779 new_wa
->free
= true;
1782 target
->working_areas
= new_wa
;
1785 /* only allocate multiples of 4 byte */
1787 size
= (size
+ 3) & (~3UL);
1789 struct working_area
*c
= target
->working_areas
;
1791 /* Find the first large enough working area */
1793 if (c
->free
&& c
->size
>= size
)
1799 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1801 /* Split the working area into the requested size */
1802 target_split_working_area(c
, size
);
1804 LOG_DEBUG("allocated new working area of %" PRIu32
" bytes at address " TARGET_ADDR_FMT
,
1807 if (target
->backup_working_area
) {
1808 if (c
->backup
== NULL
) {
1809 c
->backup
= malloc(c
->size
);
1810 if (c
->backup
== NULL
)
1814 int retval
= target_read_memory(target
, c
->address
, 4, c
->size
/ 4, c
->backup
);
1815 if (retval
!= ERROR_OK
)
1819 /* mark as used, and return the new (reused) area */
1826 print_wa_layout(target
);
1831 int target_alloc_working_area(struct target
*target
, uint32_t size
, struct working_area
**area
)
1835 retval
= target_alloc_working_area_try(target
, size
, area
);
1836 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
)
1837 LOG_WARNING("not enough working area available(requested %"PRIu32
")", size
);
1842 static int target_restore_working_area(struct target
*target
, struct working_area
*area
)
1844 int retval
= ERROR_OK
;
1846 if (target
->backup_working_area
&& area
->backup
!= NULL
) {
1847 retval
= target_write_memory(target
, area
->address
, 4, area
->size
/ 4, area
->backup
);
1848 if (retval
!= ERROR_OK
)
1849 LOG_ERROR("failed to restore %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1850 area
->size
, area
->address
);
1856 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1857 static int target_free_working_area_restore(struct target
*target
, struct working_area
*area
, int restore
)
1859 int retval
= ERROR_OK
;
1865 retval
= target_restore_working_area(target
, area
);
1866 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1867 if (retval
!= ERROR_OK
)
1873 LOG_DEBUG("freed %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1874 area
->size
, area
->address
);
1876 /* mark user pointer invalid */
1877 /* TODO: Is this really safe? It points to some previous caller's memory.
1878 * How could we know that the area pointer is still in that place and not
1879 * some other vital data? What's the purpose of this, anyway? */
1883 target_merge_working_areas(target
);
1885 print_wa_layout(target
);
1890 int target_free_working_area(struct target
*target
, struct working_area
*area
)
1892 return target_free_working_area_restore(target
, area
, 1);
1895 static void target_destroy(struct target
*target
)
1897 if (target
->type
->deinit_target
)
1898 target
->type
->deinit_target(target
);
1900 if (target
->semihosting
)
1901 free(target
->semihosting
);
1903 jtag_unregister_event_callback(jtag_enable_callback
, target
);
1905 struct target_event_action
*teap
= target
->event_action
;
1907 struct target_event_action
*next
= teap
->next
;
1908 Jim_DecrRefCount(teap
->interp
, teap
->body
);
1913 target_free_all_working_areas(target
);
1914 /* Now we have none or only one working area marked as free */
1915 if (target
->working_areas
) {
1916 free(target
->working_areas
->backup
);
1917 free(target
->working_areas
);
1920 /* release the targets SMP list */
1922 struct target_list
*head
= target
->head
;
1923 while (head
!= NULL
) {
1924 struct target_list
*pos
= head
->next
;
1925 head
->target
->smp
= 0;
1932 free(target
->gdb_port_override
);
1934 free(target
->trace_info
);
1935 free(target
->fileio_info
);
1936 free(target
->cmd_name
);
1940 void target_quit(void)
1942 struct target_event_callback
*pe
= target_event_callbacks
;
1944 struct target_event_callback
*t
= pe
->next
;
1948 target_event_callbacks
= NULL
;
1950 struct target_timer_callback
*pt
= target_timer_callbacks
;
1952 struct target_timer_callback
*t
= pt
->next
;
1956 target_timer_callbacks
= NULL
;
1958 for (struct target
*target
= all_targets
; target
;) {
1962 target_destroy(target
);
1969 /* free resources and restore memory, if restoring memory fails,
1970 * free up resources anyway
1972 static void target_free_all_working_areas_restore(struct target
*target
, int restore
)
1974 struct working_area
*c
= target
->working_areas
;
1976 LOG_DEBUG("freeing all working areas");
1978 /* Loop through all areas, restoring the allocated ones and marking them as free */
1982 target_restore_working_area(target
, c
);
1984 *c
->user
= NULL
; /* Same as above */
1990 /* Run a merge pass to combine all areas into one */
1991 target_merge_working_areas(target
);
1993 print_wa_layout(target
);
1996 void target_free_all_working_areas(struct target
*target
)
1998 target_free_all_working_areas_restore(target
, 1);
2001 /* Find the largest number of bytes that can be allocated */
2002 uint32_t target_get_working_area_avail(struct target
*target
)
2004 struct working_area
*c
= target
->working_areas
;
2005 uint32_t max_size
= 0;
2008 return target
->working_area_size
;
2011 if (c
->free
&& max_size
< c
->size
)
2020 int target_arch_state(struct target
*target
)
2023 if (target
== NULL
) {
2024 LOG_WARNING("No target has been configured");
2028 if (target
->state
!= TARGET_HALTED
)
2031 retval
= target
->type
->arch_state(target
);
2035 static int target_get_gdb_fileio_info_default(struct target
*target
,
2036 struct gdb_fileio_info
*fileio_info
)
2038 /* If target does not support semi-hosting function, target
2039 has no need to provide .get_gdb_fileio_info callback.
2040 It just return ERROR_FAIL and gdb_server will return "Txx"
2041 as target halted every time. */
2045 static int target_gdb_fileio_end_default(struct target
*target
,
2046 int retcode
, int fileio_errno
, bool ctrl_c
)
2051 static int target_profiling_default(struct target
*target
, uint32_t *samples
,
2052 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
2054 struct timeval timeout
, now
;
2056 gettimeofday(&timeout
, NULL
);
2057 timeval_add_time(&timeout
, seconds
, 0);
2059 LOG_INFO("Starting profiling. Halting and resuming the"
2060 " target as often as we can...");
2062 uint32_t sample_count
= 0;
2063 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
2064 struct reg
*reg
= register_get_by_name(target
->reg_cache
, "pc", 1);
2066 int retval
= ERROR_OK
;
2068 target_poll(target
);
2069 if (target
->state
== TARGET_HALTED
) {
2070 uint32_t t
= buf_get_u32(reg
->value
, 0, 32);
2071 samples
[sample_count
++] = t
;
2072 /* current pc, addr = 0, do not handle breakpoints, not debugging */
2073 retval
= target_resume(target
, 1, 0, 0, 0);
2074 target_poll(target
);
2075 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
2076 } else if (target
->state
== TARGET_RUNNING
) {
2077 /* We want to quickly sample the PC. */
2078 retval
= target_halt(target
);
2080 LOG_INFO("Target not halted or running");
2085 if (retval
!= ERROR_OK
)
2088 gettimeofday(&now
, NULL
);
2089 if ((sample_count
>= max_num_samples
) || timeval_compare(&now
, &timeout
) >= 0) {
2090 LOG_INFO("Profiling completed. %" PRIu32
" samples.", sample_count
);
2095 *num_samples
= sample_count
;
2099 /* Single aligned words are guaranteed to use 16 or 32 bit access
2100 * mode respectively, otherwise data is handled as quickly as
2103 int target_write_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, const uint8_t *buffer
)
2105 LOG_DEBUG("writing buffer of %" PRIi32
" byte at " TARGET_ADDR_FMT
,
2108 if (!target_was_examined(target
)) {
2109 LOG_ERROR("Target not examined yet");
2116 if ((address
+ size
- 1) < address
) {
2117 /* GDB can request this when e.g. PC is 0xfffffffc */
2118 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2124 return target
->type
->write_buffer(target
, address
, size
, buffer
);
2127 static int target_write_buffer_default(struct target
*target
,
2128 target_addr_t address
, uint32_t count
, const uint8_t *buffer
)
2132 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2133 * will have something to do with the size we leave to it. */
2134 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2135 if (address
& size
) {
2136 int retval
= target_write_memory(target
, address
, size
, 1, buffer
);
2137 if (retval
!= ERROR_OK
)
2145 /* Write the data with as large access size as possible. */
2146 for (; size
> 0; size
/= 2) {
2147 uint32_t aligned
= count
- count
% size
;
2149 int retval
= target_write_memory(target
, address
, size
, aligned
/ size
, buffer
);
2150 if (retval
!= ERROR_OK
)
2161 /* Single aligned words are guaranteed to use 16 or 32 bit access
2162 * mode respectively, otherwise data is handled as quickly as
2165 int target_read_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, uint8_t *buffer
)
2167 LOG_DEBUG("reading buffer of %" PRIi32
" byte at " TARGET_ADDR_FMT
,
2170 if (!target_was_examined(target
)) {
2171 LOG_ERROR("Target not examined yet");
2178 if ((address
+ size
- 1) < address
) {
2179 /* GDB can request this when e.g. PC is 0xfffffffc */
2180 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2186 return target
->type
->read_buffer(target
, address
, size
, buffer
);
2189 static int target_read_buffer_default(struct target
*target
, target_addr_t address
, uint32_t count
, uint8_t *buffer
)
2193 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2194 * will have something to do with the size we leave to it. */
2195 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2196 if (address
& size
) {
2197 int retval
= target_read_memory(target
, address
, size
, 1, buffer
);
2198 if (retval
!= ERROR_OK
)
2206 /* Read the data with as large access size as possible. */
2207 for (; size
> 0; size
/= 2) {
2208 uint32_t aligned
= count
- count
% size
;
2210 int retval
= target_read_memory(target
, address
, size
, aligned
/ size
, buffer
);
2211 if (retval
!= ERROR_OK
)
2222 int target_checksum_memory(struct target
*target
, target_addr_t address
, uint32_t size
, uint32_t* crc
)
2227 uint32_t checksum
= 0;
2228 if (!target_was_examined(target
)) {
2229 LOG_ERROR("Target not examined yet");
2233 retval
= target
->type
->checksum_memory(target
, address
, size
, &checksum
);
2234 if (retval
!= ERROR_OK
) {
2235 buffer
= malloc(size
);
2236 if (buffer
== NULL
) {
2237 LOG_ERROR("error allocating buffer for section (%" PRId32
" bytes)", size
);
2238 return ERROR_COMMAND_SYNTAX_ERROR
;
2240 retval
= target_read_buffer(target
, address
, size
, buffer
);
2241 if (retval
!= ERROR_OK
) {
2246 /* convert to target endianness */
2247 for (i
= 0; i
< (size
/sizeof(uint32_t)); i
++) {
2248 uint32_t target_data
;
2249 target_data
= target_buffer_get_u32(target
, &buffer
[i
*sizeof(uint32_t)]);
2250 target_buffer_set_u32(target
, &buffer
[i
*sizeof(uint32_t)], target_data
);
2253 retval
= image_calculate_checksum(buffer
, size
, &checksum
);
2262 int target_blank_check_memory(struct target
*target
,
2263 struct target_memory_check_block
*blocks
, int num_blocks
,
2264 uint8_t erased_value
)
2266 if (!target_was_examined(target
)) {
2267 LOG_ERROR("Target not examined yet");
2271 if (target
->type
->blank_check_memory
== NULL
)
2272 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
2274 return target
->type
->blank_check_memory(target
, blocks
, num_blocks
, erased_value
);
2277 int target_read_u64(struct target
*target
, target_addr_t address
, uint64_t *value
)
2279 uint8_t value_buf
[8];
2280 if (!target_was_examined(target
)) {
2281 LOG_ERROR("Target not examined yet");
2285 int retval
= target_read_memory(target
, address
, 8, 1, value_buf
);
2287 if (retval
== ERROR_OK
) {
2288 *value
= target_buffer_get_u64(target
, value_buf
);
2289 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2294 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2301 int target_read_u32(struct target
*target
, target_addr_t address
, uint32_t *value
)
2303 uint8_t value_buf
[4];
2304 if (!target_was_examined(target
)) {
2305 LOG_ERROR("Target not examined yet");
2309 int retval
= target_read_memory(target
, address
, 4, 1, value_buf
);
2311 if (retval
== ERROR_OK
) {
2312 *value
= target_buffer_get_u32(target
, value_buf
);
2313 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2318 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2325 int target_read_u16(struct target
*target
, target_addr_t address
, uint16_t *value
)
2327 uint8_t value_buf
[2];
2328 if (!target_was_examined(target
)) {
2329 LOG_ERROR("Target not examined yet");
2333 int retval
= target_read_memory(target
, address
, 2, 1, value_buf
);
2335 if (retval
== ERROR_OK
) {
2336 *value
= target_buffer_get_u16(target
, value_buf
);
2337 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%4.4" PRIx16
,
2342 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2349 int target_read_u8(struct target
*target
, target_addr_t address
, uint8_t *value
)
2351 if (!target_was_examined(target
)) {
2352 LOG_ERROR("Target not examined yet");
2356 int retval
= target_read_memory(target
, address
, 1, 1, value
);
2358 if (retval
== ERROR_OK
) {
2359 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2364 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2371 int target_write_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2374 uint8_t value_buf
[8];
2375 if (!target_was_examined(target
)) {
2376 LOG_ERROR("Target not examined yet");
2380 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2384 target_buffer_set_u64(target
, value_buf
, value
);
2385 retval
= target_write_memory(target
, address
, 8, 1, value_buf
);
2386 if (retval
!= ERROR_OK
)
2387 LOG_DEBUG("failed: %i", retval
);
2392 int target_write_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2395 uint8_t value_buf
[4];
2396 if (!target_was_examined(target
)) {
2397 LOG_ERROR("Target not examined yet");
2401 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2405 target_buffer_set_u32(target
, value_buf
, value
);
2406 retval
= target_write_memory(target
, address
, 4, 1, value_buf
);
2407 if (retval
!= ERROR_OK
)
2408 LOG_DEBUG("failed: %i", retval
);
2413 int target_write_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2416 uint8_t value_buf
[2];
2417 if (!target_was_examined(target
)) {
2418 LOG_ERROR("Target not examined yet");
2422 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2426 target_buffer_set_u16(target
, value_buf
, value
);
2427 retval
= target_write_memory(target
, address
, 2, 1, value_buf
);
2428 if (retval
!= ERROR_OK
)
2429 LOG_DEBUG("failed: %i", retval
);
2434 int target_write_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2437 if (!target_was_examined(target
)) {
2438 LOG_ERROR("Target not examined yet");
2442 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2445 retval
= target_write_memory(target
, address
, 1, 1, &value
);
2446 if (retval
!= ERROR_OK
)
2447 LOG_DEBUG("failed: %i", retval
);
2452 int target_write_phys_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2455 uint8_t value_buf
[8];
2456 if (!target_was_examined(target
)) {
2457 LOG_ERROR("Target not examined yet");
2461 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2465 target_buffer_set_u64(target
, value_buf
, value
);
2466 retval
= target_write_phys_memory(target
, address
, 8, 1, value_buf
);
2467 if (retval
!= ERROR_OK
)
2468 LOG_DEBUG("failed: %i", retval
);
2473 int target_write_phys_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2476 uint8_t value_buf
[4];
2477 if (!target_was_examined(target
)) {
2478 LOG_ERROR("Target not examined yet");
2482 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2486 target_buffer_set_u32(target
, value_buf
, value
);
2487 retval
= target_write_phys_memory(target
, address
, 4, 1, value_buf
);
2488 if (retval
!= ERROR_OK
)
2489 LOG_DEBUG("failed: %i", retval
);
2494 int target_write_phys_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2497 uint8_t value_buf
[2];
2498 if (!target_was_examined(target
)) {
2499 LOG_ERROR("Target not examined yet");
2503 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2507 target_buffer_set_u16(target
, value_buf
, value
);
2508 retval
= target_write_phys_memory(target
, address
, 2, 1, value_buf
);
2509 if (retval
!= ERROR_OK
)
2510 LOG_DEBUG("failed: %i", retval
);
2515 int target_write_phys_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2518 if (!target_was_examined(target
)) {
2519 LOG_ERROR("Target not examined yet");
2523 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2526 retval
= target_write_phys_memory(target
, address
, 1, 1, &value
);
2527 if (retval
!= ERROR_OK
)
2528 LOG_DEBUG("failed: %i", retval
);
2533 static int find_target(struct command_context
*cmd_ctx
, const char *name
)
2535 struct target
*target
= get_target(name
);
2536 if (target
== NULL
) {
2537 LOG_ERROR("Target: %s is unknown, try one of:\n", name
);
2540 if (!target
->tap
->enabled
) {
2541 LOG_USER("Target: TAP %s is disabled, "
2542 "can't be the current target\n",
2543 target
->tap
->dotted_name
);
2547 cmd_ctx
->current_target
= target
;
2548 if (cmd_ctx
->current_target_override
)
2549 cmd_ctx
->current_target_override
= target
;
2555 COMMAND_HANDLER(handle_targets_command
)
2557 int retval
= ERROR_OK
;
2558 if (CMD_ARGC
== 1) {
2559 retval
= find_target(CMD_CTX
, CMD_ARGV
[0]);
2560 if (retval
== ERROR_OK
) {
2566 struct target
*target
= all_targets
;
2567 command_print(CMD_CTX
, " TargetName Type Endian TapName State ");
2568 command_print(CMD_CTX
, "-- ------------------ ---------- ------ ------------------ ------------");
2573 if (target
->tap
->enabled
)
2574 state
= target_state_name(target
);
2576 state
= "tap-disabled";
2578 if (CMD_CTX
->current_target
== target
)
2581 /* keep columns lined up to match the headers above */
2582 command_print(CMD_CTX
,
2583 "%2d%c %-18s %-10s %-6s %-18s %s",
2584 target
->target_number
,
2586 target_name(target
),
2587 target_type_name(target
),
2588 Jim_Nvp_value2name_simple(nvp_target_endian
,
2589 target
->endianness
)->name
,
2590 target
->tap
->dotted_name
,
2592 target
= target
->next
;
2598 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2600 static int powerDropout
;
2601 static int srstAsserted
;
2603 static int runPowerRestore
;
2604 static int runPowerDropout
;
2605 static int runSrstAsserted
;
2606 static int runSrstDeasserted
;
2608 static int sense_handler(void)
2610 static int prevSrstAsserted
;
2611 static int prevPowerdropout
;
2613 int retval
= jtag_power_dropout(&powerDropout
);
2614 if (retval
!= ERROR_OK
)
2618 powerRestored
= prevPowerdropout
&& !powerDropout
;
2620 runPowerRestore
= 1;
2622 int64_t current
= timeval_ms();
2623 static int64_t lastPower
;
2624 bool waitMore
= lastPower
+ 2000 > current
;
2625 if (powerDropout
&& !waitMore
) {
2626 runPowerDropout
= 1;
2627 lastPower
= current
;
2630 retval
= jtag_srst_asserted(&srstAsserted
);
2631 if (retval
!= ERROR_OK
)
2635 srstDeasserted
= prevSrstAsserted
&& !srstAsserted
;
2637 static int64_t lastSrst
;
2638 waitMore
= lastSrst
+ 2000 > current
;
2639 if (srstDeasserted
&& !waitMore
) {
2640 runSrstDeasserted
= 1;
2644 if (!prevSrstAsserted
&& srstAsserted
)
2645 runSrstAsserted
= 1;
2647 prevSrstAsserted
= srstAsserted
;
2648 prevPowerdropout
= powerDropout
;
2650 if (srstDeasserted
|| powerRestored
) {
2651 /* Other than logging the event we can't do anything here.
2652 * Issuing a reset is a particularly bad idea as we might
2653 * be inside a reset already.
2660 /* process target state changes */
2661 static int handle_target(void *priv
)
2663 Jim_Interp
*interp
= (Jim_Interp
*)priv
;
2664 int retval
= ERROR_OK
;
2666 if (!is_jtag_poll_safe()) {
2667 /* polling is disabled currently */
2671 /* we do not want to recurse here... */
2672 static int recursive
;
2676 /* danger! running these procedures can trigger srst assertions and power dropouts.
2677 * We need to avoid an infinite loop/recursion here and we do that by
2678 * clearing the flags after running these events.
2680 int did_something
= 0;
2681 if (runSrstAsserted
) {
2682 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2683 Jim_Eval(interp
, "srst_asserted");
2686 if (runSrstDeasserted
) {
2687 Jim_Eval(interp
, "srst_deasserted");
2690 if (runPowerDropout
) {
2691 LOG_INFO("Power dropout detected, running power_dropout proc.");
2692 Jim_Eval(interp
, "power_dropout");
2695 if (runPowerRestore
) {
2696 Jim_Eval(interp
, "power_restore");
2700 if (did_something
) {
2701 /* clear detect flags */
2705 /* clear action flags */
2707 runSrstAsserted
= 0;
2708 runSrstDeasserted
= 0;
2709 runPowerRestore
= 0;
2710 runPowerDropout
= 0;
2715 /* Poll targets for state changes unless that's globally disabled.
2716 * Skip targets that are currently disabled.
2718 for (struct target
*target
= all_targets
;
2719 is_jtag_poll_safe() && target
;
2720 target
= target
->next
) {
2722 if (!target_was_examined(target
))
2725 if (!target
->tap
->enabled
)
2728 if (target
->backoff
.times
> target
->backoff
.count
) {
2729 /* do not poll this time as we failed previously */
2730 target
->backoff
.count
++;
2733 target
->backoff
.count
= 0;
2735 /* only poll target if we've got power and srst isn't asserted */
2736 if (!powerDropout
&& !srstAsserted
) {
2737 /* polling may fail silently until the target has been examined */
2738 retval
= target_poll(target
);
2739 if (retval
!= ERROR_OK
) {
2740 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2741 if (target
->backoff
.times
* polling_interval
< 5000) {
2742 target
->backoff
.times
*= 2;
2743 target
->backoff
.times
++;
2746 /* Tell GDB to halt the debugger. This allows the user to
2747 * run monitor commands to handle the situation.
2749 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2751 if (target
->backoff
.times
> 0) {
2752 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target
));
2753 target_reset_examined(target
);
2754 retval
= target_examine_one(target
);
2755 /* Target examination could have failed due to unstable connection,
2756 * but we set the examined flag anyway to repoll it later */
2757 if (retval
!= ERROR_OK
) {
2758 target
->examined
= true;
2759 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2760 target
->backoff
.times
* polling_interval
);
2765 /* Since we succeeded, we reset backoff count */
2766 target
->backoff
.times
= 0;
2773 COMMAND_HANDLER(handle_reg_command
)
2775 struct target
*target
;
2776 struct reg
*reg
= NULL
;
2782 target
= get_current_target(CMD_CTX
);
2784 /* list all available registers for the current target */
2785 if (CMD_ARGC
== 0) {
2786 struct reg_cache
*cache
= target
->reg_cache
;
2792 command_print(CMD_CTX
, "===== %s", cache
->name
);
2794 for (i
= 0, reg
= cache
->reg_list
;
2795 i
< cache
->num_regs
;
2796 i
++, reg
++, count
++) {
2797 /* only print cached values if they are valid */
2799 value
= buf_to_str(reg
->value
,
2801 command_print(CMD_CTX
,
2802 "(%i) %s (/%" PRIu32
"): 0x%s%s",
2810 command_print(CMD_CTX
, "(%i) %s (/%" PRIu32
")",
2815 cache
= cache
->next
;
2821 /* access a single register by its ordinal number */
2822 if ((CMD_ARGV
[0][0] >= '0') && (CMD_ARGV
[0][0] <= '9')) {
2824 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num
);
2826 struct reg_cache
*cache
= target
->reg_cache
;
2830 for (i
= 0; i
< cache
->num_regs
; i
++) {
2831 if (count
++ == num
) {
2832 reg
= &cache
->reg_list
[i
];
2838 cache
= cache
->next
;
2842 command_print(CMD_CTX
, "%i is out of bounds, the current target "
2843 "has only %i registers (0 - %i)", num
, count
, count
- 1);
2847 /* access a single register by its name */
2848 reg
= register_get_by_name(target
->reg_cache
, CMD_ARGV
[0], 1);
2851 command_print(CMD_CTX
, "register %s not found in current target", CMD_ARGV
[0]);
2856 assert(reg
!= NULL
); /* give clang a hint that we *know* reg is != NULL here */
2858 /* display a register */
2859 if ((CMD_ARGC
== 1) || ((CMD_ARGC
== 2) && !((CMD_ARGV
[1][0] >= '0')
2860 && (CMD_ARGV
[1][0] <= '9')))) {
2861 if ((CMD_ARGC
== 2) && (strcmp(CMD_ARGV
[1], "force") == 0))
2864 if (reg
->valid
== 0)
2865 reg
->type
->get(reg
);
2866 value
= buf_to_str(reg
->value
, reg
->size
, 16);
2867 command_print(CMD_CTX
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2872 /* set register value */
2873 if (CMD_ARGC
== 2) {
2874 uint8_t *buf
= malloc(DIV_ROUND_UP(reg
->size
, 8));
2877 str_to_buf(CMD_ARGV
[1], strlen(CMD_ARGV
[1]), buf
, reg
->size
, 0);
2879 reg
->type
->set(reg
, buf
);
2881 value
= buf_to_str(reg
->value
, reg
->size
, 16);
2882 command_print(CMD_CTX
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2890 return ERROR_COMMAND_SYNTAX_ERROR
;
2893 COMMAND_HANDLER(handle_poll_command
)
2895 int retval
= ERROR_OK
;
2896 struct target
*target
= get_current_target(CMD_CTX
);
2898 if (CMD_ARGC
== 0) {
2899 command_print(CMD_CTX
, "background polling: %s",
2900 jtag_poll_get_enabled() ? "on" : "off");
2901 command_print(CMD_CTX
, "TAP: %s (%s)",
2902 target
->tap
->dotted_name
,
2903 target
->tap
->enabled
? "enabled" : "disabled");
2904 if (!target
->tap
->enabled
)
2906 retval
= target_poll(target
);
2907 if (retval
!= ERROR_OK
)
2909 retval
= target_arch_state(target
);
2910 if (retval
!= ERROR_OK
)
2912 } else if (CMD_ARGC
== 1) {
2914 COMMAND_PARSE_ON_OFF(CMD_ARGV
[0], enable
);
2915 jtag_poll_set_enabled(enable
);
2917 return ERROR_COMMAND_SYNTAX_ERROR
;
2922 COMMAND_HANDLER(handle_wait_halt_command
)
2925 return ERROR_COMMAND_SYNTAX_ERROR
;
2927 unsigned ms
= DEFAULT_HALT_TIMEOUT
;
2928 if (1 == CMD_ARGC
) {
2929 int retval
= parse_uint(CMD_ARGV
[0], &ms
);
2930 if (ERROR_OK
!= retval
)
2931 return ERROR_COMMAND_SYNTAX_ERROR
;
2934 struct target
*target
= get_current_target(CMD_CTX
);
2935 return target_wait_state(target
, TARGET_HALTED
, ms
);
2938 /* wait for target state to change. The trick here is to have a low
2939 * latency for short waits and not to suck up all the CPU time
2942 * After 500ms, keep_alive() is invoked
2944 int target_wait_state(struct target
*target
, enum target_state state
, int ms
)
2947 int64_t then
= 0, cur
;
2951 retval
= target_poll(target
);
2952 if (retval
!= ERROR_OK
)
2954 if (target
->state
== state
)
2959 then
= timeval_ms();
2960 LOG_DEBUG("waiting for target %s...",
2961 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
2967 if ((cur
-then
) > ms
) {
2968 LOG_ERROR("timed out while waiting for target %s",
2969 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
2977 COMMAND_HANDLER(handle_halt_command
)
2981 struct target
*target
= get_current_target(CMD_CTX
);
2983 target
->verbose_halt_msg
= true;
2985 int retval
= target_halt(target
);
2986 if (ERROR_OK
!= retval
)
2989 if (CMD_ARGC
== 1) {
2990 unsigned wait_local
;
2991 retval
= parse_uint(CMD_ARGV
[0], &wait_local
);
2992 if (ERROR_OK
!= retval
)
2993 return ERROR_COMMAND_SYNTAX_ERROR
;
2998 return CALL_COMMAND_HANDLER(handle_wait_halt_command
);
3001 COMMAND_HANDLER(handle_soft_reset_halt_command
)
3003 struct target
*target
= get_current_target(CMD_CTX
);
3005 LOG_USER("requesting target halt and executing a soft reset");
3007 target_soft_reset_halt(target
);
3012 COMMAND_HANDLER(handle_reset_command
)
3015 return ERROR_COMMAND_SYNTAX_ERROR
;
3017 enum target_reset_mode reset_mode
= RESET_RUN
;
3018 if (CMD_ARGC
== 1) {
3020 n
= Jim_Nvp_name2value_simple(nvp_reset_modes
, CMD_ARGV
[0]);
3021 if ((n
->name
== NULL
) || (n
->value
== RESET_UNKNOWN
))
3022 return ERROR_COMMAND_SYNTAX_ERROR
;
3023 reset_mode
= n
->value
;
3026 /* reset *all* targets */
3027 return target_process_reset(CMD_CTX
, reset_mode
);
3031 COMMAND_HANDLER(handle_resume_command
)
3035 return ERROR_COMMAND_SYNTAX_ERROR
;
3037 struct target
*target
= get_current_target(CMD_CTX
);
3039 /* with no CMD_ARGV, resume from current pc, addr = 0,
3040 * with one arguments, addr = CMD_ARGV[0],
3041 * handle breakpoints, not debugging */
3042 target_addr_t addr
= 0;
3043 if (CMD_ARGC
== 1) {
3044 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3048 return target_resume(target
, current
, addr
, 1, 0);
3051 COMMAND_HANDLER(handle_step_command
)
3054 return ERROR_COMMAND_SYNTAX_ERROR
;
3058 /* with no CMD_ARGV, step from current pc, addr = 0,
3059 * with one argument addr = CMD_ARGV[0],
3060 * handle breakpoints, debugging */
3061 target_addr_t addr
= 0;
3063 if (CMD_ARGC
== 1) {
3064 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3068 struct target
*target
= get_current_target(CMD_CTX
);
3070 return target
->type
->step(target
, current_pc
, addr
, 1);
3073 static void handle_md_output(struct command_context
*cmd_ctx
,
3074 struct target
*target
, target_addr_t address
, unsigned size
,
3075 unsigned count
, const uint8_t *buffer
)
3077 const unsigned line_bytecnt
= 32;
3078 unsigned line_modulo
= line_bytecnt
/ size
;
3080 char output
[line_bytecnt
* 4 + 1];
3081 unsigned output_len
= 0;
3083 const char *value_fmt
;
3086 value_fmt
= "%16.16"PRIx64
" ";
3089 value_fmt
= "%8.8"PRIx64
" ";
3092 value_fmt
= "%4.4"PRIx64
" ";
3095 value_fmt
= "%2.2"PRIx64
" ";
3098 /* "can't happen", caller checked */
3099 LOG_ERROR("invalid memory read size: %u", size
);
3103 for (unsigned i
= 0; i
< count
; i
++) {
3104 if (i
% line_modulo
== 0) {
3105 output_len
+= snprintf(output
+ output_len
,
3106 sizeof(output
) - output_len
,
3107 TARGET_ADDR_FMT
": ",
3108 (address
+ (i
* size
)));
3112 const uint8_t *value_ptr
= buffer
+ i
* size
;
3115 value
= target_buffer_get_u64(target
, value_ptr
);
3118 value
= target_buffer_get_u32(target
, value_ptr
);
3121 value
= target_buffer_get_u16(target
, value_ptr
);
3126 output_len
+= snprintf(output
+ output_len
,
3127 sizeof(output
) - output_len
,
3130 if ((i
% line_modulo
== line_modulo
- 1) || (i
== count
- 1)) {
3131 command_print(cmd_ctx
, "%s", output
);
3137 COMMAND_HANDLER(handle_md_command
)
3140 return ERROR_COMMAND_SYNTAX_ERROR
;
3143 switch (CMD_NAME
[2]) {
3157 return ERROR_COMMAND_SYNTAX_ERROR
;
3160 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3161 int (*fn
)(struct target
*target
,
3162 target_addr_t address
, uint32_t size_value
, uint32_t count
, uint8_t *buffer
);
3166 fn
= target_read_phys_memory
;
3168 fn
= target_read_memory
;
3169 if ((CMD_ARGC
< 1) || (CMD_ARGC
> 2))
3170 return ERROR_COMMAND_SYNTAX_ERROR
;
3172 target_addr_t address
;
3173 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3177 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], count
);
3179 uint8_t *buffer
= calloc(count
, size
);
3180 if (buffer
== NULL
) {
3181 LOG_ERROR("Failed to allocate md read buffer");
3185 struct target
*target
= get_current_target(CMD_CTX
);
3186 int retval
= fn(target
, address
, size
, count
, buffer
);
3187 if (ERROR_OK
== retval
)
3188 handle_md_output(CMD_CTX
, target
, address
, size
, count
, buffer
);
3195 typedef int (*target_write_fn
)(struct target
*target
,
3196 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
);
3198 static int target_fill_mem(struct target
*target
,
3199 target_addr_t address
,
3207 /* We have to write in reasonably large chunks to be able
3208 * to fill large memory areas with any sane speed */
3209 const unsigned chunk_size
= 16384;
3210 uint8_t *target_buf
= malloc(chunk_size
* data_size
);
3211 if (target_buf
== NULL
) {
3212 LOG_ERROR("Out of memory");
3216 for (unsigned i
= 0; i
< chunk_size
; i
++) {
3217 switch (data_size
) {
3219 target_buffer_set_u64(target
, target_buf
+ i
* data_size
, b
);
3222 target_buffer_set_u32(target
, target_buf
+ i
* data_size
, b
);
3225 target_buffer_set_u16(target
, target_buf
+ i
* data_size
, b
);
3228 target_buffer_set_u8(target
, target_buf
+ i
* data_size
, b
);
3235 int retval
= ERROR_OK
;
3237 for (unsigned x
= 0; x
< c
; x
+= chunk_size
) {
3240 if (current
> chunk_size
)
3241 current
= chunk_size
;
3242 retval
= fn(target
, address
+ x
* data_size
, data_size
, current
, target_buf
);
3243 if (retval
!= ERROR_OK
)
3245 /* avoid GDB timeouts */
3254 COMMAND_HANDLER(handle_mw_command
)
3257 return ERROR_COMMAND_SYNTAX_ERROR
;
3258 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3263 fn
= target_write_phys_memory
;
3265 fn
= target_write_memory
;
3266 if ((CMD_ARGC
< 2) || (CMD_ARGC
> 3))
3267 return ERROR_COMMAND_SYNTAX_ERROR
;
3269 target_addr_t address
;
3270 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3272 target_addr_t value
;
3273 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], value
);
3277 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[2], count
);
3279 struct target
*target
= get_current_target(CMD_CTX
);
3281 switch (CMD_NAME
[2]) {
3295 return ERROR_COMMAND_SYNTAX_ERROR
;
3298 return target_fill_mem(target
, address
, fn
, wordsize
, value
, count
);
3301 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV
, struct image
*image
,
3302 target_addr_t
*min_address
, target_addr_t
*max_address
)
3304 if (CMD_ARGC
< 1 || CMD_ARGC
> 5)
3305 return ERROR_COMMAND_SYNTAX_ERROR
;
3307 /* a base address isn't always necessary,
3308 * default to 0x0 (i.e. don't relocate) */
3309 if (CMD_ARGC
>= 2) {
3311 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3312 image
->base_address
= addr
;
3313 image
->base_address_set
= 1;
3315 image
->base_address_set
= 0;
3317 image
->start_address_set
= 0;
3320 COMMAND_PARSE_ADDRESS(CMD_ARGV
[3], *min_address
);
3321 if (CMD_ARGC
== 5) {
3322 COMMAND_PARSE_ADDRESS(CMD_ARGV
[4], *max_address
);
3323 /* use size (given) to find max (required) */
3324 *max_address
+= *min_address
;
3327 if (*min_address
> *max_address
)
3328 return ERROR_COMMAND_SYNTAX_ERROR
;
3333 COMMAND_HANDLER(handle_load_image_command
)
3337 uint32_t image_size
;
3338 target_addr_t min_address
= 0;
3339 target_addr_t max_address
= -1;
3343 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
3344 &image
, &min_address
, &max_address
);
3345 if (ERROR_OK
!= retval
)
3348 struct target
*target
= get_current_target(CMD_CTX
);
3350 struct duration bench
;
3351 duration_start(&bench
);
3353 if (image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
) != ERROR_OK
)
3358 for (i
= 0; i
< image
.num_sections
; i
++) {
3359 buffer
= malloc(image
.sections
[i
].size
);
3360 if (buffer
== NULL
) {
3361 command_print(CMD_CTX
,
3362 "error allocating buffer for section (%d bytes)",
3363 (int)(image
.sections
[i
].size
));
3364 retval
= ERROR_FAIL
;
3368 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3369 if (retval
!= ERROR_OK
) {
3374 uint32_t offset
= 0;
3375 uint32_t length
= buf_cnt
;
3377 /* DANGER!!! beware of unsigned comparision here!!! */
3379 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
3380 (image
.sections
[i
].base_address
< max_address
)) {
3382 if (image
.sections
[i
].base_address
< min_address
) {
3383 /* clip addresses below */
3384 offset
+= min_address
-image
.sections
[i
].base_address
;
3388 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
3389 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
3391 retval
= target_write_buffer(target
,
3392 image
.sections
[i
].base_address
+ offset
, length
, buffer
+ offset
);
3393 if (retval
!= ERROR_OK
) {
3397 image_size
+= length
;
3398 command_print(CMD_CTX
, "%u bytes written at address " TARGET_ADDR_FMT
"",
3399 (unsigned int)length
,
3400 image
.sections
[i
].base_address
+ offset
);
3406 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3407 command_print(CMD_CTX
, "downloaded %" PRIu32
" bytes "
3408 "in %fs (%0.3f KiB/s)", image_size
,
3409 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3412 image_close(&image
);
3418 COMMAND_HANDLER(handle_dump_image_command
)
3420 struct fileio
*fileio
;
3422 int retval
, retvaltemp
;
3423 target_addr_t address
, size
;
3424 struct duration bench
;
3425 struct target
*target
= get_current_target(CMD_CTX
);
3428 return ERROR_COMMAND_SYNTAX_ERROR
;
3430 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], address
);
3431 COMMAND_PARSE_ADDRESS(CMD_ARGV
[2], size
);
3433 uint32_t buf_size
= (size
> 4096) ? 4096 : size
;
3434 buffer
= malloc(buf_size
);
3438 retval
= fileio_open(&fileio
, CMD_ARGV
[0], FILEIO_WRITE
, FILEIO_BINARY
);
3439 if (retval
!= ERROR_OK
) {
3444 duration_start(&bench
);
3447 size_t size_written
;
3448 uint32_t this_run_size
= (size
> buf_size
) ? buf_size
: size
;
3449 retval
= target_read_buffer(target
, address
, this_run_size
, buffer
);
3450 if (retval
!= ERROR_OK
)
3453 retval
= fileio_write(fileio
, this_run_size
, buffer
, &size_written
);
3454 if (retval
!= ERROR_OK
)
3457 size
-= this_run_size
;
3458 address
+= this_run_size
;
3463 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3465 retval
= fileio_size(fileio
, &filesize
);
3466 if (retval
!= ERROR_OK
)
3468 command_print(CMD_CTX
,
3469 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize
,
3470 duration_elapsed(&bench
), duration_kbps(&bench
, filesize
));
3473 retvaltemp
= fileio_close(fileio
);
3474 if (retvaltemp
!= ERROR_OK
)
3483 IMAGE_CHECKSUM_ONLY
= 2
3486 static COMMAND_HELPER(handle_verify_image_command_internal
, enum verify_mode verify
)
3490 uint32_t image_size
;
3493 uint32_t checksum
= 0;
3494 uint32_t mem_checksum
= 0;
3498 struct target
*target
= get_current_target(CMD_CTX
);
3501 return ERROR_COMMAND_SYNTAX_ERROR
;
3504 LOG_ERROR("no target selected");
3508 struct duration bench
;
3509 duration_start(&bench
);
3511 if (CMD_ARGC
>= 2) {
3513 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3514 image
.base_address
= addr
;
3515 image
.base_address_set
= 1;
3517 image
.base_address_set
= 0;
3518 image
.base_address
= 0x0;
3521 image
.start_address_set
= 0;
3523 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
3524 if (retval
!= ERROR_OK
)
3530 for (i
= 0; i
< image
.num_sections
; i
++) {
3531 buffer
= malloc(image
.sections
[i
].size
);
3532 if (buffer
== NULL
) {
3533 command_print(CMD_CTX
,
3534 "error allocating buffer for section (%d bytes)",
3535 (int)(image
.sections
[i
].size
));
3538 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3539 if (retval
!= ERROR_OK
) {
3544 if (verify
>= IMAGE_VERIFY
) {
3545 /* calculate checksum of image */
3546 retval
= image_calculate_checksum(buffer
, buf_cnt
, &checksum
);
3547 if (retval
!= ERROR_OK
) {
3552 retval
= target_checksum_memory(target
, image
.sections
[i
].base_address
, buf_cnt
, &mem_checksum
);
3553 if (retval
!= ERROR_OK
) {
3557 if ((checksum
!= mem_checksum
) && (verify
== IMAGE_CHECKSUM_ONLY
)) {
3558 LOG_ERROR("checksum mismatch");
3560 retval
= ERROR_FAIL
;
3563 if (checksum
!= mem_checksum
) {
3564 /* failed crc checksum, fall back to a binary compare */
3568 LOG_ERROR("checksum mismatch - attempting binary compare");
3570 data
= malloc(buf_cnt
);
3572 /* Can we use 32bit word accesses? */
3574 int count
= buf_cnt
;
3575 if ((count
% 4) == 0) {
3579 retval
= target_read_memory(target
, image
.sections
[i
].base_address
, size
, count
, data
);
3580 if (retval
== ERROR_OK
) {
3582 for (t
= 0; t
< buf_cnt
; t
++) {
3583 if (data
[t
] != buffer
[t
]) {
3584 command_print(CMD_CTX
,
3585 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3587 (unsigned)(t
+ image
.sections
[i
].base_address
),
3590 if (diffs
++ >= 127) {
3591 command_print(CMD_CTX
, "More than 128 errors, the rest are not printed.");
3603 command_print(CMD_CTX
, "address " TARGET_ADDR_FMT
" length 0x%08zx",
3604 image
.sections
[i
].base_address
,
3609 image_size
+= buf_cnt
;
3612 command_print(CMD_CTX
, "No more differences found.");
3615 retval
= ERROR_FAIL
;
3616 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3617 command_print(CMD_CTX
, "verified %" PRIu32
" bytes "
3618 "in %fs (%0.3f KiB/s)", image_size
,
3619 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3622 image_close(&image
);
3627 COMMAND_HANDLER(handle_verify_image_checksum_command
)
3629 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_CHECKSUM_ONLY
);
3632 COMMAND_HANDLER(handle_verify_image_command
)
3634 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_VERIFY
);
3637 COMMAND_HANDLER(handle_test_image_command
)
3639 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_TEST
);
3642 static int handle_bp_command_list(struct command_context
*cmd_ctx
)
3644 struct target
*target
= get_current_target(cmd_ctx
);
3645 struct breakpoint
*breakpoint
= target
->breakpoints
;
3646 while (breakpoint
) {
3647 if (breakpoint
->type
== BKPT_SOFT
) {
3648 char *buf
= buf_to_str(breakpoint
->orig_instr
,
3649 breakpoint
->length
, 16);
3650 command_print(cmd_ctx
, "IVA breakpoint: " TARGET_ADDR_FMT
", 0x%x, %i, 0x%s",
3651 breakpoint
->address
,
3653 breakpoint
->set
, buf
);
3656 if ((breakpoint
->address
== 0) && (breakpoint
->asid
!= 0))
3657 command_print(cmd_ctx
, "Context breakpoint: 0x%8.8" PRIx32
", 0x%x, %i",
3659 breakpoint
->length
, breakpoint
->set
);
3660 else if ((breakpoint
->address
!= 0) && (breakpoint
->asid
!= 0)) {
3661 command_print(cmd_ctx
, "Hybrid breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3662 breakpoint
->address
,
3663 breakpoint
->length
, breakpoint
->set
);
3664 command_print(cmd_ctx
, "\t|--->linked with ContextID: 0x%8.8" PRIx32
,
3667 command_print(cmd_ctx
, "Breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3668 breakpoint
->address
,
3669 breakpoint
->length
, breakpoint
->set
);
3672 breakpoint
= breakpoint
->next
;
3677 static int handle_bp_command_set(struct command_context
*cmd_ctx
,
3678 target_addr_t addr
, uint32_t asid
, uint32_t length
, int hw
)
3680 struct target
*target
= get_current_target(cmd_ctx
);
3684 retval
= breakpoint_add(target
, addr
, length
, hw
);
3685 if (ERROR_OK
== retval
)
3686 command_print(cmd_ctx
, "breakpoint set at " TARGET_ADDR_FMT
"", addr
);
3688 LOG_ERROR("Failure setting breakpoint, the same address(IVA) is already used");
3691 } else if (addr
== 0) {
3692 if (target
->type
->add_context_breakpoint
== NULL
) {
3693 LOG_WARNING("Context breakpoint not available");
3696 retval
= context_breakpoint_add(target
, asid
, length
, hw
);
3697 if (ERROR_OK
== retval
)
3698 command_print(cmd_ctx
, "Context breakpoint set at 0x%8.8" PRIx32
"", asid
);
3700 LOG_ERROR("Failure setting breakpoint, the same address(CONTEXTID) is already used");
3704 if (target
->type
->add_hybrid_breakpoint
== NULL
) {
3705 LOG_WARNING("Hybrid breakpoint not available");
3708 retval
= hybrid_breakpoint_add(target
, addr
, asid
, length
, hw
);
3709 if (ERROR_OK
== retval
)
3710 command_print(cmd_ctx
, "Hybrid breakpoint set at 0x%8.8" PRIx32
"", asid
);
3712 LOG_ERROR("Failure setting breakpoint, the same address is already used");
3719 COMMAND_HANDLER(handle_bp_command
)
3728 return handle_bp_command_list(CMD_CTX
);
3732 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3733 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3734 return handle_bp_command_set(CMD_CTX
, addr
, asid
, length
, hw
);
3737 if (strcmp(CMD_ARGV
[2], "hw") == 0) {
3739 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3740 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3742 return handle_bp_command_set(CMD_CTX
, addr
, asid
, length
, hw
);
3743 } else if (strcmp(CMD_ARGV
[2], "hw_ctx") == 0) {
3745 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], asid
);
3746 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3748 return handle_bp_command_set(CMD_CTX
, addr
, asid
, length
, hw
);
3753 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3754 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], asid
);
3755 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], length
);
3756 return handle_bp_command_set(CMD_CTX
, addr
, asid
, length
, hw
);
3759 return ERROR_COMMAND_SYNTAX_ERROR
;
3763 COMMAND_HANDLER(handle_rbp_command
)
3766 return ERROR_COMMAND_SYNTAX_ERROR
;
3769 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3771 struct target
*target
= get_current_target(CMD_CTX
);
3772 breakpoint_remove(target
, addr
);
3777 COMMAND_HANDLER(handle_wp_command
)
3779 struct target
*target
= get_current_target(CMD_CTX
);
3781 if (CMD_ARGC
== 0) {
3782 struct watchpoint
*watchpoint
= target
->watchpoints
;
3784 while (watchpoint
) {
3785 command_print(CMD_CTX
, "address: " TARGET_ADDR_FMT
3786 ", len: 0x%8.8" PRIx32
3787 ", r/w/a: %i, value: 0x%8.8" PRIx32
3788 ", mask: 0x%8.8" PRIx32
,
3789 watchpoint
->address
,
3791 (int)watchpoint
->rw
,
3794 watchpoint
= watchpoint
->next
;
3799 enum watchpoint_rw type
= WPT_ACCESS
;
3801 uint32_t length
= 0;
3802 uint32_t data_value
= 0x0;
3803 uint32_t data_mask
= 0xffffffff;
3807 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[4], data_mask
);
3810 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], data_value
);
3813 switch (CMD_ARGV
[2][0]) {
3824 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV
[2][0]);
3825 return ERROR_COMMAND_SYNTAX_ERROR
;
3829 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3830 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3834 return ERROR_COMMAND_SYNTAX_ERROR
;
3837 int retval
= watchpoint_add(target
, addr
, length
, type
,
3838 data_value
, data_mask
);
3839 if (ERROR_OK
!= retval
)
3840 LOG_ERROR("Failure setting watchpoints");
3845 COMMAND_HANDLER(handle_rwp_command
)
3848 return ERROR_COMMAND_SYNTAX_ERROR
;
3851 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3853 struct target
*target
= get_current_target(CMD_CTX
);
3854 watchpoint_remove(target
, addr
);
3860 * Translate a virtual address to a physical address.
3862 * The low-level target implementation must have logged a detailed error
3863 * which is forwarded to telnet/GDB session.
3865 COMMAND_HANDLER(handle_virt2phys_command
)
3868 return ERROR_COMMAND_SYNTAX_ERROR
;
3871 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], va
);
3874 struct target
*target
= get_current_target(CMD_CTX
);
3875 int retval
= target
->type
->virt2phys(target
, va
, &pa
);
3876 if (retval
== ERROR_OK
)
3877 command_print(CMD_CTX
, "Physical address " TARGET_ADDR_FMT
"", pa
);
3882 static void writeData(FILE *f
, const void *data
, size_t len
)
3884 size_t written
= fwrite(data
, 1, len
, f
);
3886 LOG_ERROR("failed to write %zu bytes: %s", len
, strerror(errno
));
3889 static void writeLong(FILE *f
, int l
, struct target
*target
)
3893 target_buffer_set_u32(target
, val
, l
);
3894 writeData(f
, val
, 4);
3897 static void writeString(FILE *f
, char *s
)
3899 writeData(f
, s
, strlen(s
));
3902 typedef unsigned char UNIT
[2]; /* unit of profiling */
3904 /* Dump a gmon.out histogram file. */
3905 static void write_gmon(uint32_t *samples
, uint32_t sampleNum
, const char *filename
, bool with_range
,
3906 uint32_t start_address
, uint32_t end_address
, struct target
*target
, uint32_t duration_ms
)
3909 FILE *f
= fopen(filename
, "w");
3912 writeString(f
, "gmon");
3913 writeLong(f
, 0x00000001, target
); /* Version */
3914 writeLong(f
, 0, target
); /* padding */
3915 writeLong(f
, 0, target
); /* padding */
3916 writeLong(f
, 0, target
); /* padding */
3918 uint8_t zero
= 0; /* GMON_TAG_TIME_HIST */
3919 writeData(f
, &zero
, 1);
3921 /* figure out bucket size */
3925 min
= start_address
;
3930 for (i
= 0; i
< sampleNum
; i
++) {
3931 if (min
> samples
[i
])
3933 if (max
< samples
[i
])
3937 /* max should be (largest sample + 1)
3938 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
3942 int addressSpace
= max
- min
;
3943 assert(addressSpace
>= 2);
3945 /* FIXME: What is the reasonable number of buckets?
3946 * The profiling result will be more accurate if there are enough buckets. */
3947 static const uint32_t maxBuckets
= 128 * 1024; /* maximum buckets. */
3948 uint32_t numBuckets
= addressSpace
/ sizeof(UNIT
);
3949 if (numBuckets
> maxBuckets
)
3950 numBuckets
= maxBuckets
;
3951 int *buckets
= malloc(sizeof(int) * numBuckets
);
3952 if (buckets
== NULL
) {
3956 memset(buckets
, 0, sizeof(int) * numBuckets
);
3957 for (i
= 0; i
< sampleNum
; i
++) {
3958 uint32_t address
= samples
[i
];
3960 if ((address
< min
) || (max
<= address
))
3963 long long a
= address
- min
;
3964 long long b
= numBuckets
;
3965 long long c
= addressSpace
;
3966 int index_t
= (a
* b
) / c
; /* danger!!!! int32 overflows */
3970 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3971 writeLong(f
, min
, target
); /* low_pc */
3972 writeLong(f
, max
, target
); /* high_pc */
3973 writeLong(f
, numBuckets
, target
); /* # of buckets */
3974 float sample_rate
= sampleNum
/ (duration_ms
/ 1000.0);
3975 writeLong(f
, sample_rate
, target
);
3976 writeString(f
, "seconds");
3977 for (i
= 0; i
< (15-strlen("seconds")); i
++)
3978 writeData(f
, &zero
, 1);
3979 writeString(f
, "s");
3981 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3983 char *data
= malloc(2 * numBuckets
);
3985 for (i
= 0; i
< numBuckets
; i
++) {
3990 data
[i
* 2] = val
&0xff;
3991 data
[i
* 2 + 1] = (val
>> 8) & 0xff;
3994 writeData(f
, data
, numBuckets
* 2);
4002 /* profiling samples the CPU PC as quickly as OpenOCD is able,
4003 * which will be used as a random sampling of PC */
4004 COMMAND_HANDLER(handle_profile_command
)
4006 struct target
*target
= get_current_target(CMD_CTX
);
4008 if ((CMD_ARGC
!= 2) && (CMD_ARGC
!= 4))
4009 return ERROR_COMMAND_SYNTAX_ERROR
;
4011 const uint32_t MAX_PROFILE_SAMPLE_NUM
= 10000;
4013 uint32_t num_of_samples
;
4014 int retval
= ERROR_OK
;
4016 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], offset
);
4018 uint32_t *samples
= malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM
);
4019 if (samples
== NULL
) {
4020 LOG_ERROR("No memory to store samples.");
4024 uint64_t timestart_ms
= timeval_ms();
4026 * Some cores let us sample the PC without the
4027 * annoying halt/resume step; for example, ARMv7 PCSR.
4028 * Provide a way to use that more efficient mechanism.
4030 retval
= target_profiling(target
, samples
, MAX_PROFILE_SAMPLE_NUM
,
4031 &num_of_samples
, offset
);
4032 if (retval
!= ERROR_OK
) {
4036 uint32_t duration_ms
= timeval_ms() - timestart_ms
;
4038 assert(num_of_samples
<= MAX_PROFILE_SAMPLE_NUM
);
4040 retval
= target_poll(target
);
4041 if (retval
!= ERROR_OK
) {
4045 if (target
->state
== TARGET_RUNNING
) {
4046 retval
= target_halt(target
);
4047 if (retval
!= ERROR_OK
) {
4053 retval
= target_poll(target
);
4054 if (retval
!= ERROR_OK
) {
4059 uint32_t start_address
= 0;
4060 uint32_t end_address
= 0;
4061 bool with_range
= false;
4062 if (CMD_ARGC
== 4) {
4064 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], start_address
);
4065 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], end_address
);
4068 write_gmon(samples
, num_of_samples
, CMD_ARGV
[1],
4069 with_range
, start_address
, end_address
, target
, duration_ms
);
4070 command_print(CMD_CTX
, "Wrote %s", CMD_ARGV
[1]);
4076 static int new_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t val
)
4079 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4082 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4086 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4087 valObjPtr
= Jim_NewIntObj(interp
, val
);
4088 if (!nameObjPtr
|| !valObjPtr
) {
4093 Jim_IncrRefCount(nameObjPtr
);
4094 Jim_IncrRefCount(valObjPtr
);
4095 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
4096 Jim_DecrRefCount(interp
, nameObjPtr
);
4097 Jim_DecrRefCount(interp
, valObjPtr
);
4099 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
4103 static int jim_mem2array(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4105 struct command_context
*context
;
4106 struct target
*target
;
4108 context
= current_command_context(interp
);
4109 assert(context
!= NULL
);
4111 target
= get_current_target(context
);
4112 if (target
== NULL
) {
4113 LOG_ERROR("mem2array: no current target");
4117 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
4120 static int target_mem2array(Jim_Interp
*interp
, struct target
*target
, int argc
, Jim_Obj
*const *argv
)
4128 const char *varname
;
4134 /* argv[1] = name of array to receive the data
4135 * argv[2] = desired width
4136 * argv[3] = memory address
4137 * argv[4] = count of times to read
4140 if (argc
< 4 || argc
> 5) {
4141 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4144 varname
= Jim_GetString(argv
[0], &len
);
4145 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4147 e
= Jim_GetLong(interp
, argv
[1], &l
);
4152 e
= Jim_GetLong(interp
, argv
[2], &l
);
4156 e
= Jim_GetLong(interp
, argv
[3], &l
);
4162 phys
= Jim_GetString(argv
[4], &n
);
4163 if (!strncmp(phys
, "phys", n
))
4179 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4180 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "Invalid width param, must be 8/16/32", NULL
);
4184 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4185 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: zero width read?", NULL
);
4188 if ((addr
+ (len
* width
)) < addr
) {
4189 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4190 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: addr + len - wraps to zero?", NULL
);
4193 /* absurd transfer size? */
4195 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4196 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: absurd > 64K item request", NULL
);
4201 ((width
== 2) && ((addr
& 1) == 0)) ||
4202 ((width
== 4) && ((addr
& 3) == 0))) {
4206 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4207 sprintf(buf
, "mem2array address: 0x%08" PRIx32
" is not aligned for %" PRId32
" byte reads",
4210 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4219 size_t buffersize
= 4096;
4220 uint8_t *buffer
= malloc(buffersize
);
4227 /* Slurp... in buffer size chunks */
4229 count
= len
; /* in objects.. */
4230 if (count
> (buffersize
/ width
))
4231 count
= (buffersize
/ width
);
4234 retval
= target_read_phys_memory(target
, addr
, width
, count
, buffer
);
4236 retval
= target_read_memory(target
, addr
, width
, count
, buffer
);
4237 if (retval
!= ERROR_OK
) {
4239 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32
", w=%" PRId32
", cnt=%" PRId32
", failed",
4243 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4244 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: cannot read memory", NULL
);
4248 v
= 0; /* shut up gcc */
4249 for (i
= 0; i
< count
; i
++, n
++) {
4252 v
= target_buffer_get_u32(target
, &buffer
[i
*width
]);
4255 v
= target_buffer_get_u16(target
, &buffer
[i
*width
]);
4258 v
= buffer
[i
] & 0x0ff;
4261 new_int_array_element(interp
, varname
, n
, v
);
4264 addr
+= count
* width
;
4270 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4275 static int get_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t *val
)
4278 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4282 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4286 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4292 Jim_IncrRefCount(nameObjPtr
);
4293 valObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, JIM_ERRMSG
);
4294 Jim_DecrRefCount(interp
, nameObjPtr
);
4296 if (valObjPtr
== NULL
)
4299 result
= Jim_GetLong(interp
, valObjPtr
, &l
);
4300 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4305 static int jim_array2mem(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4307 struct command_context
*context
;
4308 struct target
*target
;
4310 context
= current_command_context(interp
);
4311 assert(context
!= NULL
);
4313 target
= get_current_target(context
);
4314 if (target
== NULL
) {
4315 LOG_ERROR("array2mem: no current target");
4319 return target_array2mem(interp
, target
, argc
-1, argv
+ 1);
4322 static int target_array2mem(Jim_Interp
*interp
, struct target
*target
,
4323 int argc
, Jim_Obj
*const *argv
)
4331 const char *varname
;
4337 /* argv[1] = name of array to get the data
4338 * argv[2] = desired width
4339 * argv[3] = memory address
4340 * argv[4] = count to write
4342 if (argc
< 4 || argc
> 5) {
4343 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4346 varname
= Jim_GetString(argv
[0], &len
);
4347 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4349 e
= Jim_GetLong(interp
, argv
[1], &l
);
4354 e
= Jim_GetLong(interp
, argv
[2], &l
);
4358 e
= Jim_GetLong(interp
, argv
[3], &l
);
4364 phys
= Jim_GetString(argv
[4], &n
);
4365 if (!strncmp(phys
, "phys", n
))
4381 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4382 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4383 "Invalid width param, must be 8/16/32", NULL
);
4387 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4388 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4389 "array2mem: zero width read?", NULL
);
4392 if ((addr
+ (len
* width
)) < addr
) {
4393 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4394 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4395 "array2mem: addr + len - wraps to zero?", NULL
);
4398 /* absurd transfer size? */
4400 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4401 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4402 "array2mem: absurd > 64K item request", NULL
);
4407 ((width
== 2) && ((addr
& 1) == 0)) ||
4408 ((width
== 4) && ((addr
& 3) == 0))) {
4412 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4413 sprintf(buf
, "array2mem address: 0x%08" PRIx32
" is not aligned for %" PRId32
" byte reads",
4416 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4427 size_t buffersize
= 4096;
4428 uint8_t *buffer
= malloc(buffersize
);
4433 /* Slurp... in buffer size chunks */
4435 count
= len
; /* in objects.. */
4436 if (count
> (buffersize
/ width
))
4437 count
= (buffersize
/ width
);
4439 v
= 0; /* shut up gcc */
4440 for (i
= 0; i
< count
; i
++, n
++) {
4441 get_int_array_element(interp
, varname
, n
, &v
);
4444 target_buffer_set_u32(target
, &buffer
[i
* width
], v
);
4447 target_buffer_set_u16(target
, &buffer
[i
* width
], v
);
4450 buffer
[i
] = v
& 0x0ff;
4457 retval
= target_write_phys_memory(target
, addr
, width
, count
, buffer
);
4459 retval
= target_write_memory(target
, addr
, width
, count
, buffer
);
4460 if (retval
!= ERROR_OK
) {
4462 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32
", w=%" PRId32
", cnt=%" PRId32
", failed",
4466 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4467 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "array2mem: cannot read memory", NULL
);
4471 addr
+= count
* width
;
4476 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4481 /* FIX? should we propagate errors here rather than printing them
4484 void target_handle_event(struct target
*target
, enum target_event e
)
4486 struct target_event_action
*teap
;
4488 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4489 if (teap
->event
== e
) {
4490 LOG_DEBUG("target(%d): %s (%s) event: %d (%s) action: %s",
4491 target
->target_number
,
4492 target_name(target
),
4493 target_type_name(target
),
4495 Jim_Nvp_value2name_simple(nvp_target_event
, e
)->name
,
4496 Jim_GetString(teap
->body
, NULL
));
4498 /* Override current target by the target an event
4499 * is issued from (lot of scripts need it).
4500 * Return back to previous override as soon
4501 * as the handler processing is done */
4502 struct command_context
*cmd_ctx
= current_command_context(teap
->interp
);
4503 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
4504 cmd_ctx
->current_target_override
= target
;
4506 if (Jim_EvalObj(teap
->interp
, teap
->body
) != JIM_OK
) {
4507 Jim_MakeErrorMessage(teap
->interp
);
4508 command_print(NULL
, "%s\n", Jim_GetString(Jim_GetResult(teap
->interp
), NULL
));
4511 cmd_ctx
->current_target_override
= saved_target_override
;
4517 * Returns true only if the target has a handler for the specified event.
4519 bool target_has_event_action(struct target
*target
, enum target_event event
)
4521 struct target_event_action
*teap
;
4523 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4524 if (teap
->event
== event
)
4530 enum target_cfg_param
{
4533 TCFG_WORK_AREA_VIRT
,
4534 TCFG_WORK_AREA_PHYS
,
4535 TCFG_WORK_AREA_SIZE
,
4536 TCFG_WORK_AREA_BACKUP
,
4539 TCFG_CHAIN_POSITION
,
4546 static Jim_Nvp nvp_config_opts
[] = {
4547 { .name
= "-type", .value
= TCFG_TYPE
},
4548 { .name
= "-event", .value
= TCFG_EVENT
},
4549 { .name
= "-work-area-virt", .value
= TCFG_WORK_AREA_VIRT
},
4550 { .name
= "-work-area-phys", .value
= TCFG_WORK_AREA_PHYS
},
4551 { .name
= "-work-area-size", .value
= TCFG_WORK_AREA_SIZE
},
4552 { .name
= "-work-area-backup", .value
= TCFG_WORK_AREA_BACKUP
},
4553 { .name
= "-endian" , .value
= TCFG_ENDIAN
},
4554 { .name
= "-coreid", .value
= TCFG_COREID
},
4555 { .name
= "-chain-position", .value
= TCFG_CHAIN_POSITION
},
4556 { .name
= "-dbgbase", .value
= TCFG_DBGBASE
},
4557 { .name
= "-rtos", .value
= TCFG_RTOS
},
4558 { .name
= "-defer-examine", .value
= TCFG_DEFER_EXAMINE
},
4559 { .name
= "-gdb-port", .value
= TCFG_GDB_PORT
},
4560 { .name
= NULL
, .value
= -1 }
4563 static int target_configure(Jim_GetOptInfo
*goi
, struct target
*target
)
4570 /* parse config or cget options ... */
4571 while (goi
->argc
> 0) {
4572 Jim_SetEmptyResult(goi
->interp
);
4573 /* Jim_GetOpt_Debug(goi); */
4575 if (target
->type
->target_jim_configure
) {
4576 /* target defines a configure function */
4577 /* target gets first dibs on parameters */
4578 e
= (*(target
->type
->target_jim_configure
))(target
, goi
);
4587 /* otherwise we 'continue' below */
4589 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
4591 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
4597 if (goi
->isconfigure
) {
4598 Jim_SetResultFormatted(goi
->interp
,
4599 "not settable: %s", n
->name
);
4603 if (goi
->argc
!= 0) {
4604 Jim_WrongNumArgs(goi
->interp
,
4605 goi
->argc
, goi
->argv
,
4610 Jim_SetResultString(goi
->interp
,
4611 target_type_name(target
), -1);
4615 if (goi
->argc
== 0) {
4616 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ...");
4620 e
= Jim_GetOpt_Nvp(goi
, nvp_target_event
, &n
);
4622 Jim_GetOpt_NvpUnknown(goi
, nvp_target_event
, 1);
4626 if (goi
->isconfigure
) {
4627 if (goi
->argc
!= 1) {
4628 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
4632 if (goi
->argc
!= 0) {
4633 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
4639 struct target_event_action
*teap
;
4641 teap
= target
->event_action
;
4642 /* replace existing? */
4644 if (teap
->event
== (enum target_event
)n
->value
)
4649 if (goi
->isconfigure
) {
4650 bool replace
= true;
4653 teap
= calloc(1, sizeof(*teap
));
4656 teap
->event
= n
->value
;
4657 teap
->interp
= goi
->interp
;
4658 Jim_GetOpt_Obj(goi
, &o
);
4660 Jim_DecrRefCount(teap
->interp
, teap
->body
);
4661 teap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
4664 * Tcl/TK - "tk events" have a nice feature.
4665 * See the "BIND" command.
4666 * We should support that here.
4667 * You can specify %X and %Y in the event code.
4668 * The idea is: %T - target name.
4669 * The idea is: %N - target number
4670 * The idea is: %E - event name.
4672 Jim_IncrRefCount(teap
->body
);
4675 /* add to head of event list */
4676 teap
->next
= target
->event_action
;
4677 target
->event_action
= teap
;
4679 Jim_SetEmptyResult(goi
->interp
);
4683 Jim_SetEmptyResult(goi
->interp
);
4685 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, teap
->body
));
4691 case TCFG_WORK_AREA_VIRT
:
4692 if (goi
->isconfigure
) {
4693 target_free_all_working_areas(target
);
4694 e
= Jim_GetOpt_Wide(goi
, &w
);
4697 target
->working_area_virt
= w
;
4698 target
->working_area_virt_spec
= true;
4703 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_virt
));
4707 case TCFG_WORK_AREA_PHYS
:
4708 if (goi
->isconfigure
) {
4709 target_free_all_working_areas(target
);
4710 e
= Jim_GetOpt_Wide(goi
, &w
);
4713 target
->working_area_phys
= w
;
4714 target
->working_area_phys_spec
= true;
4719 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_phys
));
4723 case TCFG_WORK_AREA_SIZE
:
4724 if (goi
->isconfigure
) {
4725 target_free_all_working_areas(target
);
4726 e
= Jim_GetOpt_Wide(goi
, &w
);
4729 target
->working_area_size
= w
;
4734 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_size
));
4738 case TCFG_WORK_AREA_BACKUP
:
4739 if (goi
->isconfigure
) {
4740 target_free_all_working_areas(target
);
4741 e
= Jim_GetOpt_Wide(goi
, &w
);
4744 /* make this exactly 1 or 0 */
4745 target
->backup_working_area
= (!!w
);
4750 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->backup_working_area
));
4751 /* loop for more e*/
4756 if (goi
->isconfigure
) {
4757 e
= Jim_GetOpt_Nvp(goi
, nvp_target_endian
, &n
);
4759 Jim_GetOpt_NvpUnknown(goi
, nvp_target_endian
, 1);
4762 target
->endianness
= n
->value
;
4767 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4768 if (n
->name
== NULL
) {
4769 target
->endianness
= TARGET_LITTLE_ENDIAN
;
4770 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4772 Jim_SetResultString(goi
->interp
, n
->name
, -1);
4777 if (goi
->isconfigure
) {
4778 e
= Jim_GetOpt_Wide(goi
, &w
);
4781 target
->coreid
= (int32_t)w
;
4786 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_size
));
4790 case TCFG_CHAIN_POSITION
:
4791 if (goi
->isconfigure
) {
4793 struct jtag_tap
*tap
;
4795 if (target
->has_dap
) {
4796 Jim_SetResultString(goi
->interp
,
4797 "target requires -dap parameter instead of -chain-position!", -1);
4801 target_free_all_working_areas(target
);
4802 e
= Jim_GetOpt_Obj(goi
, &o_t
);
4805 tap
= jtag_tap_by_jim_obj(goi
->interp
, o_t
);
4809 target
->tap_configured
= true;
4814 Jim_SetResultString(goi
->interp
, target
->tap
->dotted_name
, -1);
4815 /* loop for more e*/
4818 if (goi
->isconfigure
) {
4819 e
= Jim_GetOpt_Wide(goi
, &w
);
4822 target
->dbgbase
= (uint32_t)w
;
4823 target
->dbgbase_set
= true;
4828 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->dbgbase
));
4834 int result
= rtos_create(goi
, target
);
4835 if (result
!= JIM_OK
)
4841 case TCFG_DEFER_EXAMINE
:
4843 target
->defer_examine
= true;
4848 if (goi
->isconfigure
) {
4850 e
= Jim_GetOpt_String(goi
, &s
, NULL
);
4853 target
->gdb_port_override
= strdup(s
);
4858 Jim_SetResultString(goi
->interp
, target
->gdb_port_override
? : "undefined", -1);
4862 } /* while (goi->argc) */
4865 /* done - we return */
4869 static int jim_target_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
4873 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
4874 goi
.isconfigure
= !strcmp(Jim_GetString(argv
[0], NULL
), "configure");
4876 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
4877 "missing: -option ...");
4880 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
4881 return target_configure(&goi
, target
);
4884 static int jim_target_mw(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4886 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
4889 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
4891 if (goi
.argc
< 2 || goi
.argc
> 4) {
4892 Jim_SetResultFormatted(goi
.interp
,
4893 "usage: %s [phys] <address> <data> [<count>]", cmd_name
);
4898 fn
= target_write_memory
;
4901 if (strcmp(Jim_GetString(argv
[1], NULL
), "phys") == 0) {
4903 struct Jim_Obj
*obj
;
4904 e
= Jim_GetOpt_Obj(&goi
, &obj
);
4908 fn
= target_write_phys_memory
;
4912 e
= Jim_GetOpt_Wide(&goi
, &a
);
4917 e
= Jim_GetOpt_Wide(&goi
, &b
);
4922 if (goi
.argc
== 1) {
4923 e
= Jim_GetOpt_Wide(&goi
, &c
);
4928 /* all args must be consumed */
4932 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
4934 if (strcasecmp(cmd_name
, "mww") == 0)
4936 else if (strcasecmp(cmd_name
, "mwh") == 0)
4938 else if (strcasecmp(cmd_name
, "mwb") == 0)
4941 LOG_ERROR("command '%s' unknown: ", cmd_name
);
4945 return (target_fill_mem(target
, a
, fn
, data_size
, b
, c
) == ERROR_OK
) ? JIM_OK
: JIM_ERR
;
4949 * @brief Reads an array of words/halfwords/bytes from target memory starting at specified address.
4951 * Usage: mdw [phys] <address> [<count>] - for 32 bit reads
4952 * mdh [phys] <address> [<count>] - for 16 bit reads
4953 * mdb [phys] <address> [<count>] - for 8 bit reads
4955 * Count defaults to 1.
4957 * Calls target_read_memory or target_read_phys_memory depending on
4958 * the presence of the "phys" argument
4959 * Reads the target memory in blocks of max. 32 bytes, and returns an array of ints formatted
4960 * to int representation in base16.
4961 * Also outputs read data in a human readable form using command_print
4963 * @param phys if present target_read_phys_memory will be used instead of target_read_memory
4964 * @param address address where to start the read. May be specified in decimal or hex using the standard "0x" prefix
4965 * @param count optional count parameter to read an array of values. If not specified, defaults to 1.
4966 * @returns: JIM_ERR on error or JIM_OK on success and sets the result string to an array of ascii formatted numbers
4967 * on success, with [<count>] number of elements.
4969 * In case of little endian target:
4970 * Example1: "mdw 0x00000000" returns "10123456"
4971 * Exmaple2: "mdh 0x00000000 1" returns "3456"
4972 * Example3: "mdb 0x00000000" returns "56"
4973 * Example4: "mdh 0x00000000 2" returns "3456 1012"
4974 * Example5: "mdb 0x00000000 3" returns "56 34 12"
4976 static int jim_target_md(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4978 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
4981 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
4983 if ((goi
.argc
< 1) || (goi
.argc
> 3)) {
4984 Jim_SetResultFormatted(goi
.interp
,
4985 "usage: %s [phys] <address> [<count>]", cmd_name
);
4989 int (*fn
)(struct target
*target
,
4990 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
4991 fn
= target_read_memory
;
4994 if (strcmp(Jim_GetString(argv
[1], NULL
), "phys") == 0) {
4996 struct Jim_Obj
*obj
;
4997 e
= Jim_GetOpt_Obj(&goi
, &obj
);
5001 fn
= target_read_phys_memory
;
5004 /* Read address parameter */
5006 e
= Jim_GetOpt_Wide(&goi
, &addr
);
5010 /* If next parameter exists, read it out as the count parameter, if not, set it to 1 (default) */
5012 if (goi
.argc
== 1) {
5013 e
= Jim_GetOpt_Wide(&goi
, &count
);
5019 /* all args must be consumed */
5023 jim_wide dwidth
= 1; /* shut up gcc */
5024 if (strcasecmp(cmd_name
, "mdw") == 0)
5026 else if (strcasecmp(cmd_name
, "mdh") == 0)
5028 else if (strcasecmp(cmd_name
, "mdb") == 0)
5031 LOG_ERROR("command '%s' unknown: ", cmd_name
);
5035 /* convert count to "bytes" */
5036 int bytes
= count
* dwidth
;
5038 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
5039 uint8_t target_buf
[32];
5042 y
= (bytes
< 16) ? bytes
: 16; /* y = min(bytes, 16); */
5044 /* Try to read out next block */
5045 e
= fn(target
, addr
, dwidth
, y
/ dwidth
, target_buf
);
5047 if (e
!= ERROR_OK
) {
5048 Jim_SetResultFormatted(interp
, "error reading target @ 0x%08lx", (long)addr
);
5052 command_print_sameline(NULL
, "0x%08x ", (int)(addr
));
5055 for (x
= 0; x
< 16 && x
< y
; x
+= 4) {
5056 z
= target_buffer_get_u32(target
, &(target_buf
[x
]));
5057 command_print_sameline(NULL
, "%08x ", (int)(z
));
5059 for (; (x
< 16) ; x
+= 4)
5060 command_print_sameline(NULL
, " ");
5063 for (x
= 0; x
< 16 && x
< y
; x
+= 2) {
5064 z
= target_buffer_get_u16(target
, &(target_buf
[x
]));
5065 command_print_sameline(NULL
, "%04x ", (int)(z
));
5067 for (; (x
< 16) ; x
+= 2)
5068 command_print_sameline(NULL
, " ");
5072 for (x
= 0 ; (x
< 16) && (x
< y
) ; x
+= 1) {
5073 z
= target_buffer_get_u8(target
, &(target_buf
[x
]));
5074 command_print_sameline(NULL
, "%02x ", (int)(z
));
5076 for (; (x
< 16) ; x
+= 1)
5077 command_print_sameline(NULL
, " ");
5080 /* ascii-ify the bytes */
5081 for (x
= 0 ; x
< y
; x
++) {
5082 if ((target_buf
[x
] >= 0x20) &&
5083 (target_buf
[x
] <= 0x7e)) {
5087 target_buf
[x
] = '.';
5092 target_buf
[x
] = ' ';
5097 /* print - with a newline */
5098 command_print_sameline(NULL
, "%s\n", target_buf
);
5106 static int jim_target_mem2array(Jim_Interp
*interp
,
5107 int argc
, Jim_Obj
*const *argv
)
5109 struct target
*target
= Jim_CmdPrivData(interp
);
5110 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
5113 static int jim_target_array2mem(Jim_Interp
*interp
,
5114 int argc
, Jim_Obj
*const *argv
)
5116 struct target
*target
= Jim_CmdPrivData(interp
);
5117 return target_array2mem(interp
, target
, argc
- 1, argv
+ 1);
5120 static int jim_target_tap_disabled(Jim_Interp
*interp
)
5122 Jim_SetResultFormatted(interp
, "[TAP is disabled]");
5126 static int jim_target_examine(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5128 bool allow_defer
= false;
5131 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5133 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5134 Jim_SetResultFormatted(goi
.interp
,
5135 "usage: %s ['allow-defer']", cmd_name
);
5139 strcmp(Jim_GetString(argv
[1], NULL
), "allow-defer") == 0) {
5141 struct Jim_Obj
*obj
;
5142 int e
= Jim_GetOpt_Obj(&goi
, &obj
);
5148 struct target
*target
= Jim_CmdPrivData(interp
);
5149 if (!target
->tap
->enabled
)
5150 return jim_target_tap_disabled(interp
);
5152 if (allow_defer
&& target
->defer_examine
) {
5153 LOG_INFO("Deferring arp_examine of %s", target_name(target
));
5154 LOG_INFO("Use arp_examine command to examine it manually!");
5158 int e
= target
->type
->examine(target
);
5164 static int jim_target_was_examined(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5166 struct target
*target
= Jim_CmdPrivData(interp
);
5168 Jim_SetResultBool(interp
, target_was_examined(target
));
5172 static int jim_target_examine_deferred(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5174 struct target
*target
= Jim_CmdPrivData(interp
);
5176 Jim_SetResultBool(interp
, target
->defer_examine
);
5180 static int jim_target_halt_gdb(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5183 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5186 struct target
*target
= Jim_CmdPrivData(interp
);
5188 if (target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
) != ERROR_OK
)
5194 static int jim_target_poll(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5197 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5200 struct target
*target
= Jim_CmdPrivData(interp
);
5201 if (!target
->tap
->enabled
)
5202 return jim_target_tap_disabled(interp
);
5205 if (!(target_was_examined(target
)))
5206 e
= ERROR_TARGET_NOT_EXAMINED
;
5208 e
= target
->type
->poll(target
);
5214 static int jim_target_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5217 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5219 if (goi
.argc
!= 2) {
5220 Jim_WrongNumArgs(interp
, 0, argv
,
5221 "([tT]|[fF]|assert|deassert) BOOL");
5226 int e
= Jim_GetOpt_Nvp(&goi
, nvp_assert
, &n
);
5228 Jim_GetOpt_NvpUnknown(&goi
, nvp_assert
, 1);
5231 /* the halt or not param */
5233 e
= Jim_GetOpt_Wide(&goi
, &a
);
5237 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
5238 if (!target
->tap
->enabled
)
5239 return jim_target_tap_disabled(interp
);
5241 if (!target
->type
->assert_reset
|| !target
->type
->deassert_reset
) {
5242 Jim_SetResultFormatted(interp
,
5243 "No target-specific reset for %s",
5244 target_name(target
));
5248 if (target
->defer_examine
)
5249 target_reset_examined(target
);
5251 /* determine if we should halt or not. */
5252 target
->reset_halt
= !!a
;
5253 /* When this happens - all workareas are invalid. */
5254 target_free_all_working_areas_restore(target
, 0);
5257 if (n
->value
== NVP_ASSERT
)
5258 e
= target
->type
->assert_reset(target
);
5260 e
= target
->type
->deassert_reset(target
);
5261 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5264 static int jim_target_halt(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5267 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5270 struct target
*target
= Jim_CmdPrivData(interp
);
5271 if (!target
->tap
->enabled
)
5272 return jim_target_tap_disabled(interp
);
5273 int e
= target
->type
->halt(target
);
5274 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5277 static int jim_target_wait_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5280 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5282 /* params: <name> statename timeoutmsecs */
5283 if (goi
.argc
!= 2) {
5284 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5285 Jim_SetResultFormatted(goi
.interp
,
5286 "%s <state_name> <timeout_in_msec>", cmd_name
);
5291 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_state
, &n
);
5293 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_state
, 1);
5297 e
= Jim_GetOpt_Wide(&goi
, &a
);
5300 struct target
*target
= Jim_CmdPrivData(interp
);
5301 if (!target
->tap
->enabled
)
5302 return jim_target_tap_disabled(interp
);
5304 e
= target_wait_state(target
, n
->value
, a
);
5305 if (e
!= ERROR_OK
) {
5306 Jim_Obj
*eObj
= Jim_NewIntObj(interp
, e
);
5307 Jim_SetResultFormatted(goi
.interp
,
5308 "target: %s wait %s fails (%#s) %s",
5309 target_name(target
), n
->name
,
5310 eObj
, target_strerror_safe(e
));
5311 Jim_FreeNewObj(interp
, eObj
);
5316 /* List for human, Events defined for this target.
5317 * scripts/programs should use 'name cget -event NAME'
5319 static int jim_target_event_list(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5321 struct command_context
*cmd_ctx
= current_command_context(interp
);
5322 assert(cmd_ctx
!= NULL
);
5324 struct target
*target
= Jim_CmdPrivData(interp
);
5325 struct target_event_action
*teap
= target
->event_action
;
5326 command_print(cmd_ctx
, "Event actions for target (%d) %s\n",
5327 target
->target_number
,
5328 target_name(target
));
5329 command_print(cmd_ctx
, "%-25s | Body", "Event");
5330 command_print(cmd_ctx
, "------------------------- | "
5331 "----------------------------------------");
5333 Jim_Nvp
*opt
= Jim_Nvp_value2name_simple(nvp_target_event
, teap
->event
);
5334 command_print(cmd_ctx
, "%-25s | %s",
5335 opt
->name
, Jim_GetString(teap
->body
, NULL
));
5338 command_print(cmd_ctx
, "***END***");
5341 static int jim_target_current_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5344 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5347 struct target
*target
= Jim_CmdPrivData(interp
);
5348 Jim_SetResultString(interp
, target_state_name(target
), -1);
5351 static int jim_target_invoke_event(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5354 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5355 if (goi
.argc
!= 1) {
5356 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5357 Jim_SetResultFormatted(goi
.interp
, "%s <eventname>", cmd_name
);
5361 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_event
, &n
);
5363 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_event
, 1);
5366 struct target
*target
= Jim_CmdPrivData(interp
);
5367 target_handle_event(target
, n
->value
);
5371 static const struct command_registration target_instance_command_handlers
[] = {
5373 .name
= "configure",
5374 .mode
= COMMAND_CONFIG
,
5375 .jim_handler
= jim_target_configure
,
5376 .help
= "configure a new target for use",
5377 .usage
= "[target_attribute ...]",
5381 .mode
= COMMAND_ANY
,
5382 .jim_handler
= jim_target_configure
,
5383 .help
= "returns the specified target attribute",
5384 .usage
= "target_attribute",
5388 .mode
= COMMAND_EXEC
,
5389 .jim_handler
= jim_target_mw
,
5390 .help
= "Write 32-bit word(s) to target memory",
5391 .usage
= "address data [count]",
5395 .mode
= COMMAND_EXEC
,
5396 .jim_handler
= jim_target_mw
,
5397 .help
= "Write 16-bit half-word(s) to target memory",
5398 .usage
= "address data [count]",
5402 .mode
= COMMAND_EXEC
,
5403 .jim_handler
= jim_target_mw
,
5404 .help
= "Write byte(s) to target memory",
5405 .usage
= "address data [count]",
5409 .mode
= COMMAND_EXEC
,
5410 .jim_handler
= jim_target_md
,
5411 .help
= "Display target memory as 32-bit words",
5412 .usage
= "address [count]",
5416 .mode
= COMMAND_EXEC
,
5417 .jim_handler
= jim_target_md
,
5418 .help
= "Display target memory as 16-bit half-words",
5419 .usage
= "address [count]",
5423 .mode
= COMMAND_EXEC
,
5424 .jim_handler
= jim_target_md
,
5425 .help
= "Display target memory as 8-bit bytes",
5426 .usage
= "address [count]",
5429 .name
= "array2mem",
5430 .mode
= COMMAND_EXEC
,
5431 .jim_handler
= jim_target_array2mem
,
5432 .help
= "Writes Tcl array of 8/16/32 bit numbers "
5434 .usage
= "arrayname bitwidth address count",
5437 .name
= "mem2array",
5438 .mode
= COMMAND_EXEC
,
5439 .jim_handler
= jim_target_mem2array
,
5440 .help
= "Loads Tcl array of 8/16/32 bit numbers "
5441 "from target memory",
5442 .usage
= "arrayname bitwidth address count",
5445 .name
= "eventlist",
5446 .mode
= COMMAND_EXEC
,
5447 .jim_handler
= jim_target_event_list
,
5448 .help
= "displays a table of events defined for this target",
5452 .mode
= COMMAND_EXEC
,
5453 .jim_handler
= jim_target_current_state
,
5454 .help
= "displays the current state of this target",
5457 .name
= "arp_examine",
5458 .mode
= COMMAND_EXEC
,
5459 .jim_handler
= jim_target_examine
,
5460 .help
= "used internally for reset processing",
5461 .usage
= "['allow-defer']",
5464 .name
= "was_examined",
5465 .mode
= COMMAND_EXEC
,
5466 .jim_handler
= jim_target_was_examined
,
5467 .help
= "used internally for reset processing",
5470 .name
= "examine_deferred",
5471 .mode
= COMMAND_EXEC
,
5472 .jim_handler
= jim_target_examine_deferred
,
5473 .help
= "used internally for reset processing",
5476 .name
= "arp_halt_gdb",
5477 .mode
= COMMAND_EXEC
,
5478 .jim_handler
= jim_target_halt_gdb
,
5479 .help
= "used internally for reset processing to halt GDB",
5483 .mode
= COMMAND_EXEC
,
5484 .jim_handler
= jim_target_poll
,
5485 .help
= "used internally for reset processing",
5488 .name
= "arp_reset",
5489 .mode
= COMMAND_EXEC
,
5490 .jim_handler
= jim_target_reset
,
5491 .help
= "used internally for reset processing",
5495 .mode
= COMMAND_EXEC
,
5496 .jim_handler
= jim_target_halt
,
5497 .help
= "used internally for reset processing",
5500 .name
= "arp_waitstate",
5501 .mode
= COMMAND_EXEC
,
5502 .jim_handler
= jim_target_wait_state
,
5503 .help
= "used internally for reset processing",
5506 .name
= "invoke-event",
5507 .mode
= COMMAND_EXEC
,
5508 .jim_handler
= jim_target_invoke_event
,
5509 .help
= "invoke handler for specified event",
5510 .usage
= "event_name",
5512 COMMAND_REGISTRATION_DONE
5515 static int target_create(Jim_GetOptInfo
*goi
)
5522 struct target
*target
;
5523 struct command_context
*cmd_ctx
;
5525 cmd_ctx
= current_command_context(goi
->interp
);
5526 assert(cmd_ctx
!= NULL
);
5528 if (goi
->argc
< 3) {
5529 Jim_WrongNumArgs(goi
->interp
, 1, goi
->argv
, "?name? ?type? ..options...");
5534 Jim_GetOpt_Obj(goi
, &new_cmd
);
5535 /* does this command exist? */
5536 cmd
= Jim_GetCommand(goi
->interp
, new_cmd
, JIM_ERRMSG
);
5538 cp
= Jim_GetString(new_cmd
, NULL
);
5539 Jim_SetResultFormatted(goi
->interp
, "Command/target: %s Exists", cp
);
5544 e
= Jim_GetOpt_String(goi
, &cp
, NULL
);
5547 struct transport
*tr
= get_current_transport();
5548 if (tr
->override_target
) {
5549 e
= tr
->override_target(&cp
);
5550 if (e
!= ERROR_OK
) {
5551 LOG_ERROR("The selected transport doesn't support this target");
5554 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5556 /* now does target type exist */
5557 for (x
= 0 ; target_types
[x
] ; x
++) {
5558 if (0 == strcmp(cp
, target_types
[x
]->name
)) {
5563 /* check for deprecated name */
5564 if (target_types
[x
]->deprecated_name
) {
5565 if (0 == strcmp(cp
, target_types
[x
]->deprecated_name
)) {
5567 LOG_WARNING("target name is deprecated use: \'%s\'", target_types
[x
]->name
);
5572 if (target_types
[x
] == NULL
) {
5573 Jim_SetResultFormatted(goi
->interp
, "Unknown target type %s, try one of ", cp
);
5574 for (x
= 0 ; target_types
[x
] ; x
++) {
5575 if (target_types
[x
+ 1]) {
5576 Jim_AppendStrings(goi
->interp
,
5577 Jim_GetResult(goi
->interp
),
5578 target_types
[x
]->name
,
5581 Jim_AppendStrings(goi
->interp
,
5582 Jim_GetResult(goi
->interp
),
5584 target_types
[x
]->name
, NULL
);
5591 target
= calloc(1, sizeof(struct target
));
5592 /* set target number */
5593 target
->target_number
= new_target_number();
5594 cmd_ctx
->current_target
= target
;
5596 /* allocate memory for each unique target type */
5597 target
->type
= calloc(1, sizeof(struct target_type
));
5599 memcpy(target
->type
, target_types
[x
], sizeof(struct target_type
));
5601 /* will be set by "-endian" */
5602 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5604 /* default to first core, override with -coreid */
5607 target
->working_area
= 0x0;
5608 target
->working_area_size
= 0x0;
5609 target
->working_areas
= NULL
;
5610 target
->backup_working_area
= 0;
5612 target
->state
= TARGET_UNKNOWN
;
5613 target
->debug_reason
= DBG_REASON_UNDEFINED
;
5614 target
->reg_cache
= NULL
;
5615 target
->breakpoints
= NULL
;
5616 target
->watchpoints
= NULL
;
5617 target
->next
= NULL
;
5618 target
->arch_info
= NULL
;
5620 target
->verbose_halt_msg
= true;
5622 target
->halt_issued
= false;
5624 /* initialize trace information */
5625 target
->trace_info
= calloc(1, sizeof(struct trace
));
5627 target
->dbgmsg
= NULL
;
5628 target
->dbg_msg_enabled
= 0;
5630 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5632 target
->rtos
= NULL
;
5633 target
->rtos_auto_detect
= false;
5635 target
->gdb_port_override
= NULL
;
5637 /* Do the rest as "configure" options */
5638 goi
->isconfigure
= 1;
5639 e
= target_configure(goi
, target
);
5642 if (target
->has_dap
) {
5643 if (!target
->dap_configured
) {
5644 Jim_SetResultString(goi
->interp
, "-dap ?name? required when creating target", -1);
5648 if (!target
->tap_configured
) {
5649 Jim_SetResultString(goi
->interp
, "-chain-position ?name? required when creating target", -1);
5653 /* tap must be set after target was configured */
5654 if (target
->tap
== NULL
)
5659 free(target
->gdb_port_override
);
5665 if (target
->endianness
== TARGET_ENDIAN_UNKNOWN
) {
5666 /* default endian to little if not specified */
5667 target
->endianness
= TARGET_LITTLE_ENDIAN
;
5670 cp
= Jim_GetString(new_cmd
, NULL
);
5671 target
->cmd_name
= strdup(cp
);
5673 if (target
->type
->target_create
) {
5674 e
= (*(target
->type
->target_create
))(target
, goi
->interp
);
5675 if (e
!= ERROR_OK
) {
5676 LOG_DEBUG("target_create failed");
5677 free(target
->gdb_port_override
);
5679 free(target
->cmd_name
);
5685 /* create the target specific commands */
5686 if (target
->type
->commands
) {
5687 e
= register_commands(cmd_ctx
, NULL
, target
->type
->commands
);
5689 LOG_ERROR("unable to register '%s' commands", cp
);
5692 /* append to end of list */
5694 struct target
**tpp
;
5695 tpp
= &(all_targets
);
5697 tpp
= &((*tpp
)->next
);
5701 /* now - create the new target name command */
5702 const struct command_registration target_subcommands
[] = {
5704 .chain
= target_instance_command_handlers
,
5707 .chain
= target
->type
->commands
,
5709 COMMAND_REGISTRATION_DONE
5711 const struct command_registration target_commands
[] = {
5714 .mode
= COMMAND_ANY
,
5715 .help
= "target command group",
5717 .chain
= target_subcommands
,
5719 COMMAND_REGISTRATION_DONE
5721 e
= register_commands(cmd_ctx
, NULL
, target_commands
);
5725 struct command
*c
= command_find_in_context(cmd_ctx
, cp
);
5727 command_set_handler_data(c
, target
);
5729 return (ERROR_OK
== e
) ? JIM_OK
: JIM_ERR
;
5732 static int jim_target_current(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5735 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5738 struct command_context
*cmd_ctx
= current_command_context(interp
);
5739 assert(cmd_ctx
!= NULL
);
5741 Jim_SetResultString(interp
, target_name(get_current_target(cmd_ctx
)), -1);
5745 static int jim_target_types(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5748 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5751 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5752 for (unsigned x
= 0; NULL
!= target_types
[x
]; x
++) {
5753 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5754 Jim_NewStringObj(interp
, target_types
[x
]->name
, -1));
5759 static int jim_target_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5762 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5765 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5766 struct target
*target
= all_targets
;
5768 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5769 Jim_NewStringObj(interp
, target_name(target
), -1));
5770 target
= target
->next
;
5775 static int jim_target_smp(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5778 const char *targetname
;
5780 struct target
*target
= (struct target
*) NULL
;
5781 struct target_list
*head
, *curr
, *new;
5782 curr
= (struct target_list
*) NULL
;
5783 head
= (struct target_list
*) NULL
;
5786 LOG_DEBUG("%d", argc
);
5787 /* argv[1] = target to associate in smp
5788 * argv[2] = target to assoicate in smp
5792 for (i
= 1; i
< argc
; i
++) {
5794 targetname
= Jim_GetString(argv
[i
], &len
);
5795 target
= get_target(targetname
);
5796 LOG_DEBUG("%s ", targetname
);
5798 new = malloc(sizeof(struct target_list
));
5799 new->target
= target
;
5800 new->next
= (struct target_list
*)NULL
;
5801 if (head
== (struct target_list
*)NULL
) {
5810 /* now parse the list of cpu and put the target in smp mode*/
5813 while (curr
!= (struct target_list
*)NULL
) {
5814 target
= curr
->target
;
5816 target
->head
= head
;
5820 if (target
&& target
->rtos
)
5821 retval
= rtos_smp_init(head
->target
);
5827 static int jim_target_create(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5830 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5832 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
5833 "<name> <target_type> [<target_options> ...]");
5836 return target_create(&goi
);
5839 static const struct command_registration target_subcommand_handlers
[] = {
5842 .mode
= COMMAND_CONFIG
,
5843 .handler
= handle_target_init_command
,
5844 .help
= "initialize targets",
5848 /* REVISIT this should be COMMAND_CONFIG ... */
5849 .mode
= COMMAND_ANY
,
5850 .jim_handler
= jim_target_create
,
5851 .usage
= "name type '-chain-position' name [options ...]",
5852 .help
= "Creates and selects a new target",
5856 .mode
= COMMAND_ANY
,
5857 .jim_handler
= jim_target_current
,
5858 .help
= "Returns the currently selected target",
5862 .mode
= COMMAND_ANY
,
5863 .jim_handler
= jim_target_types
,
5864 .help
= "Returns the available target types as "
5865 "a list of strings",
5869 .mode
= COMMAND_ANY
,
5870 .jim_handler
= jim_target_names
,
5871 .help
= "Returns the names of all targets as a list of strings",
5875 .mode
= COMMAND_ANY
,
5876 .jim_handler
= jim_target_smp
,
5877 .usage
= "targetname1 targetname2 ...",
5878 .help
= "gather several target in a smp list"
5881 COMMAND_REGISTRATION_DONE
5885 target_addr_t address
;
5891 static int fastload_num
;
5892 static struct FastLoad
*fastload
;
5894 static void free_fastload(void)
5896 if (fastload
!= NULL
) {
5898 for (i
= 0; i
< fastload_num
; i
++) {
5899 if (fastload
[i
].data
)
5900 free(fastload
[i
].data
);
5907 COMMAND_HANDLER(handle_fast_load_image_command
)
5911 uint32_t image_size
;
5912 target_addr_t min_address
= 0;
5913 target_addr_t max_address
= -1;
5918 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
5919 &image
, &min_address
, &max_address
);
5920 if (ERROR_OK
!= retval
)
5923 struct duration bench
;
5924 duration_start(&bench
);
5926 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
);
5927 if (retval
!= ERROR_OK
)
5932 fastload_num
= image
.num_sections
;
5933 fastload
= malloc(sizeof(struct FastLoad
)*image
.num_sections
);
5934 if (fastload
== NULL
) {
5935 command_print(CMD_CTX
, "out of memory");
5936 image_close(&image
);
5939 memset(fastload
, 0, sizeof(struct FastLoad
)*image
.num_sections
);
5940 for (i
= 0; i
< image
.num_sections
; i
++) {
5941 buffer
= malloc(image
.sections
[i
].size
);
5942 if (buffer
== NULL
) {
5943 command_print(CMD_CTX
, "error allocating buffer for section (%d bytes)",
5944 (int)(image
.sections
[i
].size
));
5945 retval
= ERROR_FAIL
;
5949 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
5950 if (retval
!= ERROR_OK
) {
5955 uint32_t offset
= 0;
5956 uint32_t length
= buf_cnt
;
5958 /* DANGER!!! beware of unsigned comparision here!!! */
5960 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
5961 (image
.sections
[i
].base_address
< max_address
)) {
5962 if (image
.sections
[i
].base_address
< min_address
) {
5963 /* clip addresses below */
5964 offset
+= min_address
-image
.sections
[i
].base_address
;
5968 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
5969 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
5971 fastload
[i
].address
= image
.sections
[i
].base_address
+ offset
;
5972 fastload
[i
].data
= malloc(length
);
5973 if (fastload
[i
].data
== NULL
) {
5975 command_print(CMD_CTX
, "error allocating buffer for section (%" PRIu32
" bytes)",
5977 retval
= ERROR_FAIL
;
5980 memcpy(fastload
[i
].data
, buffer
+ offset
, length
);
5981 fastload
[i
].length
= length
;
5983 image_size
+= length
;
5984 command_print(CMD_CTX
, "%u bytes written at address 0x%8.8x",
5985 (unsigned int)length
,
5986 ((unsigned int)(image
.sections
[i
].base_address
+ offset
)));
5992 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
5993 command_print(CMD_CTX
, "Loaded %" PRIu32
" bytes "
5994 "in %fs (%0.3f KiB/s)", image_size
,
5995 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
5997 command_print(CMD_CTX
,
5998 "WARNING: image has not been loaded to target!"
5999 "You can issue a 'fast_load' to finish loading.");
6002 image_close(&image
);
6004 if (retval
!= ERROR_OK
)
6010 COMMAND_HANDLER(handle_fast_load_command
)
6013 return ERROR_COMMAND_SYNTAX_ERROR
;
6014 if (fastload
== NULL
) {
6015 LOG_ERROR("No image in memory");
6019 int64_t ms
= timeval_ms();
6021 int retval
= ERROR_OK
;
6022 for (i
= 0; i
< fastload_num
; i
++) {
6023 struct target
*target
= get_current_target(CMD_CTX
);
6024 command_print(CMD_CTX
, "Write to 0x%08x, length 0x%08x",
6025 (unsigned int)(fastload
[i
].address
),
6026 (unsigned int)(fastload
[i
].length
));
6027 retval
= target_write_buffer(target
, fastload
[i
].address
, fastload
[i
].length
, fastload
[i
].data
);
6028 if (retval
!= ERROR_OK
)
6030 size
+= fastload
[i
].length
;
6032 if (retval
== ERROR_OK
) {
6033 int64_t after
= timeval_ms();
6034 command_print(CMD_CTX
, "Loaded image %f kBytes/s", (float)(size
/1024.0)/((float)(after
-ms
)/1000.0));
6039 static const struct command_registration target_command_handlers
[] = {
6042 .handler
= handle_targets_command
,
6043 .mode
= COMMAND_ANY
,
6044 .help
= "change current default target (one parameter) "
6045 "or prints table of all targets (no parameters)",
6046 .usage
= "[target]",
6050 .mode
= COMMAND_CONFIG
,
6051 .help
= "configure target",
6053 .chain
= target_subcommand_handlers
,
6055 COMMAND_REGISTRATION_DONE
6058 int target_register_commands(struct command_context
*cmd_ctx
)
6060 return register_commands(cmd_ctx
, NULL
, target_command_handlers
);
6063 static bool target_reset_nag
= true;
6065 bool get_target_reset_nag(void)
6067 return target_reset_nag
;
6070 COMMAND_HANDLER(handle_target_reset_nag
)
6072 return CALL_COMMAND_HANDLER(handle_command_parse_bool
,
6073 &target_reset_nag
, "Nag after each reset about options to improve "
6077 COMMAND_HANDLER(handle_ps_command
)
6079 struct target
*target
= get_current_target(CMD_CTX
);
6081 if (target
->state
!= TARGET_HALTED
) {
6082 LOG_INFO("target not halted !!");
6086 if ((target
->rtos
) && (target
->rtos
->type
)
6087 && (target
->rtos
->type
->ps_command
)) {
6088 display
= target
->rtos
->type
->ps_command(target
);
6089 command_print(CMD_CTX
, "%s", display
);
6094 return ERROR_TARGET_FAILURE
;
6098 static void binprint(struct command_context
*cmd_ctx
, const char *text
, const uint8_t *buf
, int size
)
6101 command_print_sameline(cmd_ctx
, "%s", text
);
6102 for (int i
= 0; i
< size
; i
++)
6103 command_print_sameline(cmd_ctx
, " %02x", buf
[i
]);
6104 command_print(cmd_ctx
, " ");
6107 COMMAND_HANDLER(handle_test_mem_access_command
)
6109 struct target
*target
= get_current_target(CMD_CTX
);
6111 int retval
= ERROR_OK
;
6113 if (target
->state
!= TARGET_HALTED
) {
6114 LOG_INFO("target not halted !!");
6119 return ERROR_COMMAND_SYNTAX_ERROR
;
6121 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], test_size
);
6124 size_t num_bytes
= test_size
+ 4;
6126 struct working_area
*wa
= NULL
;
6127 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
6128 if (retval
!= ERROR_OK
) {
6129 LOG_ERROR("Not enough working area");
6133 uint8_t *test_pattern
= malloc(num_bytes
);
6135 for (size_t i
= 0; i
< num_bytes
; i
++)
6136 test_pattern
[i
] = rand();
6138 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6139 if (retval
!= ERROR_OK
) {
6140 LOG_ERROR("Test pattern write failed");
6144 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6145 for (int size
= 1; size
<= 4; size
*= 2) {
6146 for (int offset
= 0; offset
< 4; offset
++) {
6147 uint32_t count
= test_size
/ size
;
6148 size_t host_bufsiz
= (count
+ 2) * size
+ host_offset
;
6149 uint8_t *read_ref
= malloc(host_bufsiz
);
6150 uint8_t *read_buf
= malloc(host_bufsiz
);
6152 for (size_t i
= 0; i
< host_bufsiz
; i
++) {
6153 read_ref
[i
] = rand();
6154 read_buf
[i
] = read_ref
[i
];
6156 command_print_sameline(CMD_CTX
,
6157 "Test read %" PRIu32
" x %d @ %d to %saligned buffer: ", count
,
6158 size
, offset
, host_offset
? "un" : "");
6160 struct duration bench
;
6161 duration_start(&bench
);
6163 retval
= target_read_memory(target
, wa
->address
+ offset
, size
, count
,
6164 read_buf
+ size
+ host_offset
);
6166 duration_measure(&bench
);
6168 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6169 command_print(CMD_CTX
, "Unsupported alignment");
6171 } else if (retval
!= ERROR_OK
) {
6172 command_print(CMD_CTX
, "Memory read failed");
6176 /* replay on host */
6177 memcpy(read_ref
+ size
+ host_offset
, test_pattern
+ offset
, count
* size
);
6180 int result
= memcmp(read_ref
, read_buf
, host_bufsiz
);
6182 command_print(CMD_CTX
, "Pass in %fs (%0.3f KiB/s)",
6183 duration_elapsed(&bench
),
6184 duration_kbps(&bench
, count
* size
));
6186 command_print(CMD_CTX
, "Compare failed");
6187 binprint(CMD_CTX
, "ref:", read_ref
, host_bufsiz
);
6188 binprint(CMD_CTX
, "buf:", read_buf
, host_bufsiz
);
6201 target_free_working_area(target
, wa
);
6204 num_bytes
= test_size
+ 4 + 4 + 4;
6206 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
6207 if (retval
!= ERROR_OK
) {
6208 LOG_ERROR("Not enough working area");
6212 test_pattern
= malloc(num_bytes
);
6214 for (size_t i
= 0; i
< num_bytes
; i
++)
6215 test_pattern
[i
] = rand();
6217 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6218 for (int size
= 1; size
<= 4; size
*= 2) {
6219 for (int offset
= 0; offset
< 4; offset
++) {
6220 uint32_t count
= test_size
/ size
;
6221 size_t host_bufsiz
= count
* size
+ host_offset
;
6222 uint8_t *read_ref
= malloc(num_bytes
);
6223 uint8_t *read_buf
= malloc(num_bytes
);
6224 uint8_t *write_buf
= malloc(host_bufsiz
);
6226 for (size_t i
= 0; i
< host_bufsiz
; i
++)
6227 write_buf
[i
] = rand();
6228 command_print_sameline(CMD_CTX
,
6229 "Test write %" PRIu32
" x %d @ %d from %saligned buffer: ", count
,
6230 size
, offset
, host_offset
? "un" : "");
6232 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6233 if (retval
!= ERROR_OK
) {
6234 command_print(CMD_CTX
, "Test pattern write failed");
6238 /* replay on host */
6239 memcpy(read_ref
, test_pattern
, num_bytes
);
6240 memcpy(read_ref
+ size
+ offset
, write_buf
+ host_offset
, count
* size
);
6242 struct duration bench
;
6243 duration_start(&bench
);
6245 retval
= target_write_memory(target
, wa
->address
+ size
+ offset
, size
, count
,
6246 write_buf
+ host_offset
);
6248 duration_measure(&bench
);
6250 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6251 command_print(CMD_CTX
, "Unsupported alignment");
6253 } else if (retval
!= ERROR_OK
) {
6254 command_print(CMD_CTX
, "Memory write failed");
6259 retval
= target_read_memory(target
, wa
->address
, 1, num_bytes
, read_buf
);
6260 if (retval
!= ERROR_OK
) {
6261 command_print(CMD_CTX
, "Test pattern write failed");
6266 int result
= memcmp(read_ref
, read_buf
, num_bytes
);
6268 command_print(CMD_CTX
, "Pass in %fs (%0.3f KiB/s)",
6269 duration_elapsed(&bench
),
6270 duration_kbps(&bench
, count
* size
));
6272 command_print(CMD_CTX
, "Compare failed");
6273 binprint(CMD_CTX
, "ref:", read_ref
, num_bytes
);
6274 binprint(CMD_CTX
, "buf:", read_buf
, num_bytes
);
6286 target_free_working_area(target
, wa
);
6290 static const struct command_registration target_exec_command_handlers
[] = {
6292 .name
= "fast_load_image",
6293 .handler
= handle_fast_load_image_command
,
6294 .mode
= COMMAND_ANY
,
6295 .help
= "Load image into server memory for later use by "
6296 "fast_load; primarily for profiling",
6297 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6298 "[min_address [max_length]]",
6301 .name
= "fast_load",
6302 .handler
= handle_fast_load_command
,
6303 .mode
= COMMAND_EXEC
,
6304 .help
= "loads active fast load image to current target "
6305 "- mainly for profiling purposes",
6310 .handler
= handle_profile_command
,
6311 .mode
= COMMAND_EXEC
,
6312 .usage
= "seconds filename [start end]",
6313 .help
= "profiling samples the CPU PC",
6315 /** @todo don't register virt2phys() unless target supports it */
6317 .name
= "virt2phys",
6318 .handler
= handle_virt2phys_command
,
6319 .mode
= COMMAND_ANY
,
6320 .help
= "translate a virtual address into a physical address",
6321 .usage
= "virtual_address",
6325 .handler
= handle_reg_command
,
6326 .mode
= COMMAND_EXEC
,
6327 .help
= "display (reread from target with \"force\") or set a register; "
6328 "with no arguments, displays all registers and their values",
6329 .usage
= "[(register_number|register_name) [(value|'force')]]",
6333 .handler
= handle_poll_command
,
6334 .mode
= COMMAND_EXEC
,
6335 .help
= "poll target state; or reconfigure background polling",
6336 .usage
= "['on'|'off']",
6339 .name
= "wait_halt",
6340 .handler
= handle_wait_halt_command
,
6341 .mode
= COMMAND_EXEC
,
6342 .help
= "wait up to the specified number of milliseconds "
6343 "(default 5000) for a previously requested halt",
6344 .usage
= "[milliseconds]",
6348 .handler
= handle_halt_command
,
6349 .mode
= COMMAND_EXEC
,
6350 .help
= "request target to halt, then wait up to the specified"
6351 "number of milliseconds (default 5000) for it to complete",
6352 .usage
= "[milliseconds]",
6356 .handler
= handle_resume_command
,
6357 .mode
= COMMAND_EXEC
,
6358 .help
= "resume target execution from current PC or address",
6359 .usage
= "[address]",
6363 .handler
= handle_reset_command
,
6364 .mode
= COMMAND_EXEC
,
6365 .usage
= "[run|halt|init]",
6366 .help
= "Reset all targets into the specified mode."
6367 "Default reset mode is run, if not given.",
6370 .name
= "soft_reset_halt",
6371 .handler
= handle_soft_reset_halt_command
,
6372 .mode
= COMMAND_EXEC
,
6374 .help
= "halt the target and do a soft reset",
6378 .handler
= handle_step_command
,
6379 .mode
= COMMAND_EXEC
,
6380 .help
= "step one instruction from current PC or address",
6381 .usage
= "[address]",
6385 .handler
= handle_md_command
,
6386 .mode
= COMMAND_EXEC
,
6387 .help
= "display memory words",
6388 .usage
= "['phys'] address [count]",
6392 .handler
= handle_md_command
,
6393 .mode
= COMMAND_EXEC
,
6394 .help
= "display memory words",
6395 .usage
= "['phys'] address [count]",
6399 .handler
= handle_md_command
,
6400 .mode
= COMMAND_EXEC
,
6401 .help
= "display memory half-words",
6402 .usage
= "['phys'] address [count]",
6406 .handler
= handle_md_command
,
6407 .mode
= COMMAND_EXEC
,
6408 .help
= "display memory bytes",
6409 .usage
= "['phys'] address [count]",
6413 .handler
= handle_mw_command
,
6414 .mode
= COMMAND_EXEC
,
6415 .help
= "write memory word",
6416 .usage
= "['phys'] address value [count]",
6420 .handler
= handle_mw_command
,
6421 .mode
= COMMAND_EXEC
,
6422 .help
= "write memory word",
6423 .usage
= "['phys'] address value [count]",
6427 .handler
= handle_mw_command
,
6428 .mode
= COMMAND_EXEC
,
6429 .help
= "write memory half-word",
6430 .usage
= "['phys'] address value [count]",
6434 .handler
= handle_mw_command
,
6435 .mode
= COMMAND_EXEC
,
6436 .help
= "write memory byte",
6437 .usage
= "['phys'] address value [count]",
6441 .handler
= handle_bp_command
,
6442 .mode
= COMMAND_EXEC
,
6443 .help
= "list or set hardware or software breakpoint",
6444 .usage
= "<address> [<asid>] <length> ['hw'|'hw_ctx']",
6448 .handler
= handle_rbp_command
,
6449 .mode
= COMMAND_EXEC
,
6450 .help
= "remove breakpoint",
6455 .handler
= handle_wp_command
,
6456 .mode
= COMMAND_EXEC
,
6457 .help
= "list (no params) or create watchpoints",
6458 .usage
= "[address length [('r'|'w'|'a') value [mask]]]",
6462 .handler
= handle_rwp_command
,
6463 .mode
= COMMAND_EXEC
,
6464 .help
= "remove watchpoint",
6468 .name
= "load_image",
6469 .handler
= handle_load_image_command
,
6470 .mode
= COMMAND_EXEC
,
6471 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6472 "[min_address] [max_length]",
6475 .name
= "dump_image",
6476 .handler
= handle_dump_image_command
,
6477 .mode
= COMMAND_EXEC
,
6478 .usage
= "filename address size",
6481 .name
= "verify_image_checksum",
6482 .handler
= handle_verify_image_checksum_command
,
6483 .mode
= COMMAND_EXEC
,
6484 .usage
= "filename [offset [type]]",
6487 .name
= "verify_image",
6488 .handler
= handle_verify_image_command
,
6489 .mode
= COMMAND_EXEC
,
6490 .usage
= "filename [offset [type]]",
6493 .name
= "test_image",
6494 .handler
= handle_test_image_command
,
6495 .mode
= COMMAND_EXEC
,
6496 .usage
= "filename [offset [type]]",
6499 .name
= "mem2array",
6500 .mode
= COMMAND_EXEC
,
6501 .jim_handler
= jim_mem2array
,
6502 .help
= "read 8/16/32 bit memory and return as a TCL array "
6503 "for script processing",
6504 .usage
= "arrayname bitwidth address count",
6507 .name
= "array2mem",
6508 .mode
= COMMAND_EXEC
,
6509 .jim_handler
= jim_array2mem
,
6510 .help
= "convert a TCL array to memory locations "
6511 "and write the 8/16/32 bit values",
6512 .usage
= "arrayname bitwidth address count",
6515 .name
= "reset_nag",
6516 .handler
= handle_target_reset_nag
,
6517 .mode
= COMMAND_ANY
,
6518 .help
= "Nag after each reset about options that could have been "
6519 "enabled to improve performance. ",
6520 .usage
= "['enable'|'disable']",
6524 .handler
= handle_ps_command
,
6525 .mode
= COMMAND_EXEC
,
6526 .help
= "list all tasks ",
6530 .name
= "test_mem_access",
6531 .handler
= handle_test_mem_access_command
,
6532 .mode
= COMMAND_EXEC
,
6533 .help
= "Test the target's memory access functions",
6537 COMMAND_REGISTRATION_DONE
6539 static int target_register_user_commands(struct command_context
*cmd_ctx
)
6541 int retval
= ERROR_OK
;
6542 retval
= target_request_register_commands(cmd_ctx
);
6543 if (retval
!= ERROR_OK
)
6546 retval
= trace_register_commands(cmd_ctx
);
6547 if (retval
!= ERROR_OK
)
6551 return register_commands(cmd_ctx
, NULL
, target_exec_command_handlers
);