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 mips_mips64_target
;
98 extern struct target_type avr_target
;
99 extern struct target_type dsp563xx_target
;
100 extern struct target_type dsp5680xx_target
;
101 extern struct target_type testee_target
;
102 extern struct target_type avr32_ap7k_target
;
103 extern struct target_type hla_target
;
104 extern struct target_type nds32_v2_target
;
105 extern struct target_type nds32_v3_target
;
106 extern struct target_type nds32_v3m_target
;
107 extern struct target_type or1k_target
;
108 extern struct target_type quark_x10xx_target
;
109 extern struct target_type quark_d20xx_target
;
110 extern struct target_type stm8_target
;
111 extern struct target_type riscv_target
;
112 extern struct target_type mem_ap_target
;
113 extern struct target_type esirisc_target
;
114 extern struct target_type arcv2_target
;
116 static struct target_type
*target_types
[] = {
158 struct target
*all_targets
;
159 static struct target_event_callback
*target_event_callbacks
;
160 static struct target_timer_callback
*target_timer_callbacks
;
161 LIST_HEAD(target_reset_callback_list
);
162 LIST_HEAD(target_trace_callback_list
);
163 static const int polling_interval
= 100;
165 static const Jim_Nvp nvp_assert
[] = {
166 { .name
= "assert", NVP_ASSERT
},
167 { .name
= "deassert", NVP_DEASSERT
},
168 { .name
= "T", NVP_ASSERT
},
169 { .name
= "F", NVP_DEASSERT
},
170 { .name
= "t", NVP_ASSERT
},
171 { .name
= "f", NVP_DEASSERT
},
172 { .name
= NULL
, .value
= -1 }
175 static const Jim_Nvp nvp_error_target
[] = {
176 { .value
= ERROR_TARGET_INVALID
, .name
= "err-invalid" },
177 { .value
= ERROR_TARGET_INIT_FAILED
, .name
= "err-init-failed" },
178 { .value
= ERROR_TARGET_TIMEOUT
, .name
= "err-timeout" },
179 { .value
= ERROR_TARGET_NOT_HALTED
, .name
= "err-not-halted" },
180 { .value
= ERROR_TARGET_FAILURE
, .name
= "err-failure" },
181 { .value
= ERROR_TARGET_UNALIGNED_ACCESS
, .name
= "err-unaligned-access" },
182 { .value
= ERROR_TARGET_DATA_ABORT
, .name
= "err-data-abort" },
183 { .value
= ERROR_TARGET_RESOURCE_NOT_AVAILABLE
, .name
= "err-resource-not-available" },
184 { .value
= ERROR_TARGET_TRANSLATION_FAULT
, .name
= "err-translation-fault" },
185 { .value
= ERROR_TARGET_NOT_RUNNING
, .name
= "err-not-running" },
186 { .value
= ERROR_TARGET_NOT_EXAMINED
, .name
= "err-not-examined" },
187 { .value
= -1, .name
= NULL
}
190 static const char *target_strerror_safe(int err
)
194 n
= Jim_Nvp_value2name_simple(nvp_error_target
, err
);
201 static const Jim_Nvp nvp_target_event
[] = {
203 { .value
= TARGET_EVENT_GDB_HALT
, .name
= "gdb-halt" },
204 { .value
= TARGET_EVENT_HALTED
, .name
= "halted" },
205 { .value
= TARGET_EVENT_RESUMED
, .name
= "resumed" },
206 { .value
= TARGET_EVENT_RESUME_START
, .name
= "resume-start" },
207 { .value
= TARGET_EVENT_RESUME_END
, .name
= "resume-end" },
209 { .name
= "gdb-start", .value
= TARGET_EVENT_GDB_START
},
210 { .name
= "gdb-end", .value
= TARGET_EVENT_GDB_END
},
212 { .value
= TARGET_EVENT_RESET_START
, .name
= "reset-start" },
213 { .value
= TARGET_EVENT_RESET_ASSERT_PRE
, .name
= "reset-assert-pre" },
214 { .value
= TARGET_EVENT_RESET_ASSERT
, .name
= "reset-assert" },
215 { .value
= TARGET_EVENT_RESET_ASSERT_POST
, .name
= "reset-assert-post" },
216 { .value
= TARGET_EVENT_RESET_DEASSERT_PRE
, .name
= "reset-deassert-pre" },
217 { .value
= TARGET_EVENT_RESET_DEASSERT_POST
, .name
= "reset-deassert-post" },
218 { .value
= TARGET_EVENT_RESET_INIT
, .name
= "reset-init" },
219 { .value
= TARGET_EVENT_RESET_END
, .name
= "reset-end" },
221 { .value
= TARGET_EVENT_EXAMINE_START
, .name
= "examine-start" },
222 { .value
= TARGET_EVENT_EXAMINE_FAIL
, .name
= "examine-fail" },
223 { .value
= TARGET_EVENT_EXAMINE_END
, .name
= "examine-end" },
225 { .value
= TARGET_EVENT_DEBUG_HALTED
, .name
= "debug-halted" },
226 { .value
= TARGET_EVENT_DEBUG_RESUMED
, .name
= "debug-resumed" },
228 { .value
= TARGET_EVENT_GDB_ATTACH
, .name
= "gdb-attach" },
229 { .value
= TARGET_EVENT_GDB_DETACH
, .name
= "gdb-detach" },
231 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_START
, .name
= "gdb-flash-write-start" },
232 { .value
= TARGET_EVENT_GDB_FLASH_WRITE_END
, .name
= "gdb-flash-write-end" },
234 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_START
, .name
= "gdb-flash-erase-start" },
235 { .value
= TARGET_EVENT_GDB_FLASH_ERASE_END
, .name
= "gdb-flash-erase-end" },
237 { .value
= TARGET_EVENT_TRACE_CONFIG
, .name
= "trace-config" },
239 { .name
= NULL
, .value
= -1 }
242 static const Jim_Nvp nvp_target_state
[] = {
243 { .name
= "unknown", .value
= TARGET_UNKNOWN
},
244 { .name
= "running", .value
= TARGET_RUNNING
},
245 { .name
= "halted", .value
= TARGET_HALTED
},
246 { .name
= "reset", .value
= TARGET_RESET
},
247 { .name
= "debug-running", .value
= TARGET_DEBUG_RUNNING
},
248 { .name
= NULL
, .value
= -1 },
251 static const Jim_Nvp nvp_target_debug_reason
[] = {
252 { .name
= "debug-request" , .value
= DBG_REASON_DBGRQ
},
253 { .name
= "breakpoint" , .value
= DBG_REASON_BREAKPOINT
},
254 { .name
= "watchpoint" , .value
= DBG_REASON_WATCHPOINT
},
255 { .name
= "watchpoint-and-breakpoint", .value
= DBG_REASON_WPTANDBKPT
},
256 { .name
= "single-step" , .value
= DBG_REASON_SINGLESTEP
},
257 { .name
= "target-not-halted" , .value
= DBG_REASON_NOTHALTED
},
258 { .name
= "program-exit" , .value
= DBG_REASON_EXIT
},
259 { .name
= "exception-catch" , .value
= DBG_REASON_EXC_CATCH
},
260 { .name
= "undefined" , .value
= DBG_REASON_UNDEFINED
},
261 { .name
= NULL
, .value
= -1 },
264 static const Jim_Nvp nvp_target_endian
[] = {
265 { .name
= "big", .value
= TARGET_BIG_ENDIAN
},
266 { .name
= "little", .value
= TARGET_LITTLE_ENDIAN
},
267 { .name
= "be", .value
= TARGET_BIG_ENDIAN
},
268 { .name
= "le", .value
= TARGET_LITTLE_ENDIAN
},
269 { .name
= NULL
, .value
= -1 },
272 static const Jim_Nvp nvp_reset_modes
[] = {
273 { .name
= "unknown", .value
= RESET_UNKNOWN
},
274 { .name
= "run" , .value
= RESET_RUN
},
275 { .name
= "halt" , .value
= RESET_HALT
},
276 { .name
= "init" , .value
= RESET_INIT
},
277 { .name
= NULL
, .value
= -1 },
280 const char *debug_reason_name(struct target
*t
)
284 cp
= Jim_Nvp_value2name_simple(nvp_target_debug_reason
,
285 t
->debug_reason
)->name
;
287 LOG_ERROR("Invalid debug reason: %d", (int)(t
->debug_reason
));
288 cp
= "(*BUG*unknown*BUG*)";
293 const char *target_state_name(struct target
*t
)
296 cp
= Jim_Nvp_value2name_simple(nvp_target_state
, t
->state
)->name
;
298 LOG_ERROR("Invalid target state: %d", (int)(t
->state
));
299 cp
= "(*BUG*unknown*BUG*)";
302 if (!target_was_examined(t
) && t
->defer_examine
)
303 cp
= "examine deferred";
308 const char *target_event_name(enum target_event event
)
311 cp
= Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
;
313 LOG_ERROR("Invalid target event: %d", (int)(event
));
314 cp
= "(*BUG*unknown*BUG*)";
319 const char *target_reset_mode_name(enum target_reset_mode reset_mode
)
322 cp
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
;
324 LOG_ERROR("Invalid target reset mode: %d", (int)(reset_mode
));
325 cp
= "(*BUG*unknown*BUG*)";
330 /* determine the number of the new target */
331 static int new_target_number(void)
336 /* number is 0 based */
340 if (x
< t
->target_number
)
341 x
= t
->target_number
;
347 /* read a uint64_t from a buffer in target memory endianness */
348 uint64_t target_buffer_get_u64(struct target
*target
, const uint8_t *buffer
)
350 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
351 return le_to_h_u64(buffer
);
353 return be_to_h_u64(buffer
);
356 /* read a uint32_t from a buffer in target memory endianness */
357 uint32_t target_buffer_get_u32(struct target
*target
, const uint8_t *buffer
)
359 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
360 return le_to_h_u32(buffer
);
362 return be_to_h_u32(buffer
);
365 /* read a uint24_t from a buffer in target memory endianness */
366 uint32_t target_buffer_get_u24(struct target
*target
, const uint8_t *buffer
)
368 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
369 return le_to_h_u24(buffer
);
371 return be_to_h_u24(buffer
);
374 /* read a uint16_t from a buffer in target memory endianness */
375 uint16_t target_buffer_get_u16(struct target
*target
, const uint8_t *buffer
)
377 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
378 return le_to_h_u16(buffer
);
380 return be_to_h_u16(buffer
);
383 /* write a uint64_t to a buffer in target memory endianness */
384 void target_buffer_set_u64(struct target
*target
, uint8_t *buffer
, uint64_t value
)
386 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
387 h_u64_to_le(buffer
, value
);
389 h_u64_to_be(buffer
, value
);
392 /* write a uint32_t to a buffer in target memory endianness */
393 void target_buffer_set_u32(struct target
*target
, uint8_t *buffer
, uint32_t value
)
395 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
396 h_u32_to_le(buffer
, value
);
398 h_u32_to_be(buffer
, value
);
401 /* write a uint24_t to a buffer in target memory endianness */
402 void target_buffer_set_u24(struct target
*target
, uint8_t *buffer
, uint32_t value
)
404 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
405 h_u24_to_le(buffer
, value
);
407 h_u24_to_be(buffer
, value
);
410 /* write a uint16_t to a buffer in target memory endianness */
411 void target_buffer_set_u16(struct target
*target
, uint8_t *buffer
, uint16_t value
)
413 if (target
->endianness
== TARGET_LITTLE_ENDIAN
)
414 h_u16_to_le(buffer
, value
);
416 h_u16_to_be(buffer
, value
);
419 /* write a uint8_t to a buffer in target memory endianness */
420 static void target_buffer_set_u8(struct target
*target
, uint8_t *buffer
, uint8_t value
)
425 /* write a uint64_t array to a buffer in target memory endianness */
426 void target_buffer_get_u64_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint64_t *dstbuf
)
429 for (i
= 0; i
< count
; i
++)
430 dstbuf
[i
] = target_buffer_get_u64(target
, &buffer
[i
* 8]);
433 /* write a uint32_t array to a buffer in target memory endianness */
434 void target_buffer_get_u32_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint32_t *dstbuf
)
437 for (i
= 0; i
< count
; i
++)
438 dstbuf
[i
] = target_buffer_get_u32(target
, &buffer
[i
* 4]);
441 /* write a uint16_t array to a buffer in target memory endianness */
442 void target_buffer_get_u16_array(struct target
*target
, const uint8_t *buffer
, uint32_t count
, uint16_t *dstbuf
)
445 for (i
= 0; i
< count
; i
++)
446 dstbuf
[i
] = target_buffer_get_u16(target
, &buffer
[i
* 2]);
449 /* write a uint64_t array to a buffer in target memory endianness */
450 void target_buffer_set_u64_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint64_t *srcbuf
)
453 for (i
= 0; i
< count
; i
++)
454 target_buffer_set_u64(target
, &buffer
[i
* 8], srcbuf
[i
]);
457 /* write a uint32_t array to a buffer in target memory endianness */
458 void target_buffer_set_u32_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint32_t *srcbuf
)
461 for (i
= 0; i
< count
; i
++)
462 target_buffer_set_u32(target
, &buffer
[i
* 4], srcbuf
[i
]);
465 /* write a uint16_t array to a buffer in target memory endianness */
466 void target_buffer_set_u16_array(struct target
*target
, uint8_t *buffer
, uint32_t count
, const uint16_t *srcbuf
)
469 for (i
= 0; i
< count
; i
++)
470 target_buffer_set_u16(target
, &buffer
[i
* 2], srcbuf
[i
]);
473 /* return a pointer to a configured target; id is name or number */
474 struct target
*get_target(const char *id
)
476 struct target
*target
;
478 /* try as tcltarget name */
479 for (target
= all_targets
; target
; target
= target
->next
) {
480 if (target_name(target
) == NULL
)
482 if (strcmp(id
, target_name(target
)) == 0)
486 /* It's OK to remove this fallback sometime after August 2010 or so */
488 /* no match, try as number */
490 if (parse_uint(id
, &num
) != ERROR_OK
)
493 for (target
= all_targets
; target
; target
= target
->next
) {
494 if (target
->target_number
== (int)num
) {
495 LOG_WARNING("use '%s' as target identifier, not '%u'",
496 target_name(target
), num
);
504 /* returns a pointer to the n-th configured target */
505 struct target
*get_target_by_num(int num
)
507 struct target
*target
= all_targets
;
510 if (target
->target_number
== num
)
512 target
= target
->next
;
518 struct target
*get_current_target(struct command_context
*cmd_ctx
)
520 struct target
*target
= get_current_target_or_null(cmd_ctx
);
522 if (target
== NULL
) {
523 LOG_ERROR("BUG: current_target out of bounds");
530 struct target
*get_current_target_or_null(struct command_context
*cmd_ctx
)
532 return cmd_ctx
->current_target_override
533 ? cmd_ctx
->current_target_override
534 : cmd_ctx
->current_target
;
537 int target_poll(struct target
*target
)
541 /* We can't poll until after examine */
542 if (!target_was_examined(target
)) {
543 /* Fail silently lest we pollute the log */
547 retval
= target
->type
->poll(target
);
548 if (retval
!= ERROR_OK
)
551 if (target
->halt_issued
) {
552 if (target
->state
== TARGET_HALTED
)
553 target
->halt_issued
= false;
555 int64_t t
= timeval_ms() - target
->halt_issued_time
;
556 if (t
> DEFAULT_HALT_TIMEOUT
) {
557 target
->halt_issued
= false;
558 LOG_INFO("Halt timed out, wake up GDB.");
559 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
567 int target_halt(struct target
*target
)
570 /* We can't poll until after examine */
571 if (!target_was_examined(target
)) {
572 LOG_ERROR("Target not examined yet");
576 retval
= target
->type
->halt(target
);
577 if (retval
!= ERROR_OK
)
580 target
->halt_issued
= true;
581 target
->halt_issued_time
= timeval_ms();
587 * Make the target (re)start executing using its saved execution
588 * context (possibly with some modifications).
590 * @param target Which target should start executing.
591 * @param current True to use the target's saved program counter instead
592 * of the address parameter
593 * @param address Optionally used as the program counter.
594 * @param handle_breakpoints True iff breakpoints at the resumption PC
595 * should be skipped. (For example, maybe execution was stopped by
596 * such a breakpoint, in which case it would be counterprodutive to
598 * @param debug_execution False if all working areas allocated by OpenOCD
599 * should be released and/or restored to their original contents.
600 * (This would for example be true to run some downloaded "helper"
601 * algorithm code, which resides in one such working buffer and uses
602 * another for data storage.)
604 * @todo Resolve the ambiguity about what the "debug_execution" flag
605 * signifies. For example, Target implementations don't agree on how
606 * it relates to invalidation of the register cache, or to whether
607 * breakpoints and watchpoints should be enabled. (It would seem wrong
608 * to enable breakpoints when running downloaded "helper" algorithms
609 * (debug_execution true), since the breakpoints would be set to match
610 * target firmware being debugged, not the helper algorithm.... and
611 * enabling them could cause such helpers to malfunction (for example,
612 * by overwriting data with a breakpoint instruction. On the other
613 * hand the infrastructure for running such helpers might use this
614 * procedure but rely on hardware breakpoint to detect termination.)
616 int target_resume(struct target
*target
, int current
, target_addr_t address
,
617 int handle_breakpoints
, int debug_execution
)
621 /* We can't poll until after examine */
622 if (!target_was_examined(target
)) {
623 LOG_ERROR("Target not examined yet");
627 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_START
);
629 /* note that resume *must* be asynchronous. The CPU can halt before
630 * we poll. The CPU can even halt at the current PC as a result of
631 * a software breakpoint being inserted by (a bug?) the application.
633 retval
= target
->type
->resume(target
, current
, address
, handle_breakpoints
, debug_execution
);
634 if (retval
!= ERROR_OK
)
637 target_call_event_callbacks(target
, TARGET_EVENT_RESUME_END
);
642 static int target_process_reset(struct command_invocation
*cmd
, enum target_reset_mode reset_mode
)
647 n
= Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
);
648 if (n
->name
== NULL
) {
649 LOG_ERROR("invalid reset mode");
653 struct target
*target
;
654 for (target
= all_targets
; target
; target
= target
->next
)
655 target_call_reset_callbacks(target
, reset_mode
);
657 /* disable polling during reset to make reset event scripts
658 * more predictable, i.e. dr/irscan & pathmove in events will
659 * not have JTAG operations injected into the middle of a sequence.
661 bool save_poll
= jtag_poll_get_enabled();
663 jtag_poll_set_enabled(false);
665 sprintf(buf
, "ocd_process_reset %s", n
->name
);
666 retval
= Jim_Eval(cmd
->ctx
->interp
, buf
);
668 jtag_poll_set_enabled(save_poll
);
670 if (retval
!= JIM_OK
) {
671 Jim_MakeErrorMessage(cmd
->ctx
->interp
);
672 command_print(cmd
, "%s", Jim_GetString(Jim_GetResult(cmd
->ctx
->interp
), NULL
));
676 /* We want any events to be processed before the prompt */
677 retval
= target_call_timer_callbacks_now();
679 for (target
= all_targets
; target
; target
= target
->next
) {
680 target
->type
->check_reset(target
);
681 target
->running_alg
= false;
687 static int identity_virt2phys(struct target
*target
,
688 target_addr_t
virtual, target_addr_t
*physical
)
694 static int no_mmu(struct target
*target
, int *enabled
)
700 static int default_examine(struct target
*target
)
702 target_set_examined(target
);
706 /* no check by default */
707 static int default_check_reset(struct target
*target
)
712 /* Equvivalent Tcl code arp_examine_one is in src/target/startup.tcl
714 int target_examine_one(struct target
*target
)
716 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_START
);
718 int retval
= target
->type
->examine(target
);
719 if (retval
!= ERROR_OK
) {
720 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_FAIL
);
724 target_call_event_callbacks(target
, TARGET_EVENT_EXAMINE_END
);
729 static int jtag_enable_callback(enum jtag_event event
, void *priv
)
731 struct target
*target
= priv
;
733 if (event
!= JTAG_TAP_EVENT_ENABLE
|| !target
->tap
->enabled
)
736 jtag_unregister_event_callback(jtag_enable_callback
, target
);
738 return target_examine_one(target
);
741 /* Targets that correctly implement init + examine, i.e.
742 * no communication with target during init:
746 int target_examine(void)
748 int retval
= ERROR_OK
;
749 struct target
*target
;
751 for (target
= all_targets
; target
; target
= target
->next
) {
752 /* defer examination, but don't skip it */
753 if (!target
->tap
->enabled
) {
754 jtag_register_event_callback(jtag_enable_callback
,
759 if (target
->defer_examine
)
762 retval
= target_examine_one(target
);
763 if (retval
!= ERROR_OK
)
769 const char *target_type_name(struct target
*target
)
771 return target
->type
->name
;
774 static int target_soft_reset_halt(struct target
*target
)
776 if (!target_was_examined(target
)) {
777 LOG_ERROR("Target not examined yet");
780 if (!target
->type
->soft_reset_halt
) {
781 LOG_ERROR("Target %s does not support soft_reset_halt",
782 target_name(target
));
785 return target
->type
->soft_reset_halt(target
);
789 * Downloads a target-specific native code algorithm to the target,
790 * and executes it. * Note that some targets may need to set up, enable,
791 * and tear down a breakpoint (hard or * soft) to detect algorithm
792 * termination, while others may support lower overhead schemes where
793 * soft breakpoints embedded in the algorithm automatically terminate the
796 * @param target used to run the algorithm
797 * @param arch_info target-specific description of the algorithm.
799 int target_run_algorithm(struct target
*target
,
800 int num_mem_params
, struct mem_param
*mem_params
,
801 int num_reg_params
, struct reg_param
*reg_param
,
802 uint32_t entry_point
, uint32_t exit_point
,
803 int timeout_ms
, void *arch_info
)
805 int retval
= ERROR_FAIL
;
807 if (!target_was_examined(target
)) {
808 LOG_ERROR("Target not examined yet");
811 if (!target
->type
->run_algorithm
) {
812 LOG_ERROR("Target type '%s' does not support %s",
813 target_type_name(target
), __func__
);
817 target
->running_alg
= true;
818 retval
= target
->type
->run_algorithm(target
,
819 num_mem_params
, mem_params
,
820 num_reg_params
, reg_param
,
821 entry_point
, exit_point
, timeout_ms
, arch_info
);
822 target
->running_alg
= false;
829 * Executes a target-specific native code algorithm and leaves it running.
831 * @param target used to run the algorithm
832 * @param arch_info target-specific description of the algorithm.
834 int target_start_algorithm(struct target
*target
,
835 int num_mem_params
, struct mem_param
*mem_params
,
836 int num_reg_params
, struct reg_param
*reg_params
,
837 uint32_t entry_point
, uint32_t exit_point
,
840 int retval
= ERROR_FAIL
;
842 if (!target_was_examined(target
)) {
843 LOG_ERROR("Target not examined yet");
846 if (!target
->type
->start_algorithm
) {
847 LOG_ERROR("Target type '%s' does not support %s",
848 target_type_name(target
), __func__
);
851 if (target
->running_alg
) {
852 LOG_ERROR("Target is already running an algorithm");
856 target
->running_alg
= true;
857 retval
= target
->type
->start_algorithm(target
,
858 num_mem_params
, mem_params
,
859 num_reg_params
, reg_params
,
860 entry_point
, exit_point
, arch_info
);
867 * Waits for an algorithm started with target_start_algorithm() to complete.
869 * @param target used to run the algorithm
870 * @param arch_info target-specific description of the algorithm.
872 int target_wait_algorithm(struct target
*target
,
873 int num_mem_params
, struct mem_param
*mem_params
,
874 int num_reg_params
, struct reg_param
*reg_params
,
875 uint32_t exit_point
, int timeout_ms
,
878 int retval
= ERROR_FAIL
;
880 if (!target
->type
->wait_algorithm
) {
881 LOG_ERROR("Target type '%s' does not support %s",
882 target_type_name(target
), __func__
);
885 if (!target
->running_alg
) {
886 LOG_ERROR("Target is not running an algorithm");
890 retval
= target
->type
->wait_algorithm(target
,
891 num_mem_params
, mem_params
,
892 num_reg_params
, reg_params
,
893 exit_point
, timeout_ms
, arch_info
);
894 if (retval
!= ERROR_TARGET_TIMEOUT
)
895 target
->running_alg
= false;
902 * Streams data to a circular buffer on target intended for consumption by code
903 * running asynchronously on target.
905 * This is intended for applications where target-specific native code runs
906 * on the target, receives data from the circular buffer, does something with
907 * it (most likely writing it to a flash memory), and advances the circular
910 * This assumes that the helper algorithm has already been loaded to the target,
911 * but has not been started yet. Given memory and register parameters are passed
914 * The buffer is defined by (buffer_start, buffer_size) arguments and has the
917 * [buffer_start + 0, buffer_start + 4):
918 * Write Pointer address (aka head). Written and updated by this
919 * routine when new data is written to the circular buffer.
920 * [buffer_start + 4, buffer_start + 8):
921 * Read Pointer address (aka tail). Updated by code running on the
922 * target after it consumes data.
923 * [buffer_start + 8, buffer_start + buffer_size):
924 * Circular buffer contents.
926 * See contrib/loaders/flash/stm32f1x.S for an example.
928 * @param target used to run the algorithm
929 * @param buffer address on the host where data to be sent is located
930 * @param count number of blocks to send
931 * @param block_size size in bytes of each block
932 * @param num_mem_params count of memory-based params to pass to algorithm
933 * @param mem_params memory-based params to pass to algorithm
934 * @param num_reg_params count of register-based params to pass to algorithm
935 * @param reg_params memory-based params to pass to algorithm
936 * @param buffer_start address on the target of the circular buffer structure
937 * @param buffer_size size of the circular buffer structure
938 * @param entry_point address on the target to execute to start the algorithm
939 * @param exit_point address at which to set a breakpoint to catch the
940 * end of the algorithm; can be 0 if target triggers a breakpoint itself
943 int target_run_flash_async_algorithm(struct target
*target
,
944 const uint8_t *buffer
, uint32_t count
, int block_size
,
945 int num_mem_params
, struct mem_param
*mem_params
,
946 int num_reg_params
, struct reg_param
*reg_params
,
947 uint32_t buffer_start
, uint32_t buffer_size
,
948 uint32_t entry_point
, uint32_t exit_point
, void *arch_info
)
953 const uint8_t *buffer_orig
= buffer
;
955 /* Set up working area. First word is write pointer, second word is read pointer,
956 * rest is fifo data area. */
957 uint32_t wp_addr
= buffer_start
;
958 uint32_t rp_addr
= buffer_start
+ 4;
959 uint32_t fifo_start_addr
= buffer_start
+ 8;
960 uint32_t fifo_end_addr
= buffer_start
+ buffer_size
;
962 uint32_t wp
= fifo_start_addr
;
963 uint32_t rp
= fifo_start_addr
;
965 /* validate block_size is 2^n */
966 assert(!block_size
|| !(block_size
& (block_size
- 1)));
968 retval
= target_write_u32(target
, wp_addr
, wp
);
969 if (retval
!= ERROR_OK
)
971 retval
= target_write_u32(target
, rp_addr
, rp
);
972 if (retval
!= ERROR_OK
)
975 /* Start up algorithm on target and let it idle while writing the first chunk */
976 retval
= target_start_algorithm(target
, num_mem_params
, mem_params
,
977 num_reg_params
, reg_params
,
982 if (retval
!= ERROR_OK
) {
983 LOG_ERROR("error starting target flash write algorithm");
989 retval
= target_read_u32(target
, rp_addr
, &rp
);
990 if (retval
!= ERROR_OK
) {
991 LOG_ERROR("failed to get read pointer");
995 LOG_DEBUG("offs 0x%zx count 0x%" PRIx32
" wp 0x%" PRIx32
" rp 0x%" PRIx32
,
996 (size_t) (buffer
- buffer_orig
), count
, wp
, rp
);
999 LOG_ERROR("flash write algorithm aborted by target");
1000 retval
= ERROR_FLASH_OPERATION_FAILED
;
1004 if (((rp
- fifo_start_addr
) & (block_size
- 1)) || rp
< fifo_start_addr
|| rp
>= fifo_end_addr
) {
1005 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32
, rp
);
1009 /* Count the number of bytes available in the fifo without
1010 * crossing the wrap around. Make sure to not fill it completely,
1011 * because that would make wp == rp and that's the empty condition. */
1012 uint32_t thisrun_bytes
;
1014 thisrun_bytes
= rp
- wp
- block_size
;
1015 else if (rp
> fifo_start_addr
)
1016 thisrun_bytes
= fifo_end_addr
- wp
;
1018 thisrun_bytes
= fifo_end_addr
- wp
- block_size
;
1020 if (thisrun_bytes
== 0) {
1021 /* Throttle polling a bit if transfer is (much) faster than flash
1022 * programming. The exact delay shouldn't matter as long as it's
1023 * less than buffer size / flash speed. This is very unlikely to
1024 * run when using high latency connections such as USB. */
1027 /* to stop an infinite loop on some targets check and increment a timeout
1028 * this issue was observed on a stellaris using the new ICDI interface */
1029 if (timeout
++ >= 500) {
1030 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
1031 return ERROR_FLASH_OPERATION_FAILED
;
1036 /* reset our timeout */
1039 /* Limit to the amount of data we actually want to write */
1040 if (thisrun_bytes
> count
* block_size
)
1041 thisrun_bytes
= count
* block_size
;
1043 /* Write data to fifo */
1044 retval
= target_write_buffer(target
, wp
, thisrun_bytes
, buffer
);
1045 if (retval
!= ERROR_OK
)
1048 /* Update counters and wrap write pointer */
1049 buffer
+= thisrun_bytes
;
1050 count
-= thisrun_bytes
/ block_size
;
1051 wp
+= thisrun_bytes
;
1052 if (wp
>= fifo_end_addr
)
1053 wp
= fifo_start_addr
;
1055 /* Store updated write pointer to target */
1056 retval
= target_write_u32(target
, wp_addr
, wp
);
1057 if (retval
!= ERROR_OK
)
1060 /* Avoid GDB timeouts */
1064 if (retval
!= ERROR_OK
) {
1065 /* abort flash write algorithm on target */
1066 target_write_u32(target
, wp_addr
, 0);
1069 int retval2
= target_wait_algorithm(target
, num_mem_params
, mem_params
,
1070 num_reg_params
, reg_params
,
1075 if (retval2
!= ERROR_OK
) {
1076 LOG_ERROR("error waiting for target flash write algorithm");
1080 if (retval
== ERROR_OK
) {
1081 /* check if algorithm set rp = 0 after fifo writer loop finished */
1082 retval
= target_read_u32(target
, rp_addr
, &rp
);
1083 if (retval
== ERROR_OK
&& rp
== 0) {
1084 LOG_ERROR("flash write algorithm aborted by target");
1085 retval
= ERROR_FLASH_OPERATION_FAILED
;
1092 int target_read_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_memory
) {
1100 LOG_ERROR("Target %s doesn't support read_memory", target_name(target
));
1103 return target
->type
->read_memory(target
, address
, size
, count
, buffer
);
1106 int target_read_phys_memory(struct target
*target
,
1107 target_addr_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
)
1109 if (!target_was_examined(target
)) {
1110 LOG_ERROR("Target not examined yet");
1113 if (!target
->type
->read_phys_memory
) {
1114 LOG_ERROR("Target %s doesn't support read_phys_memory", target_name(target
));
1117 return target
->type
->read_phys_memory(target
, address
, size
, count
, buffer
);
1120 int target_write_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_memory
) {
1128 LOG_ERROR("Target %s doesn't support write_memory", target_name(target
));
1131 return target
->type
->write_memory(target
, address
, size
, count
, buffer
);
1134 int target_write_phys_memory(struct target
*target
,
1135 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
)
1137 if (!target_was_examined(target
)) {
1138 LOG_ERROR("Target not examined yet");
1141 if (!target
->type
->write_phys_memory
) {
1142 LOG_ERROR("Target %s doesn't support write_phys_memory", target_name(target
));
1145 return target
->type
->write_phys_memory(target
, address
, size
, count
, buffer
);
1148 int target_add_breakpoint(struct target
*target
,
1149 struct breakpoint
*breakpoint
)
1151 if ((target
->state
!= TARGET_HALTED
) && (breakpoint
->type
!= BKPT_HARD
)) {
1152 LOG_WARNING("target %s is not halted (add breakpoint)", target_name(target
));
1153 return ERROR_TARGET_NOT_HALTED
;
1155 return target
->type
->add_breakpoint(target
, breakpoint
);
1158 int target_add_context_breakpoint(struct target
*target
,
1159 struct breakpoint
*breakpoint
)
1161 if (target
->state
!= TARGET_HALTED
) {
1162 LOG_WARNING("target %s is not halted (add context breakpoint)", target_name(target
));
1163 return ERROR_TARGET_NOT_HALTED
;
1165 return target
->type
->add_context_breakpoint(target
, breakpoint
);
1168 int target_add_hybrid_breakpoint(struct target
*target
,
1169 struct breakpoint
*breakpoint
)
1171 if (target
->state
!= TARGET_HALTED
) {
1172 LOG_WARNING("target %s is not halted (add hybrid breakpoint)", target_name(target
));
1173 return ERROR_TARGET_NOT_HALTED
;
1175 return target
->type
->add_hybrid_breakpoint(target
, breakpoint
);
1178 int target_remove_breakpoint(struct target
*target
,
1179 struct breakpoint
*breakpoint
)
1181 return target
->type
->remove_breakpoint(target
, breakpoint
);
1184 int target_add_watchpoint(struct target
*target
,
1185 struct watchpoint
*watchpoint
)
1187 if (target
->state
!= TARGET_HALTED
) {
1188 LOG_WARNING("target %s is not halted (add watchpoint)", target_name(target
));
1189 return ERROR_TARGET_NOT_HALTED
;
1191 return target
->type
->add_watchpoint(target
, watchpoint
);
1193 int target_remove_watchpoint(struct target
*target
,
1194 struct watchpoint
*watchpoint
)
1196 return target
->type
->remove_watchpoint(target
, watchpoint
);
1198 int target_hit_watchpoint(struct target
*target
,
1199 struct watchpoint
**hit_watchpoint
)
1201 if (target
->state
!= TARGET_HALTED
) {
1202 LOG_WARNING("target %s is not halted (hit watchpoint)", target
->cmd_name
);
1203 return ERROR_TARGET_NOT_HALTED
;
1206 if (target
->type
->hit_watchpoint
== NULL
) {
1207 /* For backward compatible, if hit_watchpoint is not implemented,
1208 * return ERROR_FAIL such that gdb_server will not take the nonsense
1213 return target
->type
->hit_watchpoint(target
, hit_watchpoint
);
1216 const char *target_get_gdb_arch(struct target
*target
)
1218 if (target
->type
->get_gdb_arch
== NULL
)
1220 return target
->type
->get_gdb_arch(target
);
1223 int target_get_gdb_reg_list(struct target
*target
,
1224 struct reg
**reg_list
[], int *reg_list_size
,
1225 enum target_register_class reg_class
)
1227 int result
= target
->type
->get_gdb_reg_list(target
, reg_list
,
1228 reg_list_size
, reg_class
);
1229 if (result
!= ERROR_OK
) {
1236 int target_get_gdb_reg_list_noread(struct target
*target
,
1237 struct reg
**reg_list
[], int *reg_list_size
,
1238 enum target_register_class reg_class
)
1240 if (target
->type
->get_gdb_reg_list_noread
&&
1241 target
->type
->get_gdb_reg_list_noread(target
, reg_list
,
1242 reg_list_size
, reg_class
) == ERROR_OK
)
1244 return target_get_gdb_reg_list(target
, reg_list
, reg_list_size
, reg_class
);
1247 bool target_supports_gdb_connection(struct target
*target
)
1250 * based on current code, we can simply exclude all the targets that
1251 * don't provide get_gdb_reg_list; this could change with new targets.
1253 return !!target
->type
->get_gdb_reg_list
;
1256 int target_step(struct target
*target
,
1257 int current
, target_addr_t address
, int handle_breakpoints
)
1259 return target
->type
->step(target
, current
, address
, handle_breakpoints
);
1262 int target_get_gdb_fileio_info(struct target
*target
, struct gdb_fileio_info
*fileio_info
)
1264 if (target
->state
!= TARGET_HALTED
) {
1265 LOG_WARNING("target %s is not halted (gdb fileio)", target
->cmd_name
);
1266 return ERROR_TARGET_NOT_HALTED
;
1268 return target
->type
->get_gdb_fileio_info(target
, fileio_info
);
1271 int target_gdb_fileio_end(struct target
*target
, int retcode
, int fileio_errno
, bool ctrl_c
)
1273 if (target
->state
!= TARGET_HALTED
) {
1274 LOG_WARNING("target %s is not halted (gdb fileio end)", target
->cmd_name
);
1275 return ERROR_TARGET_NOT_HALTED
;
1277 return target
->type
->gdb_fileio_end(target
, retcode
, fileio_errno
, ctrl_c
);
1280 target_addr_t
target_address_max(struct target
*target
)
1282 unsigned bits
= target_address_bits(target
);
1283 if (sizeof(target_addr_t
) * 8 == bits
)
1284 return (target_addr_t
) -1;
1286 return (((target_addr_t
) 1) << bits
) - 1;
1289 unsigned target_address_bits(struct target
*target
)
1291 if (target
->type
->address_bits
)
1292 return target
->type
->address_bits(target
);
1296 int target_profiling(struct target
*target
, uint32_t *samples
,
1297 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
1299 if (target
->state
!= TARGET_HALTED
) {
1300 LOG_WARNING("target %s is not halted (profiling)", target
->cmd_name
);
1301 return ERROR_TARGET_NOT_HALTED
;
1303 return target
->type
->profiling(target
, samples
, max_num_samples
,
1304 num_samples
, seconds
);
1308 * Reset the @c examined flag for the given target.
1309 * Pure paranoia -- targets are zeroed on allocation.
1311 static void target_reset_examined(struct target
*target
)
1313 target
->examined
= false;
1316 static int handle_target(void *priv
);
1318 static int target_init_one(struct command_context
*cmd_ctx
,
1319 struct target
*target
)
1321 target_reset_examined(target
);
1323 struct target_type
*type
= target
->type
;
1324 if (type
->examine
== NULL
)
1325 type
->examine
= default_examine
;
1327 if (type
->check_reset
== NULL
)
1328 type
->check_reset
= default_check_reset
;
1330 assert(type
->init_target
!= NULL
);
1332 int retval
= type
->init_target(cmd_ctx
, target
);
1333 if (ERROR_OK
!= retval
) {
1334 LOG_ERROR("target '%s' init failed", target_name(target
));
1338 /* Sanity-check MMU support ... stub in what we must, to help
1339 * implement it in stages, but warn if we need to do so.
1342 if (type
->virt2phys
== NULL
) {
1343 LOG_ERROR("type '%s' is missing virt2phys", type
->name
);
1344 type
->virt2phys
= identity_virt2phys
;
1347 /* Make sure no-MMU targets all behave the same: make no
1348 * distinction between physical and virtual addresses, and
1349 * ensure that virt2phys() is always an identity mapping.
1351 if (type
->write_phys_memory
|| type
->read_phys_memory
|| type
->virt2phys
)
1352 LOG_WARNING("type '%s' has bad MMU hooks", type
->name
);
1355 type
->write_phys_memory
= type
->write_memory
;
1356 type
->read_phys_memory
= type
->read_memory
;
1357 type
->virt2phys
= identity_virt2phys
;
1360 if (target
->type
->read_buffer
== NULL
)
1361 target
->type
->read_buffer
= target_read_buffer_default
;
1363 if (target
->type
->write_buffer
== NULL
)
1364 target
->type
->write_buffer
= target_write_buffer_default
;
1366 if (target
->type
->get_gdb_fileio_info
== NULL
)
1367 target
->type
->get_gdb_fileio_info
= target_get_gdb_fileio_info_default
;
1369 if (target
->type
->gdb_fileio_end
== NULL
)
1370 target
->type
->gdb_fileio_end
= target_gdb_fileio_end_default
;
1372 if (target
->type
->profiling
== NULL
)
1373 target
->type
->profiling
= target_profiling_default
;
1378 static int target_init(struct command_context
*cmd_ctx
)
1380 struct target
*target
;
1383 for (target
= all_targets
; target
; target
= target
->next
) {
1384 retval
= target_init_one(cmd_ctx
, target
);
1385 if (ERROR_OK
!= retval
)
1392 retval
= target_register_user_commands(cmd_ctx
);
1393 if (ERROR_OK
!= retval
)
1396 retval
= target_register_timer_callback(&handle_target
,
1397 polling_interval
, TARGET_TIMER_TYPE_PERIODIC
, cmd_ctx
->interp
);
1398 if (ERROR_OK
!= retval
)
1404 COMMAND_HANDLER(handle_target_init_command
)
1409 return ERROR_COMMAND_SYNTAX_ERROR
;
1411 static bool target_initialized
;
1412 if (target_initialized
) {
1413 LOG_INFO("'target init' has already been called");
1416 target_initialized
= true;
1418 retval
= command_run_line(CMD_CTX
, "init_targets");
1419 if (ERROR_OK
!= retval
)
1422 retval
= command_run_line(CMD_CTX
, "init_target_events");
1423 if (ERROR_OK
!= retval
)
1426 retval
= command_run_line(CMD_CTX
, "init_board");
1427 if (ERROR_OK
!= retval
)
1430 LOG_DEBUG("Initializing targets...");
1431 return target_init(CMD_CTX
);
1434 int target_register_event_callback(int (*callback
)(struct target
*target
,
1435 enum target_event event
, void *priv
), void *priv
)
1437 struct target_event_callback
**callbacks_p
= &target_event_callbacks
;
1439 if (callback
== NULL
)
1440 return ERROR_COMMAND_SYNTAX_ERROR
;
1443 while ((*callbacks_p
)->next
)
1444 callbacks_p
= &((*callbacks_p
)->next
);
1445 callbacks_p
= &((*callbacks_p
)->next
);
1448 (*callbacks_p
) = malloc(sizeof(struct target_event_callback
));
1449 (*callbacks_p
)->callback
= callback
;
1450 (*callbacks_p
)->priv
= priv
;
1451 (*callbacks_p
)->next
= NULL
;
1456 int target_register_reset_callback(int (*callback
)(struct target
*target
,
1457 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1459 struct target_reset_callback
*entry
;
1461 if (callback
== NULL
)
1462 return ERROR_COMMAND_SYNTAX_ERROR
;
1464 entry
= malloc(sizeof(struct target_reset_callback
));
1465 if (entry
== NULL
) {
1466 LOG_ERROR("error allocating buffer for reset callback entry");
1467 return ERROR_COMMAND_SYNTAX_ERROR
;
1470 entry
->callback
= callback
;
1472 list_add(&entry
->list
, &target_reset_callback_list
);
1478 int target_register_trace_callback(int (*callback
)(struct target
*target
,
1479 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1481 struct target_trace_callback
*entry
;
1483 if (callback
== NULL
)
1484 return ERROR_COMMAND_SYNTAX_ERROR
;
1486 entry
= malloc(sizeof(struct target_trace_callback
));
1487 if (entry
== NULL
) {
1488 LOG_ERROR("error allocating buffer for trace callback entry");
1489 return ERROR_COMMAND_SYNTAX_ERROR
;
1492 entry
->callback
= callback
;
1494 list_add(&entry
->list
, &target_trace_callback_list
);
1500 int target_register_timer_callback(int (*callback
)(void *priv
),
1501 unsigned int time_ms
, enum target_timer_type type
, void *priv
)
1503 struct target_timer_callback
**callbacks_p
= &target_timer_callbacks
;
1505 if (callback
== NULL
)
1506 return ERROR_COMMAND_SYNTAX_ERROR
;
1509 while ((*callbacks_p
)->next
)
1510 callbacks_p
= &((*callbacks_p
)->next
);
1511 callbacks_p
= &((*callbacks_p
)->next
);
1514 (*callbacks_p
) = malloc(sizeof(struct target_timer_callback
));
1515 (*callbacks_p
)->callback
= callback
;
1516 (*callbacks_p
)->type
= type
;
1517 (*callbacks_p
)->time_ms
= time_ms
;
1518 (*callbacks_p
)->removed
= false;
1520 gettimeofday(&(*callbacks_p
)->when
, NULL
);
1521 timeval_add_time(&(*callbacks_p
)->when
, 0, time_ms
* 1000);
1523 (*callbacks_p
)->priv
= priv
;
1524 (*callbacks_p
)->next
= NULL
;
1529 int target_unregister_event_callback(int (*callback
)(struct target
*target
,
1530 enum target_event event
, void *priv
), void *priv
)
1532 struct target_event_callback
**p
= &target_event_callbacks
;
1533 struct target_event_callback
*c
= target_event_callbacks
;
1535 if (callback
== NULL
)
1536 return ERROR_COMMAND_SYNTAX_ERROR
;
1539 struct target_event_callback
*next
= c
->next
;
1540 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1552 int target_unregister_reset_callback(int (*callback
)(struct target
*target
,
1553 enum target_reset_mode reset_mode
, void *priv
), void *priv
)
1555 struct target_reset_callback
*entry
;
1557 if (callback
== NULL
)
1558 return ERROR_COMMAND_SYNTAX_ERROR
;
1560 list_for_each_entry(entry
, &target_reset_callback_list
, list
) {
1561 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1562 list_del(&entry
->list
);
1571 int target_unregister_trace_callback(int (*callback
)(struct target
*target
,
1572 size_t len
, uint8_t *data
, void *priv
), void *priv
)
1574 struct target_trace_callback
*entry
;
1576 if (callback
== NULL
)
1577 return ERROR_COMMAND_SYNTAX_ERROR
;
1579 list_for_each_entry(entry
, &target_trace_callback_list
, list
) {
1580 if (entry
->callback
== callback
&& entry
->priv
== priv
) {
1581 list_del(&entry
->list
);
1590 int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
)
1592 if (callback
== NULL
)
1593 return ERROR_COMMAND_SYNTAX_ERROR
;
1595 for (struct target_timer_callback
*c
= target_timer_callbacks
;
1597 if ((c
->callback
== callback
) && (c
->priv
== priv
)) {
1606 int target_call_event_callbacks(struct target
*target
, enum target_event event
)
1608 struct target_event_callback
*callback
= target_event_callbacks
;
1609 struct target_event_callback
*next_callback
;
1611 if (event
== TARGET_EVENT_HALTED
) {
1612 /* execute early halted first */
1613 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
1616 LOG_DEBUG("target event %i (%s) for core %s", event
,
1617 Jim_Nvp_value2name_simple(nvp_target_event
, event
)->name
,
1618 target_name(target
));
1620 target_handle_event(target
, event
);
1623 next_callback
= callback
->next
;
1624 callback
->callback(target
, event
, callback
->priv
);
1625 callback
= next_callback
;
1631 int target_call_reset_callbacks(struct target
*target
, enum target_reset_mode reset_mode
)
1633 struct target_reset_callback
*callback
;
1635 LOG_DEBUG("target reset %i (%s)", reset_mode
,
1636 Jim_Nvp_value2name_simple(nvp_reset_modes
, reset_mode
)->name
);
1638 list_for_each_entry(callback
, &target_reset_callback_list
, list
)
1639 callback
->callback(target
, reset_mode
, callback
->priv
);
1644 int target_call_trace_callbacks(struct target
*target
, size_t len
, uint8_t *data
)
1646 struct target_trace_callback
*callback
;
1648 list_for_each_entry(callback
, &target_trace_callback_list
, list
)
1649 callback
->callback(target
, len
, data
, callback
->priv
);
1654 static int target_timer_callback_periodic_restart(
1655 struct target_timer_callback
*cb
, struct timeval
*now
)
1658 timeval_add_time(&cb
->when
, 0, cb
->time_ms
* 1000L);
1662 static int target_call_timer_callback(struct target_timer_callback
*cb
,
1663 struct timeval
*now
)
1665 cb
->callback(cb
->priv
);
1667 if (cb
->type
== TARGET_TIMER_TYPE_PERIODIC
)
1668 return target_timer_callback_periodic_restart(cb
, now
);
1670 return target_unregister_timer_callback(cb
->callback
, cb
->priv
);
1673 static int target_call_timer_callbacks_check_time(int checktime
)
1675 static bool callback_processing
;
1677 /* Do not allow nesting */
1678 if (callback_processing
)
1681 callback_processing
= true;
1686 gettimeofday(&now
, NULL
);
1688 /* Store an address of the place containing a pointer to the
1689 * next item; initially, that's a standalone "root of the
1690 * list" variable. */
1691 struct target_timer_callback
**callback
= &target_timer_callbacks
;
1692 while (callback
&& *callback
) {
1693 if ((*callback
)->removed
) {
1694 struct target_timer_callback
*p
= *callback
;
1695 *callback
= (*callback
)->next
;
1700 bool call_it
= (*callback
)->callback
&&
1701 ((!checktime
&& (*callback
)->type
== TARGET_TIMER_TYPE_PERIODIC
) ||
1702 timeval_compare(&now
, &(*callback
)->when
) >= 0);
1705 target_call_timer_callback(*callback
, &now
);
1707 callback
= &(*callback
)->next
;
1710 callback_processing
= false;
1714 int target_call_timer_callbacks(void)
1716 return target_call_timer_callbacks_check_time(1);
1719 /* invoke periodic callbacks immediately */
1720 int target_call_timer_callbacks_now(void)
1722 return target_call_timer_callbacks_check_time(0);
1725 /* Prints the working area layout for debug purposes */
1726 static void print_wa_layout(struct target
*target
)
1728 struct working_area
*c
= target
->working_areas
;
1731 LOG_DEBUG("%c%c " TARGET_ADDR_FMT
"-" TARGET_ADDR_FMT
" (%" PRIu32
" bytes)",
1732 c
->backup
? 'b' : ' ', c
->free
? ' ' : '*',
1733 c
->address
, c
->address
+ c
->size
- 1, c
->size
);
1738 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1739 static void target_split_working_area(struct working_area
*area
, uint32_t size
)
1741 assert(area
->free
); /* Shouldn't split an allocated area */
1742 assert(size
<= area
->size
); /* Caller should guarantee this */
1744 /* Split only if not already the right size */
1745 if (size
< area
->size
) {
1746 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1751 new_wa
->next
= area
->next
;
1752 new_wa
->size
= area
->size
- size
;
1753 new_wa
->address
= area
->address
+ size
;
1754 new_wa
->backup
= NULL
;
1755 new_wa
->user
= NULL
;
1756 new_wa
->free
= true;
1758 area
->next
= new_wa
;
1761 /* If backup memory was allocated to this area, it has the wrong size
1762 * now so free it and it will be reallocated if/when needed */
1765 area
->backup
= NULL
;
1770 /* Merge all adjacent free areas into one */
1771 static void target_merge_working_areas(struct target
*target
)
1773 struct working_area
*c
= target
->working_areas
;
1775 while (c
&& c
->next
) {
1776 assert(c
->next
->address
== c
->address
+ c
->size
); /* This is an invariant */
1778 /* Find two adjacent free areas */
1779 if (c
->free
&& c
->next
->free
) {
1780 /* Merge the last into the first */
1781 c
->size
+= c
->next
->size
;
1783 /* Remove the last */
1784 struct working_area
*to_be_freed
= c
->next
;
1785 c
->next
= c
->next
->next
;
1786 if (to_be_freed
->backup
)
1787 free(to_be_freed
->backup
);
1790 /* If backup memory was allocated to the remaining area, it's has
1791 * the wrong size now */
1802 int target_alloc_working_area_try(struct target
*target
, uint32_t size
, struct working_area
**area
)
1804 /* Reevaluate working area address based on MMU state*/
1805 if (target
->working_areas
== NULL
) {
1809 retval
= target
->type
->mmu(target
, &enabled
);
1810 if (retval
!= ERROR_OK
)
1814 if (target
->working_area_phys_spec
) {
1815 LOG_DEBUG("MMU disabled, using physical "
1816 "address for working memory " TARGET_ADDR_FMT
,
1817 target
->working_area_phys
);
1818 target
->working_area
= target
->working_area_phys
;
1820 LOG_ERROR("No working memory available. "
1821 "Specify -work-area-phys to target.");
1822 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1825 if (target
->working_area_virt_spec
) {
1826 LOG_DEBUG("MMU enabled, using virtual "
1827 "address for working memory " TARGET_ADDR_FMT
,
1828 target
->working_area_virt
);
1829 target
->working_area
= target
->working_area_virt
;
1831 LOG_ERROR("No working memory available. "
1832 "Specify -work-area-virt to target.");
1833 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1837 /* Set up initial working area on first call */
1838 struct working_area
*new_wa
= malloc(sizeof(*new_wa
));
1840 new_wa
->next
= NULL
;
1841 new_wa
->size
= target
->working_area_size
& ~3UL; /* 4-byte align */
1842 new_wa
->address
= target
->working_area
;
1843 new_wa
->backup
= NULL
;
1844 new_wa
->user
= NULL
;
1845 new_wa
->free
= true;
1848 target
->working_areas
= new_wa
;
1851 /* only allocate multiples of 4 byte */
1853 size
= (size
+ 3) & (~3UL);
1855 struct working_area
*c
= target
->working_areas
;
1857 /* Find the first large enough working area */
1859 if (c
->free
&& c
->size
>= size
)
1865 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
1867 /* Split the working area into the requested size */
1868 target_split_working_area(c
, size
);
1870 LOG_DEBUG("allocated new working area of %" PRIu32
" bytes at address " TARGET_ADDR_FMT
,
1873 if (target
->backup_working_area
) {
1874 if (c
->backup
== NULL
) {
1875 c
->backup
= malloc(c
->size
);
1876 if (c
->backup
== NULL
)
1880 int retval
= target_read_memory(target
, c
->address
, 4, c
->size
/ 4, c
->backup
);
1881 if (retval
!= ERROR_OK
)
1885 /* mark as used, and return the new (reused) area */
1892 print_wa_layout(target
);
1897 int target_alloc_working_area(struct target
*target
, uint32_t size
, struct working_area
**area
)
1901 retval
= target_alloc_working_area_try(target
, size
, area
);
1902 if (retval
== ERROR_TARGET_RESOURCE_NOT_AVAILABLE
)
1903 LOG_WARNING("not enough working area available(requested %"PRIu32
")", size
);
1908 static int target_restore_working_area(struct target
*target
, struct working_area
*area
)
1910 int retval
= ERROR_OK
;
1912 if (target
->backup_working_area
&& area
->backup
!= NULL
) {
1913 retval
= target_write_memory(target
, area
->address
, 4, area
->size
/ 4, area
->backup
);
1914 if (retval
!= ERROR_OK
)
1915 LOG_ERROR("failed to restore %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1916 area
->size
, area
->address
);
1922 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1923 static int target_free_working_area_restore(struct target
*target
, struct working_area
*area
, int restore
)
1925 int retval
= ERROR_OK
;
1931 retval
= target_restore_working_area(target
, area
);
1932 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1933 if (retval
!= ERROR_OK
)
1939 LOG_DEBUG("freed %" PRIu32
" bytes of working area at address " TARGET_ADDR_FMT
,
1940 area
->size
, area
->address
);
1942 /* mark user pointer invalid */
1943 /* TODO: Is this really safe? It points to some previous caller's memory.
1944 * How could we know that the area pointer is still in that place and not
1945 * some other vital data? What's the purpose of this, anyway? */
1949 target_merge_working_areas(target
);
1951 print_wa_layout(target
);
1956 int target_free_working_area(struct target
*target
, struct working_area
*area
)
1958 return target_free_working_area_restore(target
, area
, 1);
1961 /* free resources and restore memory, if restoring memory fails,
1962 * free up resources anyway
1964 static void target_free_all_working_areas_restore(struct target
*target
, int restore
)
1966 struct working_area
*c
= target
->working_areas
;
1968 LOG_DEBUG("freeing all working areas");
1970 /* Loop through all areas, restoring the allocated ones and marking them as free */
1974 target_restore_working_area(target
, c
);
1976 *c
->user
= NULL
; /* Same as above */
1982 /* Run a merge pass to combine all areas into one */
1983 target_merge_working_areas(target
);
1985 print_wa_layout(target
);
1988 void target_free_all_working_areas(struct target
*target
)
1990 target_free_all_working_areas_restore(target
, 1);
1992 /* Now we have none or only one working area marked as free */
1993 if (target
->working_areas
) {
1994 /* Free the last one to allow on-the-fly moving and resizing */
1995 free(target
->working_areas
->backup
);
1996 free(target
->working_areas
);
1997 target
->working_areas
= NULL
;
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 static void target_destroy(struct target
*target
)
2022 if (target
->type
->deinit_target
)
2023 target
->type
->deinit_target(target
);
2025 if (target
->semihosting
)
2026 free(target
->semihosting
);
2028 jtag_unregister_event_callback(jtag_enable_callback
, target
);
2030 struct target_event_action
*teap
= target
->event_action
;
2032 struct target_event_action
*next
= teap
->next
;
2033 Jim_DecrRefCount(teap
->interp
, teap
->body
);
2038 target_free_all_working_areas(target
);
2040 /* release the targets SMP list */
2042 struct target_list
*head
= target
->head
;
2043 while (head
!= NULL
) {
2044 struct target_list
*pos
= head
->next
;
2045 head
->target
->smp
= 0;
2052 free(target
->gdb_port_override
);
2054 free(target
->trace_info
);
2055 free(target
->fileio_info
);
2056 free(target
->cmd_name
);
2060 void target_quit(void)
2062 struct target_event_callback
*pe
= target_event_callbacks
;
2064 struct target_event_callback
*t
= pe
->next
;
2068 target_event_callbacks
= NULL
;
2070 struct target_timer_callback
*pt
= target_timer_callbacks
;
2072 struct target_timer_callback
*t
= pt
->next
;
2076 target_timer_callbacks
= NULL
;
2078 for (struct target
*target
= all_targets
; target
;) {
2082 target_destroy(target
);
2089 int target_arch_state(struct target
*target
)
2092 if (target
== NULL
) {
2093 LOG_WARNING("No target has been configured");
2097 if (target
->state
!= TARGET_HALTED
)
2100 retval
= target
->type
->arch_state(target
);
2104 static int target_get_gdb_fileio_info_default(struct target
*target
,
2105 struct gdb_fileio_info
*fileio_info
)
2107 /* If target does not support semi-hosting function, target
2108 has no need to provide .get_gdb_fileio_info callback.
2109 It just return ERROR_FAIL and gdb_server will return "Txx"
2110 as target halted every time. */
2114 static int target_gdb_fileio_end_default(struct target
*target
,
2115 int retcode
, int fileio_errno
, bool ctrl_c
)
2120 static int target_profiling_default(struct target
*target
, uint32_t *samples
,
2121 uint32_t max_num_samples
, uint32_t *num_samples
, uint32_t seconds
)
2123 struct timeval timeout
, now
;
2125 gettimeofday(&timeout
, NULL
);
2126 timeval_add_time(&timeout
, seconds
, 0);
2128 LOG_INFO("Starting profiling. Halting and resuming the"
2129 " target as often as we can...");
2131 uint32_t sample_count
= 0;
2132 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
2133 struct reg
*reg
= register_get_by_name(target
->reg_cache
, "pc", 1);
2135 int retval
= ERROR_OK
;
2137 target_poll(target
);
2138 if (target
->state
== TARGET_HALTED
) {
2139 uint32_t t
= buf_get_u32(reg
->value
, 0, 32);
2140 samples
[sample_count
++] = t
;
2141 /* current pc, addr = 0, do not handle breakpoints, not debugging */
2142 retval
= target_resume(target
, 1, 0, 0, 0);
2143 target_poll(target
);
2144 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
2145 } else if (target
->state
== TARGET_RUNNING
) {
2146 /* We want to quickly sample the PC. */
2147 retval
= target_halt(target
);
2149 LOG_INFO("Target not halted or running");
2154 if (retval
!= ERROR_OK
)
2157 gettimeofday(&now
, NULL
);
2158 if ((sample_count
>= max_num_samples
) || timeval_compare(&now
, &timeout
) >= 0) {
2159 LOG_INFO("Profiling completed. %" PRIu32
" samples.", sample_count
);
2164 *num_samples
= sample_count
;
2168 /* Single aligned words are guaranteed to use 16 or 32 bit access
2169 * mode respectively, otherwise data is handled as quickly as
2172 int target_write_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, const uint8_t *buffer
)
2174 LOG_DEBUG("writing buffer of %" PRIi32
" byte at " TARGET_ADDR_FMT
,
2177 if (!target_was_examined(target
)) {
2178 LOG_ERROR("Target not examined yet");
2185 if ((address
+ size
- 1) < address
) {
2186 /* GDB can request this when e.g. PC is 0xfffffffc */
2187 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2193 return target
->type
->write_buffer(target
, address
, size
, buffer
);
2196 static int target_write_buffer_default(struct target
*target
,
2197 target_addr_t address
, uint32_t count
, const uint8_t *buffer
)
2201 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2202 * will have something to do with the size we leave to it. */
2203 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2204 if (address
& size
) {
2205 int retval
= target_write_memory(target
, address
, size
, 1, buffer
);
2206 if (retval
!= ERROR_OK
)
2214 /* Write the data with as large access size as possible. */
2215 for (; size
> 0; size
/= 2) {
2216 uint32_t aligned
= count
- count
% size
;
2218 int retval
= target_write_memory(target
, address
, size
, aligned
/ size
, buffer
);
2219 if (retval
!= ERROR_OK
)
2230 /* Single aligned words are guaranteed to use 16 or 32 bit access
2231 * mode respectively, otherwise data is handled as quickly as
2234 int target_read_buffer(struct target
*target
, target_addr_t address
, uint32_t size
, uint8_t *buffer
)
2236 LOG_DEBUG("reading buffer of %" PRIi32
" byte at " TARGET_ADDR_FMT
,
2239 if (!target_was_examined(target
)) {
2240 LOG_ERROR("Target not examined yet");
2247 if ((address
+ size
- 1) < address
) {
2248 /* GDB can request this when e.g. PC is 0xfffffffc */
2249 LOG_ERROR("address + size wrapped (" TARGET_ADDR_FMT
", 0x%08" PRIx32
")",
2255 return target
->type
->read_buffer(target
, address
, size
, buffer
);
2258 static int target_read_buffer_default(struct target
*target
, target_addr_t address
, uint32_t count
, uint8_t *buffer
)
2262 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
2263 * will have something to do with the size we leave to it. */
2264 for (size
= 1; size
< 4 && count
>= size
* 2 + (address
& size
); size
*= 2) {
2265 if (address
& size
) {
2266 int retval
= target_read_memory(target
, address
, size
, 1, buffer
);
2267 if (retval
!= ERROR_OK
)
2275 /* Read the data with as large access size as possible. */
2276 for (; size
> 0; size
/= 2) {
2277 uint32_t aligned
= count
- count
% size
;
2279 int retval
= target_read_memory(target
, address
, size
, aligned
/ size
, buffer
);
2280 if (retval
!= ERROR_OK
)
2291 int target_checksum_memory(struct target
*target
, target_addr_t address
, uint32_t size
, uint32_t *crc
)
2296 uint32_t checksum
= 0;
2297 if (!target_was_examined(target
)) {
2298 LOG_ERROR("Target not examined yet");
2302 retval
= target
->type
->checksum_memory(target
, address
, size
, &checksum
);
2303 if (retval
!= ERROR_OK
) {
2304 buffer
= malloc(size
);
2305 if (buffer
== NULL
) {
2306 LOG_ERROR("error allocating buffer for section (%" PRId32
" bytes)", size
);
2307 return ERROR_COMMAND_SYNTAX_ERROR
;
2309 retval
= target_read_buffer(target
, address
, size
, buffer
);
2310 if (retval
!= ERROR_OK
) {
2315 /* convert to target endianness */
2316 for (i
= 0; i
< (size
/sizeof(uint32_t)); i
++) {
2317 uint32_t target_data
;
2318 target_data
= target_buffer_get_u32(target
, &buffer
[i
*sizeof(uint32_t)]);
2319 target_buffer_set_u32(target
, &buffer
[i
*sizeof(uint32_t)], target_data
);
2322 retval
= image_calculate_checksum(buffer
, size
, &checksum
);
2331 int target_blank_check_memory(struct target
*target
,
2332 struct target_memory_check_block
*blocks
, int num_blocks
,
2333 uint8_t erased_value
)
2335 if (!target_was_examined(target
)) {
2336 LOG_ERROR("Target not examined yet");
2340 if (target
->type
->blank_check_memory
== NULL
)
2341 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
2343 return target
->type
->blank_check_memory(target
, blocks
, num_blocks
, erased_value
);
2346 int target_read_u64(struct target
*target
, target_addr_t address
, uint64_t *value
)
2348 uint8_t value_buf
[8];
2349 if (!target_was_examined(target
)) {
2350 LOG_ERROR("Target not examined yet");
2354 int retval
= target_read_memory(target
, address
, 8, 1, value_buf
);
2356 if (retval
== ERROR_OK
) {
2357 *value
= target_buffer_get_u64(target
, value_buf
);
2358 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2363 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2370 int target_read_u32(struct target
*target
, target_addr_t address
, uint32_t *value
)
2372 uint8_t value_buf
[4];
2373 if (!target_was_examined(target
)) {
2374 LOG_ERROR("Target not examined yet");
2378 int retval
= target_read_memory(target
, address
, 4, 1, value_buf
);
2380 if (retval
== ERROR_OK
) {
2381 *value
= target_buffer_get_u32(target
, value_buf
);
2382 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2387 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2394 int target_read_u16(struct target
*target
, target_addr_t address
, uint16_t *value
)
2396 uint8_t value_buf
[2];
2397 if (!target_was_examined(target
)) {
2398 LOG_ERROR("Target not examined yet");
2402 int retval
= target_read_memory(target
, address
, 2, 1, value_buf
);
2404 if (retval
== ERROR_OK
) {
2405 *value
= target_buffer_get_u16(target
, value_buf
);
2406 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%4.4" PRIx16
,
2411 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2418 int target_read_u8(struct target
*target
, target_addr_t address
, uint8_t *value
)
2420 if (!target_was_examined(target
)) {
2421 LOG_ERROR("Target not examined yet");
2425 int retval
= target_read_memory(target
, address
, 1, 1, value
);
2427 if (retval
== ERROR_OK
) {
2428 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2433 LOG_DEBUG("address: " TARGET_ADDR_FMT
" failed",
2440 int target_write_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2443 uint8_t value_buf
[8];
2444 if (!target_was_examined(target
)) {
2445 LOG_ERROR("Target not examined yet");
2449 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2453 target_buffer_set_u64(target
, value_buf
, value
);
2454 retval
= target_write_memory(target
, address
, 8, 1, value_buf
);
2455 if (retval
!= ERROR_OK
)
2456 LOG_DEBUG("failed: %i", retval
);
2461 int target_write_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2464 uint8_t value_buf
[4];
2465 if (!target_was_examined(target
)) {
2466 LOG_ERROR("Target not examined yet");
2470 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2474 target_buffer_set_u32(target
, value_buf
, value
);
2475 retval
= target_write_memory(target
, address
, 4, 1, value_buf
);
2476 if (retval
!= ERROR_OK
)
2477 LOG_DEBUG("failed: %i", retval
);
2482 int target_write_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2485 uint8_t value_buf
[2];
2486 if (!target_was_examined(target
)) {
2487 LOG_ERROR("Target not examined yet");
2491 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2495 target_buffer_set_u16(target
, value_buf
, value
);
2496 retval
= target_write_memory(target
, address
, 2, 1, value_buf
);
2497 if (retval
!= ERROR_OK
)
2498 LOG_DEBUG("failed: %i", retval
);
2503 int target_write_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2506 if (!target_was_examined(target
)) {
2507 LOG_ERROR("Target not examined yet");
2511 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2514 retval
= target_write_memory(target
, address
, 1, 1, &value
);
2515 if (retval
!= ERROR_OK
)
2516 LOG_DEBUG("failed: %i", retval
);
2521 int target_write_phys_u64(struct target
*target
, target_addr_t address
, uint64_t value
)
2524 uint8_t value_buf
[8];
2525 if (!target_was_examined(target
)) {
2526 LOG_ERROR("Target not examined yet");
2530 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%16.16" PRIx64
"",
2534 target_buffer_set_u64(target
, value_buf
, value
);
2535 retval
= target_write_phys_memory(target
, address
, 8, 1, value_buf
);
2536 if (retval
!= ERROR_OK
)
2537 LOG_DEBUG("failed: %i", retval
);
2542 int target_write_phys_u32(struct target
*target
, target_addr_t address
, uint32_t value
)
2545 uint8_t value_buf
[4];
2546 if (!target_was_examined(target
)) {
2547 LOG_ERROR("Target not examined yet");
2551 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx32
"",
2555 target_buffer_set_u32(target
, value_buf
, value
);
2556 retval
= target_write_phys_memory(target
, address
, 4, 1, value_buf
);
2557 if (retval
!= ERROR_OK
)
2558 LOG_DEBUG("failed: %i", retval
);
2563 int target_write_phys_u16(struct target
*target
, target_addr_t address
, uint16_t value
)
2566 uint8_t value_buf
[2];
2567 if (!target_was_examined(target
)) {
2568 LOG_ERROR("Target not examined yet");
2572 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%8.8" PRIx16
,
2576 target_buffer_set_u16(target
, value_buf
, value
);
2577 retval
= target_write_phys_memory(target
, address
, 2, 1, value_buf
);
2578 if (retval
!= ERROR_OK
)
2579 LOG_DEBUG("failed: %i", retval
);
2584 int target_write_phys_u8(struct target
*target
, target_addr_t address
, uint8_t value
)
2587 if (!target_was_examined(target
)) {
2588 LOG_ERROR("Target not examined yet");
2592 LOG_DEBUG("address: " TARGET_ADDR_FMT
", value: 0x%2.2" PRIx8
,
2595 retval
= target_write_phys_memory(target
, address
, 1, 1, &value
);
2596 if (retval
!= ERROR_OK
)
2597 LOG_DEBUG("failed: %i", retval
);
2602 static int find_target(struct command_invocation
*cmd
, const char *name
)
2604 struct target
*target
= get_target(name
);
2605 if (target
== NULL
) {
2606 command_print(cmd
, "Target: %s is unknown, try one of:\n", name
);
2609 if (!target
->tap
->enabled
) {
2610 command_print(cmd
, "Target: TAP %s is disabled, "
2611 "can't be the current target\n",
2612 target
->tap
->dotted_name
);
2616 cmd
->ctx
->current_target
= target
;
2617 if (cmd
->ctx
->current_target_override
)
2618 cmd
->ctx
->current_target_override
= target
;
2624 COMMAND_HANDLER(handle_targets_command
)
2626 int retval
= ERROR_OK
;
2627 if (CMD_ARGC
== 1) {
2628 retval
= find_target(CMD
, CMD_ARGV
[0]);
2629 if (retval
== ERROR_OK
) {
2635 struct target
*target
= all_targets
;
2636 command_print(CMD
, " TargetName Type Endian TapName State ");
2637 command_print(CMD
, "-- ------------------ ---------- ------ ------------------ ------------");
2642 if (target
->tap
->enabled
)
2643 state
= target_state_name(target
);
2645 state
= "tap-disabled";
2647 if (CMD_CTX
->current_target
== target
)
2650 /* keep columns lined up to match the headers above */
2652 "%2d%c %-18s %-10s %-6s %-18s %s",
2653 target
->target_number
,
2655 target_name(target
),
2656 target_type_name(target
),
2657 Jim_Nvp_value2name_simple(nvp_target_endian
,
2658 target
->endianness
)->name
,
2659 target
->tap
->dotted_name
,
2661 target
= target
->next
;
2667 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2669 static int powerDropout
;
2670 static int srstAsserted
;
2672 static int runPowerRestore
;
2673 static int runPowerDropout
;
2674 static int runSrstAsserted
;
2675 static int runSrstDeasserted
;
2677 static int sense_handler(void)
2679 static int prevSrstAsserted
;
2680 static int prevPowerdropout
;
2682 int retval
= jtag_power_dropout(&powerDropout
);
2683 if (retval
!= ERROR_OK
)
2687 powerRestored
= prevPowerdropout
&& !powerDropout
;
2689 runPowerRestore
= 1;
2691 int64_t current
= timeval_ms();
2692 static int64_t lastPower
;
2693 bool waitMore
= lastPower
+ 2000 > current
;
2694 if (powerDropout
&& !waitMore
) {
2695 runPowerDropout
= 1;
2696 lastPower
= current
;
2699 retval
= jtag_srst_asserted(&srstAsserted
);
2700 if (retval
!= ERROR_OK
)
2704 srstDeasserted
= prevSrstAsserted
&& !srstAsserted
;
2706 static int64_t lastSrst
;
2707 waitMore
= lastSrst
+ 2000 > current
;
2708 if (srstDeasserted
&& !waitMore
) {
2709 runSrstDeasserted
= 1;
2713 if (!prevSrstAsserted
&& srstAsserted
)
2714 runSrstAsserted
= 1;
2716 prevSrstAsserted
= srstAsserted
;
2717 prevPowerdropout
= powerDropout
;
2719 if (srstDeasserted
|| powerRestored
) {
2720 /* Other than logging the event we can't do anything here.
2721 * Issuing a reset is a particularly bad idea as we might
2722 * be inside a reset already.
2729 /* process target state changes */
2730 static int handle_target(void *priv
)
2732 Jim_Interp
*interp
= (Jim_Interp
*)priv
;
2733 int retval
= ERROR_OK
;
2735 if (!is_jtag_poll_safe()) {
2736 /* polling is disabled currently */
2740 /* we do not want to recurse here... */
2741 static int recursive
;
2745 /* danger! running these procedures can trigger srst assertions and power dropouts.
2746 * We need to avoid an infinite loop/recursion here and we do that by
2747 * clearing the flags after running these events.
2749 int did_something
= 0;
2750 if (runSrstAsserted
) {
2751 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2752 Jim_Eval(interp
, "srst_asserted");
2755 if (runSrstDeasserted
) {
2756 Jim_Eval(interp
, "srst_deasserted");
2759 if (runPowerDropout
) {
2760 LOG_INFO("Power dropout detected, running power_dropout proc.");
2761 Jim_Eval(interp
, "power_dropout");
2764 if (runPowerRestore
) {
2765 Jim_Eval(interp
, "power_restore");
2769 if (did_something
) {
2770 /* clear detect flags */
2774 /* clear action flags */
2776 runSrstAsserted
= 0;
2777 runSrstDeasserted
= 0;
2778 runPowerRestore
= 0;
2779 runPowerDropout
= 0;
2784 /* Poll targets for state changes unless that's globally disabled.
2785 * Skip targets that are currently disabled.
2787 for (struct target
*target
= all_targets
;
2788 is_jtag_poll_safe() && target
;
2789 target
= target
->next
) {
2791 if (!target_was_examined(target
))
2794 if (!target
->tap
->enabled
)
2797 if (target
->backoff
.times
> target
->backoff
.count
) {
2798 /* do not poll this time as we failed previously */
2799 target
->backoff
.count
++;
2802 target
->backoff
.count
= 0;
2804 /* only poll target if we've got power and srst isn't asserted */
2805 if (!powerDropout
&& !srstAsserted
) {
2806 /* polling may fail silently until the target has been examined */
2807 retval
= target_poll(target
);
2808 if (retval
!= ERROR_OK
) {
2809 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2810 if (target
->backoff
.times
* polling_interval
< 5000) {
2811 target
->backoff
.times
*= 2;
2812 target
->backoff
.times
++;
2815 /* Tell GDB to halt the debugger. This allows the user to
2816 * run monitor commands to handle the situation.
2818 target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
);
2820 if (target
->backoff
.times
> 0) {
2821 LOG_USER("Polling target %s failed, trying to reexamine", target_name(target
));
2822 target_reset_examined(target
);
2823 retval
= target_examine_one(target
);
2824 /* Target examination could have failed due to unstable connection,
2825 * but we set the examined flag anyway to repoll it later */
2826 if (retval
!= ERROR_OK
) {
2827 target
->examined
= true;
2828 LOG_USER("Examination failed, GDB will be halted. Polling again in %dms",
2829 target
->backoff
.times
* polling_interval
);
2834 /* Since we succeeded, we reset backoff count */
2835 target
->backoff
.times
= 0;
2842 COMMAND_HANDLER(handle_reg_command
)
2844 struct target
*target
;
2845 struct reg
*reg
= NULL
;
2851 target
= get_current_target(CMD_CTX
);
2853 /* list all available registers for the current target */
2854 if (CMD_ARGC
== 0) {
2855 struct reg_cache
*cache
= target
->reg_cache
;
2861 command_print(CMD
, "===== %s", cache
->name
);
2863 for (i
= 0, reg
= cache
->reg_list
;
2864 i
< cache
->num_regs
;
2865 i
++, reg
++, count
++) {
2866 if (reg
->exist
== false)
2868 /* only print cached values if they are valid */
2870 value
= buf_to_str(reg
->value
,
2873 "(%i) %s (/%" PRIu32
"): 0x%s%s",
2881 command_print(CMD
, "(%i) %s (/%" PRIu32
")",
2886 cache
= cache
->next
;
2892 /* access a single register by its ordinal number */
2893 if ((CMD_ARGV
[0][0] >= '0') && (CMD_ARGV
[0][0] <= '9')) {
2895 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], num
);
2897 struct reg_cache
*cache
= target
->reg_cache
;
2901 for (i
= 0; i
< cache
->num_regs
; i
++) {
2902 if (count
++ == num
) {
2903 reg
= &cache
->reg_list
[i
];
2909 cache
= cache
->next
;
2913 command_print(CMD
, "%i is out of bounds, the current target "
2914 "has only %i registers (0 - %i)", num
, count
, count
- 1);
2918 /* access a single register by its name */
2919 reg
= register_get_by_name(target
->reg_cache
, CMD_ARGV
[0], 1);
2925 assert(reg
!= NULL
); /* give clang a hint that we *know* reg is != NULL here */
2930 /* display a register */
2931 if ((CMD_ARGC
== 1) || ((CMD_ARGC
== 2) && !((CMD_ARGV
[1][0] >= '0')
2932 && (CMD_ARGV
[1][0] <= '9')))) {
2933 if ((CMD_ARGC
== 2) && (strcmp(CMD_ARGV
[1], "force") == 0))
2936 if (reg
->valid
== 0)
2937 reg
->type
->get(reg
);
2938 value
= buf_to_str(reg
->value
, reg
->size
, 16);
2939 command_print(CMD
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2944 /* set register value */
2945 if (CMD_ARGC
== 2) {
2946 uint8_t *buf
= malloc(DIV_ROUND_UP(reg
->size
, 8));
2949 str_to_buf(CMD_ARGV
[1], strlen(CMD_ARGV
[1]), buf
, reg
->size
, 0);
2951 reg
->type
->set(reg
, buf
);
2953 value
= buf_to_str(reg
->value
, reg
->size
, 16);
2954 command_print(CMD
, "%s (/%i): 0x%s", reg
->name
, (int)(reg
->size
), value
);
2962 return ERROR_COMMAND_SYNTAX_ERROR
;
2965 command_print(CMD
, "register %s not found in current target", CMD_ARGV
[0]);
2969 COMMAND_HANDLER(handle_poll_command
)
2971 int retval
= ERROR_OK
;
2972 struct target
*target
= get_current_target(CMD_CTX
);
2974 if (CMD_ARGC
== 0) {
2975 command_print(CMD
, "background polling: %s",
2976 jtag_poll_get_enabled() ? "on" : "off");
2977 command_print(CMD
, "TAP: %s (%s)",
2978 target
->tap
->dotted_name
,
2979 target
->tap
->enabled
? "enabled" : "disabled");
2980 if (!target
->tap
->enabled
)
2982 retval
= target_poll(target
);
2983 if (retval
!= ERROR_OK
)
2985 retval
= target_arch_state(target
);
2986 if (retval
!= ERROR_OK
)
2988 } else if (CMD_ARGC
== 1) {
2990 COMMAND_PARSE_ON_OFF(CMD_ARGV
[0], enable
);
2991 jtag_poll_set_enabled(enable
);
2993 return ERROR_COMMAND_SYNTAX_ERROR
;
2998 COMMAND_HANDLER(handle_wait_halt_command
)
3001 return ERROR_COMMAND_SYNTAX_ERROR
;
3003 unsigned ms
= DEFAULT_HALT_TIMEOUT
;
3004 if (1 == CMD_ARGC
) {
3005 int retval
= parse_uint(CMD_ARGV
[0], &ms
);
3006 if (ERROR_OK
!= retval
)
3007 return ERROR_COMMAND_SYNTAX_ERROR
;
3010 struct target
*target
= get_current_target(CMD_CTX
);
3011 return target_wait_state(target
, TARGET_HALTED
, ms
);
3014 /* wait for target state to change. The trick here is to have a low
3015 * latency for short waits and not to suck up all the CPU time
3018 * After 500ms, keep_alive() is invoked
3020 int target_wait_state(struct target
*target
, enum target_state state
, int ms
)
3023 int64_t then
= 0, cur
;
3027 retval
= target_poll(target
);
3028 if (retval
!= ERROR_OK
)
3030 if (target
->state
== state
)
3035 then
= timeval_ms();
3036 LOG_DEBUG("waiting for target %s...",
3037 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
3043 if ((cur
-then
) > ms
) {
3044 LOG_ERROR("timed out while waiting for target %s",
3045 Jim_Nvp_value2name_simple(nvp_target_state
, state
)->name
);
3053 COMMAND_HANDLER(handle_halt_command
)
3057 struct target
*target
= get_current_target(CMD_CTX
);
3059 target
->verbose_halt_msg
= true;
3061 int retval
= target_halt(target
);
3062 if (ERROR_OK
!= retval
)
3065 if (CMD_ARGC
== 1) {
3066 unsigned wait_local
;
3067 retval
= parse_uint(CMD_ARGV
[0], &wait_local
);
3068 if (ERROR_OK
!= retval
)
3069 return ERROR_COMMAND_SYNTAX_ERROR
;
3074 return CALL_COMMAND_HANDLER(handle_wait_halt_command
);
3077 COMMAND_HANDLER(handle_soft_reset_halt_command
)
3079 struct target
*target
= get_current_target(CMD_CTX
);
3081 LOG_USER("requesting target halt and executing a soft reset");
3083 target_soft_reset_halt(target
);
3088 COMMAND_HANDLER(handle_reset_command
)
3091 return ERROR_COMMAND_SYNTAX_ERROR
;
3093 enum target_reset_mode reset_mode
= RESET_RUN
;
3094 if (CMD_ARGC
== 1) {
3096 n
= Jim_Nvp_name2value_simple(nvp_reset_modes
, CMD_ARGV
[0]);
3097 if ((n
->name
== NULL
) || (n
->value
== RESET_UNKNOWN
))
3098 return ERROR_COMMAND_SYNTAX_ERROR
;
3099 reset_mode
= n
->value
;
3102 /* reset *all* targets */
3103 return target_process_reset(CMD
, reset_mode
);
3107 COMMAND_HANDLER(handle_resume_command
)
3111 return ERROR_COMMAND_SYNTAX_ERROR
;
3113 struct target
*target
= get_current_target(CMD_CTX
);
3115 /* with no CMD_ARGV, resume from current pc, addr = 0,
3116 * with one arguments, addr = CMD_ARGV[0],
3117 * handle breakpoints, not debugging */
3118 target_addr_t addr
= 0;
3119 if (CMD_ARGC
== 1) {
3120 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3124 return target_resume(target
, current
, addr
, 1, 0);
3127 COMMAND_HANDLER(handle_step_command
)
3130 return ERROR_COMMAND_SYNTAX_ERROR
;
3134 /* with no CMD_ARGV, step from current pc, addr = 0,
3135 * with one argument addr = CMD_ARGV[0],
3136 * handle breakpoints, debugging */
3137 target_addr_t addr
= 0;
3139 if (CMD_ARGC
== 1) {
3140 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3144 struct target
*target
= get_current_target(CMD_CTX
);
3146 return target
->type
->step(target
, current_pc
, addr
, 1);
3149 void target_handle_md_output(struct command_invocation
*cmd
,
3150 struct target
*target
, target_addr_t address
, unsigned size
,
3151 unsigned count
, const uint8_t *buffer
)
3153 const unsigned line_bytecnt
= 32;
3154 unsigned line_modulo
= line_bytecnt
/ size
;
3156 char output
[line_bytecnt
* 4 + 1];
3157 unsigned output_len
= 0;
3159 const char *value_fmt
;
3162 value_fmt
= "%16.16"PRIx64
" ";
3165 value_fmt
= "%8.8"PRIx64
" ";
3168 value_fmt
= "%4.4"PRIx64
" ";
3171 value_fmt
= "%2.2"PRIx64
" ";
3174 /* "can't happen", caller checked */
3175 LOG_ERROR("invalid memory read size: %u", size
);
3179 for (unsigned i
= 0; i
< count
; i
++) {
3180 if (i
% line_modulo
== 0) {
3181 output_len
+= snprintf(output
+ output_len
,
3182 sizeof(output
) - output_len
,
3183 TARGET_ADDR_FMT
": ",
3184 (address
+ (i
* size
)));
3188 const uint8_t *value_ptr
= buffer
+ i
* size
;
3191 value
= target_buffer_get_u64(target
, value_ptr
);
3194 value
= target_buffer_get_u32(target
, value_ptr
);
3197 value
= target_buffer_get_u16(target
, value_ptr
);
3202 output_len
+= snprintf(output
+ output_len
,
3203 sizeof(output
) - output_len
,
3206 if ((i
% line_modulo
== line_modulo
- 1) || (i
== count
- 1)) {
3207 command_print(cmd
, "%s", output
);
3213 COMMAND_HANDLER(handle_md_command
)
3216 return ERROR_COMMAND_SYNTAX_ERROR
;
3219 switch (CMD_NAME
[2]) {
3233 return ERROR_COMMAND_SYNTAX_ERROR
;
3236 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3237 int (*fn
)(struct target
*target
,
3238 target_addr_t address
, uint32_t size_value
, uint32_t count
, uint8_t *buffer
);
3242 fn
= target_read_phys_memory
;
3244 fn
= target_read_memory
;
3245 if ((CMD_ARGC
< 1) || (CMD_ARGC
> 2))
3246 return ERROR_COMMAND_SYNTAX_ERROR
;
3248 target_addr_t address
;
3249 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3253 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[1], count
);
3255 uint8_t *buffer
= calloc(count
, size
);
3256 if (buffer
== NULL
) {
3257 LOG_ERROR("Failed to allocate md read buffer");
3261 struct target
*target
= get_current_target(CMD_CTX
);
3262 int retval
= fn(target
, address
, size
, count
, buffer
);
3263 if (ERROR_OK
== retval
)
3264 target_handle_md_output(CMD
, target
, address
, size
, count
, buffer
);
3271 typedef int (*target_write_fn
)(struct target
*target
,
3272 target_addr_t address
, uint32_t size
, uint32_t count
, const uint8_t *buffer
);
3274 static int target_fill_mem(struct target
*target
,
3275 target_addr_t address
,
3283 /* We have to write in reasonably large chunks to be able
3284 * to fill large memory areas with any sane speed */
3285 const unsigned chunk_size
= 16384;
3286 uint8_t *target_buf
= malloc(chunk_size
* data_size
);
3287 if (target_buf
== NULL
) {
3288 LOG_ERROR("Out of memory");
3292 for (unsigned i
= 0; i
< chunk_size
; i
++) {
3293 switch (data_size
) {
3295 target_buffer_set_u64(target
, target_buf
+ i
* data_size
, b
);
3298 target_buffer_set_u32(target
, target_buf
+ i
* data_size
, b
);
3301 target_buffer_set_u16(target
, target_buf
+ i
* data_size
, b
);
3304 target_buffer_set_u8(target
, target_buf
+ i
* data_size
, b
);
3311 int retval
= ERROR_OK
;
3313 for (unsigned x
= 0; x
< c
; x
+= chunk_size
) {
3316 if (current
> chunk_size
)
3317 current
= chunk_size
;
3318 retval
= fn(target
, address
+ x
* data_size
, data_size
, current
, target_buf
);
3319 if (retval
!= ERROR_OK
)
3321 /* avoid GDB timeouts */
3330 COMMAND_HANDLER(handle_mw_command
)
3333 return ERROR_COMMAND_SYNTAX_ERROR
;
3334 bool physical
= strcmp(CMD_ARGV
[0], "phys") == 0;
3339 fn
= target_write_phys_memory
;
3341 fn
= target_write_memory
;
3342 if ((CMD_ARGC
< 2) || (CMD_ARGC
> 3))
3343 return ERROR_COMMAND_SYNTAX_ERROR
;
3345 target_addr_t address
;
3346 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], address
);
3349 COMMAND_PARSE_NUMBER(u64
, CMD_ARGV
[1], value
);
3353 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[2], count
);
3355 struct target
*target
= get_current_target(CMD_CTX
);
3357 switch (CMD_NAME
[2]) {
3371 return ERROR_COMMAND_SYNTAX_ERROR
;
3374 return target_fill_mem(target
, address
, fn
, wordsize
, value
, count
);
3377 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV
, struct image
*image
,
3378 target_addr_t
*min_address
, target_addr_t
*max_address
)
3380 if (CMD_ARGC
< 1 || CMD_ARGC
> 5)
3381 return ERROR_COMMAND_SYNTAX_ERROR
;
3383 /* a base address isn't always necessary,
3384 * default to 0x0 (i.e. don't relocate) */
3385 if (CMD_ARGC
>= 2) {
3387 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3388 image
->base_address
= addr
;
3389 image
->base_address_set
= 1;
3391 image
->base_address_set
= 0;
3393 image
->start_address_set
= 0;
3396 COMMAND_PARSE_ADDRESS(CMD_ARGV
[3], *min_address
);
3397 if (CMD_ARGC
== 5) {
3398 COMMAND_PARSE_ADDRESS(CMD_ARGV
[4], *max_address
);
3399 /* use size (given) to find max (required) */
3400 *max_address
+= *min_address
;
3403 if (*min_address
> *max_address
)
3404 return ERROR_COMMAND_SYNTAX_ERROR
;
3409 COMMAND_HANDLER(handle_load_image_command
)
3413 uint32_t image_size
;
3414 target_addr_t min_address
= 0;
3415 target_addr_t max_address
= -1;
3419 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
3420 &image
, &min_address
, &max_address
);
3421 if (ERROR_OK
!= retval
)
3424 struct target
*target
= get_current_target(CMD_CTX
);
3426 struct duration bench
;
3427 duration_start(&bench
);
3429 if (image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
) != ERROR_OK
)
3434 for (i
= 0; i
< image
.num_sections
; i
++) {
3435 buffer
= malloc(image
.sections
[i
].size
);
3436 if (buffer
== NULL
) {
3438 "error allocating buffer for section (%d bytes)",
3439 (int)(image
.sections
[i
].size
));
3440 retval
= ERROR_FAIL
;
3444 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3445 if (retval
!= ERROR_OK
) {
3450 uint32_t offset
= 0;
3451 uint32_t length
= buf_cnt
;
3453 /* DANGER!!! beware of unsigned comparision here!!! */
3455 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
3456 (image
.sections
[i
].base_address
< max_address
)) {
3458 if (image
.sections
[i
].base_address
< min_address
) {
3459 /* clip addresses below */
3460 offset
+= min_address
-image
.sections
[i
].base_address
;
3464 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
3465 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
3467 retval
= target_write_buffer(target
,
3468 image
.sections
[i
].base_address
+ offset
, length
, buffer
+ offset
);
3469 if (retval
!= ERROR_OK
) {
3473 image_size
+= length
;
3474 command_print(CMD
, "%u bytes written at address " TARGET_ADDR_FMT
"",
3475 (unsigned int)length
,
3476 image
.sections
[i
].base_address
+ offset
);
3482 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3483 command_print(CMD
, "downloaded %" PRIu32
" bytes "
3484 "in %fs (%0.3f KiB/s)", image_size
,
3485 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3488 image_close(&image
);
3494 COMMAND_HANDLER(handle_dump_image_command
)
3496 struct fileio
*fileio
;
3498 int retval
, retvaltemp
;
3499 target_addr_t address
, size
;
3500 struct duration bench
;
3501 struct target
*target
= get_current_target(CMD_CTX
);
3504 return ERROR_COMMAND_SYNTAX_ERROR
;
3506 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], address
);
3507 COMMAND_PARSE_ADDRESS(CMD_ARGV
[2], size
);
3509 uint32_t buf_size
= (size
> 4096) ? 4096 : size
;
3510 buffer
= malloc(buf_size
);
3514 retval
= fileio_open(&fileio
, CMD_ARGV
[0], FILEIO_WRITE
, FILEIO_BINARY
);
3515 if (retval
!= ERROR_OK
) {
3520 duration_start(&bench
);
3523 size_t size_written
;
3524 uint32_t this_run_size
= (size
> buf_size
) ? buf_size
: size
;
3525 retval
= target_read_buffer(target
, address
, this_run_size
, buffer
);
3526 if (retval
!= ERROR_OK
)
3529 retval
= fileio_write(fileio
, this_run_size
, buffer
, &size_written
);
3530 if (retval
!= ERROR_OK
)
3533 size
-= this_run_size
;
3534 address
+= this_run_size
;
3539 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3541 retval
= fileio_size(fileio
, &filesize
);
3542 if (retval
!= ERROR_OK
)
3545 "dumped %zu bytes in %fs (%0.3f KiB/s)", filesize
,
3546 duration_elapsed(&bench
), duration_kbps(&bench
, filesize
));
3549 retvaltemp
= fileio_close(fileio
);
3550 if (retvaltemp
!= ERROR_OK
)
3559 IMAGE_CHECKSUM_ONLY
= 2
3562 static COMMAND_HELPER(handle_verify_image_command_internal
, enum verify_mode verify
)
3566 uint32_t image_size
;
3569 uint32_t checksum
= 0;
3570 uint32_t mem_checksum
= 0;
3574 struct target
*target
= get_current_target(CMD_CTX
);
3577 return ERROR_COMMAND_SYNTAX_ERROR
;
3580 LOG_ERROR("no target selected");
3584 struct duration bench
;
3585 duration_start(&bench
);
3587 if (CMD_ARGC
>= 2) {
3589 COMMAND_PARSE_ADDRESS(CMD_ARGV
[1], addr
);
3590 image
.base_address
= addr
;
3591 image
.base_address_set
= 1;
3593 image
.base_address_set
= 0;
3594 image
.base_address
= 0x0;
3597 image
.start_address_set
= 0;
3599 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
== 3) ? CMD_ARGV
[2] : NULL
);
3600 if (retval
!= ERROR_OK
)
3606 for (i
= 0; i
< image
.num_sections
; i
++) {
3607 buffer
= malloc(image
.sections
[i
].size
);
3608 if (buffer
== NULL
) {
3610 "error allocating buffer for section (%d bytes)",
3611 (int)(image
.sections
[i
].size
));
3614 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
3615 if (retval
!= ERROR_OK
) {
3620 if (verify
>= IMAGE_VERIFY
) {
3621 /* calculate checksum of image */
3622 retval
= image_calculate_checksum(buffer
, buf_cnt
, &checksum
);
3623 if (retval
!= ERROR_OK
) {
3628 retval
= target_checksum_memory(target
, image
.sections
[i
].base_address
, buf_cnt
, &mem_checksum
);
3629 if (retval
!= ERROR_OK
) {
3633 if ((checksum
!= mem_checksum
) && (verify
== IMAGE_CHECKSUM_ONLY
)) {
3634 LOG_ERROR("checksum mismatch");
3636 retval
= ERROR_FAIL
;
3639 if (checksum
!= mem_checksum
) {
3640 /* failed crc checksum, fall back to a binary compare */
3644 LOG_ERROR("checksum mismatch - attempting binary compare");
3646 data
= malloc(buf_cnt
);
3648 retval
= target_read_buffer(target
, image
.sections
[i
].base_address
, buf_cnt
, data
);
3649 if (retval
== ERROR_OK
) {
3651 for (t
= 0; t
< buf_cnt
; t
++) {
3652 if (data
[t
] != buffer
[t
]) {
3654 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3656 (unsigned)(t
+ image
.sections
[i
].base_address
),
3659 if (diffs
++ >= 127) {
3660 command_print(CMD
, "More than 128 errors, the rest are not printed.");
3672 command_print(CMD
, "address " TARGET_ADDR_FMT
" length 0x%08zx",
3673 image
.sections
[i
].base_address
,
3678 image_size
+= buf_cnt
;
3681 command_print(CMD
, "No more differences found.");
3684 retval
= ERROR_FAIL
;
3685 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
3686 command_print(CMD
, "verified %" PRIu32
" bytes "
3687 "in %fs (%0.3f KiB/s)", image_size
,
3688 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
3691 image_close(&image
);
3696 COMMAND_HANDLER(handle_verify_image_checksum_command
)
3698 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_CHECKSUM_ONLY
);
3701 COMMAND_HANDLER(handle_verify_image_command
)
3703 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_VERIFY
);
3706 COMMAND_HANDLER(handle_test_image_command
)
3708 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal
, IMAGE_TEST
);
3711 static int handle_bp_command_list(struct command_invocation
*cmd
)
3713 struct target
*target
= get_current_target(cmd
->ctx
);
3714 struct breakpoint
*breakpoint
= target
->breakpoints
;
3715 while (breakpoint
) {
3716 if (breakpoint
->type
== BKPT_SOFT
) {
3717 char *buf
= buf_to_str(breakpoint
->orig_instr
,
3718 breakpoint
->length
, 16);
3719 command_print(cmd
, "IVA breakpoint: " TARGET_ADDR_FMT
", 0x%x, %i, 0x%s",
3720 breakpoint
->address
,
3722 breakpoint
->set
, buf
);
3725 if ((breakpoint
->address
== 0) && (breakpoint
->asid
!= 0))
3726 command_print(cmd
, "Context breakpoint: 0x%8.8" PRIx32
", 0x%x, %i",
3728 breakpoint
->length
, breakpoint
->set
);
3729 else if ((breakpoint
->address
!= 0) && (breakpoint
->asid
!= 0)) {
3730 command_print(cmd
, "Hybrid breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3731 breakpoint
->address
,
3732 breakpoint
->length
, breakpoint
->set
);
3733 command_print(cmd
, "\t|--->linked with ContextID: 0x%8.8" PRIx32
,
3736 command_print(cmd
, "Breakpoint(IVA): " TARGET_ADDR_FMT
", 0x%x, %i",
3737 breakpoint
->address
,
3738 breakpoint
->length
, breakpoint
->set
);
3741 breakpoint
= breakpoint
->next
;
3746 static int handle_bp_command_set(struct command_invocation
*cmd
,
3747 target_addr_t addr
, uint32_t asid
, uint32_t length
, int hw
)
3749 struct target
*target
= get_current_target(cmd
->ctx
);
3753 retval
= breakpoint_add(target
, addr
, length
, hw
);
3754 /* error is always logged in breakpoint_add(), do not print it again */
3755 if (ERROR_OK
== retval
)
3756 command_print(cmd
, "breakpoint set at " TARGET_ADDR_FMT
"", addr
);
3758 } else if (addr
== 0) {
3759 if (target
->type
->add_context_breakpoint
== NULL
) {
3760 LOG_ERROR("Context breakpoint not available");
3761 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
3763 retval
= context_breakpoint_add(target
, asid
, length
, hw
);
3764 /* error is always logged in context_breakpoint_add(), do not print it again */
3765 if (ERROR_OK
== retval
)
3766 command_print(cmd
, "Context breakpoint set at 0x%8.8" PRIx32
"", asid
);
3769 if (target
->type
->add_hybrid_breakpoint
== NULL
) {
3770 LOG_ERROR("Hybrid breakpoint not available");
3771 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE
;
3773 retval
= hybrid_breakpoint_add(target
, addr
, asid
, length
, hw
);
3774 /* error is always logged in hybrid_breakpoint_add(), do not print it again */
3775 if (ERROR_OK
== retval
)
3776 command_print(cmd
, "Hybrid breakpoint set at 0x%8.8" PRIx32
"", asid
);
3781 COMMAND_HANDLER(handle_bp_command
)
3790 return handle_bp_command_list(CMD
);
3794 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3795 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3796 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3799 if (strcmp(CMD_ARGV
[2], "hw") == 0) {
3801 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3802 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3804 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3805 } else if (strcmp(CMD_ARGV
[2], "hw_ctx") == 0) {
3807 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], asid
);
3808 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3810 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3815 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3816 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], asid
);
3817 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], length
);
3818 return handle_bp_command_set(CMD
, addr
, asid
, length
, hw
);
3821 return ERROR_COMMAND_SYNTAX_ERROR
;
3825 COMMAND_HANDLER(handle_rbp_command
)
3828 return ERROR_COMMAND_SYNTAX_ERROR
;
3831 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], addr
);
3833 struct target
*target
= get_current_target(CMD_CTX
);
3834 breakpoint_remove(target
, addr
);
3839 COMMAND_HANDLER(handle_wp_command
)
3841 struct target
*target
= get_current_target(CMD_CTX
);
3843 if (CMD_ARGC
== 0) {
3844 struct watchpoint
*watchpoint
= target
->watchpoints
;
3846 while (watchpoint
) {
3847 command_print(CMD
, "address: " TARGET_ADDR_FMT
3848 ", len: 0x%8.8" PRIx32
3849 ", r/w/a: %i, value: 0x%8.8" PRIx32
3850 ", mask: 0x%8.8" PRIx32
,
3851 watchpoint
->address
,
3853 (int)watchpoint
->rw
,
3856 watchpoint
= watchpoint
->next
;
3861 enum watchpoint_rw type
= WPT_ACCESS
;
3863 uint32_t length
= 0;
3864 uint32_t data_value
= 0x0;
3865 uint32_t data_mask
= 0xffffffff;
3869 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[4], data_mask
);
3872 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], data_value
);
3875 switch (CMD_ARGV
[2][0]) {
3886 LOG_ERROR("invalid watchpoint mode ('%c')", CMD_ARGV
[2][0]);
3887 return ERROR_COMMAND_SYNTAX_ERROR
;
3891 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[1], length
);
3892 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3896 return ERROR_COMMAND_SYNTAX_ERROR
;
3899 int retval
= watchpoint_add(target
, addr
, length
, type
,
3900 data_value
, data_mask
);
3901 if (ERROR_OK
!= retval
)
3902 LOG_ERROR("Failure setting watchpoints");
3907 COMMAND_HANDLER(handle_rwp_command
)
3910 return ERROR_COMMAND_SYNTAX_ERROR
;
3913 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], addr
);
3915 struct target
*target
= get_current_target(CMD_CTX
);
3916 watchpoint_remove(target
, addr
);
3922 * Translate a virtual address to a physical address.
3924 * The low-level target implementation must have logged a detailed error
3925 * which is forwarded to telnet/GDB session.
3927 COMMAND_HANDLER(handle_virt2phys_command
)
3930 return ERROR_COMMAND_SYNTAX_ERROR
;
3933 COMMAND_PARSE_ADDRESS(CMD_ARGV
[0], va
);
3936 struct target
*target
= get_current_target(CMD_CTX
);
3937 int retval
= target
->type
->virt2phys(target
, va
, &pa
);
3938 if (retval
== ERROR_OK
)
3939 command_print(CMD
, "Physical address " TARGET_ADDR_FMT
"", pa
);
3944 static void writeData(FILE *f
, const void *data
, size_t len
)
3946 size_t written
= fwrite(data
, 1, len
, f
);
3948 LOG_ERROR("failed to write %zu bytes: %s", len
, strerror(errno
));
3951 static void writeLong(FILE *f
, int l
, struct target
*target
)
3955 target_buffer_set_u32(target
, val
, l
);
3956 writeData(f
, val
, 4);
3959 static void writeString(FILE *f
, char *s
)
3961 writeData(f
, s
, strlen(s
));
3964 typedef unsigned char UNIT
[2]; /* unit of profiling */
3966 /* Dump a gmon.out histogram file. */
3967 static void write_gmon(uint32_t *samples
, uint32_t sampleNum
, const char *filename
, bool with_range
,
3968 uint32_t start_address
, uint32_t end_address
, struct target
*target
, uint32_t duration_ms
)
3971 FILE *f
= fopen(filename
, "w");
3974 writeString(f
, "gmon");
3975 writeLong(f
, 0x00000001, target
); /* Version */
3976 writeLong(f
, 0, target
); /* padding */
3977 writeLong(f
, 0, target
); /* padding */
3978 writeLong(f
, 0, target
); /* padding */
3980 uint8_t zero
= 0; /* GMON_TAG_TIME_HIST */
3981 writeData(f
, &zero
, 1);
3983 /* figure out bucket size */
3987 min
= start_address
;
3992 for (i
= 0; i
< sampleNum
; i
++) {
3993 if (min
> samples
[i
])
3995 if (max
< samples
[i
])
3999 /* max should be (largest sample + 1)
4000 * Refer to binutils/gprof/hist.c (find_histogram_for_pc) */
4004 int addressSpace
= max
- min
;
4005 assert(addressSpace
>= 2);
4007 /* FIXME: What is the reasonable number of buckets?
4008 * The profiling result will be more accurate if there are enough buckets. */
4009 static const uint32_t maxBuckets
= 128 * 1024; /* maximum buckets. */
4010 uint32_t numBuckets
= addressSpace
/ sizeof(UNIT
);
4011 if (numBuckets
> maxBuckets
)
4012 numBuckets
= maxBuckets
;
4013 int *buckets
= malloc(sizeof(int) * numBuckets
);
4014 if (buckets
== NULL
) {
4018 memset(buckets
, 0, sizeof(int) * numBuckets
);
4019 for (i
= 0; i
< sampleNum
; i
++) {
4020 uint32_t address
= samples
[i
];
4022 if ((address
< min
) || (max
<= address
))
4025 long long a
= address
- min
;
4026 long long b
= numBuckets
;
4027 long long c
= addressSpace
;
4028 int index_t
= (a
* b
) / c
; /* danger!!!! int32 overflows */
4032 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
4033 writeLong(f
, min
, target
); /* low_pc */
4034 writeLong(f
, max
, target
); /* high_pc */
4035 writeLong(f
, numBuckets
, target
); /* # of buckets */
4036 float sample_rate
= sampleNum
/ (duration_ms
/ 1000.0);
4037 writeLong(f
, sample_rate
, target
);
4038 writeString(f
, "seconds");
4039 for (i
= 0; i
< (15-strlen("seconds")); i
++)
4040 writeData(f
, &zero
, 1);
4041 writeString(f
, "s");
4043 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
4045 char *data
= malloc(2 * numBuckets
);
4047 for (i
= 0; i
< numBuckets
; i
++) {
4052 data
[i
* 2] = val
&0xff;
4053 data
[i
* 2 + 1] = (val
>> 8) & 0xff;
4056 writeData(f
, data
, numBuckets
* 2);
4064 /* profiling samples the CPU PC as quickly as OpenOCD is able,
4065 * which will be used as a random sampling of PC */
4066 COMMAND_HANDLER(handle_profile_command
)
4068 struct target
*target
= get_current_target(CMD_CTX
);
4070 if ((CMD_ARGC
!= 2) && (CMD_ARGC
!= 4))
4071 return ERROR_COMMAND_SYNTAX_ERROR
;
4073 const uint32_t MAX_PROFILE_SAMPLE_NUM
= 10000;
4075 uint32_t num_of_samples
;
4076 int retval
= ERROR_OK
;
4078 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], offset
);
4080 uint32_t *samples
= malloc(sizeof(uint32_t) * MAX_PROFILE_SAMPLE_NUM
);
4081 if (samples
== NULL
) {
4082 LOG_ERROR("No memory to store samples.");
4086 uint64_t timestart_ms
= timeval_ms();
4088 * Some cores let us sample the PC without the
4089 * annoying halt/resume step; for example, ARMv7 PCSR.
4090 * Provide a way to use that more efficient mechanism.
4092 retval
= target_profiling(target
, samples
, MAX_PROFILE_SAMPLE_NUM
,
4093 &num_of_samples
, offset
);
4094 if (retval
!= ERROR_OK
) {
4098 uint32_t duration_ms
= timeval_ms() - timestart_ms
;
4100 assert(num_of_samples
<= MAX_PROFILE_SAMPLE_NUM
);
4102 retval
= target_poll(target
);
4103 if (retval
!= ERROR_OK
) {
4107 if (target
->state
== TARGET_RUNNING
) {
4108 retval
= target_halt(target
);
4109 if (retval
!= ERROR_OK
) {
4115 retval
= target_poll(target
);
4116 if (retval
!= ERROR_OK
) {
4121 uint32_t start_address
= 0;
4122 uint32_t end_address
= 0;
4123 bool with_range
= false;
4124 if (CMD_ARGC
== 4) {
4126 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[2], start_address
);
4127 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[3], end_address
);
4130 write_gmon(samples
, num_of_samples
, CMD_ARGV
[1],
4131 with_range
, start_address
, end_address
, target
, duration_ms
);
4132 command_print(CMD
, "Wrote %s", CMD_ARGV
[1]);
4138 static int new_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t val
)
4141 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4144 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4148 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4149 valObjPtr
= Jim_NewIntObj(interp
, val
);
4150 if (!nameObjPtr
|| !valObjPtr
) {
4155 Jim_IncrRefCount(nameObjPtr
);
4156 Jim_IncrRefCount(valObjPtr
);
4157 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
4158 Jim_DecrRefCount(interp
, nameObjPtr
);
4159 Jim_DecrRefCount(interp
, valObjPtr
);
4161 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
4165 static int jim_mem2array(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4167 struct command_context
*context
;
4168 struct target
*target
;
4170 context
= current_command_context(interp
);
4171 assert(context
!= NULL
);
4173 target
= get_current_target(context
);
4174 if (target
== NULL
) {
4175 LOG_ERROR("mem2array: no current target");
4179 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
4182 static int target_mem2array(Jim_Interp
*interp
, struct target
*target
, int argc
, Jim_Obj
*const *argv
)
4190 const char *varname
;
4196 /* argv[1] = name of array to receive the data
4197 * argv[2] = desired width
4198 * argv[3] = memory address
4199 * argv[4] = count of times to read
4202 if (argc
< 4 || argc
> 5) {
4203 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4206 varname
= Jim_GetString(argv
[0], &len
);
4207 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4209 e
= Jim_GetLong(interp
, argv
[1], &l
);
4214 e
= Jim_GetLong(interp
, argv
[2], &l
);
4218 e
= Jim_GetLong(interp
, argv
[3], &l
);
4224 phys
= Jim_GetString(argv
[4], &n
);
4225 if (!strncmp(phys
, "phys", n
))
4241 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4242 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "Invalid width param, must be 8/16/32", NULL
);
4246 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4247 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: zero width read?", NULL
);
4250 if ((addr
+ (len
* width
)) < addr
) {
4251 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4252 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: addr + len - wraps to zero?", NULL
);
4255 /* absurd transfer size? */
4257 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4258 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: absurd > 64K item request", NULL
);
4263 ((width
== 2) && ((addr
& 1) == 0)) ||
4264 ((width
== 4) && ((addr
& 3) == 0))) {
4268 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4269 sprintf(buf
, "mem2array address: 0x%08" PRIx32
" is not aligned for %" PRId32
" byte reads",
4272 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4281 size_t buffersize
= 4096;
4282 uint8_t *buffer
= malloc(buffersize
);
4289 /* Slurp... in buffer size chunks */
4291 count
= len
; /* in objects.. */
4292 if (count
> (buffersize
/ width
))
4293 count
= (buffersize
/ width
);
4296 retval
= target_read_phys_memory(target
, addr
, width
, count
, buffer
);
4298 retval
= target_read_memory(target
, addr
, width
, count
, buffer
);
4299 if (retval
!= ERROR_OK
) {
4301 LOG_ERROR("mem2array: Read @ 0x%08" PRIx32
", w=%" PRId32
", cnt=%" PRId32
", failed",
4305 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4306 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "mem2array: cannot read memory", NULL
);
4310 v
= 0; /* shut up gcc */
4311 for (i
= 0; i
< count
; i
++, n
++) {
4314 v
= target_buffer_get_u32(target
, &buffer
[i
*width
]);
4317 v
= target_buffer_get_u16(target
, &buffer
[i
*width
]);
4320 v
= buffer
[i
] & 0x0ff;
4323 new_int_array_element(interp
, varname
, n
, v
);
4326 addr
+= count
* width
;
4332 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4337 static int get_int_array_element(Jim_Interp
*interp
, const char *varname
, int idx
, uint32_t *val
)
4340 Jim_Obj
*nameObjPtr
, *valObjPtr
;
4344 namebuf
= alloc_printf("%s(%d)", varname
, idx
);
4348 nameObjPtr
= Jim_NewStringObj(interp
, namebuf
, -1);
4354 Jim_IncrRefCount(nameObjPtr
);
4355 valObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, JIM_ERRMSG
);
4356 Jim_DecrRefCount(interp
, nameObjPtr
);
4358 if (valObjPtr
== NULL
)
4361 result
= Jim_GetLong(interp
, valObjPtr
, &l
);
4362 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
4367 static int jim_array2mem(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4369 struct command_context
*context
;
4370 struct target
*target
;
4372 context
= current_command_context(interp
);
4373 assert(context
!= NULL
);
4375 target
= get_current_target(context
);
4376 if (target
== NULL
) {
4377 LOG_ERROR("array2mem: no current target");
4381 return target_array2mem(interp
, target
, argc
-1, argv
+ 1);
4384 static int target_array2mem(Jim_Interp
*interp
, struct target
*target
,
4385 int argc
, Jim_Obj
*const *argv
)
4393 const char *varname
;
4399 /* argv[1] = name of array to get the data
4400 * argv[2] = desired width
4401 * argv[3] = memory address
4402 * argv[4] = count to write
4404 if (argc
< 4 || argc
> 5) {
4405 Jim_WrongNumArgs(interp
, 0, argv
, "varname width addr nelems [phys]");
4408 varname
= Jim_GetString(argv
[0], &len
);
4409 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
4411 e
= Jim_GetLong(interp
, argv
[1], &l
);
4416 e
= Jim_GetLong(interp
, argv
[2], &l
);
4420 e
= Jim_GetLong(interp
, argv
[3], &l
);
4426 phys
= Jim_GetString(argv
[4], &n
);
4427 if (!strncmp(phys
, "phys", n
))
4443 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4444 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4445 "Invalid width param, must be 8/16/32", NULL
);
4449 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4450 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4451 "array2mem: zero width read?", NULL
);
4454 if ((addr
+ (len
* width
)) < addr
) {
4455 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4456 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4457 "array2mem: addr + len - wraps to zero?", NULL
);
4460 /* absurd transfer size? */
4462 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4463 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4464 "array2mem: absurd > 64K item request", NULL
);
4469 ((width
== 2) && ((addr
& 1) == 0)) ||
4470 ((width
== 4) && ((addr
& 3) == 0))) {
4474 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4475 sprintf(buf
, "array2mem address: 0x%08" PRIx32
" is not aligned for %" PRId32
" byte reads",
4478 Jim_AppendStrings(interp
, Jim_GetResult(interp
), buf
, NULL
);
4489 size_t buffersize
= 4096;
4490 uint8_t *buffer
= malloc(buffersize
);
4495 /* Slurp... in buffer size chunks */
4497 count
= len
; /* in objects.. */
4498 if (count
> (buffersize
/ width
))
4499 count
= (buffersize
/ width
);
4501 v
= 0; /* shut up gcc */
4502 for (i
= 0; i
< count
; i
++, n
++) {
4503 get_int_array_element(interp
, varname
, n
, &v
);
4506 target_buffer_set_u32(target
, &buffer
[i
* width
], v
);
4509 target_buffer_set_u16(target
, &buffer
[i
* width
], v
);
4512 buffer
[i
] = v
& 0x0ff;
4519 retval
= target_write_phys_memory(target
, addr
, width
, count
, buffer
);
4521 retval
= target_write_memory(target
, addr
, width
, count
, buffer
);
4522 if (retval
!= ERROR_OK
) {
4524 LOG_ERROR("array2mem: Write @ 0x%08" PRIx32
", w=%" PRId32
", cnt=%" PRId32
", failed",
4528 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4529 Jim_AppendStrings(interp
, Jim_GetResult(interp
), "array2mem: cannot read memory", NULL
);
4533 addr
+= count
* width
;
4538 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4543 /* FIX? should we propagate errors here rather than printing them
4546 void target_handle_event(struct target
*target
, enum target_event e
)
4548 struct target_event_action
*teap
;
4551 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4552 if (teap
->event
== e
) {
4553 LOG_DEBUG("target(%d): %s (%s) event: %d (%s) action: %s",
4554 target
->target_number
,
4555 target_name(target
),
4556 target_type_name(target
),
4558 Jim_Nvp_value2name_simple(nvp_target_event
, e
)->name
,
4559 Jim_GetString(teap
->body
, NULL
));
4561 /* Override current target by the target an event
4562 * is issued from (lot of scripts need it).
4563 * Return back to previous override as soon
4564 * as the handler processing is done */
4565 struct command_context
*cmd_ctx
= current_command_context(teap
->interp
);
4566 struct target
*saved_target_override
= cmd_ctx
->current_target_override
;
4567 cmd_ctx
->current_target_override
= target
;
4568 retval
= Jim_EvalObj(teap
->interp
, teap
->body
);
4570 if (retval
== JIM_RETURN
)
4571 retval
= teap
->interp
->returnCode
;
4573 if (retval
!= JIM_OK
) {
4574 Jim_MakeErrorMessage(teap
->interp
);
4575 LOG_USER("Error executing event %s on target %s:\n%s",
4576 Jim_Nvp_value2name_simple(nvp_target_event
, e
)->name
,
4577 target_name(target
),
4578 Jim_GetString(Jim_GetResult(teap
->interp
), NULL
));
4579 /* clean both error code and stacktrace before return */
4580 Jim_Eval(teap
->interp
, "error \"\" \"\"");
4583 cmd_ctx
->current_target_override
= saved_target_override
;
4589 * Returns true only if the target has a handler for the specified event.
4591 bool target_has_event_action(struct target
*target
, enum target_event event
)
4593 struct target_event_action
*teap
;
4595 for (teap
= target
->event_action
; teap
!= NULL
; teap
= teap
->next
) {
4596 if (teap
->event
== event
)
4602 enum target_cfg_param
{
4605 TCFG_WORK_AREA_VIRT
,
4606 TCFG_WORK_AREA_PHYS
,
4607 TCFG_WORK_AREA_SIZE
,
4608 TCFG_WORK_AREA_BACKUP
,
4611 TCFG_CHAIN_POSITION
,
4618 static Jim_Nvp nvp_config_opts
[] = {
4619 { .name
= "-type", .value
= TCFG_TYPE
},
4620 { .name
= "-event", .value
= TCFG_EVENT
},
4621 { .name
= "-work-area-virt", .value
= TCFG_WORK_AREA_VIRT
},
4622 { .name
= "-work-area-phys", .value
= TCFG_WORK_AREA_PHYS
},
4623 { .name
= "-work-area-size", .value
= TCFG_WORK_AREA_SIZE
},
4624 { .name
= "-work-area-backup", .value
= TCFG_WORK_AREA_BACKUP
},
4625 { .name
= "-endian" , .value
= TCFG_ENDIAN
},
4626 { .name
= "-coreid", .value
= TCFG_COREID
},
4627 { .name
= "-chain-position", .value
= TCFG_CHAIN_POSITION
},
4628 { .name
= "-dbgbase", .value
= TCFG_DBGBASE
},
4629 { .name
= "-rtos", .value
= TCFG_RTOS
},
4630 { .name
= "-defer-examine", .value
= TCFG_DEFER_EXAMINE
},
4631 { .name
= "-gdb-port", .value
= TCFG_GDB_PORT
},
4632 { .name
= NULL
, .value
= -1 }
4635 static int target_configure(Jim_GetOptInfo
*goi
, struct target
*target
)
4642 /* parse config or cget options ... */
4643 while (goi
->argc
> 0) {
4644 Jim_SetEmptyResult(goi
->interp
);
4645 /* Jim_GetOpt_Debug(goi); */
4647 if (target
->type
->target_jim_configure
) {
4648 /* target defines a configure function */
4649 /* target gets first dibs on parameters */
4650 e
= (*(target
->type
->target_jim_configure
))(target
, goi
);
4659 /* otherwise we 'continue' below */
4661 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
4663 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
4669 if (goi
->isconfigure
) {
4670 Jim_SetResultFormatted(goi
->interp
,
4671 "not settable: %s", n
->name
);
4675 if (goi
->argc
!= 0) {
4676 Jim_WrongNumArgs(goi
->interp
,
4677 goi
->argc
, goi
->argv
,
4682 Jim_SetResultString(goi
->interp
,
4683 target_type_name(target
), -1);
4687 if (goi
->argc
== 0) {
4688 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ...");
4692 e
= Jim_GetOpt_Nvp(goi
, nvp_target_event
, &n
);
4694 Jim_GetOpt_NvpUnknown(goi
, nvp_target_event
, 1);
4698 if (goi
->isconfigure
) {
4699 if (goi
->argc
!= 1) {
4700 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
4704 if (goi
->argc
!= 0) {
4705 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
4711 struct target_event_action
*teap
;
4713 teap
= target
->event_action
;
4714 /* replace existing? */
4716 if (teap
->event
== (enum target_event
)n
->value
)
4721 if (goi
->isconfigure
) {
4722 bool replace
= true;
4725 teap
= calloc(1, sizeof(*teap
));
4728 teap
->event
= n
->value
;
4729 teap
->interp
= goi
->interp
;
4730 Jim_GetOpt_Obj(goi
, &o
);
4732 Jim_DecrRefCount(teap
->interp
, teap
->body
);
4733 teap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
4736 * Tcl/TK - "tk events" have a nice feature.
4737 * See the "BIND" command.
4738 * We should support that here.
4739 * You can specify %X and %Y in the event code.
4740 * The idea is: %T - target name.
4741 * The idea is: %N - target number
4742 * The idea is: %E - event name.
4744 Jim_IncrRefCount(teap
->body
);
4747 /* add to head of event list */
4748 teap
->next
= target
->event_action
;
4749 target
->event_action
= teap
;
4751 Jim_SetEmptyResult(goi
->interp
);
4755 Jim_SetEmptyResult(goi
->interp
);
4757 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, teap
->body
));
4763 case TCFG_WORK_AREA_VIRT
:
4764 if (goi
->isconfigure
) {
4765 target_free_all_working_areas(target
);
4766 e
= Jim_GetOpt_Wide(goi
, &w
);
4769 target
->working_area_virt
= w
;
4770 target
->working_area_virt_spec
= true;
4775 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_virt
));
4779 case TCFG_WORK_AREA_PHYS
:
4780 if (goi
->isconfigure
) {
4781 target_free_all_working_areas(target
);
4782 e
= Jim_GetOpt_Wide(goi
, &w
);
4785 target
->working_area_phys
= w
;
4786 target
->working_area_phys_spec
= true;
4791 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_phys
));
4795 case TCFG_WORK_AREA_SIZE
:
4796 if (goi
->isconfigure
) {
4797 target_free_all_working_areas(target
);
4798 e
= Jim_GetOpt_Wide(goi
, &w
);
4801 target
->working_area_size
= w
;
4806 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->working_area_size
));
4810 case TCFG_WORK_AREA_BACKUP
:
4811 if (goi
->isconfigure
) {
4812 target_free_all_working_areas(target
);
4813 e
= Jim_GetOpt_Wide(goi
, &w
);
4816 /* make this exactly 1 or 0 */
4817 target
->backup_working_area
= (!!w
);
4822 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->backup_working_area
));
4823 /* loop for more e*/
4828 if (goi
->isconfigure
) {
4829 e
= Jim_GetOpt_Nvp(goi
, nvp_target_endian
, &n
);
4831 Jim_GetOpt_NvpUnknown(goi
, nvp_target_endian
, 1);
4834 target
->endianness
= n
->value
;
4839 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4840 if (n
->name
== NULL
) {
4841 target
->endianness
= TARGET_LITTLE_ENDIAN
;
4842 n
= Jim_Nvp_value2name_simple(nvp_target_endian
, target
->endianness
);
4844 Jim_SetResultString(goi
->interp
, n
->name
, -1);
4849 if (goi
->isconfigure
) {
4850 e
= Jim_GetOpt_Wide(goi
, &w
);
4853 target
->coreid
= (int32_t)w
;
4858 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->coreid
));
4862 case TCFG_CHAIN_POSITION
:
4863 if (goi
->isconfigure
) {
4865 struct jtag_tap
*tap
;
4867 if (target
->has_dap
) {
4868 Jim_SetResultString(goi
->interp
,
4869 "target requires -dap parameter instead of -chain-position!", -1);
4873 target_free_all_working_areas(target
);
4874 e
= Jim_GetOpt_Obj(goi
, &o_t
);
4877 tap
= jtag_tap_by_jim_obj(goi
->interp
, o_t
);
4881 target
->tap_configured
= true;
4886 Jim_SetResultString(goi
->interp
, target
->tap
->dotted_name
, -1);
4887 /* loop for more e*/
4890 if (goi
->isconfigure
) {
4891 e
= Jim_GetOpt_Wide(goi
, &w
);
4894 target
->dbgbase
= (uint32_t)w
;
4895 target
->dbgbase_set
= true;
4900 Jim_SetResult(goi
->interp
, Jim_NewIntObj(goi
->interp
, target
->dbgbase
));
4906 int result
= rtos_create(goi
, target
);
4907 if (result
!= JIM_OK
)
4913 case TCFG_DEFER_EXAMINE
:
4915 target
->defer_examine
= true;
4920 if (goi
->isconfigure
) {
4921 struct command_context
*cmd_ctx
= current_command_context(goi
->interp
);
4922 if (cmd_ctx
->mode
!= COMMAND_CONFIG
) {
4923 Jim_SetResultString(goi
->interp
, "-gdb-port must be configured before 'init'", -1);
4928 e
= Jim_GetOpt_String(goi
, &s
, NULL
);
4931 target
->gdb_port_override
= strdup(s
);
4936 Jim_SetResultString(goi
->interp
, target
->gdb_port_override
? : "undefined", -1);
4940 } /* while (goi->argc) */
4943 /* done - we return */
4947 static int jim_target_configure(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
4951 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
4952 goi
.isconfigure
= !strcmp(Jim_GetString(argv
[0], NULL
), "configure");
4954 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
4955 "missing: -option ...");
4958 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
4959 return target_configure(&goi
, target
);
4962 static int jim_target_mem2array(Jim_Interp
*interp
,
4963 int argc
, Jim_Obj
*const *argv
)
4965 struct target
*target
= Jim_CmdPrivData(interp
);
4966 return target_mem2array(interp
, target
, argc
- 1, argv
+ 1);
4969 static int jim_target_array2mem(Jim_Interp
*interp
,
4970 int argc
, Jim_Obj
*const *argv
)
4972 struct target
*target
= Jim_CmdPrivData(interp
);
4973 return target_array2mem(interp
, target
, argc
- 1, argv
+ 1);
4976 static int jim_target_tap_disabled(Jim_Interp
*interp
)
4978 Jim_SetResultFormatted(interp
, "[TAP is disabled]");
4982 static int jim_target_examine(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
4984 bool allow_defer
= false;
4987 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
4989 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
4990 Jim_SetResultFormatted(goi
.interp
,
4991 "usage: %s ['allow-defer']", cmd_name
);
4995 strcmp(Jim_GetString(argv
[1], NULL
), "allow-defer") == 0) {
4997 struct Jim_Obj
*obj
;
4998 int e
= Jim_GetOpt_Obj(&goi
, &obj
);
5004 struct target
*target
= Jim_CmdPrivData(interp
);
5005 if (!target
->tap
->enabled
)
5006 return jim_target_tap_disabled(interp
);
5008 if (allow_defer
&& target
->defer_examine
) {
5009 LOG_INFO("Deferring arp_examine of %s", target_name(target
));
5010 LOG_INFO("Use arp_examine command to examine it manually!");
5014 int e
= target
->type
->examine(target
);
5020 static int jim_target_was_examined(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5022 struct target
*target
= Jim_CmdPrivData(interp
);
5024 Jim_SetResultBool(interp
, target_was_examined(target
));
5028 static int jim_target_examine_deferred(Jim_Interp
*interp
, int argc
, Jim_Obj
* const *argv
)
5030 struct target
*target
= Jim_CmdPrivData(interp
);
5032 Jim_SetResultBool(interp
, target
->defer_examine
);
5036 static int jim_target_halt_gdb(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5039 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5042 struct target
*target
= Jim_CmdPrivData(interp
);
5044 if (target_call_event_callbacks(target
, TARGET_EVENT_GDB_HALT
) != ERROR_OK
)
5050 static int jim_target_poll(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5053 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5056 struct target
*target
= Jim_CmdPrivData(interp
);
5057 if (!target
->tap
->enabled
)
5058 return jim_target_tap_disabled(interp
);
5061 if (!(target_was_examined(target
)))
5062 e
= ERROR_TARGET_NOT_EXAMINED
;
5064 e
= target
->type
->poll(target
);
5070 static int jim_target_reset(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5073 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5075 if (goi
.argc
!= 2) {
5076 Jim_WrongNumArgs(interp
, 0, argv
,
5077 "([tT]|[fF]|assert|deassert) BOOL");
5082 int e
= Jim_GetOpt_Nvp(&goi
, nvp_assert
, &n
);
5084 Jim_GetOpt_NvpUnknown(&goi
, nvp_assert
, 1);
5087 /* the halt or not param */
5089 e
= Jim_GetOpt_Wide(&goi
, &a
);
5093 struct target
*target
= Jim_CmdPrivData(goi
.interp
);
5094 if (!target
->tap
->enabled
)
5095 return jim_target_tap_disabled(interp
);
5097 if (!target
->type
->assert_reset
|| !target
->type
->deassert_reset
) {
5098 Jim_SetResultFormatted(interp
,
5099 "No target-specific reset for %s",
5100 target_name(target
));
5104 if (target
->defer_examine
)
5105 target_reset_examined(target
);
5107 /* determine if we should halt or not. */
5108 target
->reset_halt
= !!a
;
5109 /* When this happens - all workareas are invalid. */
5110 target_free_all_working_areas_restore(target
, 0);
5113 if (n
->value
== NVP_ASSERT
)
5114 e
= target
->type
->assert_reset(target
);
5116 e
= target
->type
->deassert_reset(target
);
5117 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5120 static int jim_target_halt(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5123 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5126 struct target
*target
= Jim_CmdPrivData(interp
);
5127 if (!target
->tap
->enabled
)
5128 return jim_target_tap_disabled(interp
);
5129 int e
= target
->type
->halt(target
);
5130 return (e
== ERROR_OK
) ? JIM_OK
: JIM_ERR
;
5133 static int jim_target_wait_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5136 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5138 /* params: <name> statename timeoutmsecs */
5139 if (goi
.argc
!= 2) {
5140 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5141 Jim_SetResultFormatted(goi
.interp
,
5142 "%s <state_name> <timeout_in_msec>", cmd_name
);
5147 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_state
, &n
);
5149 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_state
, 1);
5153 e
= Jim_GetOpt_Wide(&goi
, &a
);
5156 struct target
*target
= Jim_CmdPrivData(interp
);
5157 if (!target
->tap
->enabled
)
5158 return jim_target_tap_disabled(interp
);
5160 e
= target_wait_state(target
, n
->value
, a
);
5161 if (e
!= ERROR_OK
) {
5162 Jim_Obj
*eObj
= Jim_NewIntObj(interp
, e
);
5163 Jim_SetResultFormatted(goi
.interp
,
5164 "target: %s wait %s fails (%#s) %s",
5165 target_name(target
), n
->name
,
5166 eObj
, target_strerror_safe(e
));
5167 Jim_FreeNewObj(interp
, eObj
);
5172 /* List for human, Events defined for this target.
5173 * scripts/programs should use 'name cget -event NAME'
5175 COMMAND_HANDLER(handle_target_event_list
)
5177 struct target
*target
= get_current_target(CMD_CTX
);
5178 struct target_event_action
*teap
= target
->event_action
;
5180 command_print(CMD
, "Event actions for target (%d) %s\n",
5181 target
->target_number
,
5182 target_name(target
));
5183 command_print(CMD
, "%-25s | Body", "Event");
5184 command_print(CMD
, "------------------------- | "
5185 "----------------------------------------");
5187 Jim_Nvp
*opt
= Jim_Nvp_value2name_simple(nvp_target_event
, teap
->event
);
5188 command_print(CMD
, "%-25s | %s",
5189 opt
->name
, Jim_GetString(teap
->body
, NULL
));
5192 command_print(CMD
, "***END***");
5195 static int jim_target_current_state(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5198 Jim_WrongNumArgs(interp
, 1, argv
, "[no parameters]");
5201 struct target
*target
= Jim_CmdPrivData(interp
);
5202 Jim_SetResultString(interp
, target_state_name(target
), -1);
5205 static int jim_target_invoke_event(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5208 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5209 if (goi
.argc
!= 1) {
5210 const char *cmd_name
= Jim_GetString(argv
[0], NULL
);
5211 Jim_SetResultFormatted(goi
.interp
, "%s <eventname>", cmd_name
);
5215 int e
= Jim_GetOpt_Nvp(&goi
, nvp_target_event
, &n
);
5217 Jim_GetOpt_NvpUnknown(&goi
, nvp_target_event
, 1);
5220 struct target
*target
= Jim_CmdPrivData(interp
);
5221 target_handle_event(target
, n
->value
);
5225 static const struct command_registration target_instance_command_handlers
[] = {
5227 .name
= "configure",
5228 .mode
= COMMAND_ANY
,
5229 .jim_handler
= jim_target_configure
,
5230 .help
= "configure a new target for use",
5231 .usage
= "[target_attribute ...]",
5235 .mode
= COMMAND_ANY
,
5236 .jim_handler
= jim_target_configure
,
5237 .help
= "returns the specified target attribute",
5238 .usage
= "target_attribute",
5242 .handler
= handle_mw_command
,
5243 .mode
= COMMAND_EXEC
,
5244 .help
= "Write 64-bit word(s) to target memory",
5245 .usage
= "address data [count]",
5249 .handler
= handle_mw_command
,
5250 .mode
= COMMAND_EXEC
,
5251 .help
= "Write 32-bit word(s) to target memory",
5252 .usage
= "address data [count]",
5256 .handler
= handle_mw_command
,
5257 .mode
= COMMAND_EXEC
,
5258 .help
= "Write 16-bit half-word(s) to target memory",
5259 .usage
= "address data [count]",
5263 .handler
= handle_mw_command
,
5264 .mode
= COMMAND_EXEC
,
5265 .help
= "Write byte(s) to target memory",
5266 .usage
= "address data [count]",
5270 .handler
= handle_md_command
,
5271 .mode
= COMMAND_EXEC
,
5272 .help
= "Display target memory as 64-bit words",
5273 .usage
= "address [count]",
5277 .handler
= handle_md_command
,
5278 .mode
= COMMAND_EXEC
,
5279 .help
= "Display target memory as 32-bit words",
5280 .usage
= "address [count]",
5284 .handler
= handle_md_command
,
5285 .mode
= COMMAND_EXEC
,
5286 .help
= "Display target memory as 16-bit half-words",
5287 .usage
= "address [count]",
5291 .handler
= handle_md_command
,
5292 .mode
= COMMAND_EXEC
,
5293 .help
= "Display target memory as 8-bit bytes",
5294 .usage
= "address [count]",
5297 .name
= "array2mem",
5298 .mode
= COMMAND_EXEC
,
5299 .jim_handler
= jim_target_array2mem
,
5300 .help
= "Writes Tcl array of 8/16/32 bit numbers "
5302 .usage
= "arrayname bitwidth address count",
5305 .name
= "mem2array",
5306 .mode
= COMMAND_EXEC
,
5307 .jim_handler
= jim_target_mem2array
,
5308 .help
= "Loads Tcl array of 8/16/32 bit numbers "
5309 "from target memory",
5310 .usage
= "arrayname bitwidth address count",
5313 .name
= "eventlist",
5314 .handler
= handle_target_event_list
,
5315 .mode
= COMMAND_EXEC
,
5316 .help
= "displays a table of events defined for this target",
5321 .mode
= COMMAND_EXEC
,
5322 .jim_handler
= jim_target_current_state
,
5323 .help
= "displays the current state of this target",
5326 .name
= "arp_examine",
5327 .mode
= COMMAND_EXEC
,
5328 .jim_handler
= jim_target_examine
,
5329 .help
= "used internally for reset processing",
5330 .usage
= "['allow-defer']",
5333 .name
= "was_examined",
5334 .mode
= COMMAND_EXEC
,
5335 .jim_handler
= jim_target_was_examined
,
5336 .help
= "used internally for reset processing",
5339 .name
= "examine_deferred",
5340 .mode
= COMMAND_EXEC
,
5341 .jim_handler
= jim_target_examine_deferred
,
5342 .help
= "used internally for reset processing",
5345 .name
= "arp_halt_gdb",
5346 .mode
= COMMAND_EXEC
,
5347 .jim_handler
= jim_target_halt_gdb
,
5348 .help
= "used internally for reset processing to halt GDB",
5352 .mode
= COMMAND_EXEC
,
5353 .jim_handler
= jim_target_poll
,
5354 .help
= "used internally for reset processing",
5357 .name
= "arp_reset",
5358 .mode
= COMMAND_EXEC
,
5359 .jim_handler
= jim_target_reset
,
5360 .help
= "used internally for reset processing",
5364 .mode
= COMMAND_EXEC
,
5365 .jim_handler
= jim_target_halt
,
5366 .help
= "used internally for reset processing",
5369 .name
= "arp_waitstate",
5370 .mode
= COMMAND_EXEC
,
5371 .jim_handler
= jim_target_wait_state
,
5372 .help
= "used internally for reset processing",
5375 .name
= "invoke-event",
5376 .mode
= COMMAND_EXEC
,
5377 .jim_handler
= jim_target_invoke_event
,
5378 .help
= "invoke handler for specified event",
5379 .usage
= "event_name",
5381 COMMAND_REGISTRATION_DONE
5384 static int target_create(Jim_GetOptInfo
*goi
)
5391 struct target
*target
;
5392 struct command_context
*cmd_ctx
;
5394 cmd_ctx
= current_command_context(goi
->interp
);
5395 assert(cmd_ctx
!= NULL
);
5397 if (goi
->argc
< 3) {
5398 Jim_WrongNumArgs(goi
->interp
, 1, goi
->argv
, "?name? ?type? ..options...");
5403 Jim_GetOpt_Obj(goi
, &new_cmd
);
5404 /* does this command exist? */
5405 cmd
= Jim_GetCommand(goi
->interp
, new_cmd
, JIM_ERRMSG
);
5407 cp
= Jim_GetString(new_cmd
, NULL
);
5408 Jim_SetResultFormatted(goi
->interp
, "Command/target: %s Exists", cp
);
5413 e
= Jim_GetOpt_String(goi
, &cp
, NULL
);
5416 struct transport
*tr
= get_current_transport();
5417 if (tr
->override_target
) {
5418 e
= tr
->override_target(&cp
);
5419 if (e
!= ERROR_OK
) {
5420 LOG_ERROR("The selected transport doesn't support this target");
5423 LOG_INFO("The selected transport took over low-level target control. The results might differ compared to plain JTAG/SWD");
5425 /* now does target type exist */
5426 for (x
= 0 ; target_types
[x
] ; x
++) {
5427 if (0 == strcmp(cp
, target_types
[x
]->name
)) {
5432 /* check for deprecated name */
5433 if (target_types
[x
]->deprecated_name
) {
5434 if (0 == strcmp(cp
, target_types
[x
]->deprecated_name
)) {
5436 LOG_WARNING("target name is deprecated use: \'%s\'", target_types
[x
]->name
);
5441 if (target_types
[x
] == NULL
) {
5442 Jim_SetResultFormatted(goi
->interp
, "Unknown target type %s, try one of ", cp
);
5443 for (x
= 0 ; target_types
[x
] ; x
++) {
5444 if (target_types
[x
+ 1]) {
5445 Jim_AppendStrings(goi
->interp
,
5446 Jim_GetResult(goi
->interp
),
5447 target_types
[x
]->name
,
5450 Jim_AppendStrings(goi
->interp
,
5451 Jim_GetResult(goi
->interp
),
5453 target_types
[x
]->name
, NULL
);
5460 target
= calloc(1, sizeof(struct target
));
5461 /* set target number */
5462 target
->target_number
= new_target_number();
5463 cmd_ctx
->current_target
= target
;
5465 /* allocate memory for each unique target type */
5466 target
->type
= calloc(1, sizeof(struct target_type
));
5468 memcpy(target
->type
, target_types
[x
], sizeof(struct target_type
));
5470 /* will be set by "-endian" */
5471 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5473 /* default to first core, override with -coreid */
5476 target
->working_area
= 0x0;
5477 target
->working_area_size
= 0x0;
5478 target
->working_areas
= NULL
;
5479 target
->backup_working_area
= 0;
5481 target
->state
= TARGET_UNKNOWN
;
5482 target
->debug_reason
= DBG_REASON_UNDEFINED
;
5483 target
->reg_cache
= NULL
;
5484 target
->breakpoints
= NULL
;
5485 target
->watchpoints
= NULL
;
5486 target
->next
= NULL
;
5487 target
->arch_info
= NULL
;
5489 target
->verbose_halt_msg
= true;
5491 target
->halt_issued
= false;
5493 /* initialize trace information */
5494 target
->trace_info
= calloc(1, sizeof(struct trace
));
5496 target
->dbgmsg
= NULL
;
5497 target
->dbg_msg_enabled
= 0;
5499 target
->endianness
= TARGET_ENDIAN_UNKNOWN
;
5501 target
->rtos
= NULL
;
5502 target
->rtos_auto_detect
= false;
5504 target
->gdb_port_override
= NULL
;
5506 /* Do the rest as "configure" options */
5507 goi
->isconfigure
= 1;
5508 e
= target_configure(goi
, target
);
5511 if (target
->has_dap
) {
5512 if (!target
->dap_configured
) {
5513 Jim_SetResultString(goi
->interp
, "-dap ?name? required when creating target", -1);
5517 if (!target
->tap_configured
) {
5518 Jim_SetResultString(goi
->interp
, "-chain-position ?name? required when creating target", -1);
5522 /* tap must be set after target was configured */
5523 if (target
->tap
== NULL
)
5528 free(target
->gdb_port_override
);
5534 if (target
->endianness
== TARGET_ENDIAN_UNKNOWN
) {
5535 /* default endian to little if not specified */
5536 target
->endianness
= TARGET_LITTLE_ENDIAN
;
5539 cp
= Jim_GetString(new_cmd
, NULL
);
5540 target
->cmd_name
= strdup(cp
);
5542 if (target
->type
->target_create
) {
5543 e
= (*(target
->type
->target_create
))(target
, goi
->interp
);
5544 if (e
!= ERROR_OK
) {
5545 LOG_DEBUG("target_create failed");
5546 free(target
->gdb_port_override
);
5548 free(target
->cmd_name
);
5554 /* create the target specific commands */
5555 if (target
->type
->commands
) {
5556 e
= register_commands(cmd_ctx
, NULL
, target
->type
->commands
);
5558 LOG_ERROR("unable to register '%s' commands", cp
);
5561 /* append to end of list */
5563 struct target
**tpp
;
5564 tpp
= &(all_targets
);
5566 tpp
= &((*tpp
)->next
);
5570 /* now - create the new target name command */
5571 const struct command_registration target_subcommands
[] = {
5573 .chain
= target_instance_command_handlers
,
5576 .chain
= target
->type
->commands
,
5578 COMMAND_REGISTRATION_DONE
5580 const struct command_registration target_commands
[] = {
5583 .mode
= COMMAND_ANY
,
5584 .help
= "target command group",
5586 .chain
= target_subcommands
,
5588 COMMAND_REGISTRATION_DONE
5590 e
= register_commands(cmd_ctx
, NULL
, target_commands
);
5594 struct command
*c
= command_find_in_context(cmd_ctx
, cp
);
5596 command_set_handler_data(c
, target
);
5598 return (ERROR_OK
== e
) ? JIM_OK
: JIM_ERR
;
5601 static int jim_target_current(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5604 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5607 struct command_context
*cmd_ctx
= current_command_context(interp
);
5608 assert(cmd_ctx
!= NULL
);
5610 Jim_SetResultString(interp
, target_name(get_current_target(cmd_ctx
)), -1);
5614 static int jim_target_types(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5617 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5620 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5621 for (unsigned x
= 0; NULL
!= target_types
[x
]; x
++) {
5622 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5623 Jim_NewStringObj(interp
, target_types
[x
]->name
, -1));
5628 static int jim_target_names(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5631 Jim_WrongNumArgs(interp
, 1, argv
, "Too many parameters");
5634 Jim_SetResult(interp
, Jim_NewListObj(interp
, NULL
, 0));
5635 struct target
*target
= all_targets
;
5637 Jim_ListAppendElement(interp
, Jim_GetResult(interp
),
5638 Jim_NewStringObj(interp
, target_name(target
), -1));
5639 target
= target
->next
;
5644 static int jim_target_smp(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5647 const char *targetname
;
5649 struct target
*target
= (struct target
*) NULL
;
5650 struct target_list
*head
, *curr
, *new;
5651 curr
= (struct target_list
*) NULL
;
5652 head
= (struct target_list
*) NULL
;
5655 LOG_DEBUG("%d", argc
);
5656 /* argv[1] = target to associate in smp
5657 * argv[2] = target to assoicate in smp
5661 for (i
= 1; i
< argc
; i
++) {
5663 targetname
= Jim_GetString(argv
[i
], &len
);
5664 target
= get_target(targetname
);
5665 LOG_DEBUG("%s ", targetname
);
5667 new = malloc(sizeof(struct target_list
));
5668 new->target
= target
;
5669 new->next
= (struct target_list
*)NULL
;
5670 if (head
== (struct target_list
*)NULL
) {
5679 /* now parse the list of cpu and put the target in smp mode*/
5682 while (curr
!= (struct target_list
*)NULL
) {
5683 target
= curr
->target
;
5685 target
->head
= head
;
5689 if (target
&& target
->rtos
)
5690 retval
= rtos_smp_init(head
->target
);
5696 static int jim_target_create(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
5699 Jim_GetOpt_Setup(&goi
, interp
, argc
- 1, argv
+ 1);
5701 Jim_WrongNumArgs(goi
.interp
, goi
.argc
, goi
.argv
,
5702 "<name> <target_type> [<target_options> ...]");
5705 return target_create(&goi
);
5708 static const struct command_registration target_subcommand_handlers
[] = {
5711 .mode
= COMMAND_CONFIG
,
5712 .handler
= handle_target_init_command
,
5713 .help
= "initialize targets",
5718 .mode
= COMMAND_CONFIG
,
5719 .jim_handler
= jim_target_create
,
5720 .usage
= "name type '-chain-position' name [options ...]",
5721 .help
= "Creates and selects a new target",
5725 .mode
= COMMAND_ANY
,
5726 .jim_handler
= jim_target_current
,
5727 .help
= "Returns the currently selected target",
5731 .mode
= COMMAND_ANY
,
5732 .jim_handler
= jim_target_types
,
5733 .help
= "Returns the available target types as "
5734 "a list of strings",
5738 .mode
= COMMAND_ANY
,
5739 .jim_handler
= jim_target_names
,
5740 .help
= "Returns the names of all targets as a list of strings",
5744 .mode
= COMMAND_ANY
,
5745 .jim_handler
= jim_target_smp
,
5746 .usage
= "targetname1 targetname2 ...",
5747 .help
= "gather several target in a smp list"
5750 COMMAND_REGISTRATION_DONE
5754 target_addr_t address
;
5760 static int fastload_num
;
5761 static struct FastLoad
*fastload
;
5763 static void free_fastload(void)
5765 if (fastload
!= NULL
) {
5767 for (i
= 0; i
< fastload_num
; i
++) {
5768 if (fastload
[i
].data
)
5769 free(fastload
[i
].data
);
5776 COMMAND_HANDLER(handle_fast_load_image_command
)
5780 uint32_t image_size
;
5781 target_addr_t min_address
= 0;
5782 target_addr_t max_address
= -1;
5787 int retval
= CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV
,
5788 &image
, &min_address
, &max_address
);
5789 if (ERROR_OK
!= retval
)
5792 struct duration bench
;
5793 duration_start(&bench
);
5795 retval
= image_open(&image
, CMD_ARGV
[0], (CMD_ARGC
>= 3) ? CMD_ARGV
[2] : NULL
);
5796 if (retval
!= ERROR_OK
)
5801 fastload_num
= image
.num_sections
;
5802 fastload
= malloc(sizeof(struct FastLoad
)*image
.num_sections
);
5803 if (fastload
== NULL
) {
5804 command_print(CMD
, "out of memory");
5805 image_close(&image
);
5808 memset(fastload
, 0, sizeof(struct FastLoad
)*image
.num_sections
);
5809 for (i
= 0; i
< image
.num_sections
; i
++) {
5810 buffer
= malloc(image
.sections
[i
].size
);
5811 if (buffer
== NULL
) {
5812 command_print(CMD
, "error allocating buffer for section (%d bytes)",
5813 (int)(image
.sections
[i
].size
));
5814 retval
= ERROR_FAIL
;
5818 retval
= image_read_section(&image
, i
, 0x0, image
.sections
[i
].size
, buffer
, &buf_cnt
);
5819 if (retval
!= ERROR_OK
) {
5824 uint32_t offset
= 0;
5825 uint32_t length
= buf_cnt
;
5827 /* DANGER!!! beware of unsigned comparision here!!! */
5829 if ((image
.sections
[i
].base_address
+ buf_cnt
>= min_address
) &&
5830 (image
.sections
[i
].base_address
< max_address
)) {
5831 if (image
.sections
[i
].base_address
< min_address
) {
5832 /* clip addresses below */
5833 offset
+= min_address
-image
.sections
[i
].base_address
;
5837 if (image
.sections
[i
].base_address
+ buf_cnt
> max_address
)
5838 length
-= (image
.sections
[i
].base_address
+ buf_cnt
)-max_address
;
5840 fastload
[i
].address
= image
.sections
[i
].base_address
+ offset
;
5841 fastload
[i
].data
= malloc(length
);
5842 if (fastload
[i
].data
== NULL
) {
5844 command_print(CMD
, "error allocating buffer for section (%" PRIu32
" bytes)",
5846 retval
= ERROR_FAIL
;
5849 memcpy(fastload
[i
].data
, buffer
+ offset
, length
);
5850 fastload
[i
].length
= length
;
5852 image_size
+= length
;
5853 command_print(CMD
, "%u bytes written at address 0x%8.8x",
5854 (unsigned int)length
,
5855 ((unsigned int)(image
.sections
[i
].base_address
+ offset
)));
5861 if ((ERROR_OK
== retval
) && (duration_measure(&bench
) == ERROR_OK
)) {
5862 command_print(CMD
, "Loaded %" PRIu32
" bytes "
5863 "in %fs (%0.3f KiB/s)", image_size
,
5864 duration_elapsed(&bench
), duration_kbps(&bench
, image_size
));
5867 "WARNING: image has not been loaded to target!"
5868 "You can issue a 'fast_load' to finish loading.");
5871 image_close(&image
);
5873 if (retval
!= ERROR_OK
)
5879 COMMAND_HANDLER(handle_fast_load_command
)
5882 return ERROR_COMMAND_SYNTAX_ERROR
;
5883 if (fastload
== NULL
) {
5884 LOG_ERROR("No image in memory");
5888 int64_t ms
= timeval_ms();
5890 int retval
= ERROR_OK
;
5891 for (i
= 0; i
< fastload_num
; i
++) {
5892 struct target
*target
= get_current_target(CMD_CTX
);
5893 command_print(CMD
, "Write to 0x%08x, length 0x%08x",
5894 (unsigned int)(fastload
[i
].address
),
5895 (unsigned int)(fastload
[i
].length
));
5896 retval
= target_write_buffer(target
, fastload
[i
].address
, fastload
[i
].length
, fastload
[i
].data
);
5897 if (retval
!= ERROR_OK
)
5899 size
+= fastload
[i
].length
;
5901 if (retval
== ERROR_OK
) {
5902 int64_t after
= timeval_ms();
5903 command_print(CMD
, "Loaded image %f kBytes/s", (float)(size
/1024.0)/((float)(after
-ms
)/1000.0));
5908 static const struct command_registration target_command_handlers
[] = {
5911 .handler
= handle_targets_command
,
5912 .mode
= COMMAND_ANY
,
5913 .help
= "change current default target (one parameter) "
5914 "or prints table of all targets (no parameters)",
5915 .usage
= "[target]",
5919 .mode
= COMMAND_CONFIG
,
5920 .help
= "configure target",
5921 .chain
= target_subcommand_handlers
,
5924 COMMAND_REGISTRATION_DONE
5927 int target_register_commands(struct command_context
*cmd_ctx
)
5929 return register_commands(cmd_ctx
, NULL
, target_command_handlers
);
5932 static bool target_reset_nag
= true;
5934 bool get_target_reset_nag(void)
5936 return target_reset_nag
;
5939 COMMAND_HANDLER(handle_target_reset_nag
)
5941 return CALL_COMMAND_HANDLER(handle_command_parse_bool
,
5942 &target_reset_nag
, "Nag after each reset about options to improve "
5946 COMMAND_HANDLER(handle_ps_command
)
5948 struct target
*target
= get_current_target(CMD_CTX
);
5950 if (target
->state
!= TARGET_HALTED
) {
5951 LOG_INFO("target not halted !!");
5955 if ((target
->rtos
) && (target
->rtos
->type
)
5956 && (target
->rtos
->type
->ps_command
)) {
5957 display
= target
->rtos
->type
->ps_command(target
);
5958 command_print(CMD
, "%s", display
);
5963 return ERROR_TARGET_FAILURE
;
5967 static void binprint(struct command_invocation
*cmd
, const char *text
, const uint8_t *buf
, int size
)
5970 command_print_sameline(cmd
, "%s", text
);
5971 for (int i
= 0; i
< size
; i
++)
5972 command_print_sameline(cmd
, " %02x", buf
[i
]);
5973 command_print(cmd
, " ");
5976 COMMAND_HANDLER(handle_test_mem_access_command
)
5978 struct target
*target
= get_current_target(CMD_CTX
);
5980 int retval
= ERROR_OK
;
5982 if (target
->state
!= TARGET_HALTED
) {
5983 LOG_INFO("target not halted !!");
5988 return ERROR_COMMAND_SYNTAX_ERROR
;
5990 COMMAND_PARSE_NUMBER(u32
, CMD_ARGV
[0], test_size
);
5993 size_t num_bytes
= test_size
+ 4;
5995 struct working_area
*wa
= NULL
;
5996 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
5997 if (retval
!= ERROR_OK
) {
5998 LOG_ERROR("Not enough working area");
6002 uint8_t *test_pattern
= malloc(num_bytes
);
6004 for (size_t i
= 0; i
< num_bytes
; i
++)
6005 test_pattern
[i
] = rand();
6007 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6008 if (retval
!= ERROR_OK
) {
6009 LOG_ERROR("Test pattern write failed");
6013 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6014 for (int size
= 1; size
<= 4; size
*= 2) {
6015 for (int offset
= 0; offset
< 4; offset
++) {
6016 uint32_t count
= test_size
/ size
;
6017 size_t host_bufsiz
= (count
+ 2) * size
+ host_offset
;
6018 uint8_t *read_ref
= malloc(host_bufsiz
);
6019 uint8_t *read_buf
= malloc(host_bufsiz
);
6021 for (size_t i
= 0; i
< host_bufsiz
; i
++) {
6022 read_ref
[i
] = rand();
6023 read_buf
[i
] = read_ref
[i
];
6025 command_print_sameline(CMD
,
6026 "Test read %" PRIu32
" x %d @ %d to %saligned buffer: ", count
,
6027 size
, offset
, host_offset
? "un" : "");
6029 struct duration bench
;
6030 duration_start(&bench
);
6032 retval
= target_read_memory(target
, wa
->address
+ offset
, size
, count
,
6033 read_buf
+ size
+ host_offset
);
6035 duration_measure(&bench
);
6037 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6038 command_print(CMD
, "Unsupported alignment");
6040 } else if (retval
!= ERROR_OK
) {
6041 command_print(CMD
, "Memory read failed");
6045 /* replay on host */
6046 memcpy(read_ref
+ size
+ host_offset
, test_pattern
+ offset
, count
* size
);
6049 int result
= memcmp(read_ref
, read_buf
, host_bufsiz
);
6051 command_print(CMD
, "Pass in %fs (%0.3f KiB/s)",
6052 duration_elapsed(&bench
),
6053 duration_kbps(&bench
, count
* size
));
6055 command_print(CMD
, "Compare failed");
6056 binprint(CMD
, "ref:", read_ref
, host_bufsiz
);
6057 binprint(CMD
, "buf:", read_buf
, host_bufsiz
);
6070 target_free_working_area(target
, wa
);
6073 num_bytes
= test_size
+ 4 + 4 + 4;
6075 retval
= target_alloc_working_area(target
, num_bytes
, &wa
);
6076 if (retval
!= ERROR_OK
) {
6077 LOG_ERROR("Not enough working area");
6081 test_pattern
= malloc(num_bytes
);
6083 for (size_t i
= 0; i
< num_bytes
; i
++)
6084 test_pattern
[i
] = rand();
6086 for (int host_offset
= 0; host_offset
<= 1; host_offset
++) {
6087 for (int size
= 1; size
<= 4; size
*= 2) {
6088 for (int offset
= 0; offset
< 4; offset
++) {
6089 uint32_t count
= test_size
/ size
;
6090 size_t host_bufsiz
= count
* size
+ host_offset
;
6091 uint8_t *read_ref
= malloc(num_bytes
);
6092 uint8_t *read_buf
= malloc(num_bytes
);
6093 uint8_t *write_buf
= malloc(host_bufsiz
);
6095 for (size_t i
= 0; i
< host_bufsiz
; i
++)
6096 write_buf
[i
] = rand();
6097 command_print_sameline(CMD
,
6098 "Test write %" PRIu32
" x %d @ %d from %saligned buffer: ", count
,
6099 size
, offset
, host_offset
? "un" : "");
6101 retval
= target_write_memory(target
, wa
->address
, 1, num_bytes
, test_pattern
);
6102 if (retval
!= ERROR_OK
) {
6103 command_print(CMD
, "Test pattern write failed");
6107 /* replay on host */
6108 memcpy(read_ref
, test_pattern
, num_bytes
);
6109 memcpy(read_ref
+ size
+ offset
, write_buf
+ host_offset
, count
* size
);
6111 struct duration bench
;
6112 duration_start(&bench
);
6114 retval
= target_write_memory(target
, wa
->address
+ size
+ offset
, size
, count
,
6115 write_buf
+ host_offset
);
6117 duration_measure(&bench
);
6119 if (retval
== ERROR_TARGET_UNALIGNED_ACCESS
) {
6120 command_print(CMD
, "Unsupported alignment");
6122 } else if (retval
!= ERROR_OK
) {
6123 command_print(CMD
, "Memory write failed");
6128 retval
= target_read_memory(target
, wa
->address
, 1, num_bytes
, read_buf
);
6129 if (retval
!= ERROR_OK
) {
6130 command_print(CMD
, "Test pattern write failed");
6135 int result
= memcmp(read_ref
, read_buf
, num_bytes
);
6137 command_print(CMD
, "Pass in %fs (%0.3f KiB/s)",
6138 duration_elapsed(&bench
),
6139 duration_kbps(&bench
, count
* size
));
6141 command_print(CMD
, "Compare failed");
6142 binprint(CMD
, "ref:", read_ref
, num_bytes
);
6143 binprint(CMD
, "buf:", read_buf
, num_bytes
);
6155 target_free_working_area(target
, wa
);
6159 static const struct command_registration target_exec_command_handlers
[] = {
6161 .name
= "fast_load_image",
6162 .handler
= handle_fast_load_image_command
,
6163 .mode
= COMMAND_ANY
,
6164 .help
= "Load image into server memory for later use by "
6165 "fast_load; primarily for profiling",
6166 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6167 "[min_address [max_length]]",
6170 .name
= "fast_load",
6171 .handler
= handle_fast_load_command
,
6172 .mode
= COMMAND_EXEC
,
6173 .help
= "loads active fast load image to current target "
6174 "- mainly for profiling purposes",
6179 .handler
= handle_profile_command
,
6180 .mode
= COMMAND_EXEC
,
6181 .usage
= "seconds filename [start end]",
6182 .help
= "profiling samples the CPU PC",
6184 /** @todo don't register virt2phys() unless target supports it */
6186 .name
= "virt2phys",
6187 .handler
= handle_virt2phys_command
,
6188 .mode
= COMMAND_ANY
,
6189 .help
= "translate a virtual address into a physical address",
6190 .usage
= "virtual_address",
6194 .handler
= handle_reg_command
,
6195 .mode
= COMMAND_EXEC
,
6196 .help
= "display (reread from target with \"force\") or set a register; "
6197 "with no arguments, displays all registers and their values",
6198 .usage
= "[(register_number|register_name) [(value|'force')]]",
6202 .handler
= handle_poll_command
,
6203 .mode
= COMMAND_EXEC
,
6204 .help
= "poll target state; or reconfigure background polling",
6205 .usage
= "['on'|'off']",
6208 .name
= "wait_halt",
6209 .handler
= handle_wait_halt_command
,
6210 .mode
= COMMAND_EXEC
,
6211 .help
= "wait up to the specified number of milliseconds "
6212 "(default 5000) for a previously requested halt",
6213 .usage
= "[milliseconds]",
6217 .handler
= handle_halt_command
,
6218 .mode
= COMMAND_EXEC
,
6219 .help
= "request target to halt, then wait up to the specified"
6220 "number of milliseconds (default 5000) for it to complete",
6221 .usage
= "[milliseconds]",
6225 .handler
= handle_resume_command
,
6226 .mode
= COMMAND_EXEC
,
6227 .help
= "resume target execution from current PC or address",
6228 .usage
= "[address]",
6232 .handler
= handle_reset_command
,
6233 .mode
= COMMAND_EXEC
,
6234 .usage
= "[run|halt|init]",
6235 .help
= "Reset all targets into the specified mode."
6236 "Default reset mode is run, if not given.",
6239 .name
= "soft_reset_halt",
6240 .handler
= handle_soft_reset_halt_command
,
6241 .mode
= COMMAND_EXEC
,
6243 .help
= "halt the target and do a soft reset",
6247 .handler
= handle_step_command
,
6248 .mode
= COMMAND_EXEC
,
6249 .help
= "step one instruction from current PC or address",
6250 .usage
= "[address]",
6254 .handler
= handle_md_command
,
6255 .mode
= COMMAND_EXEC
,
6256 .help
= "display memory double-words",
6257 .usage
= "['phys'] address [count]",
6261 .handler
= handle_md_command
,
6262 .mode
= COMMAND_EXEC
,
6263 .help
= "display memory words",
6264 .usage
= "['phys'] address [count]",
6268 .handler
= handle_md_command
,
6269 .mode
= COMMAND_EXEC
,
6270 .help
= "display memory half-words",
6271 .usage
= "['phys'] address [count]",
6275 .handler
= handle_md_command
,
6276 .mode
= COMMAND_EXEC
,
6277 .help
= "display memory bytes",
6278 .usage
= "['phys'] address [count]",
6282 .handler
= handle_mw_command
,
6283 .mode
= COMMAND_EXEC
,
6284 .help
= "write memory double-word",
6285 .usage
= "['phys'] address value [count]",
6289 .handler
= handle_mw_command
,
6290 .mode
= COMMAND_EXEC
,
6291 .help
= "write memory word",
6292 .usage
= "['phys'] address value [count]",
6296 .handler
= handle_mw_command
,
6297 .mode
= COMMAND_EXEC
,
6298 .help
= "write memory half-word",
6299 .usage
= "['phys'] address value [count]",
6303 .handler
= handle_mw_command
,
6304 .mode
= COMMAND_EXEC
,
6305 .help
= "write memory byte",
6306 .usage
= "['phys'] address value [count]",
6310 .handler
= handle_bp_command
,
6311 .mode
= COMMAND_EXEC
,
6312 .help
= "list or set hardware or software breakpoint",
6313 .usage
= "[<address> [<asid>] <length> ['hw'|'hw_ctx']]",
6317 .handler
= handle_rbp_command
,
6318 .mode
= COMMAND_EXEC
,
6319 .help
= "remove breakpoint",
6324 .handler
= handle_wp_command
,
6325 .mode
= COMMAND_EXEC
,
6326 .help
= "list (no params) or create watchpoints",
6327 .usage
= "[address length [('r'|'w'|'a') value [mask]]]",
6331 .handler
= handle_rwp_command
,
6332 .mode
= COMMAND_EXEC
,
6333 .help
= "remove watchpoint",
6337 .name
= "load_image",
6338 .handler
= handle_load_image_command
,
6339 .mode
= COMMAND_EXEC
,
6340 .usage
= "filename address ['bin'|'ihex'|'elf'|'s19'] "
6341 "[min_address] [max_length]",
6344 .name
= "dump_image",
6345 .handler
= handle_dump_image_command
,
6346 .mode
= COMMAND_EXEC
,
6347 .usage
= "filename address size",
6350 .name
= "verify_image_checksum",
6351 .handler
= handle_verify_image_checksum_command
,
6352 .mode
= COMMAND_EXEC
,
6353 .usage
= "filename [offset [type]]",
6356 .name
= "verify_image",
6357 .handler
= handle_verify_image_command
,
6358 .mode
= COMMAND_EXEC
,
6359 .usage
= "filename [offset [type]]",
6362 .name
= "test_image",
6363 .handler
= handle_test_image_command
,
6364 .mode
= COMMAND_EXEC
,
6365 .usage
= "filename [offset [type]]",
6368 .name
= "mem2array",
6369 .mode
= COMMAND_EXEC
,
6370 .jim_handler
= jim_mem2array
,
6371 .help
= "read 8/16/32 bit memory and return as a TCL array "
6372 "for script processing",
6373 .usage
= "arrayname bitwidth address count",
6376 .name
= "array2mem",
6377 .mode
= COMMAND_EXEC
,
6378 .jim_handler
= jim_array2mem
,
6379 .help
= "convert a TCL array to memory locations "
6380 "and write the 8/16/32 bit values",
6381 .usage
= "arrayname bitwidth address count",
6384 .name
= "reset_nag",
6385 .handler
= handle_target_reset_nag
,
6386 .mode
= COMMAND_ANY
,
6387 .help
= "Nag after each reset about options that could have been "
6388 "enabled to improve performance. ",
6389 .usage
= "['enable'|'disable']",
6393 .handler
= handle_ps_command
,
6394 .mode
= COMMAND_EXEC
,
6395 .help
= "list all tasks ",
6399 .name
= "test_mem_access",
6400 .handler
= handle_test_mem_access_command
,
6401 .mode
= COMMAND_EXEC
,
6402 .help
= "Test the target's memory access functions",
6406 COMMAND_REGISTRATION_DONE
6408 static int target_register_user_commands(struct command_context
*cmd_ctx
)
6410 int retval
= ERROR_OK
;
6411 retval
= target_request_register_commands(cmd_ctx
);
6412 if (retval
!= ERROR_OK
)
6415 retval
= trace_register_commands(cmd_ctx
);
6416 if (retval
!= ERROR_OK
)
6420 return register_commands(cmd_ctx
, NULL
, target_exec_command_handlers
);