1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2009 Ø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 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program; if not, write to the *
29 * Free Software Foundation, Inc., *
30 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
31 ***************************************************************************/
37 #include "target_type.h"
38 #include "target_request.h"
39 #include "time_support.h"
46 static int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48 static int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49 static int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 static int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
51 static int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 static int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 static int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 static int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
55 static int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
56 static int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
57 static int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
58 static int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
59 static int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
60 static int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
61 static int handle_test_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
62 static int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
63 static int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
64 static int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
65 static int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
66 static int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc);
67 static int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
68 static int handle_fast_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
69 static int handle_fast_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
71 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
72 static int jim_mcrmrc(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
73 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
74 static int jim_target(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
76 static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
77 static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
80 extern target_type_t arm7tdmi_target;
81 extern target_type_t arm720t_target;
82 extern target_type_t arm9tdmi_target;
83 extern target_type_t arm920t_target;
84 extern target_type_t arm966e_target;
85 extern target_type_t arm926ejs_target;
86 extern target_type_t fa526_target;
87 extern target_type_t feroceon_target;
88 extern target_type_t dragonite_target;
89 extern target_type_t xscale_target;
90 extern target_type_t cortexm3_target;
91 extern target_type_t cortexa8_target;
92 extern target_type_t arm11_target;
93 extern target_type_t mips_m4k_target;
94 extern target_type_t avr_target;
96 target_type_t *target_types[] =
116 target_t *all_targets = NULL;
117 target_event_callback_t *target_event_callbacks = NULL;
118 target_timer_callback_t *target_timer_callbacks = NULL;
120 const Jim_Nvp nvp_assert[] = {
121 { .name = "assert", NVP_ASSERT },
122 { .name = "deassert", NVP_DEASSERT },
123 { .name = "T", NVP_ASSERT },
124 { .name = "F", NVP_DEASSERT },
125 { .name = "t", NVP_ASSERT },
126 { .name = "f", NVP_DEASSERT },
127 { .name = NULL, .value = -1 }
130 const Jim_Nvp nvp_error_target[] = {
131 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
132 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
133 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
134 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
135 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
136 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
137 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
138 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
139 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
140 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
141 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
142 { .value = -1, .name = NULL }
145 const char *target_strerror_safe(int err)
149 n = Jim_Nvp_value2name_simple(nvp_error_target, err);
150 if (n->name == NULL) {
157 static const Jim_Nvp nvp_target_event[] = {
158 { .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
159 { .value = TARGET_EVENT_OLD_pre_resume , .name = "old-pre_resume" },
161 { .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
162 { .value = TARGET_EVENT_HALTED, .name = "halted" },
163 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
164 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
165 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
167 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
168 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
170 /* historical name */
172 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
174 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
175 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
176 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
177 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
178 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
179 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
180 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
181 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
182 { .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
183 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
185 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
186 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
188 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
189 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
191 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
192 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
194 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
195 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
197 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
198 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
200 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
201 { .value = TARGET_EVENT_RESUMED , .name = "resume-ok" },
202 { .value = TARGET_EVENT_RESUME_END , .name = "resume-end" },
204 { .name = NULL, .value = -1 }
207 const Jim_Nvp nvp_target_state[] = {
208 { .name = "unknown", .value = TARGET_UNKNOWN },
209 { .name = "running", .value = TARGET_RUNNING },
210 { .name = "halted", .value = TARGET_HALTED },
211 { .name = "reset", .value = TARGET_RESET },
212 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
213 { .name = NULL, .value = -1 },
216 const Jim_Nvp nvp_target_debug_reason [] = {
217 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
218 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
219 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
220 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
221 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
222 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
223 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
224 { .name = NULL, .value = -1 },
227 const Jim_Nvp nvp_target_endian[] = {
228 { .name = "big", .value = TARGET_BIG_ENDIAN },
229 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
230 { .name = "be", .value = TARGET_BIG_ENDIAN },
231 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
232 { .name = NULL, .value = -1 },
235 const Jim_Nvp nvp_reset_modes[] = {
236 { .name = "unknown", .value = RESET_UNKNOWN },
237 { .name = "run" , .value = RESET_RUN },
238 { .name = "halt" , .value = RESET_HALT },
239 { .name = "init" , .value = RESET_INIT },
240 { .name = NULL , .value = -1 },
244 target_state_name( target_t *t )
247 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
249 LOG_ERROR("Invalid target state: %d", (int)(t->state));
250 cp = "(*BUG*unknown*BUG*)";
255 /* determine the number of the new target */
256 static int new_target_number(void)
261 /* number is 0 based */
265 if (x < t->target_number) {
266 x = t->target_number;
273 /* read a uint32_t from a buffer in target memory endianness */
274 uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer)
276 if (target->endianness == TARGET_LITTLE_ENDIAN)
277 return le_to_h_u32(buffer);
279 return be_to_h_u32(buffer);
282 /* read a uint16_t from a buffer in target memory endianness */
283 uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer)
285 if (target->endianness == TARGET_LITTLE_ENDIAN)
286 return le_to_h_u16(buffer);
288 return be_to_h_u16(buffer);
291 /* read a uint8_t from a buffer in target memory endianness */
292 uint8_t target_buffer_get_u8(target_t *target, const uint8_t *buffer)
294 return *buffer & 0x0ff;
297 /* write a uint32_t to a buffer in target memory endianness */
298 void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value)
300 if (target->endianness == TARGET_LITTLE_ENDIAN)
301 h_u32_to_le(buffer, value);
303 h_u32_to_be(buffer, value);
306 /* write a uint16_t to a buffer in target memory endianness */
307 void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value)
309 if (target->endianness == TARGET_LITTLE_ENDIAN)
310 h_u16_to_le(buffer, value);
312 h_u16_to_be(buffer, value);
315 /* write a uint8_t to a buffer in target memory endianness */
316 void target_buffer_set_u8(target_t *target, uint8_t *buffer, uint8_t value)
321 /* return a pointer to a configured target; id is name or number */
322 target_t *get_target(const char *id)
326 /* try as tcltarget name */
327 for (target = all_targets; target; target = target->next) {
328 if (target->cmd_name == NULL)
330 if (strcmp(id, target->cmd_name) == 0)
334 /* It's OK to remove this fallback sometime after August 2010 or so */
336 /* no match, try as number */
338 if (parse_uint(id, &num) != ERROR_OK)
341 for (target = all_targets; target; target = target->next) {
342 if (target->target_number == (int)num) {
343 LOG_WARNING("use '%s' as target identifier, not '%u'",
344 target->cmd_name, num);
352 /* returns a pointer to the n-th configured target */
353 static target_t *get_target_by_num(int num)
355 target_t *target = all_targets;
358 if (target->target_number == num) {
361 target = target->next;
367 target_t* get_current_target(command_context_t *cmd_ctx)
369 target_t *target = get_target_by_num(cmd_ctx->current_target);
373 LOG_ERROR("BUG: current_target out of bounds");
380 int target_poll(struct target_s *target)
384 /* We can't poll until after examine */
385 if (!target_was_examined(target))
387 /* Fail silently lest we pollute the log */
391 retval = target->type->poll(target);
392 if (retval != ERROR_OK)
395 if (target->halt_issued)
397 if (target->state == TARGET_HALTED)
399 target->halt_issued = false;
402 long long t = timeval_ms() - target->halt_issued_time;
405 target->halt_issued = false;
406 LOG_INFO("Halt timed out, wake up GDB.");
407 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
415 int target_halt(struct target_s *target)
418 /* We can't poll until after examine */
419 if (!target_was_examined(target))
421 LOG_ERROR("Target not examined yet");
425 retval = target->type->halt(target);
426 if (retval != ERROR_OK)
429 target->halt_issued = true;
430 target->halt_issued_time = timeval_ms();
435 int target_resume(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
439 /* We can't poll until after examine */
440 if (!target_was_examined(target))
442 LOG_ERROR("Target not examined yet");
446 /* note that resume *must* be asynchronous. The CPU can halt before we poll. The CPU can
447 * even halt at the current PC as a result of a software breakpoint being inserted by (a bug?)
450 if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
456 int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
461 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
462 if (n->name == NULL) {
463 LOG_ERROR("invalid reset mode");
467 /* disable polling during reset to make reset event scripts
468 * more predictable, i.e. dr/irscan & pathmove in events will
469 * not have JTAG operations injected into the middle of a sequence.
471 bool save_poll = jtag_poll_get_enabled();
473 jtag_poll_set_enabled(false);
475 sprintf(buf, "ocd_process_reset %s", n->name);
476 retval = Jim_Eval(interp, buf);
478 jtag_poll_set_enabled(save_poll);
480 if (retval != JIM_OK) {
481 Jim_PrintErrorMessage(interp);
485 /* We want any events to be processed before the prompt */
486 retval = target_call_timer_callbacks_now();
491 static int default_virt2phys(struct target_s *target, uint32_t virtual, uint32_t *physical)
497 static int default_mmu(struct target_s *target, int *enabled)
499 LOG_ERROR("Not implemented.");
503 static int default_has_mmu(struct target_s *target, bool *has_mmu)
509 static int default_examine(struct target_s *target)
511 target_set_examined(target);
515 int target_examine_one(struct target_s *target)
517 return target->type->examine(target);
520 static int jtag_enable_callback(enum jtag_event event, void *priv)
522 target_t *target = priv;
524 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
527 jtag_unregister_event_callback(jtag_enable_callback, target);
528 return target_examine_one(target);
532 /* Targets that correctly implement init + examine, i.e.
533 * no communication with target during init:
537 int target_examine(void)
539 int retval = ERROR_OK;
542 for (target = all_targets; target; target = target->next)
544 /* defer examination, but don't skip it */
545 if (!target->tap->enabled) {
546 jtag_register_event_callback(jtag_enable_callback,
550 if ((retval = target_examine_one(target)) != ERROR_OK)
555 const char *target_get_name(struct target_s *target)
557 return target->type->name;
560 static int target_write_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
562 if (!target_was_examined(target))
564 LOG_ERROR("Target not examined yet");
567 return target->type->write_memory_imp(target, address, size, count, buffer);
570 static int target_read_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
572 if (!target_was_examined(target))
574 LOG_ERROR("Target not examined yet");
577 return target->type->read_memory_imp(target, address, size, count, buffer);
580 static int target_soft_reset_halt_imp(struct target_s *target)
582 if (!target_was_examined(target))
584 LOG_ERROR("Target not examined yet");
587 if (!target->type->soft_reset_halt_imp) {
588 LOG_ERROR("Target %s does not support soft_reset_halt",
592 return target->type->soft_reset_halt_imp(target);
595 static int target_run_algorithm_imp(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info)
597 if (!target_was_examined(target))
599 LOG_ERROR("Target not examined yet");
602 return target->type->run_algorithm_imp(target, num_mem_params, mem_params, num_reg_params, reg_param, entry_point, exit_point, timeout_ms, arch_info);
605 int target_read_memory(struct target_s *target,
606 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
608 return target->type->read_memory(target, address, size, count, buffer);
611 int target_read_phys_memory(struct target_s *target,
612 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
614 return target->type->read_phys_memory(target, address, size, count, buffer);
617 int target_write_memory(struct target_s *target,
618 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
620 return target->type->write_memory(target, address, size, count, buffer);
623 int target_write_phys_memory(struct target_s *target,
624 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
626 return target->type->write_phys_memory(target, address, size, count, buffer);
629 int target_bulk_write_memory(struct target_s *target,
630 uint32_t address, uint32_t count, uint8_t *buffer)
632 return target->type->bulk_write_memory(target, address, count, buffer);
635 int target_add_breakpoint(struct target_s *target,
636 struct breakpoint_s *breakpoint)
638 return target->type->add_breakpoint(target, breakpoint);
640 int target_remove_breakpoint(struct target_s *target,
641 struct breakpoint_s *breakpoint)
643 return target->type->remove_breakpoint(target, breakpoint);
646 int target_add_watchpoint(struct target_s *target,
647 struct watchpoint_s *watchpoint)
649 return target->type->add_watchpoint(target, watchpoint);
651 int target_remove_watchpoint(struct target_s *target,
652 struct watchpoint_s *watchpoint)
654 return target->type->remove_watchpoint(target, watchpoint);
657 int target_get_gdb_reg_list(struct target_s *target,
658 struct reg_s **reg_list[], int *reg_list_size)
660 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
662 int target_step(struct target_s *target,
663 int current, uint32_t address, int handle_breakpoints)
665 return target->type->step(target, current, address, handle_breakpoints);
669 int target_run_algorithm(struct target_s *target,
670 int num_mem_params, mem_param_t *mem_params,
671 int num_reg_params, reg_param_t *reg_param,
672 uint32_t entry_point, uint32_t exit_point,
673 int timeout_ms, void *arch_info)
675 return target->type->run_algorithm(target,
676 num_mem_params, mem_params, num_reg_params, reg_param,
677 entry_point, exit_point, timeout_ms, arch_info);
680 /// @returns @c true if the target has been examined.
681 bool target_was_examined(struct target_s *target)
683 return target->type->examined;
685 /// Sets the @c examined flag for the given target.
686 void target_set_examined(struct target_s *target)
688 target->type->examined = true;
690 // Reset the @c examined flag for the given target.
691 void target_reset_examined(struct target_s *target)
693 target->type->examined = false;
698 static int default_mrc(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
700 LOG_ERROR("Not implemented");
704 static int default_mcr(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
706 LOG_ERROR("Not implemented");
710 static int arm_cp_check(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
713 if (!target_was_examined(target))
715 LOG_ERROR("Target not examined yet");
719 if ((cpnum <0) || (cpnum > 15))
721 LOG_ERROR("Illegal co-processor %d", cpnum);
727 LOG_ERROR("Illegal op1");
733 LOG_ERROR("Illegal op2");
739 LOG_ERROR("Illegal CRn");
745 LOG_ERROR("Illegal CRm");
752 int target_mrc(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
756 retval = arm_cp_check(target, cpnum, op1, op2, CRn, CRm);
757 if (retval != ERROR_OK)
760 return target->type->mrc(target, cpnum, op1, op2, CRn, CRm, value);
763 int target_mcr(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
767 retval = arm_cp_check(target, cpnum, op1, op2, CRn, CRm);
768 if (retval != ERROR_OK)
771 return target->type->mcr(target, cpnum, op1, op2, CRn, CRm, value);
774 static int default_read_phys_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
778 retval = target->type->has_mmu(target, &mmu);
779 if (retval != ERROR_OK)
783 LOG_ERROR("Not implemented");
786 return target_read_memory(target, address, size, count, buffer);
789 static int default_write_phys_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
793 retval = target->type->has_mmu(target, &mmu);
794 if (retval != ERROR_OK)
798 LOG_ERROR("Not implemented");
801 return target_write_memory(target, address, size, count, buffer);
805 int target_init(struct command_context_s *cmd_ctx)
807 target_t *target = all_targets;
812 target_reset_examined(target);
813 if (target->type->examine == NULL)
815 target->type->examine = default_examine;
818 if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
820 LOG_ERROR("target '%s' init failed", target_get_name(target));
824 /* Set up default functions if none are provided by target */
825 if (target->type->virt2phys == NULL)
827 target->type->virt2phys = default_virt2phys;
830 if (target->type->read_phys_memory == NULL)
832 target->type->read_phys_memory = default_read_phys_memory;
835 if (target->type->write_phys_memory == NULL)
837 target->type->write_phys_memory = default_write_phys_memory;
840 if (target->type->mcr == NULL)
842 target->type->mcr = default_mcr;
845 /* FIX! multiple targets will generally register global commands
846 * multiple times. Only register this one if *one* of the
847 * targets need the command. Hmm... make it a command on the
848 * Jim Tcl target object?
850 register_jim(cmd_ctx, "mcr", jim_mcrmrc, "write coprocessor <cpnum> <op1> <op2> <CRn> <CRm> <value>");
853 if (target->type->mrc == NULL)
855 target->type->mrc = default_mrc;
858 register_jim(cmd_ctx, "mrc", jim_mcrmrc, "read coprocessor <cpnum> <op1> <op2> <CRn> <CRm>");
862 /* a non-invasive way(in terms of patches) to add some code that
863 * runs before the type->write/read_memory implementation
865 target->type->write_memory_imp = target->type->write_memory;
866 target->type->write_memory = target_write_memory_imp;
867 target->type->read_memory_imp = target->type->read_memory;
868 target->type->read_memory = target_read_memory_imp;
869 target->type->soft_reset_halt_imp = target->type->soft_reset_halt;
870 target->type->soft_reset_halt = target_soft_reset_halt_imp;
871 target->type->run_algorithm_imp = target->type->run_algorithm;
872 target->type->run_algorithm = target_run_algorithm_imp;
874 if (target->type->mmu == NULL)
876 target->type->mmu = default_mmu;
878 if (target->type->has_mmu == NULL)
880 target->type->has_mmu = default_has_mmu;
882 target = target->next;
887 if ((retval = target_register_user_commands(cmd_ctx)) != ERROR_OK)
889 if ((retval = target_register_timer_callback(handle_target, 100, 1, NULL)) != ERROR_OK)
896 int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
898 target_event_callback_t **callbacks_p = &target_event_callbacks;
900 if (callback == NULL)
902 return ERROR_INVALID_ARGUMENTS;
907 while ((*callbacks_p)->next)
908 callbacks_p = &((*callbacks_p)->next);
909 callbacks_p = &((*callbacks_p)->next);
912 (*callbacks_p) = malloc(sizeof(target_event_callback_t));
913 (*callbacks_p)->callback = callback;
914 (*callbacks_p)->priv = priv;
915 (*callbacks_p)->next = NULL;
920 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
922 target_timer_callback_t **callbacks_p = &target_timer_callbacks;
925 if (callback == NULL)
927 return ERROR_INVALID_ARGUMENTS;
932 while ((*callbacks_p)->next)
933 callbacks_p = &((*callbacks_p)->next);
934 callbacks_p = &((*callbacks_p)->next);
937 (*callbacks_p) = malloc(sizeof(target_timer_callback_t));
938 (*callbacks_p)->callback = callback;
939 (*callbacks_p)->periodic = periodic;
940 (*callbacks_p)->time_ms = time_ms;
942 gettimeofday(&now, NULL);
943 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
944 time_ms -= (time_ms % 1000);
945 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
946 if ((*callbacks_p)->when.tv_usec > 1000000)
948 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
949 (*callbacks_p)->when.tv_sec += 1;
952 (*callbacks_p)->priv = priv;
953 (*callbacks_p)->next = NULL;
958 int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
960 target_event_callback_t **p = &target_event_callbacks;
961 target_event_callback_t *c = target_event_callbacks;
963 if (callback == NULL)
965 return ERROR_INVALID_ARGUMENTS;
970 target_event_callback_t *next = c->next;
971 if ((c->callback == callback) && (c->priv == priv))
985 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
987 target_timer_callback_t **p = &target_timer_callbacks;
988 target_timer_callback_t *c = target_timer_callbacks;
990 if (callback == NULL)
992 return ERROR_INVALID_ARGUMENTS;
997 target_timer_callback_t *next = c->next;
998 if ((c->callback == callback) && (c->priv == priv))
1012 int target_call_event_callbacks(target_t *target, enum target_event event)
1014 target_event_callback_t *callback = target_event_callbacks;
1015 target_event_callback_t *next_callback;
1017 if (event == TARGET_EVENT_HALTED)
1019 /* execute early halted first */
1020 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1023 LOG_DEBUG("target event %i (%s)",
1025 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1027 target_handle_event(target, event);
1031 next_callback = callback->next;
1032 callback->callback(target, event, callback->priv);
1033 callback = next_callback;
1039 static int target_timer_callback_periodic_restart(
1040 target_timer_callback_t *cb, struct timeval *now)
1042 int time_ms = cb->time_ms;
1043 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1044 time_ms -= (time_ms % 1000);
1045 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1046 if (cb->when.tv_usec > 1000000)
1048 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1049 cb->when.tv_sec += 1;
1054 static int target_call_timer_callback(target_timer_callback_t *cb,
1055 struct timeval *now)
1057 cb->callback(cb->priv);
1060 return target_timer_callback_periodic_restart(cb, now);
1062 return target_unregister_timer_callback(cb->callback, cb->priv);
1065 static int target_call_timer_callbacks_check_time(int checktime)
1070 gettimeofday(&now, NULL);
1072 target_timer_callback_t *callback = target_timer_callbacks;
1075 // cleaning up may unregister and free this callback
1076 target_timer_callback_t *next_callback = callback->next;
1078 bool call_it = callback->callback &&
1079 ((!checktime && callback->periodic) ||
1080 now.tv_sec > callback->when.tv_sec ||
1081 (now.tv_sec == callback->when.tv_sec &&
1082 now.tv_usec >= callback->when.tv_usec));
1086 int retval = target_call_timer_callback(callback, &now);
1087 if (retval != ERROR_OK)
1091 callback = next_callback;
1097 int target_call_timer_callbacks(void)
1099 return target_call_timer_callbacks_check_time(1);
1102 /* invoke periodic callbacks immediately */
1103 int target_call_timer_callbacks_now(void)
1105 return target_call_timer_callbacks_check_time(0);
1108 int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area)
1110 working_area_t *c = target->working_areas;
1111 working_area_t *new_wa = NULL;
1113 /* Reevaluate working area address based on MMU state*/
1114 if (target->working_areas == NULL)
1118 retval = target->type->mmu(target, &enabled);
1119 if (retval != ERROR_OK)
1126 if (target->working_area_phys_spec)
1128 LOG_DEBUG("MMU disabled, using physical address for working memory 0x%08x", (unsigned)target->working_area_phys);
1129 target->working_area = target->working_area_phys;
1132 LOG_ERROR("No working memory available. Specify -work-area-phys to target.");
1133 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1137 if (target->working_area_virt_spec)
1139 LOG_DEBUG("MMU enabled, using virtual address for working memory 0x%08x", (unsigned)target->working_area_virt);
1140 target->working_area = target->working_area_virt;
1143 LOG_ERROR("No working memory available. Specify -work-area-virt to target.");
1144 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1149 /* only allocate multiples of 4 byte */
1152 LOG_ERROR("BUG: code tried to allocate unaligned number of bytes (0x%08x), padding", ((unsigned)(size)));
1153 size = (size + 3) & (~3);
1156 /* see if there's already a matching working area */
1159 if ((c->free) && (c->size == size))
1167 /* if not, allocate a new one */
1170 working_area_t **p = &target->working_areas;
1171 uint32_t first_free = target->working_area;
1172 uint32_t free_size = target->working_area_size;
1174 c = target->working_areas;
1177 first_free += c->size;
1178 free_size -= c->size;
1183 if (free_size < size)
1185 LOG_WARNING("not enough working area available(requested %u, free %u)",
1186 (unsigned)(size), (unsigned)(free_size));
1187 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1190 LOG_DEBUG("allocated new working area at address 0x%08x", (unsigned)first_free);
1192 new_wa = malloc(sizeof(working_area_t));
1193 new_wa->next = NULL;
1194 new_wa->size = size;
1195 new_wa->address = first_free;
1197 if (target->backup_working_area)
1200 new_wa->backup = malloc(new_wa->size);
1201 if ((retval = target_read_memory(target, new_wa->address, 4, new_wa->size / 4, new_wa->backup)) != ERROR_OK)
1203 free(new_wa->backup);
1210 new_wa->backup = NULL;
1213 /* put new entry in list */
1217 /* mark as used, and return the new (reused) area */
1222 new_wa->user = area;
1227 int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore)
1232 if (restore && target->backup_working_area)
1235 if ((retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup)) != ERROR_OK)
1241 /* mark user pointer invalid */
1248 int target_free_working_area(struct target_s *target, working_area_t *area)
1250 return target_free_working_area_restore(target, area, 1);
1253 /* free resources and restore memory, if restoring memory fails,
1254 * free up resources anyway
1256 void target_free_all_working_areas_restore(struct target_s *target, int restore)
1258 working_area_t *c = target->working_areas;
1262 working_area_t *next = c->next;
1263 target_free_working_area_restore(target, c, restore);
1273 target->working_areas = NULL;
1276 void target_free_all_working_areas(struct target_s *target)
1278 target_free_all_working_areas_restore(target, 1);
1281 int target_register_commands(struct command_context_s *cmd_ctx)
1284 register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, "change the current command line target (one parameter) or lists targets (with no parameter)");
1289 register_jim(cmd_ctx, "target", jim_target, "configure target");
1294 int target_arch_state(struct target_s *target)
1299 LOG_USER("No target has been configured");
1303 LOG_USER("target state: %s", target_state_name( target ));
1305 if (target->state != TARGET_HALTED)
1308 retval = target->type->arch_state(target);
1312 /* Single aligned words are guaranteed to use 16 or 32 bit access
1313 * mode respectively, otherwise data is handled as quickly as
1316 int target_write_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer)
1319 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x",
1320 (int)size, (unsigned)address);
1322 if (!target_was_examined(target))
1324 LOG_ERROR("Target not examined yet");
1332 if ((address + size - 1) < address)
1334 /* GDB can request this when e.g. PC is 0xfffffffc*/
1335 LOG_ERROR("address + size wrapped(0x%08x, 0x%08x)",
1341 if (((address % 2) == 0) && (size == 2))
1343 return target_write_memory(target, address, 2, 1, buffer);
1346 /* handle unaligned head bytes */
1349 uint32_t unaligned = 4 - (address % 4);
1351 if (unaligned > size)
1354 if ((retval = target_write_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
1357 buffer += unaligned;
1358 address += unaligned;
1362 /* handle aligned words */
1365 int aligned = size - (size % 4);
1367 /* use bulk writes above a certain limit. This may have to be changed */
1370 if ((retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer)) != ERROR_OK)
1375 if ((retval = target_write_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
1384 /* handle tail writes of less than 4 bytes */
1387 if ((retval = target_write_memory(target, address, 1, size, buffer)) != ERROR_OK)
1394 /* Single aligned words are guaranteed to use 16 or 32 bit access
1395 * mode respectively, otherwise data is handled as quickly as
1398 int target_read_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer)
1401 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
1402 (int)size, (unsigned)address);
1404 if (!target_was_examined(target))
1406 LOG_ERROR("Target not examined yet");
1414 if ((address + size - 1) < address)
1416 /* GDB can request this when e.g. PC is 0xfffffffc*/
1417 LOG_ERROR("address + size wrapped(0x%08" PRIx32 ", 0x%08" PRIx32 ")",
1423 if (((address % 2) == 0) && (size == 2))
1425 return target_read_memory(target, address, 2, 1, buffer);
1428 /* handle unaligned head bytes */
1431 uint32_t unaligned = 4 - (address % 4);
1433 if (unaligned > size)
1436 if ((retval = target_read_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
1439 buffer += unaligned;
1440 address += unaligned;
1444 /* handle aligned words */
1447 int aligned = size - (size % 4);
1449 if ((retval = target_read_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
1457 /*prevent byte access when possible (avoid AHB access limitations in some cases)*/
1460 int aligned = size - (size%2);
1461 retval = target_read_memory(target, address, 2, aligned / 2, buffer);
1462 if (retval != ERROR_OK)
1469 /* handle tail writes of less than 4 bytes */
1472 if ((retval = target_read_memory(target, address, 1, size, buffer)) != ERROR_OK)
1479 int target_checksum_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* crc)
1484 uint32_t checksum = 0;
1485 if (!target_was_examined(target))
1487 LOG_ERROR("Target not examined yet");
1491 if ((retval = target->type->checksum_memory(target, address,
1492 size, &checksum)) != ERROR_OK)
1494 buffer = malloc(size);
1497 LOG_ERROR("error allocating buffer for section (%d bytes)", (int)size);
1498 return ERROR_INVALID_ARGUMENTS;
1500 retval = target_read_buffer(target, address, size, buffer);
1501 if (retval != ERROR_OK)
1507 /* convert to target endianess */
1508 for (i = 0; i < (size/sizeof(uint32_t)); i++)
1510 uint32_t target_data;
1511 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
1512 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
1515 retval = image_calculate_checksum(buffer, size, &checksum);
1524 int target_blank_check_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* blank)
1527 if (!target_was_examined(target))
1529 LOG_ERROR("Target not examined yet");
1533 if (target->type->blank_check_memory == 0)
1534 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1536 retval = target->type->blank_check_memory(target, address, size, blank);
1541 int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value)
1543 uint8_t value_buf[4];
1544 if (!target_was_examined(target))
1546 LOG_ERROR("Target not examined yet");
1550 int retval = target_read_memory(target, address, 4, 1, value_buf);
1552 if (retval == ERROR_OK)
1554 *value = target_buffer_get_u32(target, value_buf);
1555 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1562 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1569 int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value)
1571 uint8_t value_buf[2];
1572 if (!target_was_examined(target))
1574 LOG_ERROR("Target not examined yet");
1578 int retval = target_read_memory(target, address, 2, 1, value_buf);
1580 if (retval == ERROR_OK)
1582 *value = target_buffer_get_u16(target, value_buf);
1583 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4x",
1590 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1597 int target_read_u8(struct target_s *target, uint32_t address, uint8_t *value)
1599 int retval = target_read_memory(target, address, 1, 1, value);
1600 if (!target_was_examined(target))
1602 LOG_ERROR("Target not examined yet");
1606 if (retval == ERROR_OK)
1608 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
1615 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
1622 int target_write_u32(struct target_s *target, uint32_t address, uint32_t value)
1625 uint8_t value_buf[4];
1626 if (!target_was_examined(target))
1628 LOG_ERROR("Target not examined yet");
1632 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1636 target_buffer_set_u32(target, value_buf, value);
1637 if ((retval = target_write_memory(target, address, 4, 1, value_buf)) != ERROR_OK)
1639 LOG_DEBUG("failed: %i", retval);
1645 int target_write_u16(struct target_s *target, uint32_t address, uint16_t value)
1648 uint8_t value_buf[2];
1649 if (!target_was_examined(target))
1651 LOG_ERROR("Target not examined yet");
1655 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8x",
1659 target_buffer_set_u16(target, value_buf, value);
1660 if ((retval = target_write_memory(target, address, 2, 1, value_buf)) != ERROR_OK)
1662 LOG_DEBUG("failed: %i", retval);
1668 int target_write_u8(struct target_s *target, uint32_t address, uint8_t value)
1671 if (!target_was_examined(target))
1673 LOG_ERROR("Target not examined yet");
1677 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
1680 if ((retval = target_write_memory(target, address, 1, 1, &value)) != ERROR_OK)
1682 LOG_DEBUG("failed: %i", retval);
1688 int target_register_user_commands(struct command_context_s *cmd_ctx)
1690 int retval = ERROR_OK;
1693 /* script procedures */
1694 register_command(cmd_ctx, NULL, "profile", handle_profile_command, COMMAND_EXEC, "profiling samples the CPU PC");
1695 register_jim(cmd_ctx, "ocd_mem2array", jim_mem2array, "read memory and return as a TCL array for script processing <ARRAYNAME> <WIDTH = 32/16/8> <ADDRESS> <COUNT>");
1696 register_jim(cmd_ctx, "ocd_array2mem", jim_array2mem, "convert a TCL array to memory locations and write the values <ARRAYNAME> <WIDTH = 32/16/8> <ADDRESS> <COUNT>");
1698 register_command(cmd_ctx, NULL, "fast_load_image", handle_fast_load_image_command, COMMAND_ANY,
1699 "same args as load_image, image stored in memory - mainly for profiling purposes");
1701 register_command(cmd_ctx, NULL, "fast_load", handle_fast_load_command, COMMAND_ANY,
1702 "loads active fast load image to current target - mainly for profiling purposes");
1705 register_command(cmd_ctx, NULL, "virt2phys", handle_virt2phys_command, COMMAND_ANY, "translate a virtual address into a physical address");
1706 register_command(cmd_ctx, NULL, "reg", handle_reg_command, COMMAND_EXEC, "display or set a register");
1707 register_command(cmd_ctx, NULL, "poll", handle_poll_command, COMMAND_EXEC, "poll target state");
1708 register_command(cmd_ctx, NULL, "wait_halt", handle_wait_halt_command, COMMAND_EXEC, "wait for target halt [time (s)]");
1709 register_command(cmd_ctx, NULL, "halt", handle_halt_command, COMMAND_EXEC, "halt target");
1710 register_command(cmd_ctx, NULL, "resume", handle_resume_command, COMMAND_EXEC, "resume target [addr]");
1711 register_command(cmd_ctx, NULL, "step", handle_step_command, COMMAND_EXEC, "step one instruction from current PC or [addr]");
1712 register_command(cmd_ctx, NULL, "reset", handle_reset_command, COMMAND_EXEC, "reset target [run | halt | init] - default is run");
1713 register_command(cmd_ctx, NULL, "soft_reset_halt", handle_soft_reset_halt_command, COMMAND_EXEC, "halt the target and do a soft reset");
1715 register_command(cmd_ctx, NULL, "mdw", handle_md_command, COMMAND_EXEC, "display memory words [phys] <addr> [count]");
1716 register_command(cmd_ctx, NULL, "mdh", handle_md_command, COMMAND_EXEC, "display memory half-words [phys] <addr> [count]");
1717 register_command(cmd_ctx, NULL, "mdb", handle_md_command, COMMAND_EXEC, "display memory bytes [phys] <addr> [count]");
1719 register_command(cmd_ctx, NULL, "mww", handle_mw_command, COMMAND_EXEC, "write memory word [phys] <addr> <value> [count]");
1720 register_command(cmd_ctx, NULL, "mwh", handle_mw_command, COMMAND_EXEC, "write memory half-word [phys] <addr> <value> [count]");
1721 register_command(cmd_ctx, NULL, "mwb", handle_mw_command, COMMAND_EXEC, "write memory byte [phys] <addr> <value> [count]");
1723 register_command(cmd_ctx, NULL, "bp",
1724 handle_bp_command, COMMAND_EXEC,
1725 "list or set breakpoint [<address> <length> [hw]]");
1726 register_command(cmd_ctx, NULL, "rbp",
1727 handle_rbp_command, COMMAND_EXEC,
1728 "remove breakpoint <address>");
1729 register_command(cmd_ctx, NULL, "wp",
1730 handle_wp_command, COMMAND_EXEC,
1731 "list or set watchpoint "
1732 "[<address> <length> <r/w/a> [value] [mask]]");
1733 register_command(cmd_ctx, NULL, "rwp",
1734 handle_rwp_command, COMMAND_EXEC,
1735 "remove watchpoint <address>");
1737 register_command(cmd_ctx, NULL, "load_image", handle_load_image_command, COMMAND_EXEC, "load_image <file> <address> ['bin'|'ihex'|'elf'|'s19'] [min_address] [max_length]");
1738 register_command(cmd_ctx, NULL, "dump_image", handle_dump_image_command, COMMAND_EXEC, "dump_image <file> <address> <size>");
1739 register_command(cmd_ctx, NULL, "verify_image", handle_verify_image_command, COMMAND_EXEC, "verify_image <file> [offset] [type]");
1740 register_command(cmd_ctx, NULL, "test_image", handle_test_image_command, COMMAND_EXEC, "test_image <file> [offset] [type]");
1742 if ((retval = target_request_register_commands(cmd_ctx)) != ERROR_OK)
1744 if ((retval = trace_register_commands(cmd_ctx)) != ERROR_OK)
1750 static int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1752 target_t *target = all_targets;
1756 target = get_target(args[0]);
1757 if (target == NULL) {
1758 command_print(cmd_ctx,"Target: %s is unknown, try one of:\n", args[0]);
1761 if (!target->tap->enabled) {
1762 command_print(cmd_ctx,"Target: TAP %s is disabled, "
1763 "can't be the current target\n",
1764 target->tap->dotted_name);
1768 cmd_ctx->current_target = target->target_number;
1773 target = all_targets;
1774 command_print(cmd_ctx, " TargetName Type Endian TapName State ");
1775 command_print(cmd_ctx, "-- ------------------ ---------- ------ ------------------ ------------");
1781 if (target->tap->enabled)
1782 state = target_state_name( target );
1784 state = "tap-disabled";
1786 if (cmd_ctx->current_target == target->target_number)
1789 /* keep columns lined up to match the headers above */
1790 command_print(cmd_ctx, "%2d%c %-18s %-10s %-6s %-18s %s",
1791 target->target_number,
1794 target_get_name(target),
1795 Jim_Nvp_value2name_simple(nvp_target_endian,
1796 target->endianness)->name,
1797 target->tap->dotted_name,
1799 target = target->next;
1805 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
1807 static int powerDropout;
1808 static int srstAsserted;
1810 static int runPowerRestore;
1811 static int runPowerDropout;
1812 static int runSrstAsserted;
1813 static int runSrstDeasserted;
1815 static int sense_handler(void)
1817 static int prevSrstAsserted = 0;
1818 static int prevPowerdropout = 0;
1821 if ((retval = jtag_power_dropout(&powerDropout)) != ERROR_OK)
1825 powerRestored = prevPowerdropout && !powerDropout;
1828 runPowerRestore = 1;
1831 long long current = timeval_ms();
1832 static long long lastPower = 0;
1833 int waitMore = lastPower + 2000 > current;
1834 if (powerDropout && !waitMore)
1836 runPowerDropout = 1;
1837 lastPower = current;
1840 if ((retval = jtag_srst_asserted(&srstAsserted)) != ERROR_OK)
1844 srstDeasserted = prevSrstAsserted && !srstAsserted;
1846 static long long lastSrst = 0;
1847 waitMore = lastSrst + 2000 > current;
1848 if (srstDeasserted && !waitMore)
1850 runSrstDeasserted = 1;
1854 if (!prevSrstAsserted && srstAsserted)
1856 runSrstAsserted = 1;
1859 prevSrstAsserted = srstAsserted;
1860 prevPowerdropout = powerDropout;
1862 if (srstDeasserted || powerRestored)
1864 /* Other than logging the event we can't do anything here.
1865 * Issuing a reset is a particularly bad idea as we might
1866 * be inside a reset already.
1873 static void target_call_event_callbacks_all(enum target_event e) {
1875 target = all_targets;
1877 target_call_event_callbacks(target, e);
1878 target = target->next;
1882 /* process target state changes */
1883 int handle_target(void *priv)
1885 int retval = ERROR_OK;
1887 /* we do not want to recurse here... */
1888 static int recursive = 0;
1893 /* danger! running these procedures can trigger srst assertions and power dropouts.
1894 * We need to avoid an infinite loop/recursion here and we do that by
1895 * clearing the flags after running these events.
1897 int did_something = 0;
1898 if (runSrstAsserted)
1900 target_call_event_callbacks_all(TARGET_EVENT_GDB_HALT);
1901 Jim_Eval(interp, "srst_asserted");
1904 if (runSrstDeasserted)
1906 Jim_Eval(interp, "srst_deasserted");
1909 if (runPowerDropout)
1911 target_call_event_callbacks_all(TARGET_EVENT_GDB_HALT);
1912 Jim_Eval(interp, "power_dropout");
1915 if (runPowerRestore)
1917 Jim_Eval(interp, "power_restore");
1923 /* clear detect flags */
1927 /* clear action flags */
1929 runSrstAsserted = 0;
1930 runSrstDeasserted = 0;
1931 runPowerRestore = 0;
1932 runPowerDropout = 0;
1937 /* Poll targets for state changes unless that's globally disabled.
1938 * Skip targets that are currently disabled.
1940 for (target_t *target = all_targets;
1941 is_jtag_poll_safe() && target;
1942 target = target->next)
1944 if (!target->tap->enabled)
1947 /* only poll target if we've got power and srst isn't asserted */
1948 if (!powerDropout && !srstAsserted)
1950 /* polling may fail silently until the target has been examined */
1951 if ((retval = target_poll(target)) != ERROR_OK)
1953 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1962 static int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1971 target = get_current_target(cmd_ctx);
1973 /* list all available registers for the current target */
1976 reg_cache_t *cache = target->reg_cache;
1983 command_print(cmd_ctx, "===== %s", cache->name);
1985 for (i = 0, reg = cache->reg_list;
1986 i < cache->num_regs;
1987 i++, reg++, count++)
1989 /* only print cached values if they are valid */
1991 value = buf_to_str(reg->value,
1993 command_print(cmd_ctx,
1994 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2002 command_print(cmd_ctx, "(%i) %s (/%" PRIu32 ")",
2007 cache = cache->next;
2013 /* access a single register by its ordinal number */
2014 if ((args[0][0] >= '0') && (args[0][0] <= '9'))
2017 int retval = parse_uint(args[0], &num);
2018 if (ERROR_OK != retval)
2019 return ERROR_COMMAND_SYNTAX_ERROR;
2021 reg_cache_t *cache = target->reg_cache;
2026 for (i = 0; i < cache->num_regs; i++)
2028 if (count++ == (int)num)
2030 reg = &cache->reg_list[i];
2036 cache = cache->next;
2041 command_print(cmd_ctx, "%i is out of bounds, the current target has only %i registers (0 - %i)", num, count, count - 1);
2044 } else /* access a single register by its name */
2046 reg = register_get_by_name(target->reg_cache, args[0], 1);
2050 command_print(cmd_ctx, "register %s not found in current target", args[0]);
2055 /* display a register */
2056 if ((argc == 1) || ((argc == 2) && !((args[1][0] >= '0') && (args[1][0] <= '9'))))
2058 if ((argc == 2) && (strcmp(args[1], "force") == 0))
2061 if (reg->valid == 0)
2063 reg_arch_type_t *arch_type = register_get_arch_type(reg->arch_type);
2064 arch_type->get(reg);
2066 value = buf_to_str(reg->value, reg->size, 16);
2067 command_print(cmd_ctx, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2072 /* set register value */
2075 uint8_t *buf = malloc(CEIL(reg->size, 8));
2076 str_to_buf(args[1], strlen(args[1]), buf, reg->size, 0);
2078 reg_arch_type_t *arch_type = register_get_arch_type(reg->arch_type);
2079 arch_type->set(reg, buf);
2081 value = buf_to_str(reg->value, reg->size, 16);
2082 command_print(cmd_ctx, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2090 command_print(cmd_ctx, "usage: reg <#|name> [value]");
2095 static int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2097 int retval = ERROR_OK;
2098 target_t *target = get_current_target(cmd_ctx);
2102 command_print(cmd_ctx, "background polling: %s",
2103 jtag_poll_get_enabled() ? "on" : "off");
2104 command_print(cmd_ctx, "TAP: %s (%s)",
2105 target->tap->dotted_name,
2106 target->tap->enabled ? "enabled" : "disabled");
2107 if (!target->tap->enabled)
2109 if ((retval = target_poll(target)) != ERROR_OK)
2111 if ((retval = target_arch_state(target)) != ERROR_OK)
2117 if (strcmp(args[0], "on") == 0)
2119 jtag_poll_set_enabled(true);
2121 else if (strcmp(args[0], "off") == 0)
2123 jtag_poll_set_enabled(false);
2127 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
2131 return ERROR_COMMAND_SYNTAX_ERROR;
2137 static int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2140 return ERROR_COMMAND_SYNTAX_ERROR;
2145 int retval = parse_uint(args[0], &ms);
2146 if (ERROR_OK != retval)
2148 command_print(cmd_ctx, "usage: %s [seconds]", cmd);
2149 return ERROR_COMMAND_SYNTAX_ERROR;
2151 // convert seconds (given) to milliseconds (needed)
2155 target_t *target = get_current_target(cmd_ctx);
2156 return target_wait_state(target, TARGET_HALTED, ms);
2159 /* wait for target state to change. The trick here is to have a low
2160 * latency for short waits and not to suck up all the CPU time
2163 * After 500ms, keep_alive() is invoked
2165 int target_wait_state(target_t *target, enum target_state state, int ms)
2168 long long then = 0, cur;
2173 if ((retval = target_poll(target)) != ERROR_OK)
2175 if (target->state == state)
2183 then = timeval_ms();
2184 LOG_DEBUG("waiting for target %s...",
2185 Jim_Nvp_value2name_simple(nvp_target_state,state)->name);
2193 if ((cur-then) > ms)
2195 LOG_ERROR("timed out while waiting for target %s",
2196 Jim_Nvp_value2name_simple(nvp_target_state,state)->name);
2204 static int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2208 target_t *target = get_current_target(cmd_ctx);
2209 int retval = target_halt(target);
2210 if (ERROR_OK != retval)
2216 retval = parse_uint(args[0], &wait);
2217 if (ERROR_OK != retval)
2218 return ERROR_COMMAND_SYNTAX_ERROR;
2223 return handle_wait_halt_command(cmd_ctx, cmd, args, argc);
2226 static int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2228 target_t *target = get_current_target(cmd_ctx);
2230 LOG_USER("requesting target halt and executing a soft reset");
2232 target->type->soft_reset_halt(target);
2237 static int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2240 return ERROR_COMMAND_SYNTAX_ERROR;
2242 enum target_reset_mode reset_mode = RESET_RUN;
2246 n = Jim_Nvp_name2value_simple(nvp_reset_modes, args[0]);
2247 if ((n->name == NULL) || (n->value == RESET_UNKNOWN)) {
2248 return ERROR_COMMAND_SYNTAX_ERROR;
2250 reset_mode = n->value;
2253 /* reset *all* targets */
2254 return target_process_reset(cmd_ctx, reset_mode);
2258 static int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2262 return ERROR_COMMAND_SYNTAX_ERROR;
2264 target_t *target = get_current_target(cmd_ctx);
2265 target_handle_event(target, TARGET_EVENT_OLD_pre_resume);
2267 /* with no args, resume from current pc, addr = 0,
2268 * with one arguments, addr = args[0],
2269 * handle breakpoints, not debugging */
2273 int retval = parse_u32(args[0], &addr);
2274 if (ERROR_OK != retval)
2279 return target_resume(target, current, addr, 1, 0);
2282 static int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2285 return ERROR_COMMAND_SYNTAX_ERROR;
2289 /* with no args, step from current pc, addr = 0,
2290 * with one argument addr = args[0],
2291 * handle breakpoints, debugging */
2296 int retval = parse_u32(args[0], &addr);
2297 if (ERROR_OK != retval)
2302 target_t *target = get_current_target(cmd_ctx);
2304 return target->type->step(target, current_pc, addr, 1);
2307 static void handle_md_output(struct command_context_s *cmd_ctx,
2308 struct target_s *target, uint32_t address, unsigned size,
2309 unsigned count, const uint8_t *buffer)
2311 const unsigned line_bytecnt = 32;
2312 unsigned line_modulo = line_bytecnt / size;
2314 char output[line_bytecnt * 4 + 1];
2315 unsigned output_len = 0;
2317 const char *value_fmt;
2319 case 4: value_fmt = "%8.8x "; break;
2320 case 2: value_fmt = "%4.2x "; break;
2321 case 1: value_fmt = "%2.2x "; break;
2323 LOG_ERROR("invalid memory read size: %u", size);
2327 for (unsigned i = 0; i < count; i++)
2329 if (i % line_modulo == 0)
2331 output_len += snprintf(output + output_len,
2332 sizeof(output) - output_len,
2334 (unsigned)(address + (i*size)));
2338 const uint8_t *value_ptr = buffer + i * size;
2340 case 4: value = target_buffer_get_u32(target, value_ptr); break;
2341 case 2: value = target_buffer_get_u16(target, value_ptr); break;
2342 case 1: value = *value_ptr;
2344 output_len += snprintf(output + output_len,
2345 sizeof(output) - output_len,
2348 if ((i % line_modulo == line_modulo - 1) || (i == count - 1))
2350 command_print(cmd_ctx, "%s", output);
2356 static int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2359 return ERROR_COMMAND_SYNTAX_ERROR;
2363 case 'w': size = 4; break;
2364 case 'h': size = 2; break;
2365 case 'b': size = 1; break;
2366 default: return ERROR_COMMAND_SYNTAX_ERROR;
2369 bool physical=strcmp(args[0], "phys")==0;
2370 int (*fn)(struct target_s *target,
2371 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
2376 fn=target_read_phys_memory;
2379 fn=target_read_memory;
2381 if ((argc < 1) || (argc > 2))
2383 return ERROR_COMMAND_SYNTAX_ERROR;
2386 int retval = parse_u32(args[0], &address);
2387 if (ERROR_OK != retval)
2393 retval = parse_uint(args[1], &count);
2394 if (ERROR_OK != retval)
2398 uint8_t *buffer = calloc(count, size);
2400 target_t *target = get_current_target(cmd_ctx);
2401 retval = fn(target, address, size, count, buffer);
2402 if (ERROR_OK == retval)
2403 handle_md_output(cmd_ctx, target, address, size, count, buffer);
2410 static int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2414 return ERROR_COMMAND_SYNTAX_ERROR;
2416 bool physical=strcmp(args[0], "phys")==0;
2417 int (*fn)(struct target_s *target,
2418 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
2423 fn=target_write_phys_memory;
2426 fn=target_write_memory;
2428 if ((argc < 2) || (argc > 3))
2429 return ERROR_COMMAND_SYNTAX_ERROR;
2432 int retval = parse_u32(args[0], &address);
2433 if (ERROR_OK != retval)
2437 retval = parse_u32(args[1], &value);
2438 if (ERROR_OK != retval)
2444 retval = parse_uint(args[2], &count);
2445 if (ERROR_OK != retval)
2449 target_t *target = get_current_target(cmd_ctx);
2451 uint8_t value_buf[4];
2456 target_buffer_set_u32(target, value_buf, value);
2460 target_buffer_set_u16(target, value_buf, value);
2464 value_buf[0] = value;
2467 return ERROR_COMMAND_SYNTAX_ERROR;
2469 for (unsigned i = 0; i < count; i++)
2472 address + i * wordsize, wordsize, 1, value_buf);
2473 if (ERROR_OK != retval)
2482 static int parse_load_image_command_args(char **args, int argc,
2483 image_t *image, uint32_t *min_address, uint32_t *max_address)
2485 if (argc < 1 || argc > 5)
2486 return ERROR_COMMAND_SYNTAX_ERROR;
2488 /* a base address isn't always necessary,
2489 * default to 0x0 (i.e. don't relocate) */
2493 int retval = parse_u32(args[1], &addr);
2494 if (ERROR_OK != retval)
2495 return ERROR_COMMAND_SYNTAX_ERROR;
2496 image->base_address = addr;
2497 image->base_address_set = 1;
2500 image->base_address_set = 0;
2502 image->start_address_set = 0;
2506 int retval = parse_u32(args[3], min_address);
2507 if (ERROR_OK != retval)
2508 return ERROR_COMMAND_SYNTAX_ERROR;
2512 int retval = parse_u32(args[4], max_address);
2513 if (ERROR_OK != retval)
2514 return ERROR_COMMAND_SYNTAX_ERROR;
2515 // use size (given) to find max (required)
2516 *max_address += *min_address;
2519 if (*min_address > *max_address)
2520 return ERROR_COMMAND_SYNTAX_ERROR;
2525 static int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2529 uint32_t image_size;
2530 uint32_t min_address = 0;
2531 uint32_t max_address = 0xffffffff;
2537 duration_t duration;
2538 char *duration_text;
2540 int retval = parse_load_image_command_args(args, argc,
2541 &image, &min_address, &max_address);
2542 if (ERROR_OK != retval)
2545 target_t *target = get_current_target(cmd_ctx);
2546 duration_start_measure(&duration);
2548 if (image_open(&image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
2555 for (i = 0; i < image.num_sections; i++)
2557 buffer = malloc(image.sections[i].size);
2560 command_print(cmd_ctx,
2561 "error allocating buffer for section (%d bytes)",
2562 (int)(image.sections[i].size));
2566 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
2572 uint32_t offset = 0;
2573 uint32_t length = buf_cnt;
2575 /* DANGER!!! beware of unsigned comparision here!!! */
2577 if ((image.sections[i].base_address + buf_cnt >= min_address)&&
2578 (image.sections[i].base_address < max_address))
2580 if (image.sections[i].base_address < min_address)
2582 /* clip addresses below */
2583 offset += min_address-image.sections[i].base_address;
2587 if (image.sections[i].base_address + buf_cnt > max_address)
2589 length -= (image.sections[i].base_address + buf_cnt)-max_address;
2592 if ((retval = target_write_buffer(target, image.sections[i].base_address + offset, length, buffer + offset)) != ERROR_OK)
2597 image_size += length;
2598 command_print(cmd_ctx, "%u bytes written at address 0x%8.8" PRIx32 "",
2599 (unsigned int)length,
2600 image.sections[i].base_address + offset);
2606 if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
2608 image_close(&image);
2612 if (retval == ERROR_OK)
2614 command_print(cmd_ctx, "downloaded %u byte in %s",
2615 (unsigned int)image_size,
2618 free(duration_text);
2620 image_close(&image);
2626 static int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2630 uint8_t buffer[560];
2633 duration_t duration;
2634 char *duration_text;
2636 target_t *target = get_current_target(cmd_ctx);
2640 command_print(cmd_ctx, "usage: dump_image <filename> <address> <size>");
2645 int retval = parse_u32(args[1], &address);
2646 if (ERROR_OK != retval)
2650 retval = parse_u32(args[2], &size);
2651 if (ERROR_OK != retval)
2654 if (fileio_open(&fileio, args[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
2659 duration_start_measure(&duration);
2663 uint32_t size_written;
2664 uint32_t this_run_size = (size > 560) ? 560 : size;
2666 retval = target_read_buffer(target, address, this_run_size, buffer);
2667 if (retval != ERROR_OK)
2672 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2673 if (retval != ERROR_OK)
2678 size -= this_run_size;
2679 address += this_run_size;
2682 if ((retvaltemp = fileio_close(&fileio)) != ERROR_OK)
2685 if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
2688 if (retval == ERROR_OK)
2690 command_print(cmd_ctx, "dumped %lld byte in %s",
2691 fileio.size, duration_text);
2692 free(duration_text);
2698 static int handle_verify_image_command_internal(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, int verify)
2702 uint32_t image_size;
2704 int retval, retvaltemp;
2705 uint32_t checksum = 0;
2706 uint32_t mem_checksum = 0;
2710 duration_t duration;
2711 char *duration_text;
2713 target_t *target = get_current_target(cmd_ctx);
2717 return ERROR_COMMAND_SYNTAX_ERROR;
2722 LOG_ERROR("no target selected");
2726 duration_start_measure(&duration);
2731 retval = parse_u32(args[1], &addr);
2732 if (ERROR_OK != retval)
2733 return ERROR_COMMAND_SYNTAX_ERROR;
2734 image.base_address = addr;
2735 image.base_address_set = 1;
2739 image.base_address_set = 0;
2740 image.base_address = 0x0;
2743 image.start_address_set = 0;
2745 if ((retval = image_open(&image, args[0], (argc == 3) ? args[2] : NULL)) != ERROR_OK)
2752 for (i = 0; i < image.num_sections; i++)
2754 buffer = malloc(image.sections[i].size);
2757 command_print(cmd_ctx,
2758 "error allocating buffer for section (%d bytes)",
2759 (int)(image.sections[i].size));
2762 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
2770 /* calculate checksum of image */
2771 image_calculate_checksum(buffer, buf_cnt, &checksum);
2773 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
2774 if (retval != ERROR_OK)
2780 if (checksum != mem_checksum)
2782 /* failed crc checksum, fall back to a binary compare */
2785 command_print(cmd_ctx, "checksum mismatch - attempting binary compare");
2787 data = (uint8_t*)malloc(buf_cnt);
2789 /* Can we use 32bit word accesses? */
2791 int count = buf_cnt;
2792 if ((count % 4) == 0)
2797 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
2798 if (retval == ERROR_OK)
2801 for (t = 0; t < buf_cnt; t++)
2803 if (data[t] != buffer[t])
2805 command_print(cmd_ctx,
2806 "Verify operation failed address 0x%08x. Was 0x%02x instead of 0x%02x\n",
2807 (unsigned)(t + image.sections[i].base_address),
2812 retval = ERROR_FAIL;
2826 command_print(cmd_ctx, "address 0x%08" PRIx32 " length 0x%08" PRIx32 "",
2827 image.sections[i].base_address,
2832 image_size += buf_cnt;
2836 if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
2838 image_close(&image);
2842 if (retval == ERROR_OK)
2844 command_print(cmd_ctx, "verified %u bytes in %s",
2845 (unsigned int)image_size,
2848 free(duration_text);
2850 image_close(&image);
2855 static int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2857 return handle_verify_image_command_internal(cmd_ctx, cmd, args, argc, 1);
2860 static int handle_test_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2862 return handle_verify_image_command_internal(cmd_ctx, cmd, args, argc, 0);
2865 static int handle_bp_command_list(struct command_context_s *cmd_ctx)
2867 target_t *target = get_current_target(cmd_ctx);
2868 breakpoint_t *breakpoint = target->breakpoints;
2871 if (breakpoint->type == BKPT_SOFT)
2873 char* buf = buf_to_str(breakpoint->orig_instr,
2874 breakpoint->length, 16);
2875 command_print(cmd_ctx, "0x%8.8" PRIx32 ", 0x%x, %i, 0x%s",
2876 breakpoint->address,
2878 breakpoint->set, buf);
2883 command_print(cmd_ctx, "0x%8.8" PRIx32 ", 0x%x, %i",
2884 breakpoint->address,
2885 breakpoint->length, breakpoint->set);
2888 breakpoint = breakpoint->next;
2893 static int handle_bp_command_set(struct command_context_s *cmd_ctx,
2894 uint32_t addr, uint32_t length, int hw)
2896 target_t *target = get_current_target(cmd_ctx);
2897 int retval = breakpoint_add(target, addr, length, hw);
2898 if (ERROR_OK == retval)
2899 command_print(cmd_ctx, "breakpoint set at 0x%8.8" PRIx32 "", addr);
2901 LOG_ERROR("Failure setting breakpoint");
2905 static int handle_bp_command(struct command_context_s *cmd_ctx,
2906 char *cmd, char **args, int argc)
2909 return handle_bp_command_list(cmd_ctx);
2911 if (argc < 2 || argc > 3)
2913 command_print(cmd_ctx, "usage: bp <address> <length> ['hw']");
2914 return ERROR_COMMAND_SYNTAX_ERROR;
2918 int retval = parse_u32(args[0], &addr);
2919 if (ERROR_OK != retval)
2923 retval = parse_u32(args[1], &length);
2924 if (ERROR_OK != retval)
2930 if (strcmp(args[2], "hw") == 0)
2933 return ERROR_COMMAND_SYNTAX_ERROR;
2936 return handle_bp_command_set(cmd_ctx, addr, length, hw);
2939 static int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2942 return ERROR_COMMAND_SYNTAX_ERROR;
2945 int retval = parse_u32(args[0], &addr);
2946 if (ERROR_OK != retval)
2949 target_t *target = get_current_target(cmd_ctx);
2950 breakpoint_remove(target, addr);
2955 static int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2957 target_t *target = get_current_target(cmd_ctx);
2961 watchpoint_t *watchpoint = target->watchpoints;
2965 command_print(cmd_ctx,
2966 "address: 0x%8.8" PRIx32 ", len: 0x%8.8x, r/w/a: %i, value: 0x%8.8" PRIx32 ", mask: 0x%8.8" PRIx32 "",
2967 watchpoint->address,
2969 (int)(watchpoint->rw),
2972 watchpoint = watchpoint->next;
2977 enum watchpoint_rw type = WPT_ACCESS;
2979 uint32_t length = 0;
2980 uint32_t data_value = 0x0;
2981 uint32_t data_mask = 0xffffffff;
2987 retval = parse_u32(args[4], &data_mask);
2988 if (ERROR_OK != retval)
2992 retval = parse_u32(args[3], &data_value);
2993 if (ERROR_OK != retval)
3009 LOG_ERROR("invalid watchpoint mode ('%c')", args[2][0]);
3010 return ERROR_COMMAND_SYNTAX_ERROR;
3014 retval = parse_u32(args[1], &length);
3015 if (ERROR_OK != retval)
3017 retval = parse_u32(args[0], &addr);
3018 if (ERROR_OK != retval)
3023 command_print(cmd_ctx, "usage: wp [address length "
3024 "[(r|w|a) [value [mask]]]]");
3025 return ERROR_COMMAND_SYNTAX_ERROR;
3028 retval = watchpoint_add(target, addr, length, type,
3029 data_value, data_mask);
3030 if (ERROR_OK != retval)
3031 LOG_ERROR("Failure setting watchpoints");
3036 static int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3039 return ERROR_COMMAND_SYNTAX_ERROR;
3042 int retval = parse_u32(args[0], &addr);
3043 if (ERROR_OK != retval)
3046 target_t *target = get_current_target(cmd_ctx);
3047 watchpoint_remove(target, addr);
3054 * Translate a virtual address to a physical address.
3056 * The low-level target implementation must have logged a detailed error
3057 * which is forwarded to telnet/GDB session.
3059 static int handle_virt2phys_command(command_context_t *cmd_ctx,
3060 char *cmd, char **args, int argc)
3063 return ERROR_COMMAND_SYNTAX_ERROR;
3066 int retval = parse_u32(args[0], &va);
3067 if (ERROR_OK != retval)
3071 target_t *target = get_current_target(cmd_ctx);
3072 retval = target->type->virt2phys(target, va, &pa);
3073 if (retval == ERROR_OK)
3074 command_print(cmd_ctx, "Physical address 0x%08" PRIx32 "", pa);
3079 static void writeData(FILE *f, const void *data, size_t len)
3081 size_t written = fwrite(data, 1, len, f);
3083 LOG_ERROR("failed to write %zu bytes: %s", len, strerror(errno));
3086 static void writeLong(FILE *f, int l)
3089 for (i = 0; i < 4; i++)
3091 char c = (l >> (i*8))&0xff;
3092 writeData(f, &c, 1);
3097 static void writeString(FILE *f, char *s)
3099 writeData(f, s, strlen(s));
3102 /* Dump a gmon.out histogram file. */
3103 static void writeGmon(uint32_t *samples, uint32_t sampleNum, char *filename)
3106 FILE *f = fopen(filename, "w");
3109 writeString(f, "gmon");
3110 writeLong(f, 0x00000001); /* Version */
3111 writeLong(f, 0); /* padding */
3112 writeLong(f, 0); /* padding */
3113 writeLong(f, 0); /* padding */
3115 uint8_t zero = 0; /* GMON_TAG_TIME_HIST */
3116 writeData(f, &zero, 1);
3118 /* figure out bucket size */
3119 uint32_t min = samples[0];
3120 uint32_t max = samples[0];
3121 for (i = 0; i < sampleNum; i++)
3123 if (min > samples[i])
3127 if (max < samples[i])
3133 int addressSpace = (max-min + 1);
3135 static const uint32_t maxBuckets = 256 * 1024; /* maximum buckets. */
3136 uint32_t length = addressSpace;
3137 if (length > maxBuckets)
3139 length = maxBuckets;
3141 int *buckets = malloc(sizeof(int)*length);
3142 if (buckets == NULL)
3147 memset(buckets, 0, sizeof(int)*length);
3148 for (i = 0; i < sampleNum;i++)
3150 uint32_t address = samples[i];
3151 long long a = address-min;
3152 long long b = length-1;
3153 long long c = addressSpace-1;
3154 int index = (a*b)/c; /* danger!!!! int32 overflows */
3158 /* append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr)) */
3159 writeLong(f, min); /* low_pc */
3160 writeLong(f, max); /* high_pc */
3161 writeLong(f, length); /* # of samples */
3162 writeLong(f, 64000000); /* 64MHz */
3163 writeString(f, "seconds");
3164 for (i = 0; i < (15-strlen("seconds")); i++)
3165 writeData(f, &zero, 1);
3166 writeString(f, "s");
3168 /*append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size) */
3170 char *data = malloc(2*length);
3173 for (i = 0; i < length;i++)
3182 data[i*2 + 1]=(val >> 8)&0xff;
3185 writeData(f, data, length * 2);
3195 /* profiling samples the CPU PC as quickly as OpenOCD is able, which will be used as a random sampling of PC */
3196 static int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3198 target_t *target = get_current_target(cmd_ctx);
3199 struct timeval timeout, now;
3201 gettimeofday(&timeout, NULL);
3204 return ERROR_COMMAND_SYNTAX_ERROR;
3207 int retval = parse_uint(args[0], &offset);
3208 if (ERROR_OK != retval)
3211 timeval_add_time(&timeout, offset, 0);
3213 command_print(cmd_ctx, "Starting profiling. Halting and resuming the target as often as we can...");
3215 static const int maxSample = 10000;
3216 uint32_t *samples = malloc(sizeof(uint32_t)*maxSample);
3217 if (samples == NULL)
3221 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
3222 reg_t *reg = register_get_by_name(target->reg_cache, "pc", 1);
3226 target_poll(target);
3227 if (target->state == TARGET_HALTED)
3229 uint32_t t=*((uint32_t *)reg->value);
3230 samples[numSamples++]=t;
3231 retval = target_resume(target, 1, 0, 0, 0); /* current pc, addr = 0, do not handle breakpoints, not debugging */
3232 target_poll(target);
3233 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
3234 } else if (target->state == TARGET_RUNNING)
3236 /* We want to quickly sample the PC. */
3237 if ((retval = target_halt(target)) != ERROR_OK)
3244 command_print(cmd_ctx, "Target not halted or running");
3248 if (retval != ERROR_OK)
3253 gettimeofday(&now, NULL);
3254 if ((numSamples >= maxSample) || ((now.tv_sec >= timeout.tv_sec) && (now.tv_usec >= timeout.tv_usec)))
3256 command_print(cmd_ctx, "Profiling completed. %d samples.", numSamples);
3257 if ((retval = target_poll(target)) != ERROR_OK)
3262 if (target->state == TARGET_HALTED)
3264 target_resume(target, 1, 0, 0, 0); /* current pc, addr = 0, do not handle breakpoints, not debugging */
3266 if ((retval = target_poll(target)) != ERROR_OK)
3271 writeGmon(samples, numSamples, args[1]);
3272 command_print(cmd_ctx, "Wrote %s", args[1]);
3281 static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, uint32_t val)
3284 Jim_Obj *nameObjPtr, *valObjPtr;
3287 namebuf = alloc_printf("%s(%d)", varname, idx);
3291 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3292 valObjPtr = Jim_NewIntObj(interp, val);
3293 if (!nameObjPtr || !valObjPtr)
3299 Jim_IncrRefCount(nameObjPtr);
3300 Jim_IncrRefCount(valObjPtr);
3301 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3302 Jim_DecrRefCount(interp, nameObjPtr);
3303 Jim_DecrRefCount(interp, valObjPtr);
3305 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
3309 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3311 command_context_t *context;
3314 context = Jim_GetAssocData(interp, "context");
3315 if (context == NULL)
3317 LOG_ERROR("mem2array: no command context");
3320 target = get_current_target(context);
3323 LOG_ERROR("mem2array: no current target");
3327 return target_mem2array(interp, target, argc-1, argv + 1);
3330 static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv)
3338 const char *varname;
3339 uint8_t buffer[4096];
3343 /* argv[1] = name of array to receive the data
3344 * argv[2] = desired width
3345 * argv[3] = memory address
3346 * argv[4] = count of times to read
3349 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
3352 varname = Jim_GetString(argv[0], &len);
3353 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3355 e = Jim_GetLong(interp, argv[1], &l);
3361 e = Jim_GetLong(interp, argv[2], &l);
3366 e = Jim_GetLong(interp, argv[3], &l);
3382 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3383 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3387 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3388 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
3391 if ((addr + (len * width)) < addr) {
3392 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3393 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
3396 /* absurd transfer size? */
3398 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3399 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
3404 ((width == 2) && ((addr & 1) == 0)) ||
3405 ((width == 4) && ((addr & 3) == 0))) {
3409 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3410 sprintf(buf, "mem2array address: 0x%08" PRIx32 " is not aligned for %" PRId32 " byte reads",
3413 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3424 /* Slurp... in buffer size chunks */
3426 count = len; /* in objects.. */
3427 if (count > (sizeof(buffer)/width)) {
3428 count = (sizeof(buffer)/width);
3431 retval = target_read_memory(target, addr, width, count, buffer);
3432 if (retval != ERROR_OK) {
3434 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed",
3438 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3439 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
3443 v = 0; /* shut up gcc */
3444 for (i = 0 ;i < count ;i++, n++) {
3447 v = target_buffer_get_u32(target, &buffer[i*width]);
3450 v = target_buffer_get_u16(target, &buffer[i*width]);
3453 v = buffer[i] & 0x0ff;
3456 new_int_array_element(interp, varname, n, v);
3462 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3467 static int get_int_array_element(Jim_Interp * interp, const char *varname, int idx, uint32_t *val)
3470 Jim_Obj *nameObjPtr, *valObjPtr;
3474 namebuf = alloc_printf("%s(%d)", varname, idx);
3478 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
3485 Jim_IncrRefCount(nameObjPtr);
3486 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
3487 Jim_DecrRefCount(interp, nameObjPtr);
3489 if (valObjPtr == NULL)
3492 result = Jim_GetLong(interp, valObjPtr, &l);
3493 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
3498 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3500 command_context_t *context;
3503 context = Jim_GetAssocData(interp, "context");
3504 if (context == NULL) {
3505 LOG_ERROR("array2mem: no command context");
3508 target = get_current_target(context);
3509 if (target == NULL) {
3510 LOG_ERROR("array2mem: no current target");
3514 return target_array2mem(interp,target, argc-1, argv + 1);
3516 static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv)
3524 const char *varname;
3525 uint8_t buffer[4096];
3529 /* argv[1] = name of array to get the data
3530 * argv[2] = desired width
3531 * argv[3] = memory address
3532 * argv[4] = count to write
3535 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
3538 varname = Jim_GetString(argv[0], &len);
3539 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
3541 e = Jim_GetLong(interp, argv[1], &l);
3547 e = Jim_GetLong(interp, argv[2], &l);
3552 e = Jim_GetLong(interp, argv[3], &l);
3568 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3569 Jim_AppendStrings(interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL);
3573 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3574 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: zero width read?", NULL);
3577 if ((addr + (len * width)) < addr) {
3578 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3579 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: addr + len - wraps to zero?", NULL);
3582 /* absurd transfer size? */
3584 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3585 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: absurd > 64K item request", NULL);
3590 ((width == 2) && ((addr & 1) == 0)) ||
3591 ((width == 4) && ((addr & 3) == 0))) {
3595 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3596 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads",
3599 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
3610 /* Slurp... in buffer size chunks */
3612 count = len; /* in objects.. */
3613 if (count > (sizeof(buffer)/width)) {
3614 count = (sizeof(buffer)/width);
3617 v = 0; /* shut up gcc */
3618 for (i = 0 ;i < count ;i++, n++) {
3619 get_int_array_element(interp, varname, n, &v);
3622 target_buffer_set_u32(target, &buffer[i*width], v);
3625 target_buffer_set_u16(target, &buffer[i*width], v);
3628 buffer[i] = v & 0x0ff;
3634 retval = target_write_memory(target, addr, width, count, buffer);
3635 if (retval != ERROR_OK) {
3637 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed",
3641 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3642 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
3648 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3653 void target_all_handle_event(enum target_event e)
3657 LOG_DEBUG("**all*targets: event: %d, %s",
3659 Jim_Nvp_value2name_simple(nvp_target_event, e)->name);
3661 target = all_targets;
3663 target_handle_event(target, e);
3664 target = target->next;
3669 /* FIX? should we propagate errors here rather than printing them
3672 void target_handle_event(target_t *target, enum target_event e)
3674 target_event_action_t *teap;
3676 for (teap = target->event_action; teap != NULL; teap = teap->next) {
3677 if (teap->event == e) {
3678 LOG_DEBUG("target: (%d) %s (%s) event: %d (%s) action: %s",
3679 target->target_number,
3681 target_get_name(target),
3683 Jim_Nvp_value2name_simple(nvp_target_event, e)->name,
3684 Jim_GetString(teap->body, NULL));
3685 if (Jim_EvalObj(interp, teap->body) != JIM_OK)
3687 Jim_PrintErrorMessage(interp);
3693 enum target_cfg_param {
3696 TCFG_WORK_AREA_VIRT,
3697 TCFG_WORK_AREA_PHYS,
3698 TCFG_WORK_AREA_SIZE,
3699 TCFG_WORK_AREA_BACKUP,
3702 TCFG_CHAIN_POSITION,
3705 static Jim_Nvp nvp_config_opts[] = {
3706 { .name = "-type", .value = TCFG_TYPE },
3707 { .name = "-event", .value = TCFG_EVENT },
3708 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
3709 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
3710 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
3711 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
3712 { .name = "-endian" , .value = TCFG_ENDIAN },
3713 { .name = "-variant", .value = TCFG_VARIANT },
3714 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
3716 { .name = NULL, .value = -1 }
3719 static int target_configure(Jim_GetOptInfo *goi, target_t *target)
3727 /* parse config or cget options ... */
3728 while (goi->argc > 0) {
3729 Jim_SetEmptyResult(goi->interp);
3730 /* Jim_GetOpt_Debug(goi); */
3732 if (target->type->target_jim_configure) {
3733 /* target defines a configure function */
3734 /* target gets first dibs on parameters */
3735 e = (*(target->type->target_jim_configure))(target, goi);
3744 /* otherwise we 'continue' below */
3746 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
3748 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
3754 if (goi->isconfigure) {
3755 Jim_SetResult_sprintf(goi->interp, "not setable: %s", n->name);
3759 if (goi->argc != 0) {
3760 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "NO PARAMS");
3764 Jim_SetResultString(goi->interp, target_get_name(target), -1);
3768 if (goi->argc == 0) {
3769 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
3773 e = Jim_GetOpt_Nvp(goi, nvp_target_event, &n);
3775 Jim_GetOpt_NvpUnknown(goi, nvp_target_event, 1);
3779 if (goi->isconfigure) {
3780 if (goi->argc != 1) {
3781 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
3785 if (goi->argc != 0) {
3786 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
3792 target_event_action_t *teap;
3794 teap = target->event_action;
3795 /* replace existing? */
3797 if (teap->event == (enum target_event)n->value) {
3803 if (goi->isconfigure) {
3804 bool replace = true;
3807 teap = calloc(1, sizeof(*teap));
3810 teap->event = n->value;
3811 Jim_GetOpt_Obj(goi, &o);
3813 Jim_DecrRefCount(interp, teap->body);
3815 teap->body = Jim_DuplicateObj(goi->interp, o);
3818 * Tcl/TK - "tk events" have a nice feature.
3819 * See the "BIND" command.
3820 * We should support that here.
3821 * You can specify %X and %Y in the event code.
3822 * The idea is: %T - target name.
3823 * The idea is: %N - target number
3824 * The idea is: %E - event name.
3826 Jim_IncrRefCount(teap->body);
3830 /* add to head of event list */
3831 teap->next = target->event_action;
3832 target->event_action = teap;
3834 Jim_SetEmptyResult(goi->interp);
3838 Jim_SetEmptyResult(goi->interp);
3840 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, teap->body));
3847 case TCFG_WORK_AREA_VIRT:
3848 if (goi->isconfigure) {
3849 target_free_all_working_areas(target);
3850 e = Jim_GetOpt_Wide(goi, &w);
3854 target->working_area_virt = w;
3855 target->working_area_virt_spec = true;
3857 if (goi->argc != 0) {
3861 Jim_SetResult(interp, Jim_NewIntObj(goi->interp, target->working_area_virt));
3865 case TCFG_WORK_AREA_PHYS:
3866 if (goi->isconfigure) {
3867 target_free_all_working_areas(target);
3868 e = Jim_GetOpt_Wide(goi, &w);
3872 target->working_area_phys = w;
3873 target->working_area_phys_spec = true;
3875 if (goi->argc != 0) {
3879 Jim_SetResult(interp, Jim_NewIntObj(goi->interp, target->working_area_phys));
3883 case TCFG_WORK_AREA_SIZE:
3884 if (goi->isconfigure) {
3885 target_free_all_working_areas(target);
3886 e = Jim_GetOpt_Wide(goi, &w);
3890 target->working_area_size = w;
3892 if (goi->argc != 0) {
3896 Jim_SetResult(interp, Jim_NewIntObj(goi->interp, target->working_area_size));
3900 case TCFG_WORK_AREA_BACKUP:
3901 if (goi->isconfigure) {
3902 target_free_all_working_areas(target);
3903 e = Jim_GetOpt_Wide(goi, &w);
3907 /* make this exactly 1 or 0 */
3908 target->backup_working_area = (!!w);
3910 if (goi->argc != 0) {
3914 Jim_SetResult(interp, Jim_NewIntObj(goi->interp, target->backup_working_area));
3915 /* loop for more e*/
3919 if (goi->isconfigure) {
3920 e = Jim_GetOpt_Nvp(goi, nvp_target_endian, &n);
3922 Jim_GetOpt_NvpUnknown(goi, nvp_target_endian, 1);
3925 target->endianness = n->value;
3927 if (goi->argc != 0) {
3931 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
3932 if (n->name == NULL) {
3933 target->endianness = TARGET_LITTLE_ENDIAN;
3934 n = Jim_Nvp_value2name_simple(nvp_target_endian, target->endianness);
3936 Jim_SetResultString(goi->interp, n->name, -1);
3941 if (goi->isconfigure) {
3942 if (goi->argc < 1) {
3943 Jim_SetResult_sprintf(goi->interp,
3948 if (target->variant) {
3949 free((void *)(target->variant));
3951 e = Jim_GetOpt_String(goi, &cp, NULL);
3952 target->variant = strdup(cp);
3954 if (goi->argc != 0) {
3958 Jim_SetResultString(goi->interp, target->variant,-1);
3961 case TCFG_CHAIN_POSITION:
3962 if (goi->isconfigure) {
3965 target_free_all_working_areas(target);
3966 e = Jim_GetOpt_Obj(goi, &o);
3970 tap = jtag_tap_by_jim_obj(goi->interp, o);
3974 /* make this exactly 1 or 0 */
3977 if (goi->argc != 0) {
3981 Jim_SetResultString(interp, target->tap->dotted_name, -1);
3982 /* loop for more e*/
3985 } /* while (goi->argc) */
3988 /* done - we return */
3992 /** this is the 'tcl' handler for the target specific command */
3993 static int tcl_target_func(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
3998 uint8_t target_buf[32];
4001 struct command_context_s *cmd_ctx;
4008 TS_CMD_MWW, TS_CMD_MWH, TS_CMD_MWB,
4009 TS_CMD_MDW, TS_CMD_MDH, TS_CMD_MDB,
4010 TS_CMD_MRW, TS_CMD_MRH, TS_CMD_MRB,
4011 TS_CMD_MEM2ARRAY, TS_CMD_ARRAY2MEM,
4019 TS_CMD_INVOKE_EVENT,
4022 static const Jim_Nvp target_options[] = {
4023 { .name = "configure", .value = TS_CMD_CONFIGURE },
4024 { .name = "cget", .value = TS_CMD_CGET },
4025 { .name = "mww", .value = TS_CMD_MWW },
4026 { .name = "mwh", .value = TS_CMD_MWH },
4027 { .name = "mwb", .value = TS_CMD_MWB },
4028 { .name = "mdw", .value = TS_CMD_MDW },
4029 { .name = "mdh", .value = TS_CMD_MDH },
4030 { .name = "mdb", .value = TS_CMD_MDB },
4031 { .name = "mem2array", .value = TS_CMD_MEM2ARRAY },
4032 { .name = "array2mem", .value = TS_CMD_ARRAY2MEM },
4033 { .name = "eventlist", .value = TS_CMD_EVENTLIST },
4034 { .name = "curstate", .value = TS_CMD_CURSTATE },
4036 { .name = "arp_examine", .value = TS_CMD_EXAMINE },
4037 { .name = "arp_poll", .value = TS_CMD_POLL },
4038 { .name = "arp_reset", .value = TS_CMD_RESET },
4039 { .name = "arp_halt", .value = TS_CMD_HALT },
4040 { .name = "arp_waitstate", .value = TS_CMD_WAITSTATE },
4041 { .name = "invoke-event", .value = TS_CMD_INVOKE_EVENT },
4043 { .name = NULL, .value = -1 },
4046 /* go past the "command" */
4047 Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
4049 target = Jim_CmdPrivData(goi.interp);
4050 cmd_ctx = Jim_GetAssocData(goi.interp, "context");
4052 /* commands here are in an NVP table */
4053 e = Jim_GetOpt_Nvp(&goi, target_options, &n);
4055 Jim_GetOpt_NvpUnknown(&goi, target_options, 0);
4058 /* Assume blank result */
4059 Jim_SetEmptyResult(goi.interp);
4062 case TS_CMD_CONFIGURE:
4064 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv, "missing: -option VALUE ...");
4067 goi.isconfigure = 1;
4068 return target_configure(&goi, target);
4070 // some things take params
4072 Jim_WrongNumArgs(goi.interp, 0, goi.argv, "missing: ?-option?");
4075 goi.isconfigure = 0;
4076 return target_configure(&goi, target);
4084 * argv[3] = optional count.
4087 if ((goi.argc == 2) || (goi.argc == 3)) {
4091 Jim_SetResult_sprintf(goi.interp, "expected: %s ADDR DATA [COUNT]", n->name);
4095 e = Jim_GetOpt_Wide(&goi, &a);
4100 e = Jim_GetOpt_Wide(&goi, &b);
4104 if (goi.argc == 3) {
4105 e = Jim_GetOpt_Wide(&goi, &c);
4115 target_buffer_set_u32(target, target_buf, b);
4119 target_buffer_set_u16(target, target_buf, b);
4123 target_buffer_set_u8(target, target_buf, b);
4127 for (x = 0 ; x < c ; x++) {
4128 e = target_write_memory(target, a, b, 1, target_buf);
4129 if (e != ERROR_OK) {
4130 Jim_SetResult_sprintf(interp, "Error writing @ 0x%08x: %d\n", (int)(a), e);
4143 /* argv[0] = command
4145 * argv[2] = optional count
4147 if ((goi.argc == 2) || (goi.argc == 3)) {
4148 Jim_SetResult_sprintf(goi.interp, "expected: %s ADDR [COUNT]", n->name);
4151 e = Jim_GetOpt_Wide(&goi, &a);
4156 e = Jim_GetOpt_Wide(&goi, &c);
4163 b = 1; /* shut up gcc */
4176 /* convert to "bytes" */
4178 /* count is now in 'BYTES' */
4184 e = target_read_memory(target, a, b, y / b, target_buf);
4185 if (e != ERROR_OK) {
4186 Jim_SetResult_sprintf(interp, "error reading target @ 0x%08lx", (int)(a));
4190 Jim_fprintf(interp, interp->cookie_stdout, "0x%08x ", (int)(a));
4193 for (x = 0 ; (x < 16) && (x < y) ; x += 4) {
4194 z = target_buffer_get_u32(target, &(target_buf[ x * 4 ]));
4195 Jim_fprintf(interp, interp->cookie_stdout, "%08x ", (int)(z));
4197 for (; (x < 16) ; x += 4) {
4198 Jim_fprintf(interp, interp->cookie_stdout, " ");
4202 for (x = 0 ; (x < 16) && (x < y) ; x += 2) {
4203 z = target_buffer_get_u16(target, &(target_buf[ x * 2 ]));
4204 Jim_fprintf(interp, interp->cookie_stdout, "%04x ", (int)(z));
4206 for (; (x < 16) ; x += 2) {
4207 Jim_fprintf(interp, interp->cookie_stdout, " ");
4212 for (x = 0 ; (x < 16) && (x < y) ; x += 1) {
4213 z = target_buffer_get_u8(target, &(target_buf[ x * 4 ]));
4214 Jim_fprintf(interp, interp->cookie_stdout, "%02x ", (int)(z));
4216 for (; (x < 16) ; x += 1) {
4217 Jim_fprintf(interp, interp->cookie_stdout, " ");
4221 /* ascii-ify the bytes */
4222 for (x = 0 ; x < y ; x++) {
4223 if ((target_buf[x] >= 0x20) &&
4224 (target_buf[x] <= 0x7e)) {
4228 target_buf[x] = '.';
4233 target_buf[x] = ' ';
4238 /* print - with a newline */
4239 Jim_fprintf(interp, interp->cookie_stdout, "%s\n", target_buf);
4245 case TS_CMD_MEM2ARRAY:
4246 return target_mem2array(goi.interp, target, goi.argc, goi.argv);
4248 case TS_CMD_ARRAY2MEM:
4249 return target_array2mem(goi.interp, target, goi.argc, goi.argv);
4251 case TS_CMD_EXAMINE:
4253 Jim_WrongNumArgs(goi.interp, 2, argv, "[no parameters]");
4256 if (!target->tap->enabled)
4257 goto err_tap_disabled;
4258 e = target->type->examine(target);
4259 if (e != ERROR_OK) {
4260 Jim_SetResult_sprintf(interp, "examine-fails: %d", e);
4266 Jim_WrongNumArgs(goi.interp, 2, argv, "[no parameters]");
4269 if (!target->tap->enabled)
4270 goto err_tap_disabled;
4271 if (!(target_was_examined(target))) {
4272 e = ERROR_TARGET_NOT_EXAMINED;
4274 e = target->type->poll(target);
4276 if (e != ERROR_OK) {
4277 Jim_SetResult_sprintf(interp, "poll-fails: %d", e);
4284 if (goi.argc != 2) {
4285 Jim_WrongNumArgs(interp, 2, argv,
4286 "([tT]|[fF]|assert|deassert) BOOL");
4289 e = Jim_GetOpt_Nvp(&goi, nvp_assert, &n);
4291 Jim_GetOpt_NvpUnknown(&goi, nvp_assert, 1);
4294 /* the halt or not param */
4295 e = Jim_GetOpt_Wide(&goi, &a);
4299 if (!target->tap->enabled)
4300 goto err_tap_disabled;
4301 if (!target->type->assert_reset
4302 || !target->type->deassert_reset) {
4303 Jim_SetResult_sprintf(interp,
4304 "No target-specific reset for %s",
4308 /* determine if we should halt or not. */
4309 target->reset_halt = !!a;
4310 /* When this happens - all workareas are invalid. */
4311 target_free_all_working_areas_restore(target, 0);
4314 if (n->value == NVP_ASSERT) {
4315 e = target->type->assert_reset(target);
4317 e = target->type->deassert_reset(target);
4319 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4322 Jim_WrongNumArgs(goi.interp, 0, argv, "halt [no parameters]");
4325 if (!target->tap->enabled)
4326 goto err_tap_disabled;
4327 e = target->type->halt(target);
4328 return (e == ERROR_OK) ? JIM_OK : JIM_ERR;
4329 case TS_CMD_WAITSTATE:
4330 /* params: <name> statename timeoutmsecs */
4331 if (goi.argc != 2) {
4332 Jim_SetResult_sprintf(goi.interp, "%s STATENAME TIMEOUTMSECS", n->name);
4335 e = Jim_GetOpt_Nvp(&goi, nvp_target_state, &n);
4337 Jim_GetOpt_NvpUnknown(&goi, nvp_target_state,1);
4340 e = Jim_GetOpt_Wide(&goi, &a);
4344 if (!target->tap->enabled)
4345 goto err_tap_disabled;
4346 e = target_wait_state(target, n->value, a);
4347 if (e != ERROR_OK) {
4348 Jim_SetResult_sprintf(goi.interp,
4349 "target: %s wait %s fails (%d) %s",
4352 e, target_strerror_safe(e));
4357 case TS_CMD_EVENTLIST:
4358 /* List for human, Events defined for this target.
4359 * scripts/programs should use 'name cget -event NAME'
4362 target_event_action_t *teap;
4363 teap = target->event_action;
4364 command_print(cmd_ctx, "Event actions for target (%d) %s\n",
4365 target->target_number,
4367 command_print(cmd_ctx, "%-25s | Body", "Event");
4368 command_print(cmd_ctx, "------------------------- | ----------------------------------------");
4370 command_print(cmd_ctx,
4372 Jim_Nvp_value2name_simple(nvp_target_event, teap->event)->name,
4373 Jim_GetString(teap->body, NULL));
4376 command_print(cmd_ctx, "***END***");
4379 case TS_CMD_CURSTATE:
4380 if (goi.argc != 0) {
4381 Jim_WrongNumArgs(goi.interp, 0, argv, "[no parameters]");
4384 Jim_SetResultString(goi.interp,
4385 target_state_name( target ),
4388 case TS_CMD_INVOKE_EVENT:
4389 if (goi.argc != 1) {
4390 Jim_SetResult_sprintf(goi.interp, "%s ?EVENTNAME?",n->name);
4393 e = Jim_GetOpt_Nvp(&goi, nvp_target_event, &n);
4395 Jim_GetOpt_NvpUnknown(&goi, nvp_target_event, 1);
4398 target_handle_event(target, n->value);
4404 Jim_SetResult_sprintf(interp, "[TAP is disabled]");
4408 static int target_create(Jim_GetOptInfo *goi)
4417 struct command_context_s *cmd_ctx;
4419 cmd_ctx = Jim_GetAssocData(goi->interp, "context");
4420 if (goi->argc < 3) {
4421 Jim_WrongNumArgs(goi->interp, 1, goi->argv, "?name? ?type? ..options...");
4426 Jim_GetOpt_Obj(goi, &new_cmd);
4427 /* does this command exist? */
4428 cmd = Jim_GetCommand(goi->interp, new_cmd, JIM_ERRMSG);
4430 cp = Jim_GetString(new_cmd, NULL);
4431 Jim_SetResult_sprintf(goi->interp, "Command/target: %s Exists", cp);
4436 e = Jim_GetOpt_String(goi, &cp2, NULL);
4438 /* now does target type exist */
4439 for (x = 0 ; target_types[x] ; x++) {
4440 if (0 == strcmp(cp, target_types[x]->name)) {
4445 if (target_types[x] == NULL) {
4446 Jim_SetResult_sprintf(goi->interp, "Unknown target type %s, try one of ", cp);
4447 for (x = 0 ; target_types[x] ; x++) {
4448 if (target_types[x + 1]) {
4449 Jim_AppendStrings(goi->interp,
4450 Jim_GetResult(goi->interp),
4451 target_types[x]->name,
4454 Jim_AppendStrings(goi->interp,
4455 Jim_GetResult(goi->interp),
4457 target_types[x]->name,NULL);
4464 target = calloc(1,sizeof(target_t));
4465 /* set target number */
4466 target->target_number = new_target_number();
4468 /* allocate memory for each unique target type */
4469 target->type = (target_type_t*)calloc(1,sizeof(target_type_t));
4471 memcpy(target->type, target_types[x], sizeof(target_type_t));
4473 /* will be set by "-endian" */
4474 target->endianness = TARGET_ENDIAN_UNKNOWN;
4476 target->working_area = 0x0;
4477 target->working_area_size = 0x0;
4478 target->working_areas = NULL;
4479 target->backup_working_area = 0;
4481 target->state = TARGET_UNKNOWN;
4482 target->debug_reason = DBG_REASON_UNDEFINED;
4483 target->reg_cache = NULL;
4484 target->breakpoints = NULL;
4485 target->watchpoints = NULL;
4486 target->next = NULL;
4487 target->arch_info = NULL;
4489 target->display = 1;
4491 target->halt_issued = false;
4493 /* initialize trace information */
4494 target->trace_info = malloc(sizeof(trace_t));
4495 target->trace_info->num_trace_points = 0;
4496 target->trace_info->trace_points_size = 0;
4497 target->trace_info->trace_points = NULL;
4498 target->trace_info->trace_history_size = 0;
4499 target->trace_info->trace_history = NULL;
4500 target->trace_info->trace_history_pos = 0;
4501 target->trace_info->trace_history_overflowed = 0;
4503 target->dbgmsg = NULL;
4504 target->dbg_msg_enabled = 0;
4506 target->endianness = TARGET_ENDIAN_UNKNOWN;
4508 /* Do the rest as "configure" options */
4509 goi->isconfigure = 1;
4510 e = target_configure(goi, target);
4512 if (target->tap == NULL)
4514 Jim_SetResultString(interp, "-chain-position required when creating target", -1);
4524 if (target->endianness == TARGET_ENDIAN_UNKNOWN) {
4525 /* default endian to little if not specified */
4526 target->endianness = TARGET_LITTLE_ENDIAN;
4529 /* incase variant is not set */
4530 if (!target->variant)
4531 target->variant = strdup("");
4533 /* create the target specific commands */
4534 if (target->type->register_commands) {
4535 (*(target->type->register_commands))(cmd_ctx);
4537 if (target->type->target_create) {
4538 (*(target->type->target_create))(target, goi->interp);
4541 /* append to end of list */
4544 tpp = &(all_targets);
4546 tpp = &((*tpp)->next);
4551 cp = Jim_GetString(new_cmd, NULL);
4552 target->cmd_name = strdup(cp);
4554 /* now - create the new target name command */
4555 e = Jim_CreateCommand(goi->interp,
4558 tcl_target_func, /* C function */
4559 target, /* private data */
4560 NULL); /* no del proc */
4565 static int jim_target(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4569 struct command_context_s *cmd_ctx;
4573 /* TG = target generic */
4581 const char *target_cmds[] = {
4582 "create", "types", "names", "current", "number",
4584 NULL /* terminate */
4587 LOG_DEBUG("Target command params:");
4588 LOG_DEBUG("%s", Jim_Debug_ArgvString(interp, argc, argv));
4590 cmd_ctx = Jim_GetAssocData(interp, "context");
4592 Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
4594 if (goi.argc == 0) {
4595 Jim_WrongNumArgs(interp, 1, argv, "missing: command ...");
4599 /* Jim_GetOpt_Debug(&goi); */
4600 r = Jim_GetOpt_Enum(&goi, target_cmds, &x);
4607 Jim_Panic(goi.interp,"Why am I here?");
4609 case TG_CMD_CURRENT:
4610 if (goi.argc != 0) {
4611 Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
4614 Jim_SetResultString(goi.interp, get_current_target(cmd_ctx)->cmd_name, -1);
4617 if (goi.argc != 0) {
4618 Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
4621 Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0));
4622 for (x = 0 ; target_types[x] ; x++) {
4623 Jim_ListAppendElement(goi.interp,
4624 Jim_GetResult(goi.interp),
4625 Jim_NewStringObj(goi.interp, target_types[x]->name, -1));
4629 if (goi.argc != 0) {
4630 Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters");
4633 Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0));
4634 target = all_targets;
4636 Jim_ListAppendElement(goi.interp,
4637 Jim_GetResult(goi.interp),
4638 Jim_NewStringObj(goi.interp, target->cmd_name, -1));
4639 target = target->next;
4644 Jim_WrongNumArgs(goi.interp, goi.argc, goi.argv, "?name ... config options ...");
4647 return target_create(&goi);
4650 /* It's OK to remove this mechanism sometime after August 2010 or so */
4651 LOG_WARNING("don't use numbers as target identifiers; use names");
4652 if (goi.argc != 1) {
4653 Jim_SetResult_sprintf(goi.interp, "expected: target number ?NUMBER?");
4656 e = Jim_GetOpt_Wide(&goi, &w);
4660 for (x = 0, target = all_targets; target; target = target->next, x++) {
4661 if (target->target_number == w)
4664 if (target == NULL) {
4665 Jim_SetResult_sprintf(goi.interp,
4666 "Target: number %d does not exist", (int)(w));
4669 Jim_SetResultString(goi.interp, target->cmd_name, -1);
4672 if (goi.argc != 0) {
4673 Jim_WrongNumArgs(goi.interp, 0, goi.argv, "<no parameters>");
4676 for (x = 0, target = all_targets; target; target = target->next, x++)
4678 Jim_SetResult(goi.interp, Jim_NewIntObj(goi.interp, x));
4694 static int fastload_num;
4695 static struct FastLoad *fastload;
4697 static void free_fastload(void)
4699 if (fastload != NULL)
4702 for (i = 0; i < fastload_num; i++)
4704 if (fastload[i].data)
4705 free(fastload[i].data);
4715 static int handle_fast_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
4719 uint32_t image_size;
4720 uint32_t min_address = 0;
4721 uint32_t max_address = 0xffffffff;
4726 duration_t duration;
4727 char *duration_text;
4729 int retval = parse_load_image_command_args(args, argc,
4730 &image, &min_address, &max_address);
4731 if (ERROR_OK != retval)
4734 duration_start_measure(&duration);
4736 if (image_open(&image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
4743 fastload_num = image.num_sections;
4744 fastload = (struct FastLoad *)malloc(sizeof(struct FastLoad)*image.num_sections);
4745 if (fastload == NULL)
4747 image_close(&image);
4750 memset(fastload, 0, sizeof(struct FastLoad)*image.num_sections);
4751 for (i = 0; i < image.num_sections; i++)
4753 buffer = malloc(image.sections[i].size);
4756 command_print(cmd_ctx, "error allocating buffer for section (%d bytes)",
4757 (int)(image.sections[i].size));
4761 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
4767 uint32_t offset = 0;
4768 uint32_t length = buf_cnt;
4771 /* DANGER!!! beware of unsigned comparision here!!! */
4773 if ((image.sections[i].base_address + buf_cnt >= min_address)&&
4774 (image.sections[i].base_address < max_address))
4776 if (image.sections[i].base_address < min_address)
4778 /* clip addresses below */
4779 offset += min_address-image.sections[i].base_address;
4783 if (image.sections[i].base_address + buf_cnt > max_address)
4785 length -= (image.sections[i].base_address + buf_cnt)-max_address;
4788 fastload[i].address = image.sections[i].base_address + offset;
4789 fastload[i].data = malloc(length);
4790 if (fastload[i].data == NULL)
4795 memcpy(fastload[i].data, buffer + offset, length);
4796 fastload[i].length = length;
4798 image_size += length;
4799 command_print(cmd_ctx, "%u bytes written at address 0x%8.8x",
4800 (unsigned int)length,
4801 ((unsigned int)(image.sections[i].base_address + offset)));
4807 duration_stop_measure(&duration, &duration_text);
4808 if (retval == ERROR_OK)
4810 command_print(cmd_ctx, "Loaded %u bytes in %s", (unsigned int)image_size, duration_text);
4811 command_print(cmd_ctx, "NB!!! image has not been loaded to target, issue a subsequent 'fast_load' to do so.");
4813 free(duration_text);
4815 image_close(&image);
4817 if (retval != ERROR_OK)
4825 static int handle_fast_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
4828 return ERROR_COMMAND_SYNTAX_ERROR;
4829 if (fastload == NULL)
4831 LOG_ERROR("No image in memory");
4835 int ms = timeval_ms();
4837 int retval = ERROR_OK;
4838 for (i = 0; i < fastload_num;i++)
4840 target_t *target = get_current_target(cmd_ctx);
4841 command_print(cmd_ctx, "Write to 0x%08x, length 0x%08x",
4842 (unsigned int)(fastload[i].address),
4843 (unsigned int)(fastload[i].length));
4844 if (retval == ERROR_OK)
4846 retval = target_write_buffer(target, fastload[i].address, fastload[i].length, fastload[i].data);
4848 size += fastload[i].length;
4850 int after = timeval_ms();
4851 command_print(cmd_ctx, "Loaded image %f kBytes/s", (float)(size/1024.0)/((float)(after-ms)/1000.0));
4855 static int jim_mcrmrc(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
4857 command_context_t *context;
4861 context = Jim_GetAssocData(interp, "context");
4862 if (context == NULL) {
4863 LOG_ERROR("array2mem: no command context");
4866 target = get_current_target(context);
4867 if (target == NULL) {
4868 LOG_ERROR("array2mem: no current target");
4872 if ((argc < 6) || (argc > 7))
4886 e = Jim_GetLong(interp, argv[1], &l);
4892 e = Jim_GetLong(interp, argv[2], &l);
4898 e = Jim_GetLong(interp, argv[3], &l);
4904 e = Jim_GetLong(interp, argv[4], &l);
4910 e = Jim_GetLong(interp, argv[5], &l);
4920 e = Jim_GetLong(interp, argv[6], &l);
4926 retval = target_mcr(target, cpnum, op1, op2, CRn, CRm, value);
4927 if (retval != ERROR_OK)
4931 retval = target_mrc(target, cpnum, op1, op2, CRn, CRm, &value);
4932 if (retval != ERROR_OK)
4935 Jim_SetResult(interp, Jim_NewIntObj(interp, value));