1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
30 #include "replacements.h"
32 #include "target_request.h"
35 #include "configuration.h"
36 #include "binarybuffer.h"
43 #include <sys/types.h>
51 #include <time_support.h>
56 int cli_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv);
59 int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
61 int handle_working_area_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
63 int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
64 int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
65 int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
66 int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
67 int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
68 int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
69 int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
70 int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
71 int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
72 int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
73 int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
74 int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
75 int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
76 int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
77 int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
78 int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
79 int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
80 int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc);
81 int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
82 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
83 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
84 static int jim_target( Jim_Interp *interp, int argc, Jim_Obj *const *argv);
86 static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
87 static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
92 extern target_type_t arm7tdmi_target;
93 extern target_type_t arm720t_target;
94 extern target_type_t arm9tdmi_target;
95 extern target_type_t arm920t_target;
96 extern target_type_t arm966e_target;
97 extern target_type_t arm926ejs_target;
98 extern target_type_t feroceon_target;
99 extern target_type_t xscale_target;
100 extern target_type_t cortexm3_target;
101 extern target_type_t arm11_target;
102 extern target_type_t mips_m4k_target;
104 target_type_t *target_types[] =
120 target_t *all_targets = NULL;
121 target_event_callback_t *target_event_callbacks = NULL;
122 target_timer_callback_t *target_timer_callbacks = NULL;
124 const Jim_Nvp nvp_assert[] = {
125 { .name = "assert", NVP_ASSERT },
126 { .name = "deassert", NVP_DEASSERT },
127 { .name = "T", NVP_ASSERT },
128 { .name = "F", NVP_DEASSERT },
129 { .name = "t", NVP_ASSERT },
130 { .name = "f", NVP_DEASSERT },
131 { .name = NULL, .value = -1 }
134 const Jim_Nvp nvp_error_target[] = {
135 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
136 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
137 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
138 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
139 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
140 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
141 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
142 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
143 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
144 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
145 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
146 { .value = -1, .name = NULL }
149 const char *target_strerror_safe( int err )
153 n = Jim_Nvp_value2name_simple( nvp_error_target, err );
154 if( n->name == NULL ){
161 const Jim_Nvp nvp_target_event[] = {
162 { .value = TARGET_EVENT_OLD_pre_reset , .name = "old-pre_reset" },
163 { .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
164 { .value = TARGET_EVENT_OLD_post_reset , .name = "old-post_reset" },
165 { .value = TARGET_EVENT_OLD_pre_resume , .name = "old-pre_resume" },
168 { .value = TARGET_EVENT_HALTED, .name = "halted" },
169 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
170 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
171 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
173 /* historical name */
175 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
177 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
178 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
179 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
180 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
181 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
182 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
183 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
184 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
185 { .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
186 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
192 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
193 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-end" },
196 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
197 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
199 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
200 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
203 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
204 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
206 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
207 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
209 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
210 { .value = TARGET_EVENT_RESUMED , .name = "resume-ok" },
211 { .value = TARGET_EVENT_RESUME_END , .name = "resume-end" },
213 { .name = NULL, .value = -1 }
216 const Jim_Nvp nvp_target_state[] = {
217 { .name = "unknown", .value = TARGET_UNKNOWN },
218 { .name = "running", .value = TARGET_RUNNING },
219 { .name = "halted", .value = TARGET_HALTED },
220 { .name = "reset", .value = TARGET_RESET },
221 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
222 { .name = NULL, .value = -1 },
226 const Jim_Nvp nvp_target_debug_reason [] = {
227 { .name = "debug-request" , .value = DBG_REASON_DBGRQ },
228 { .name = "breakpoint" , .value = DBG_REASON_BREAKPOINT },
229 { .name = "watchpoint" , .value = DBG_REASON_WATCHPOINT },
230 { .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
231 { .name = "single-step" , .value = DBG_REASON_SINGLESTEP },
232 { .name = "target-not-halted" , .value = DBG_REASON_NOTHALTED },
233 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
234 { .name = NULL, .value = -1 },
238 const Jim_Nvp nvp_target_endian[] = {
239 { .name = "big", .value = TARGET_BIG_ENDIAN },
240 { .name = "little", .value = TARGET_LITTLE_ENDIAN },
241 { .name = "be", .value = TARGET_BIG_ENDIAN },
242 { .name = "le", .value = TARGET_LITTLE_ENDIAN },
243 { .name = NULL, .value = -1 },
246 const Jim_Nvp nvp_reset_modes[] = {
247 { .name = "unknown", .value = RESET_UNKNOWN },
248 { .name = "run" , .value = RESET_RUN },
249 { .name = "halt" , .value = RESET_HALT },
250 { .name = "init" , .value = RESET_INIT },
251 { .name = NULL , .value = -1 },
255 max_target_number( void )
263 if( x < t->target_number ){
264 x = (t->target_number)+1;
271 /* determine the number of the new target */
273 new_target_number( void )
278 /* number is 0 based */
282 if( x < t->target_number ){
283 x = t->target_number;
290 static int target_continous_poll = 1;
292 /* read a u32 from a buffer in target memory endianness */
293 u32 target_buffer_get_u32(target_t *target, u8 *buffer)
295 if (target->endianness == TARGET_LITTLE_ENDIAN)
296 return le_to_h_u32(buffer);
298 return be_to_h_u32(buffer);
301 /* read a u16 from a buffer in target memory endianness */
302 u16 target_buffer_get_u16(target_t *target, u8 *buffer)
304 if (target->endianness == TARGET_LITTLE_ENDIAN)
305 return le_to_h_u16(buffer);
307 return be_to_h_u16(buffer);
310 /* read a u8 from a buffer in target memory endianness */
311 u8 target_buffer_get_u8(target_t *target, u8 *buffer)
313 return *buffer & 0x0ff;
316 /* write a u32 to a buffer in target memory endianness */
317 void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value)
319 if (target->endianness == TARGET_LITTLE_ENDIAN)
320 h_u32_to_le(buffer, value);
322 h_u32_to_be(buffer, value);
325 /* write a u16 to a buffer in target memory endianness */
326 void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value)
328 if (target->endianness == TARGET_LITTLE_ENDIAN)
329 h_u16_to_le(buffer, value);
331 h_u16_to_be(buffer, value);
334 /* write a u8 to a buffer in target memory endianness */
335 void target_buffer_set_u8(target_t *target, u8 *buffer, u8 value)
340 /* returns a pointer to the n-th configured target */
341 target_t* get_target_by_num(int num)
343 target_t *target = all_targets;
346 if( target->target_number == num ){
349 target = target->next;
355 int get_num_by_target(target_t *query_target)
357 return query_target->target_number;
360 target_t* get_current_target(command_context_t *cmd_ctx)
362 target_t *target = get_target_by_num(cmd_ctx->current_target);
366 LOG_ERROR("BUG: current_target out of bounds");
374 int target_poll(struct target_s *target)
376 /* We can't poll until after examine */
377 if (!target->type->examined)
379 /* Fail silently lest we pollute the log */
382 return target->type->poll(target);
385 int target_halt(struct target_s *target)
387 /* We can't poll until after examine */
388 if (!target->type->examined)
390 LOG_ERROR("Target not examined yet");
393 return target->type->halt(target);
396 int target_resume(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution)
400 /* We can't poll until after examine */
401 if (!target->type->examined)
403 LOG_ERROR("Target not examined yet");
407 /* note that resume *must* be asynchronous. The CPU can halt before we poll. The CPU can
408 * even halt at the current PC as a result of a software breakpoint being inserted by (a bug?)
411 if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
417 // Next patch - this turns into TCL...
418 int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
420 int retval = ERROR_OK;
423 target = all_targets;
425 target_all_handle_event( TARGET_EVENT_OLD_pre_reset );
427 if ((retval = jtag_init_reset(cmd_ctx)) != ERROR_OK)
430 keep_alive(); /* we might be running on a very slow JTAG clk */
432 /* First time this is executed after launching OpenOCD, it will read out
433 * the type of CPU, etc. and init Embedded ICE registers in host
436 * It will also set up ICE registers in the target.
438 * However, if we assert TRST later, we need to set up the registers again.
440 * For the "reset halt/init" case we must only set up the registers here.
442 if ((retval = target_examine()) != ERROR_OK)
445 keep_alive(); /* we might be running on a very slow JTAG clk */
447 target = all_targets;
450 /* we have no idea what state the target is in, so we
451 * have to drop working areas
453 target_free_all_working_areas_restore(target, 0);
454 target->reset_halt=((reset_mode==RESET_HALT)||(reset_mode==RESET_INIT));
455 if ((retval = target->type->assert_reset(target))!=ERROR_OK)
457 target = target->next;
460 target = all_targets;
463 if ((retval = target->type->deassert_reset(target))!=ERROR_OK)
465 target = target->next;
468 target = all_targets;
471 /* We can fail to bring the target into the halted state, try after reset has been deasserted */
472 if (target->reset_halt)
474 /* wait up to 1 second for halt. */
475 target_wait_state(target, TARGET_HALTED, 1000);
476 if (target->state != TARGET_HALTED)
478 LOG_WARNING("Failed to reset target into halted mode - issuing halt");
479 if ((retval = target->type->halt(target))!=ERROR_OK)
484 target = target->next;
488 LOG_DEBUG("Waiting for halted stated as appropriate");
490 if ((reset_mode == RESET_HALT) || (reset_mode == RESET_INIT))
492 target = all_targets;
495 /* Wait for reset to complete, maximum 5 seconds. */
496 if (((retval=target_wait_state(target, TARGET_HALTED, 5000)))==ERROR_OK)
498 if (reset_mode == RESET_INIT){
499 target_handle_event( target, TARGET_EVENT_OLD_post_reset );
503 target = target->next;
507 /* We want any events to be processed before the prompt */
508 target_call_timer_callbacks_now();
513 static int default_virt2phys(struct target_s *target, u32 virtual, u32 *physical)
519 static int default_mmu(struct target_s *target, int *enabled)
525 static int default_examine(struct target_s *target)
527 target->type->examined = 1;
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;
540 target_t *target = all_targets;
543 if ((retval = target->type->examine(target))!=ERROR_OK)
545 target = target->next;
550 static int target_write_memory_imp(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer)
552 if (!target->type->examined)
554 LOG_ERROR("Target not examined yet");
557 return target->type->write_memory_imp(target, address, size, count, buffer);
560 static int target_read_memory_imp(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer)
562 if (!target->type->examined)
564 LOG_ERROR("Target not examined yet");
567 return target->type->read_memory_imp(target, address, size, count, buffer);
570 static int target_soft_reset_halt_imp(struct target_s *target)
572 if (!target->type->examined)
574 LOG_ERROR("Target not examined yet");
577 return target->type->soft_reset_halt_imp(target);
580 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, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info)
582 if (!target->type->examined)
584 LOG_ERROR("Target not examined yet");
587 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);
590 int target_init(struct command_context_s *cmd_ctx)
592 target_t *target = all_targets;
596 target->type->examined = 0;
597 if (target->type->examine == NULL)
599 target->type->examine = default_examine;
602 if (target->type->init_target(cmd_ctx, target) != ERROR_OK)
604 LOG_ERROR("target '%s' init failed", target->type->name);
608 /* Set up default functions if none are provided by target */
609 if (target->type->virt2phys == NULL)
611 target->type->virt2phys = default_virt2phys;
613 target->type->virt2phys = default_virt2phys;
614 /* a non-invasive way(in terms of patches) to add some code that
615 * runs before the type->write/read_memory implementation
617 target->type->write_memory_imp = target->type->write_memory;
618 target->type->write_memory = target_write_memory_imp;
619 target->type->read_memory_imp = target->type->read_memory;
620 target->type->read_memory = target_read_memory_imp;
621 target->type->soft_reset_halt_imp = target->type->soft_reset_halt;
622 target->type->soft_reset_halt = target_soft_reset_halt_imp;
623 target->type->run_algorithm_imp = target->type->run_algorithm;
624 target->type->run_algorithm = target_run_algorithm_imp;
627 if (target->type->mmu == NULL)
629 target->type->mmu = default_mmu;
631 target = target->next;
636 target_register_user_commands(cmd_ctx);
637 target_register_timer_callback(handle_target, 100, 1, NULL);
643 int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
645 target_event_callback_t **callbacks_p = &target_event_callbacks;
647 if (callback == NULL)
649 return ERROR_INVALID_ARGUMENTS;
654 while ((*callbacks_p)->next)
655 callbacks_p = &((*callbacks_p)->next);
656 callbacks_p = &((*callbacks_p)->next);
659 (*callbacks_p) = malloc(sizeof(target_event_callback_t));
660 (*callbacks_p)->callback = callback;
661 (*callbacks_p)->priv = priv;
662 (*callbacks_p)->next = NULL;
667 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
669 target_timer_callback_t **callbacks_p = &target_timer_callbacks;
672 if (callback == NULL)
674 return ERROR_INVALID_ARGUMENTS;
679 while ((*callbacks_p)->next)
680 callbacks_p = &((*callbacks_p)->next);
681 callbacks_p = &((*callbacks_p)->next);
684 (*callbacks_p) = malloc(sizeof(target_timer_callback_t));
685 (*callbacks_p)->callback = callback;
686 (*callbacks_p)->periodic = periodic;
687 (*callbacks_p)->time_ms = time_ms;
689 gettimeofday(&now, NULL);
690 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
691 time_ms -= (time_ms % 1000);
692 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
693 if ((*callbacks_p)->when.tv_usec > 1000000)
695 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
696 (*callbacks_p)->when.tv_sec += 1;
699 (*callbacks_p)->priv = priv;
700 (*callbacks_p)->next = NULL;
705 int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
707 target_event_callback_t **p = &target_event_callbacks;
708 target_event_callback_t *c = target_event_callbacks;
710 if (callback == NULL)
712 return ERROR_INVALID_ARGUMENTS;
717 target_event_callback_t *next = c->next;
718 if ((c->callback == callback) && (c->priv == priv))
732 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
734 target_timer_callback_t **p = &target_timer_callbacks;
735 target_timer_callback_t *c = target_timer_callbacks;
737 if (callback == NULL)
739 return ERROR_INVALID_ARGUMENTS;
744 target_timer_callback_t *next = c->next;
745 if ((c->callback == callback) && (c->priv == priv))
759 int target_call_event_callbacks(target_t *target, enum target_event event)
761 target_event_callback_t *callback = target_event_callbacks;
762 target_event_callback_t *next_callback;
764 LOG_DEBUG("target event %i (%s)",
766 Jim_Nvp_value2name_simple( nvp_target_event, event )->name );
768 target_handle_event( target, event );
772 next_callback = callback->next;
773 callback->callback(target, event, callback->priv);
774 callback = next_callback;
780 static int target_call_timer_callbacks_check_time(int checktime)
782 target_timer_callback_t *callback = target_timer_callbacks;
783 target_timer_callback_t *next_callback;
788 gettimeofday(&now, NULL);
792 next_callback = callback->next;
794 if ((!checktime&&callback->periodic)||
795 (((now.tv_sec >= callback->when.tv_sec) && (now.tv_usec >= callback->when.tv_usec))
796 || (now.tv_sec > callback->when.tv_sec)))
798 if(callback->callback != NULL)
800 callback->callback(callback->priv);
801 if (callback->periodic)
803 int time_ms = callback->time_ms;
804 callback->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
805 time_ms -= (time_ms % 1000);
806 callback->when.tv_sec = now.tv_sec + time_ms / 1000;
807 if (callback->when.tv_usec > 1000000)
809 callback->when.tv_usec = callback->when.tv_usec - 1000000;
810 callback->when.tv_sec += 1;
814 target_unregister_timer_callback(callback->callback, callback->priv);
818 callback = next_callback;
824 int target_call_timer_callbacks(void)
826 return target_call_timer_callbacks_check_time(1);
829 /* invoke periodic callbacks immediately */
830 int target_call_timer_callbacks_now(void)
832 return target_call_timer_callbacks();
835 int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area)
837 working_area_t *c = target->working_areas;
838 working_area_t *new_wa = NULL;
840 /* Reevaluate working area address based on MMU state*/
841 if (target->working_areas == NULL)
845 retval = target->type->mmu(target, &enabled);
846 if (retval != ERROR_OK)
852 target->working_area = target->working_area_virt;
856 target->working_area = target->working_area_phys;
860 /* only allocate multiples of 4 byte */
863 LOG_ERROR("BUG: code tried to allocate unaligned number of bytes, padding");
864 size = CEIL(size, 4);
867 /* see if there's already a matching working area */
870 if ((c->free) && (c->size == size))
878 /* if not, allocate a new one */
881 working_area_t **p = &target->working_areas;
882 u32 first_free = target->working_area;
883 u32 free_size = target->working_area_size;
885 LOG_DEBUG("allocating new working area");
887 c = target->working_areas;
890 first_free += c->size;
891 free_size -= c->size;
896 if (free_size < size)
898 LOG_WARNING("not enough working area available(requested %d, free %d)", size, free_size);
899 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
902 new_wa = malloc(sizeof(working_area_t));
905 new_wa->address = first_free;
907 if (target->backup_working_area)
909 new_wa->backup = malloc(new_wa->size);
910 target->type->read_memory(target, new_wa->address, 4, new_wa->size / 4, new_wa->backup);
914 new_wa->backup = NULL;
917 /* put new entry in list */
921 /* mark as used, and return the new (reused) area */
931 int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore)
936 if (restore&&target->backup_working_area)
937 target->type->write_memory(target, area->address, 4, area->size / 4, area->backup);
941 /* mark user pointer invalid */
948 int target_free_working_area(struct target_s *target, working_area_t *area)
950 return target_free_working_area_restore(target, area, 1);
953 int target_free_all_working_areas_restore(struct target_s *target, int restore)
955 working_area_t *c = target->working_areas;
959 working_area_t *next = c->next;
960 target_free_working_area_restore(target, c, restore);
970 target->working_areas = NULL;
975 int target_free_all_working_areas(struct target_s *target)
977 return target_free_all_working_areas_restore(target, 1);
980 int target_register_commands(struct command_context_s *cmd_ctx)
983 register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, NULL);
984 register_command(cmd_ctx, NULL, "working_area", handle_working_area_command, COMMAND_ANY, "working_area <target#> <address> <size> <'backup'|'nobackup'> [virtual address]");
985 register_command(cmd_ctx, NULL, "virt2phys", handle_virt2phys_command, COMMAND_ANY, "virt2phys <virtual address>");
986 register_command(cmd_ctx, NULL, "profile", handle_profile_command, COMMAND_EXEC, "PRELIMINARY! - profile <seconds> <gmon.out>");
988 register_jim(cmd_ctx, "target", jim_target, "configure target" );
991 /* script procedures */
992 register_jim(cmd_ctx, "ocd_mem2array", jim_mem2array, "read memory and return as a TCL array for script processing");
993 register_jim(cmd_ctx, "ocd_array2mem", jim_array2mem, "convert a TCL array to memory locations and write the values");
997 int target_arch_state(struct target_s *target)
1002 LOG_USER("No target has been configured");
1006 LOG_USER("target state: %s",
1007 Jim_Nvp_value2name_simple(nvp_target_state,target->state)->name);
1009 if (target->state!=TARGET_HALTED)
1012 retval=target->type->arch_state(target);
1016 /* Single aligned words are guaranteed to use 16 or 32 bit access
1017 * mode respectively, otherwise data is handled as quickly as
1020 int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer)
1023 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x", size, address);
1025 if (!target->type->examined)
1027 LOG_ERROR("Target not examined yet");
1031 if ((address + size - 1) < address)
1033 /* GDB can request this when e.g. PC is 0xfffffffc*/
1034 LOG_ERROR("address+size wrapped(0x%08x, 0x%08x)", address, size);
1038 if (((address % 2) == 0) && (size == 2))
1040 return target->type->write_memory(target, address, 2, 1, buffer);
1043 /* handle unaligned head bytes */
1046 int unaligned = 4 - (address % 4);
1048 if (unaligned > size)
1051 if ((retval = target->type->write_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
1054 buffer += unaligned;
1055 address += unaligned;
1059 /* handle aligned words */
1062 int aligned = size - (size % 4);
1064 /* use bulk writes above a certain limit. This may have to be changed */
1067 if ((retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer)) != ERROR_OK)
1072 if ((retval = target->type->write_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
1081 /* handle tail writes of less than 4 bytes */
1084 if ((retval = target->type->write_memory(target, address, 1, size, buffer)) != ERROR_OK)
1092 /* Single aligned words are guaranteed to use 16 or 32 bit access
1093 * mode respectively, otherwise data is handled as quickly as
1096 int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer)
1099 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x", size, address);
1101 if (!target->type->examined)
1103 LOG_ERROR("Target not examined yet");
1107 if ((address + size - 1) < address)
1109 /* GDB can request this when e.g. PC is 0xfffffffc*/
1110 LOG_ERROR("address+size wrapped(0x%08x, 0x%08x)", address, size);
1114 if (((address % 2) == 0) && (size == 2))
1116 return target->type->read_memory(target, address, 2, 1, buffer);
1119 /* handle unaligned head bytes */
1122 int unaligned = 4 - (address % 4);
1124 if (unaligned > size)
1127 if ((retval = target->type->read_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
1130 buffer += unaligned;
1131 address += unaligned;
1135 /* handle aligned words */
1138 int aligned = size - (size % 4);
1140 if ((retval = target->type->read_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
1148 /* handle tail writes of less than 4 bytes */
1151 if ((retval = target->type->read_memory(target, address, 1, size, buffer)) != ERROR_OK)
1158 int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc)
1164 if (!target->type->examined)
1166 LOG_ERROR("Target not examined yet");
1170 if ((retval = target->type->checksum_memory(target, address,
1171 size, &checksum)) == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1173 buffer = malloc(size);
1176 LOG_ERROR("error allocating buffer for section (%d bytes)", size);
1177 return ERROR_INVALID_ARGUMENTS;
1179 retval = target_read_buffer(target, address, size, buffer);
1180 if (retval != ERROR_OK)
1186 /* convert to target endianess */
1187 for (i = 0; i < (size/sizeof(u32)); i++)
1190 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(u32)]);
1191 target_buffer_set_u32(target, &buffer[i*sizeof(u32)], target_data);
1194 retval = image_calculate_checksum( buffer, size, &checksum );
1203 int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank)
1206 if (!target->type->examined)
1208 LOG_ERROR("Target not examined yet");
1212 if (target->type->blank_check_memory == 0)
1213 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1215 retval = target->type->blank_check_memory(target, address, size, blank);
1220 int target_read_u32(struct target_s *target, u32 address, u32 *value)
1223 if (!target->type->examined)
1225 LOG_ERROR("Target not examined yet");
1229 int retval = target->type->read_memory(target, address, 4, 1, value_buf);
1231 if (retval == ERROR_OK)
1233 *value = target_buffer_get_u32(target, value_buf);
1234 LOG_DEBUG("address: 0x%8.8x, value: 0x%8.8x", address, *value);
1239 LOG_DEBUG("address: 0x%8.8x failed", address);
1245 int target_read_u16(struct target_s *target, u32 address, u16 *value)
1248 if (!target->type->examined)
1250 LOG_ERROR("Target not examined yet");
1254 int retval = target->type->read_memory(target, address, 2, 1, value_buf);
1256 if (retval == ERROR_OK)
1258 *value = target_buffer_get_u16(target, value_buf);
1259 LOG_DEBUG("address: 0x%8.8x, value: 0x%4.4x", address, *value);
1264 LOG_DEBUG("address: 0x%8.8x failed", address);
1270 int target_read_u8(struct target_s *target, u32 address, u8 *value)
1272 int retval = target->type->read_memory(target, address, 1, 1, value);
1273 if (!target->type->examined)
1275 LOG_ERROR("Target not examined yet");
1279 if (retval == ERROR_OK)
1281 LOG_DEBUG("address: 0x%8.8x, value: 0x%2.2x", address, *value);
1286 LOG_DEBUG("address: 0x%8.8x failed", address);
1292 int target_write_u32(struct target_s *target, u32 address, u32 value)
1296 if (!target->type->examined)
1298 LOG_ERROR("Target not examined yet");
1302 LOG_DEBUG("address: 0x%8.8x, value: 0x%8.8x", address, value);
1304 target_buffer_set_u32(target, value_buf, value);
1305 if ((retval = target->type->write_memory(target, address, 4, 1, value_buf)) != ERROR_OK)
1307 LOG_DEBUG("failed: %i", retval);
1313 int target_write_u16(struct target_s *target, u32 address, u16 value)
1317 if (!target->type->examined)
1319 LOG_ERROR("Target not examined yet");
1323 LOG_DEBUG("address: 0x%8.8x, value: 0x%8.8x", address, value);
1325 target_buffer_set_u16(target, value_buf, value);
1326 if ((retval = target->type->write_memory(target, address, 2, 1, value_buf)) != ERROR_OK)
1328 LOG_DEBUG("failed: %i", retval);
1334 int target_write_u8(struct target_s *target, u32 address, u8 value)
1337 if (!target->type->examined)
1339 LOG_ERROR("Target not examined yet");
1343 LOG_DEBUG("address: 0x%8.8x, value: 0x%2.2x", address, value);
1345 if ((retval = target->type->read_memory(target, address, 1, 1, &value)) != ERROR_OK)
1347 LOG_DEBUG("failed: %i", retval);
1353 int target_register_user_commands(struct command_context_s *cmd_ctx)
1355 register_command(cmd_ctx, NULL, "reg", handle_reg_command, COMMAND_EXEC, NULL);
1356 register_command(cmd_ctx, NULL, "poll", handle_poll_command, COMMAND_EXEC, "poll target state");
1357 register_command(cmd_ctx, NULL, "wait_halt", handle_wait_halt_command, COMMAND_EXEC, "wait for target halt [time (s)]");
1358 register_command(cmd_ctx, NULL, "halt", handle_halt_command, COMMAND_EXEC, "halt target");
1359 register_command(cmd_ctx, NULL, "resume", handle_resume_command, COMMAND_EXEC, "resume target [addr]");
1360 register_command(cmd_ctx, NULL, "step", handle_step_command, COMMAND_EXEC, "step one instruction from current PC or [addr]");
1361 register_command(cmd_ctx, NULL, "reset", handle_reset_command, COMMAND_EXEC, "reset target [run|halt|init] - default is run");
1362 register_command(cmd_ctx, NULL, "soft_reset_halt", handle_soft_reset_halt_command, COMMAND_EXEC, "halt the target and do a soft reset");
1364 register_command(cmd_ctx, NULL, "mdw", handle_md_command, COMMAND_EXEC, "display memory words <addr> [count]");
1365 register_command(cmd_ctx, NULL, "mdh", handle_md_command, COMMAND_EXEC, "display memory half-words <addr> [count]");
1366 register_command(cmd_ctx, NULL, "mdb", handle_md_command, COMMAND_EXEC, "display memory bytes <addr> [count]");
1368 register_command(cmd_ctx, NULL, "mww", handle_mw_command, COMMAND_EXEC, "write memory word <addr> <value> [count]");
1369 register_command(cmd_ctx, NULL, "mwh", handle_mw_command, COMMAND_EXEC, "write memory half-word <addr> <value> [count]");
1370 register_command(cmd_ctx, NULL, "mwb", handle_mw_command, COMMAND_EXEC, "write memory byte <addr> <value> [count]");
1372 register_command(cmd_ctx, NULL, "bp", handle_bp_command, COMMAND_EXEC, "set breakpoint <address> <length> [hw]");
1373 register_command(cmd_ctx, NULL, "rbp", handle_rbp_command, COMMAND_EXEC, "remove breakpoint <adress>");
1374 register_command(cmd_ctx, NULL, "wp", handle_wp_command, COMMAND_EXEC, "set watchpoint <address> <length> <r/w/a> [value] [mask]");
1375 register_command(cmd_ctx, NULL, "rwp", handle_rwp_command, COMMAND_EXEC, "remove watchpoint <adress>");
1377 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]");
1378 register_command(cmd_ctx, NULL, "dump_image", handle_dump_image_command, COMMAND_EXEC, "dump_image <file> <address> <size>");
1379 register_command(cmd_ctx, NULL, "verify_image", handle_verify_image_command, COMMAND_EXEC, "verify_image <file> [offset] [type]");
1381 target_request_register_commands(cmd_ctx);
1382 trace_register_commands(cmd_ctx);
1387 int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1390 target_t *target = all_targets;
1394 /* try as tcltarget name */
1395 for( target = all_targets ; target ; target++ ){
1396 if( target->cmd_name ){
1397 if( 0 == strcmp( args[0], target->cmd_name ) ){
1403 /* no match, try as number */
1405 int num = strtoul(args[0], &cp, 0 );
1407 /* then it was not a number */
1408 command_print( cmd_ctx, "Target: %s unknown, try one of:\n", args[0] );
1412 target = get_target_by_num( num );
1413 if( target == NULL ){
1414 command_print(cmd_ctx,"Target: %s is unknown, try one of:\n", args[0] );
1418 cmd_ctx->current_target = target->target_number;
1423 command_print(cmd_ctx, " CmdName Type Endian ChainPos State ");
1424 command_print(cmd_ctx, "-- ---------- ---------- ---------- -------- ----------");
1427 /* XX: abcdefghij abcdefghij abcdefghij abcdefghij */
1428 command_print(cmd_ctx, "%2d: %-10s %-10s %-10s %8d %s",
1429 target->target_number,
1432 Jim_Nvp_value2name_simple( nvp_target_endian, target->endianness )->name,
1433 target->chain_position,
1434 Jim_Nvp_value2name_simple( nvp_target_state, target->state )->name );
1435 target = target->next;
1443 int handle_working_area_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1445 target_t *target = NULL;
1447 if ((argc < 4) || (argc > 5))
1449 return ERROR_COMMAND_SYNTAX_ERROR;
1452 target = get_target_by_num(strtoul(args[0], NULL, 0));
1455 return ERROR_COMMAND_SYNTAX_ERROR;
1457 target_free_all_working_areas(target);
1459 target->working_area_phys = target->working_area_virt = strtoul(args[1], NULL, 0);
1462 target->working_area_virt = strtoul(args[4], NULL, 0);
1464 target->working_area_size = strtoul(args[2], NULL, 0);
1466 if (strcmp(args[3], "backup") == 0)
1468 target->backup_working_area = 1;
1470 else if (strcmp(args[3], "nobackup") == 0)
1472 target->backup_working_area = 0;
1476 LOG_ERROR("unrecognized <backup|nobackup> argument (%s)", args[3]);
1477 return ERROR_COMMAND_SYNTAX_ERROR;
1484 /* process target state changes */
1485 int handle_target(void *priv)
1487 target_t *target = all_targets;
1491 if (target_continous_poll)
1493 /* polling may fail silently until the target has been examined */
1494 target_poll(target);
1497 target = target->next;
1503 int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1512 target = get_current_target(cmd_ctx);
1514 /* list all available registers for the current target */
1517 reg_cache_t *cache = target->reg_cache;
1523 for (i = 0; i < cache->num_regs; i++)
1525 value = buf_to_str(cache->reg_list[i].value, cache->reg_list[i].size, 16);
1526 command_print(cmd_ctx, "(%i) %s (/%i): 0x%s (dirty: %i, valid: %i)", count++, cache->reg_list[i].name, cache->reg_list[i].size, value, cache->reg_list[i].dirty, cache->reg_list[i].valid);
1529 cache = cache->next;
1535 /* access a single register by its ordinal number */
1536 if ((args[0][0] >= '0') && (args[0][0] <= '9'))
1538 int num = strtoul(args[0], NULL, 0);
1539 reg_cache_t *cache = target->reg_cache;
1545 for (i = 0; i < cache->num_regs; i++)
1549 reg = &cache->reg_list[i];
1555 cache = cache->next;
1560 command_print(cmd_ctx, "%i is out of bounds, the current target has only %i registers (0 - %i)", num, count, count - 1);
1563 } else /* access a single register by its name */
1565 reg = register_get_by_name(target->reg_cache, args[0], 1);
1569 command_print(cmd_ctx, "register %s not found in current target", args[0]);
1574 /* display a register */
1575 if ((argc == 1) || ((argc == 2) && !((args[1][0] >= '0') && (args[1][0] <= '9'))))
1577 if ((argc == 2) && (strcmp(args[1], "force") == 0))
1580 if (reg->valid == 0)
1582 reg_arch_type_t *arch_type = register_get_arch_type(reg->arch_type);
1583 if (arch_type == NULL)
1585 LOG_ERROR("BUG: encountered unregistered arch type");
1588 arch_type->get(reg);
1590 value = buf_to_str(reg->value, reg->size, 16);
1591 command_print(cmd_ctx, "%s (/%i): 0x%s", reg->name, reg->size, value);
1596 /* set register value */
1599 u8 *buf = malloc(CEIL(reg->size, 8));
1600 str_to_buf(args[1], strlen(args[1]), buf, reg->size, 0);
1602 reg_arch_type_t *arch_type = register_get_arch_type(reg->arch_type);
1603 if (arch_type == NULL)
1605 LOG_ERROR("BUG: encountered unregistered arch type");
1609 arch_type->set(reg, buf);
1611 value = buf_to_str(reg->value, reg->size, 16);
1612 command_print(cmd_ctx, "%s (/%i): 0x%s", reg->name, reg->size, value);
1620 command_print(cmd_ctx, "usage: reg <#|name> [value]");
1626 int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1628 target_t *target = get_current_target(cmd_ctx);
1632 target_poll(target);
1633 target_arch_state(target);
1637 if (strcmp(args[0], "on") == 0)
1639 target_continous_poll = 1;
1641 else if (strcmp(args[0], "off") == 0)
1643 target_continous_poll = 0;
1647 command_print(cmd_ctx, "arg is \"on\" or \"off\"");
1655 int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1663 ms = strtoul(args[0], &end, 0) * 1000;
1666 command_print(cmd_ctx, "usage: %s [seconds]", cmd);
1670 target_t *target = get_current_target(cmd_ctx);
1672 return target_wait_state(target, TARGET_HALTED, ms);
1675 int target_wait_state(target_t *target, enum target_state state, int ms)
1678 struct timeval timeout, now;
1680 gettimeofday(&timeout, NULL);
1681 timeval_add_time(&timeout, 0, ms * 1000);
1685 if ((retval=target_poll(target))!=ERROR_OK)
1688 if (target->state == state)
1695 LOG_DEBUG("waiting for target %s...",
1696 Jim_Nvp_value2name_simple(nvp_target_state,state)->name);
1699 gettimeofday(&now, NULL);
1700 if ((now.tv_sec > timeout.tv_sec) || ((now.tv_sec == timeout.tv_sec) && (now.tv_usec >= timeout.tv_usec)))
1702 LOG_ERROR("timed out while waiting for target %s",
1703 Jim_Nvp_value2name_simple(nvp_target_state,state)->name);
1711 int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1714 target_t *target = get_current_target(cmd_ctx);
1718 if ((retval = target_halt(target)) != ERROR_OK)
1723 return handle_wait_halt_command(cmd_ctx, cmd, args, argc);
1726 int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1728 target_t *target = get_current_target(cmd_ctx);
1730 LOG_USER("requesting target halt and executing a soft reset");
1732 target->type->soft_reset_halt(target);
1737 int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1740 enum target_reset_mode reset_mode = RESET_RUN;
1744 n = Jim_Nvp_name2value_simple( nvp_reset_modes, args[0] );
1745 if( (n->name == NULL) || (n->value == RESET_UNKNOWN) ){
1746 return ERROR_COMMAND_SYNTAX_ERROR;
1748 reset_mode = n->value;
1751 /* reset *all* targets */
1752 return target_process_reset(cmd_ctx, reset_mode);
1755 int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1758 target_t *target = get_current_target(cmd_ctx);
1760 target_handle_event( target, TARGET_EVENT_OLD_pre_resume );
1763 retval = target_resume(target, 1, 0, 1, 0); /* current pc, addr = 0, handle breakpoints, not debugging */
1765 retval = target_resume(target, 0, strtoul(args[0], NULL, 0), 1, 0); /* addr = args[0], handle breakpoints, not debugging */
1768 retval = ERROR_COMMAND_SYNTAX_ERROR;
1774 int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1776 target_t *target = get_current_target(cmd_ctx);
1781 target->type->step(target, 1, 0, 1); /* current pc, addr = 0, handle breakpoints */
1784 target->type->step(target, 0, strtoul(args[0], NULL, 0), 1); /* addr = args[0], handle breakpoints */
1789 int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1791 const int line_bytecnt = 32;
1804 target_t *target = get_current_target(cmd_ctx);
1810 count = strtoul(args[1], NULL, 0);
1812 address = strtoul(args[0], NULL, 0);
1818 size = 4; line_modulo = line_bytecnt / 4;
1821 size = 2; line_modulo = line_bytecnt / 2;
1824 size = 1; line_modulo = line_bytecnt / 1;
1830 buffer = calloc(count, size);
1831 retval = target->type->read_memory(target, address, size, count, buffer);
1832 if (retval == ERROR_OK)
1836 for (i = 0; i < count; i++)
1838 if (i%line_modulo == 0)
1839 output_len += snprintf(output + output_len, 128 - output_len, "0x%8.8x: ", address + (i*size));
1844 output_len += snprintf(output + output_len, 128 - output_len, "%8.8x ", target_buffer_get_u32(target, &buffer[i*4]));
1847 output_len += snprintf(output + output_len, 128 - output_len, "%4.4x ", target_buffer_get_u16(target, &buffer[i*2]));
1850 output_len += snprintf(output + output_len, 128 - output_len, "%2.2x ", buffer[i*1]);
1854 if ((i%line_modulo == line_modulo-1) || (i == count - 1))
1856 command_print(cmd_ctx, output);
1867 int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1874 target_t *target = get_current_target(cmd_ctx);
1877 if ((argc < 2) || (argc > 3))
1878 return ERROR_COMMAND_SYNTAX_ERROR;
1880 address = strtoul(args[0], NULL, 0);
1881 value = strtoul(args[1], NULL, 0);
1883 count = strtoul(args[2], NULL, 0);
1889 target_buffer_set_u32(target, value_buf, value);
1893 target_buffer_set_u16(target, value_buf, value);
1897 value_buf[0] = value;
1900 return ERROR_COMMAND_SYNTAX_ERROR;
1902 for (i=0; i<count; i++)
1908 retval = target->type->write_memory(target, address + i*wordsize, 4, 1, value_buf);
1911 retval = target->type->write_memory(target, address + i*wordsize, 2, 1, value_buf);
1914 retval = target->type->write_memory(target, address + i*wordsize, 1, 1, value_buf);
1919 if (retval!=ERROR_OK)
1929 int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1935 u32 max_address=0xffffffff;
1941 duration_t duration;
1942 char *duration_text;
1944 target_t *target = get_current_target(cmd_ctx);
1946 if ((argc < 1)||(argc > 5))
1948 return ERROR_COMMAND_SYNTAX_ERROR;
1951 /* a base address isn't always necessary, default to 0x0 (i.e. don't relocate) */
1954 image.base_address_set = 1;
1955 image.base_address = strtoul(args[1], NULL, 0);
1959 image.base_address_set = 0;
1963 image.start_address_set = 0;
1967 min_address=strtoul(args[3], NULL, 0);
1971 max_address=strtoul(args[4], NULL, 0)+min_address;
1974 if (min_address>max_address)
1976 return ERROR_COMMAND_SYNTAX_ERROR;
1980 duration_start_measure(&duration);
1982 if (image_open(&image, args[0], (argc >= 3) ? args[2] : NULL) != ERROR_OK)
1989 for (i = 0; i < image.num_sections; i++)
1991 buffer = malloc(image.sections[i].size);
1994 command_print(cmd_ctx, "error allocating buffer for section (%d bytes)", image.sections[i].size);
1998 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
2008 /* DANGER!!! beware of unsigned comparision here!!! */
2010 if ((image.sections[i].base_address+buf_cnt>=min_address)&&
2011 (image.sections[i].base_address<max_address))
2013 if (image.sections[i].base_address<min_address)
2015 /* clip addresses below */
2016 offset+=min_address-image.sections[i].base_address;
2020 if (image.sections[i].base_address+buf_cnt>max_address)
2022 length-=(image.sections[i].base_address+buf_cnt)-max_address;
2025 if ((retval = target_write_buffer(target, image.sections[i].base_address+offset, length, buffer+offset)) != ERROR_OK)
2030 image_size += length;
2031 command_print(cmd_ctx, "%u byte written at address 0x%8.8x", length, image.sections[i].base_address+offset);
2037 duration_stop_measure(&duration, &duration_text);
2038 if (retval==ERROR_OK)
2040 command_print(cmd_ctx, "downloaded %u byte in %s", image_size, duration_text);
2042 free(duration_text);
2044 image_close(&image);
2050 int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2057 int retval=ERROR_OK;
2059 duration_t duration;
2060 char *duration_text;
2062 target_t *target = get_current_target(cmd_ctx);
2066 command_print(cmd_ctx, "usage: dump_image <filename> <address> <size>");
2070 address = strtoul(args[1], NULL, 0);
2071 size = strtoul(args[2], NULL, 0);
2073 if ((address & 3) || (size & 3))
2075 command_print(cmd_ctx, "only 32-bit aligned address and size are supported");
2079 if (fileio_open(&fileio, args[0], FILEIO_WRITE, FILEIO_BINARY) != ERROR_OK)
2084 duration_start_measure(&duration);
2089 u32 this_run_size = (size > 560) ? 560 : size;
2091 retval = target->type->read_memory(target, address, 4, this_run_size / 4, buffer);
2092 if (retval != ERROR_OK)
2097 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2098 if (retval != ERROR_OK)
2103 size -= this_run_size;
2104 address += this_run_size;
2107 fileio_close(&fileio);
2109 duration_stop_measure(&duration, &duration_text);
2110 if (retval==ERROR_OK)
2112 command_print(cmd_ctx, "dumped %"PRIi64" byte in %s", fileio.size, duration_text);
2114 free(duration_text);
2119 int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2127 u32 mem_checksum = 0;
2131 duration_t duration;
2132 char *duration_text;
2134 target_t *target = get_current_target(cmd_ctx);
2138 return ERROR_COMMAND_SYNTAX_ERROR;
2143 LOG_ERROR("no target selected");
2147 duration_start_measure(&duration);
2151 image.base_address_set = 1;
2152 image.base_address = strtoul(args[1], NULL, 0);
2156 image.base_address_set = 0;
2157 image.base_address = 0x0;
2160 image.start_address_set = 0;
2162 if ((retval=image_open(&image, args[0], (argc == 3) ? args[2] : NULL)) != ERROR_OK)
2169 for (i = 0; i < image.num_sections; i++)
2171 buffer = malloc(image.sections[i].size);
2174 command_print(cmd_ctx, "error allocating buffer for section (%d bytes)", image.sections[i].size);
2177 if ((retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt)) != ERROR_OK)
2183 /* calculate checksum of image */
2184 image_calculate_checksum( buffer, buf_cnt, &checksum );
2186 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
2187 if( retval != ERROR_OK )
2193 if( checksum != mem_checksum )
2195 /* failed crc checksum, fall back to a binary compare */
2198 command_print(cmd_ctx, "checksum mismatch - attempting binary compare");
2200 data = (u8*)malloc(buf_cnt);
2202 /* Can we use 32bit word accesses? */
2204 int count = buf_cnt;
2205 if ((count % 4) == 0)
2210 retval = target->type->read_memory(target, image.sections[i].base_address, size, count, data);
2211 if (retval == ERROR_OK)
2214 for (t = 0; t < buf_cnt; t++)
2216 if (data[t] != buffer[t])
2218 command_print(cmd_ctx, "Verify operation failed address 0x%08x. Was 0x%02x instead of 0x%02x\n", t + image.sections[i].base_address, data[t], buffer[t]);
2231 image_size += buf_cnt;
2234 duration_stop_measure(&duration, &duration_text);
2235 if (retval==ERROR_OK)
2237 command_print(cmd_ctx, "verified %u bytes in %s", image_size, duration_text);
2239 free(duration_text);
2241 image_close(&image);
2246 int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2249 target_t *target = get_current_target(cmd_ctx);
2253 breakpoint_t *breakpoint = target->breakpoints;
2257 if (breakpoint->type == BKPT_SOFT)
2259 char* buf = buf_to_str(breakpoint->orig_instr, breakpoint->length, 16);
2260 command_print(cmd_ctx, "0x%8.8x, 0x%x, %i, 0x%s", breakpoint->address, breakpoint->length, breakpoint->set, buf);
2265 command_print(cmd_ctx, "0x%8.8x, 0x%x, %i", breakpoint->address, breakpoint->length, breakpoint->set);
2267 breakpoint = breakpoint->next;
2275 length = strtoul(args[1], NULL, 0);
2278 if (strcmp(args[2], "hw") == 0)
2281 if ((retval = breakpoint_add(target, strtoul(args[0], NULL, 0), length, hw)) != ERROR_OK)
2283 LOG_ERROR("Failure setting breakpoints");
2287 command_print(cmd_ctx, "breakpoint added at address 0x%8.8x", strtoul(args[0], NULL, 0));
2292 command_print(cmd_ctx, "usage: bp <address> <length> ['hw']");
2298 int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2300 target_t *target = get_current_target(cmd_ctx);
2303 breakpoint_remove(target, strtoul(args[0], NULL, 0));
2308 int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2310 target_t *target = get_current_target(cmd_ctx);
2315 watchpoint_t *watchpoint = target->watchpoints;
2319 command_print(cmd_ctx, "address: 0x%8.8x, len: 0x%8.8x, r/w/a: %i, value: 0x%8.8x, mask: 0x%8.8x", watchpoint->address, watchpoint->length, watchpoint->rw, watchpoint->value, watchpoint->mask);
2320 watchpoint = watchpoint->next;
2325 enum watchpoint_rw type = WPT_ACCESS;
2326 u32 data_value = 0x0;
2327 u32 data_mask = 0xffffffff;
2343 command_print(cmd_ctx, "usage: wp <address> <length> [r/w/a] [value] [mask]");
2349 data_value = strtoul(args[3], NULL, 0);
2353 data_mask = strtoul(args[4], NULL, 0);
2356 if ((retval = watchpoint_add(target, strtoul(args[0], NULL, 0),
2357 strtoul(args[1], NULL, 0), type, data_value, data_mask)) != ERROR_OK)
2359 LOG_ERROR("Failure setting breakpoints");
2364 command_print(cmd_ctx, "usage: wp <address> <length> [r/w/a] [value] [mask]");
2370 int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2372 target_t *target = get_current_target(cmd_ctx);
2375 watchpoint_remove(target, strtoul(args[0], NULL, 0));
2380 int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc)
2383 target_t *target = get_current_target(cmd_ctx);
2389 return ERROR_COMMAND_SYNTAX_ERROR;
2391 va = strtoul(args[0], NULL, 0);
2393 retval = target->type->virt2phys(target, va, &pa);
2394 if (retval == ERROR_OK)
2396 command_print(cmd_ctx, "Physical address 0x%08x", pa);
2400 /* lower levels will have logged a detailed error which is
2401 * forwarded to telnet/GDB session.
2406 static void writeLong(FILE *f, int l)
2411 char c=(l>>(i*8))&0xff;
2412 fwrite(&c, 1, 1, f);
2416 static void writeString(FILE *f, char *s)
2418 fwrite(s, 1, strlen(s), f);
2423 // Dump a gmon.out histogram file.
2424 static void writeGmon(u32 *samples, int sampleNum, char *filename)
2427 FILE *f=fopen(filename, "w");
2430 fwrite("gmon", 1, 4, f);
2431 writeLong(f, 0x00000001); // Version
2432 writeLong(f, 0); // padding
2433 writeLong(f, 0); // padding
2434 writeLong(f, 0); // padding
2436 fwrite("", 1, 1, f); // GMON_TAG_TIME_HIST
2438 // figure out bucket size
2441 for (i=0; i<sampleNum; i++)
2453 int addressSpace=(max-min+1);
2455 static int const maxBuckets=256*1024; // maximum buckets.
2456 int length=addressSpace;
2457 if (length > maxBuckets)
2461 int *buckets=malloc(sizeof(int)*length);
2467 memset(buckets, 0, sizeof(int)*length);
2468 for (i=0; i<sampleNum;i++)
2470 u32 address=samples[i];
2471 long long a=address-min;
2472 long long b=length-1;
2473 long long c=addressSpace-1;
2474 int index=(a*b)/c; // danger!!!! int32 overflows
2478 // append binary memory gmon.out &profile_hist_hdr ((char*)&profile_hist_hdr + sizeof(struct gmon_hist_hdr))
2479 writeLong(f, min); // low_pc
2480 writeLong(f, max); // high_pc
2481 writeLong(f, length); // # of samples
2482 writeLong(f, 64000000); // 64MHz
2483 writeString(f, "seconds");
2484 for (i=0; i<(15-strlen("seconds")); i++)
2486 fwrite("", 1, 1, f); // padding
2488 writeString(f, "s");
2490 // append binary memory gmon.out profile_hist_data (profile_hist_data + profile_hist_hdr.hist_size)
2492 char *data=malloc(2*length);
2495 for (i=0; i<length;i++)
2504 data[i*2+1]=(val>>8)&0xff;
2507 fwrite(data, 1, length*2, f);
2517 /* profiling samples the CPU PC as quickly as OpenOCD is able, which will be used as a random sampling of PC */
2518 int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2520 target_t *target = get_current_target(cmd_ctx);
2521 struct timeval timeout, now;
2523 gettimeofday(&timeout, NULL);
2526 return ERROR_COMMAND_SYNTAX_ERROR;
2529 timeval_add_time(&timeout, strtoul(args[0], &end, 0), 0);
2535 command_print(cmd_ctx, "Starting profiling. Halting and resuming the target as often as we can...");
2537 static const int maxSample=10000;
2538 u32 *samples=malloc(sizeof(u32)*maxSample);
2543 int retval=ERROR_OK;
2544 // hopefully it is safe to cache! We want to stop/restart as quickly as possible.
2545 reg_t *reg = register_get_by_name(target->reg_cache, "pc", 1);
2549 target_poll(target);
2550 if (target->state == TARGET_HALTED)
2552 u32 t=*((u32 *)reg->value);
2553 samples[numSamples++]=t;
2554 retval = target_resume(target, 1, 0, 0, 0); /* current pc, addr = 0, do not handle breakpoints, not debugging */
2555 target_poll(target);
2556 alive_sleep(10); // sleep 10ms, i.e. <100 samples/second.
2557 } else if (target->state == TARGET_RUNNING)
2559 // We want to quickly sample the PC.
2560 target_halt(target);
2563 command_print(cmd_ctx, "Target not halted or running");
2567 if (retval!=ERROR_OK)
2572 gettimeofday(&now, NULL);
2573 if ((numSamples>=maxSample) || ((now.tv_sec >= timeout.tv_sec) && (now.tv_usec >= timeout.tv_usec)))
2575 command_print(cmd_ctx, "Profiling completed. %d samples.", numSamples);
2576 target_poll(target);
2577 if (target->state == TARGET_HALTED)
2579 target_resume(target, 1, 0, 0, 0); /* current pc, addr = 0, do not handle breakpoints, not debugging */
2581 target_poll(target);
2582 writeGmon(samples, numSamples, args[1]);
2583 command_print(cmd_ctx, "Wrote %s", args[1]);
2592 static int new_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 val)
2595 Jim_Obj *nameObjPtr, *valObjPtr;
2598 namebuf = alloc_printf("%s(%d)", varname, idx);
2602 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
2603 valObjPtr = Jim_NewIntObj(interp, val);
2604 if (!nameObjPtr || !valObjPtr)
2610 Jim_IncrRefCount(nameObjPtr);
2611 Jim_IncrRefCount(valObjPtr);
2612 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
2613 Jim_DecrRefCount(interp, nameObjPtr);
2614 Jim_DecrRefCount(interp, valObjPtr);
2616 /* printf("%s(%d) <= 0%08x\n", varname, idx, val); */
2620 static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
2622 command_context_t *context;
2625 context = Jim_GetAssocData(interp, "context");
2626 if (context == NULL)
2628 LOG_ERROR("mem2array: no command context");
2631 target = get_current_target(context);
2634 LOG_ERROR("mem2array: no current target");
2638 return target_mem2array(interp, target, argc,argv);
2641 static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv)
2649 const char *varname;
2651 int i, n, e, retval;
2653 /* argv[1] = name of array to receive the data
2654 * argv[2] = desired width
2655 * argv[3] = memory address
2656 * argv[4] = count of times to read
2659 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
2662 varname = Jim_GetString(argv[1], &len);
2663 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
2665 e = Jim_GetLong(interp, argv[2], &l);
2671 e = Jim_GetLong(interp, argv[3], &l);
2676 e = Jim_GetLong(interp, argv[4], &l);
2692 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2693 Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
2697 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2698 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: zero width read?", NULL);
2701 if ((addr + (len * width)) < addr) {
2702 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2703 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: addr + len - wraps to zero?", NULL);
2706 /* absurd transfer size? */
2708 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2709 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: absurd > 64K item request", NULL);
2714 ((width == 2) && ((addr & 1) == 0)) ||
2715 ((width == 4) && ((addr & 3) == 0))) {
2719 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2720 sprintf(buf, "mem2array address: 0x%08x is not aligned for %d byte reads", addr, width);
2721 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
2732 /* Slurp... in buffer size chunks */
2734 count = len; /* in objects.. */
2735 if (count > (sizeof(buffer)/width)) {
2736 count = (sizeof(buffer)/width);
2739 retval = target->type->read_memory( target, addr, width, count, buffer );
2740 if (retval != ERROR_OK) {
2742 LOG_ERROR("mem2array: Read @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
2743 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2744 Jim_AppendStrings(interp, Jim_GetResult(interp), "mem2array: cannot read memory", NULL);
2748 v = 0; /* shut up gcc */
2749 for (i = 0 ;i < count ;i++, n++) {
2752 v = target_buffer_get_u32(target, &buffer[i*width]);
2755 v = target_buffer_get_u16(target, &buffer[i*width]);
2758 v = buffer[i] & 0x0ff;
2761 new_int_array_element(interp, varname, n, v);
2767 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2772 static int get_int_array_element(Jim_Interp * interp, const char *varname, int idx, u32 *val)
2775 Jim_Obj *nameObjPtr, *valObjPtr;
2779 namebuf = alloc_printf("%s(%d)", varname, idx);
2783 nameObjPtr = Jim_NewStringObj(interp, namebuf, -1);
2790 Jim_IncrRefCount(nameObjPtr);
2791 valObjPtr = Jim_GetVariable(interp, nameObjPtr, JIM_ERRMSG);
2792 Jim_DecrRefCount(interp, nameObjPtr);
2794 if (valObjPtr == NULL)
2797 result = Jim_GetLong(interp, valObjPtr, &l);
2798 /* printf("%s(%d) => 0%08x\n", varname, idx, val); */
2803 static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
2805 command_context_t *context;
2808 context = Jim_GetAssocData(interp, "context");
2809 if (context == NULL){
2810 LOG_ERROR("array2mem: no command context");
2813 target = get_current_target(context);
2814 if (target == NULL){
2815 LOG_ERROR("array2mem: no current target");
2819 return target_array2mem( interp,target, argc, argv );
2823 static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv)
2831 const char *varname;
2833 int i, n, e, retval;
2835 /* argv[1] = name of array to get the data
2836 * argv[2] = desired width
2837 * argv[3] = memory address
2838 * argv[4] = count to write
2841 Jim_WrongNumArgs(interp, 1, argv, "varname width addr nelems");
2844 varname = Jim_GetString(argv[1], &len);
2845 /* given "foo" get space for worse case "foo(%d)" .. add 20 */
2847 e = Jim_GetLong(interp, argv[2], &l);
2853 e = Jim_GetLong(interp, argv[3], &l);
2858 e = Jim_GetLong(interp, argv[4], &l);
2874 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2875 Jim_AppendStrings( interp, Jim_GetResult(interp), "Invalid width param, must be 8/16/32", NULL );
2879 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2880 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: zero width read?", NULL);
2883 if ((addr + (len * width)) < addr) {
2884 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2885 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: addr + len - wraps to zero?", NULL);
2888 /* absurd transfer size? */
2890 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2891 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: absurd > 64K item request", NULL);
2896 ((width == 2) && ((addr & 1) == 0)) ||
2897 ((width == 4) && ((addr & 3) == 0))) {
2901 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2902 sprintf(buf, "array2mem address: 0x%08x is not aligned for %d byte reads", addr, width);
2903 Jim_AppendStrings(interp, Jim_GetResult(interp), buf , NULL);
2915 /* Slurp... in buffer size chunks */
2917 count = len; /* in objects.. */
2918 if (count > (sizeof(buffer)/width)) {
2919 count = (sizeof(buffer)/width);
2922 v = 0; /* shut up gcc */
2923 for (i = 0 ;i < count ;i++, n++) {
2924 get_int_array_element(interp, varname, n, &v);
2927 target_buffer_set_u32(target, &buffer[i*width], v);
2930 target_buffer_set_u16(target, &buffer[i*width], v);
2933 buffer[i] = v & 0x0ff;
2939 retval = target->type->write_memory(target, addr, width, count, buffer);
2940 if (retval != ERROR_OK) {
2942 LOG_ERROR("array2mem: Write @ 0x%08x, w=%d, cnt=%d, failed", addr, width, count);
2943 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2944 Jim_AppendStrings(interp, Jim_GetResult(interp), "array2mem: cannot read memory", NULL);
2950 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2956 target_all_handle_event( enum target_event e )
2961 LOG_DEBUG( "**all*targets: event: %d, %s",
2963 Jim_Nvp_value2name_simple( nvp_target_event, e )->name );
2965 target = all_targets;
2967 target_handle_event( target, e );
2968 target = target->next;
2973 target_handle_event( target_t *target, enum target_event e )
2975 target_event_action_t *teap;
2978 teap = target->event_action;
2982 if( teap->event == e ){
2984 LOG_DEBUG( "target: (%d) %s (%s) event: %d (%s) action: %s\n",
2985 target->target_number,
2989 Jim_Nvp_value2name_simple( nvp_target_event, e )->name,
2990 Jim_GetString( teap->body, NULL ) );
2991 Jim_EvalObj( interp, teap->body );
2996 LOG_DEBUG( "event: %d %s - no action",
2998 Jim_Nvp_value2name_simple( nvp_target_event, e )->name );
3002 enum target_cfg_param {
3006 TCFG_WORK_AREA_VIRT,
3007 TCFG_WORK_AREA_PHYS,
3008 TCFG_WORK_AREA_SIZE,
3009 TCFG_WORK_AREA_BACKUP,
3012 TCFG_CHAIN_POSITION,
3016 static Jim_Nvp nvp_config_opts[] = {
3017 { .name = "-type", .value = TCFG_TYPE },
3018 { .name = "-event", .value = TCFG_EVENT },
3019 { .name = "-reset", .value = TCFG_RESET },
3020 { .name = "-work-area-virt", .value = TCFG_WORK_AREA_VIRT },
3021 { .name = "-work-area-phys", .value = TCFG_WORK_AREA_PHYS },
3022 { .name = "-work-area-size", .value = TCFG_WORK_AREA_SIZE },
3023 { .name = "-work-area-backup", .value = TCFG_WORK_AREA_BACKUP },
3024 { .name = "-endian" , .value = TCFG_ENDIAN },
3025 { .name = "-variant", .value = TCFG_VARIANT },
3026 { .name = "-chain-position", .value = TCFG_CHAIN_POSITION },
3028 { .name = NULL, .value = -1 }
3033 target_configure( Jim_GetOptInfo *goi,
3043 /* parse config or cget options ... */
3045 Jim_SetEmptyResult( goi->interp );
3046 //Jim_GetOpt_Debug( goi );
3048 if( target->type->target_jim_configure ){
3049 /* target defines a configure function */
3050 /* target gets first dibs on parameters */
3051 e = (*(target->type->target_jim_configure))( target, goi );
3060 /* otherwise we 'continue' below */
3062 e = Jim_GetOpt_Nvp( goi, nvp_config_opts, &n );
3064 Jim_GetOpt_NvpUnknown( goi, nvp_config_opts, 0 );
3070 if( goi->isconfigure ){
3071 Jim_SetResult_sprintf( goi->interp, "not setable: %s", n->name );
3075 if( goi->argc != 0 ){
3076 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "NO PARAMS");
3080 Jim_SetResultString( goi->interp, target->type->name, -1 );
3084 if( goi->argc == 0 ){
3085 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ...");
3089 e = Jim_GetOpt_Nvp( goi, nvp_target_event, &n );
3091 Jim_GetOpt_NvpUnknown( goi, nvp_target_event, 1 );
3095 if( goi->isconfigure ){
3096 if( goi->argc == 0 ){
3097 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
3101 if( goi->argc != 0 ){
3102 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
3109 target_event_action_t *teap;
3111 teap = target->event_action;
3112 /* replace existing? */
3114 if( teap->event == n->value ){
3120 if( goi->isconfigure ){
3123 teap = calloc( 1, sizeof(*teap) );
3125 teap->event = n->value;
3126 Jim_GetOpt_Obj( goi, &o );
3128 Jim_DecrRefCount( interp, teap->body );
3130 teap->body = Jim_DuplicateObj( goi->interp, o );
3133 * Tcl/TK - "tk events" have a nice feature.
3134 * See the "BIND" command.
3135 * We should support that here.
3136 * You can specify %X and %Y in the event code.
3137 * The idea is: %T - target name.
3138 * The idea is: %N - target number
3139 * The idea is: %E - event name.
3141 Jim_IncrRefCount( teap->body );
3143 /* add to head of event list */
3144 teap->next = target->event_action;
3145 target->event_action = teap;
3146 Jim_SetEmptyResult(goi->interp);
3150 Jim_SetEmptyResult( goi->interp );
3152 Jim_SetResult( goi->interp, Jim_DuplicateObj( goi->interp, teap->body ) );
3159 case TCFG_WORK_AREA_VIRT:
3160 if( goi->isconfigure ){
3161 target_free_all_working_areas(target);
3162 e = Jim_GetOpt_Wide( goi, &w );
3166 target->working_area_virt = w;
3168 if( goi->argc != 0 ){
3172 Jim_SetResult( interp, Jim_NewIntObj( goi->interp, target->working_area_virt ) );
3176 case TCFG_WORK_AREA_PHYS:
3177 if( goi->isconfigure ){
3178 target_free_all_working_areas(target);
3179 e = Jim_GetOpt_Wide( goi, &w );
3183 target->working_area_phys = w;
3185 if( goi->argc != 0 ){
3189 Jim_SetResult( interp, Jim_NewIntObj( goi->interp, target->working_area_phys ) );
3193 case TCFG_WORK_AREA_SIZE:
3194 if( goi->isconfigure ){
3195 target_free_all_working_areas(target);
3196 e = Jim_GetOpt_Wide( goi, &w );
3200 target->working_area_size = w;
3202 if( goi->argc != 0 ){
3206 Jim_SetResult( interp, Jim_NewIntObj( goi->interp, target->working_area_size ) );
3210 case TCFG_WORK_AREA_BACKUP:
3211 if( goi->isconfigure ){
3212 target_free_all_working_areas(target);
3213 e = Jim_GetOpt_Wide( goi, &w );
3217 /* make this exactly 1 or 0 */
3218 target->backup_working_area = (!!w);
3220 if( goi->argc != 0 ){
3224 Jim_SetResult( interp, Jim_NewIntObj( goi->interp, target->working_area_size ) );
3225 /* loop for more e*/
3229 if( goi->isconfigure ){
3230 e = Jim_GetOpt_Nvp( goi, nvp_target_endian, &n );
3232 Jim_GetOpt_NvpUnknown( goi, nvp_target_endian, 1 );
3235 target->endianness = n->value;
3237 if( goi->argc != 0 ){
3241 n = Jim_Nvp_value2name_simple( nvp_target_endian, target->endianness );
3242 if( n->name == NULL ){
3243 target->endianness = TARGET_LITTLE_ENDIAN;
3244 n = Jim_Nvp_value2name_simple( nvp_target_endian, target->endianness );
3246 Jim_SetResultString( goi->interp, n->name, -1 );
3251 if( goi->isconfigure ){
3252 if( goi->argc < 1 ){
3253 Jim_SetResult_sprintf( goi->interp,
3258 if( target->variant ){
3259 free((void *)(target->variant));
3261 e = Jim_GetOpt_String( goi, &cp, NULL );
3262 target->variant = strdup(cp);
3264 if( goi->argc != 0 ){
3268 Jim_SetResultString( goi->interp, target->variant,-1 );
3271 case TCFG_CHAIN_POSITION:
3272 if( goi->isconfigure ){
3273 target_free_all_working_areas(target);
3274 e = Jim_GetOpt_Wide( goi, &w );
3278 /* make this exactly 1 or 0 */
3279 target->chain_position = w;
3281 if( goi->argc != 0 ){
3285 Jim_SetResult( interp, Jim_NewIntObj( goi->interp, target->chain_position ) );
3286 /* loop for more e*/
3290 /* done - we return */
3295 /** this is the 'tcl' handler for the target specific command */
3297 tcl_target_func( Jim_Interp *interp,
3299 Jim_Obj *const *argv )
3307 struct command_context_s *cmd_ctx;
3315 TS_CMD_MWW, TS_CMD_MWH, TS_CMD_MWB,
3316 TS_CMD_MDW, TS_CMD_MDH, TS_CMD_MDB,
3317 TS_CMD_MRW, TS_CMD_MRH, TS_CMD_MRB,
3318 TS_CMD_MEM2ARRAY, TS_CMD_ARRAY2MEM,
3328 static const Jim_Nvp target_options[] = {
3329 { .name = "configure", .value = TS_CMD_CONFIGURE },
3330 { .name = "cget", .value = TS_CMD_CGET },
3331 { .name = "mww", .value = TS_CMD_MWW },
3332 { .name = "mwh", .value = TS_CMD_MWH },
3333 { .name = "mwb", .value = TS_CMD_MWB },
3334 { .name = "mdw", .value = TS_CMD_MDW },
3335 { .name = "mdh", .value = TS_CMD_MDH },
3336 { .name = "mdb", .value = TS_CMD_MDB },
3337 { .name = "mem2array", .value = TS_CMD_MEM2ARRAY },
3338 { .name = "array2mem", .value = TS_CMD_ARRAY2MEM },
3339 { .name = "eventlist", .value = TS_CMD_EVENTLIST },
3340 { .name = "curstate", .value = TS_CMD_CURSTATE },
3342 { .name = "arp_examine", .value = TS_CMD_EXAMINE },
3343 { .name = "arp_poll", .value = TS_CMD_POLL },
3344 { .name = "arp_reset", .value = TS_CMD_RESET },
3345 { .name = "arp_halt", .value = TS_CMD_HALT },
3346 { .name = "arp_waitstate", .value = TS_CMD_WAITSTATE },
3348 { .name = NULL, .value = -1 },
3352 /* go past the "command" */
3353 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
3355 target = Jim_CmdPrivData( goi.interp );
3356 cmd_ctx = Jim_GetAssocData(goi.interp, "context");
3358 /* commands here are in an NVP table */
3359 e = Jim_GetOpt_Nvp( &goi, target_options, &n );
3361 Jim_GetOpt_NvpUnknown( &goi, target_options, 0 );
3364 // Assume blank result
3365 Jim_SetEmptyResult( goi.interp );
3368 case TS_CMD_CONFIGURE:
3370 Jim_WrongNumArgs( goi.interp, goi.argc, goi.argv, "missing: -option VALUE ...");
3373 goi.isconfigure = 1;
3374 return target_configure( &goi, target );
3376 // some things take params
3378 Jim_WrongNumArgs( goi.interp, 0, goi.argv, "missing: ?-option?");
3381 goi.isconfigure = 0;
3382 return target_configure( &goi, target );
3390 * argv[3] = optional count.
3393 if( (goi.argc == 3) || (goi.argc == 4) ){
3397 Jim_SetResult_sprintf( goi.interp, "expected: %s ADDR DATA [COUNT]", n->name );
3401 e = Jim_GetOpt_Wide( &goi, &a );
3406 e = Jim_GetOpt_Wide( &goi, &b );
3411 e = Jim_GetOpt_Wide( &goi, &c );
3421 target_buffer_set_u32( target, target_buf, b );
3425 target_buffer_set_u16( target, target_buf, b );
3429 target_buffer_set_u8( target, target_buf, b );
3433 for( x = 0 ; x < c ; x++ ){
3434 e = target->type->write_memory( target, a, b, 1, target_buf );
3435 if( e != ERROR_OK ){
3436 Jim_SetResult_sprintf( interp, "Error writing @ 0x%08x: %d\n", (int)(a), e );
3449 /* argv[0] = command
3451 * argv[2] = optional count
3453 if( (goi.argc == 2) || (goi.argc == 3) ){
3454 Jim_SetResult_sprintf( goi.interp, "expected: %s ADDR [COUNT]", n->name );
3457 e = Jim_GetOpt_Wide( &goi, &a );
3462 e = Jim_GetOpt_Wide( &goi, &c );
3469 b = 1; /* shut up gcc */
3482 /* convert to "bytes" */
3484 /* count is now in 'BYTES' */
3490 e = target->type->read_memory( target, a, b, y / b, target_buf );
3491 if( e != ERROR_OK ){
3492 Jim_SetResult_sprintf( interp, "error reading target @ 0x%08lx", (int)(a) );
3496 Jim_fprintf( interp, interp->cookie_stdout, "0x%08x ", (int)(a) );
3499 for( x = 0 ; (x < 16) && (x < y) ; x += 4 ){
3500 z = target_buffer_get_u32( target, &(target_buf[ x * 4 ]) );
3501 Jim_fprintf( interp, interp->cookie_stdout, "%08x ", (int)(z) );
3503 for( ; (x < 16) ; x += 4 ){
3504 Jim_fprintf( interp, interp->cookie_stdout, " " );
3508 for( x = 0 ; (x < 16) && (x < y) ; x += 2 ){
3509 z = target_buffer_get_u16( target, &(target_buf[ x * 2 ]) );
3510 Jim_fprintf( interp, interp->cookie_stdout, "%04x ", (int)(z) );
3512 for( ; (x < 16) ; x += 2 ){
3513 Jim_fprintf( interp, interp->cookie_stdout, " " );
3518 for( x = 0 ; (x < 16) && (x < y) ; x += 1 ){
3519 z = target_buffer_get_u8( target, &(target_buf[ x * 4 ]) );
3520 Jim_fprintf( interp, interp->cookie_stdout, "%02x ", (int)(z) );
3522 for( ; (x < 16) ; x += 1 ){
3523 Jim_fprintf( interp, interp->cookie_stdout, " " );
3527 /* ascii-ify the bytes */
3528 for( x = 0 ; x < y ; x++ ){
3529 if( (target_buf[x] >= 0x20) &&
3530 (target_buf[x] <= 0x7e) ){
3534 target_buf[x] = '.';
3539 target_buf[x] = ' ';
3544 /* print - with a newline */
3545 Jim_fprintf( interp, interp->cookie_stdout, "%s\n", target_buf );
3551 case TS_CMD_MEM2ARRAY:
3552 return target_mem2array( goi.interp, target, goi.argc, goi.argv );
3554 case TS_CMD_ARRAY2MEM:
3555 return target_array2mem( goi.interp, target, goi.argc, goi.argv );
3557 case TS_CMD_EXAMINE:
3559 Jim_WrongNumArgs( goi.interp, 0, argv, "[no parameters]");
3562 e = target->type->examine( target );
3563 if( e != ERROR_OK ){
3564 Jim_SetResult_sprintf( interp, "examine-fails: %d", e );
3570 Jim_WrongNumArgs( goi.interp, 0, argv, "[no parameters]");
3573 if( !(target->type->examined) ){
3574 e = ERROR_TARGET_NOT_EXAMINED;
3576 e = target->type->poll( target );
3578 if( e != ERROR_OK ){
3579 Jim_SetResult_sprintf( interp, "poll-fails: %d", e );
3586 if( goi.argc != 1 ){
3587 Jim_WrongNumArgs( interp, 1, argv, "reset t|f|assert|deassert");
3590 e = Jim_GetOpt_Nvp( &goi, nvp_assert, &n );
3592 Jim_GetOpt_NvpUnknown( &goi, nvp_assert, 1 );
3595 // When this happens - all workareas are invalid.
3596 target_free_all_working_areas_restore(target, 0);
3599 if( n->value == NVP_ASSERT ){
3600 target->type->assert_reset( target );
3602 target->type->deassert_reset( target );
3607 Jim_WrongNumArgs( goi.interp, 0, argv, "halt [no parameters]");
3610 target->type->halt( target );
3612 case TS_CMD_WAITSTATE:
3613 // params: <name> statename timeoutmsecs
3614 if( goi.argc != 2 ){
3615 Jim_SetResult_sprintf( goi.interp, "%s STATENAME TIMEOUTMSECS", n->name );
3618 e = Jim_GetOpt_Nvp( &goi, nvp_target_state, &n );
3620 Jim_GetOpt_NvpUnknown( &goi, nvp_target_state,1 );
3623 e = Jim_GetOpt_Wide( &goi, &a );
3627 e = target_wait_state( target, n->value, a );
3628 if( e == ERROR_OK ){
3629 Jim_SetResult_sprintf( goi.interp,
3630 "target: %s wait %s fails %d",
3633 target_strerror_safe(e) );
3638 case TS_CMD_EVENTLIST:
3639 /* List for human, Events defined for this target.
3640 * scripts/programs should use 'name cget -event NAME'
3643 target_event_action_t *teap;
3644 teap = target->event_action;
3645 command_print( cmd_ctx, "Event actions for target (%d) %s\n",
3646 target->target_number,
3648 command_print( cmd_ctx, "%-25s | Body", "Event");
3649 command_print( cmd_ctx, "------------------------- | ----------------------------------------");
3651 command_print( cmd_ctx,
3653 Jim_Nvp_value2name_simple( nvp_target_event, teap->event )->name,
3654 Jim_GetString( teap->body, NULL ) );
3657 command_print( cmd_ctx, "***END***");
3660 case TS_CMD_CURSTATE:
3661 if( goi.argc != 0 ){
3662 Jim_WrongNumArgs( goi.interp, 0, argv, "[no parameters]");
3665 Jim_SetResultString( goi.interp,
3666 Jim_Nvp_value2name_simple(nvp_target_state,target->state)->name,-1);
3674 target_create( Jim_GetOptInfo *goi )
3684 struct command_context_s *cmd_ctx;
3686 cmd_ctx = Jim_GetAssocData(goi->interp, "context");
3687 if( goi->argc < 3 ){
3688 Jim_WrongNumArgs( goi->interp, 1, goi->argv, "?name? ?type? ..options...");
3693 Jim_GetOpt_Obj( goi, &new_cmd );
3694 /* does this command exist? */
3695 cmd = Jim_GetCommand( goi->interp, new_cmd, JIM_ERRMSG );
3697 cp = Jim_GetString( new_cmd, NULL );
3698 Jim_SetResult_sprintf(goi->interp, "Command/target: %s Exists", cp);
3703 e = Jim_GetOpt_String( goi, &cp2, NULL );
3705 /* now does target type exist */
3706 for( x = 0 ; target_types[x] ; x++ ){
3707 if( 0 == strcmp( cp, target_types[x]->name ) ){
3712 if( target_types[x] == NULL ){
3713 Jim_SetResult_sprintf( goi->interp, "Unknown target type %s, try one of ", cp );
3714 for( x = 0 ; target_types[x] ; x++ ){
3715 if( target_types[x+1] ){
3716 Jim_AppendStrings( goi->interp,
3717 Jim_GetResult(goi->interp),
3718 target_types[x]->name,
3721 Jim_AppendStrings( goi->interp,
3722 Jim_GetResult(goi->interp),
3724 target_types[x]->name,NULL );
3732 target = calloc(1,sizeof(target_t));
3733 /* set target number */
3734 target->target_number = new_target_number();
3736 /* allocate memory for each unique target type */
3737 target->type = (target_type_t*)calloc(1,sizeof(target_type_t));
3739 memcpy( target->type, target_types[x], sizeof(target_type_t));
3741 /* will be set by "-endian" */
3742 target->endianness = TARGET_ENDIAN_UNKNOWN;
3744 target->working_area = 0x0;
3745 target->working_area_size = 0x0;
3746 target->working_areas = NULL;
3747 target->backup_working_area = 0;
3749 target->state = TARGET_UNKNOWN;
3750 target->debug_reason = DBG_REASON_UNDEFINED;
3751 target->reg_cache = NULL;
3752 target->breakpoints = NULL;
3753 target->watchpoints = NULL;
3754 target->next = NULL;
3755 target->arch_info = NULL;
3757 /* initialize trace information */
3758 target->trace_info = malloc(sizeof(trace_t));
3759 target->trace_info->num_trace_points = 0;
3760 target->trace_info->trace_points_size = 0;
3761 target->trace_info->trace_points = NULL;
3762 target->trace_info->trace_history_size = 0;
3763 target->trace_info->trace_history = NULL;
3764 target->trace_info->trace_history_pos = 0;
3765 target->trace_info->trace_history_overflowed = 0;
3767 target->dbgmsg = NULL;
3768 target->dbg_msg_enabled = 0;
3770 target->endianness = TARGET_ENDIAN_UNKNOWN;
3772 /* Do the rest as "configure" options */
3773 goi->isconfigure = 1;
3774 e = target_configure( goi, target);
3776 free( target->type );
3781 if( target->endianness == TARGET_ENDIAN_UNKNOWN ){
3782 /* default endian to little if not specified */
3783 target->endianness = TARGET_LITTLE_ENDIAN;
3786 /* create the target specific commands */
3787 if( target->type->register_commands ){
3788 (*(target->type->register_commands))( cmd_ctx );
3790 if( target->type->target_create ){
3791 (*(target->type->target_create))( target, goi->interp );
3794 /* append to end of list */
3797 tpp = &(all_targets);
3799 tpp = &( (*tpp)->next );
3804 cp = Jim_GetString( new_cmd, NULL );
3805 target->cmd_name = strdup(cp);
3807 /* now - create the new target name command */
3808 e = Jim_CreateCommand( goi->interp,
3811 tcl_target_func, /* C function */
3812 target, /* private data */
3813 NULL ); /* no del proc */
3815 (*(target->type->target_create))( target, goi->interp );
3820 jim_target( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
3824 struct command_context_s *cmd_ctx;
3829 /* TG = target generic */
3837 const char *target_cmds[] = {
3838 "create", "types", "names", "current", "number",
3843 LOG_DEBUG("Target command params:");
3844 LOG_DEBUG(Jim_Debug_ArgvString( interp, argc, argv) );
3846 cmd_ctx = Jim_GetAssocData( interp, "context" );
3848 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
3850 if( goi.argc == 0 ){
3851 Jim_WrongNumArgs(interp, 1, argv, "missing: command ...");
3855 /* is this old syntax? */
3856 /* To determine: We have to peek at argv[0]*/
3857 cp = Jim_GetString( goi.argv[0], NULL );
3858 for( x = 0 ; target_types[x] ; x++ ){
3859 if( 0 == strcmp(cp,target_types[x]->name) ){
3863 if( target_types[x] ){
3864 /* YES IT IS OLD SYNTAX */
3865 Jim_Obj *new_argv[10];
3868 /* target_old_syntax
3870 * argv[0] typename (above)
3872 * argv[2] reset method, deprecated/ignored
3873 * argv[3] = old param
3874 * argv[4] = old param
3876 * We will combine all "old params" into a single param.
3877 * Then later, split them again.
3880 Jim_WrongNumArgs( interp, 1, argv, "[OLDSYNTAX] ?TYPE? ?ENDIAN? ?RESET? ?old-params?");
3884 new_argv[0] = argv[0];
3885 new_argv[1] = Jim_NewStringObj( interp, "create", -1 );
3888 sprintf( buf, "target%d", new_target_number() );
3889 new_argv[2] = Jim_NewStringObj( interp, buf , -1 );
3891 new_argv[3] = goi.argv[0]; /* typename */
3892 new_argv[4] = Jim_NewStringObj( interp, "-endian", -1 );
3893 new_argv[5] = goi.argv[1];
3894 new_argv[6] = Jim_NewStringObj( interp, "-chain-position", -1 );
3895 new_argv[7] = goi.argv[2];
3896 new_argv[8] = Jim_NewStringObj( interp, "-variant", -1 );
3897 new_argv[9] = goi.argv[3];
3904 * argv[3] = typename
3905 * argv[4] = **FIRST** "configure" option.
3907 * Here, we make them:
3911 * argv[6] = -position
3913 * argv[8] = -variant
3914 * argv[9] = "somestring"
3917 /* don't let these be released */
3918 for( x = 0 ; x < new_argc ; x++ ){
3919 Jim_IncrRefCount( new_argv[x]);
3922 LOG_DEBUG("Target OLD SYNTAX - converted to new syntax");
3924 r = jim_target( goi.interp, new_argc, new_argv );
3926 /* release? these items */
3927 for( x = 0 ; x < new_argc ; x++ ){
3928 Jim_DecrRefCount( interp, new_argv[x] );
3933 //Jim_GetOpt_Debug( &goi );
3934 r = Jim_GetOpt_Enum( &goi, target_cmds, &x );
3941 Jim_Panic(goi.interp,"Why am I here?");
3943 case TG_CMD_CURRENT:
3944 if( goi.argc != 0 ){
3945 Jim_WrongNumArgs( goi.interp, 1, goi.argv, "Too many parameters");
3948 Jim_SetResultString( goi.interp, get_current_target( cmd_ctx )->cmd_name, -1 );
3951 if( goi.argc != 0 ){
3952 Jim_WrongNumArgs( goi.interp, 1, goi.argv, "Too many parameters" );
3955 Jim_SetResult( goi.interp, Jim_NewListObj( goi.interp, NULL, 0 ) );
3956 for( x = 0 ; target_types[x] ; x++ ){
3957 Jim_ListAppendElement( goi.interp,
3958 Jim_GetResult(goi.interp),
3959 Jim_NewStringObj( goi.interp, target_types[x]->name, -1 ) );
3963 if( goi.argc != 0 ){
3964 Jim_WrongNumArgs( goi.interp, 1, goi.argv, "Too many parameters" );
3967 Jim_SetResult( goi.interp, Jim_NewListObj( goi.interp, NULL, 0 ) );
3968 target = all_targets;
3970 Jim_ListAppendElement( goi.interp,
3971 Jim_GetResult(goi.interp),
3972 Jim_NewStringObj( goi.interp, target->cmd_name, -1 ) );
3973 target = target->next;
3978 Jim_WrongNumArgs( goi.interp, goi.argc, goi.argv, "?name ... config options ...");
3981 return target_create( &goi );
3984 if( goi.argc != 1 ){
3985 Jim_SetResult_sprintf( goi.interp, "expected: target number ?NUMBER?");
3988 e = Jim_GetOpt_Wide( &goi, &w );
3994 t = get_target_by_num(w);
3996 Jim_SetResult_sprintf( goi.interp,"Target: number %d does not exist", (int)(w));
3999 Jim_SetResultString( goi.interp, t->cmd_name, -1 );
4003 if( goi.argc != 0 ){
4004 Jim_WrongNumArgs( goi.interp, 0, goi.argv, "<no parameters>");
4007 Jim_SetResult( goi.interp,
4008 Jim_NewIntObj( goi.interp, max_target_number()));
4016 * Local Variables: ***
4017 * c-basic-offset: 4 ***