target: Fix strange ordering in target_read_u8
[openocd.git] / src / target / target.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007-2010 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
10 * *
11 * Copyright (C) 2008 by Spencer Oliver *
12 * spen@spen-soft.co.uk *
13 * *
14 * Copyright (C) 2008 by Rick Altherr *
15 * kc8apf@kc8apf.net> *
16 * *
17 * Copyright (C) 2011 by Broadcom Corporation *
18 * Evan Hunter - ehunter@broadcom.com *
19 * *
20 * Copyright (C) ST-Ericsson SA 2011 *
21 * michel.jaouen@stericsson.com : smp minimum support *
22 * *
23 * Copyright (C) 2011 Andreas Fritiofson *
24 * andreas.fritiofson@gmail.com *
25 * *
26 * This program is free software; you can redistribute it and/or modify *
27 * it under the terms of the GNU General Public License as published by *
28 * the Free Software Foundation; either version 2 of the License, or *
29 * (at your option) any later version. *
30 * *
31 * This program is distributed in the hope that it will be useful, *
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
34 * GNU General Public License for more details. *
35 * *
36 * You should have received a copy of the GNU General Public License *
37 * along with this program; if not, write to the *
38 * Free Software Foundation, Inc., *
39 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
40 ***************************************************************************/
41
42 #ifdef HAVE_CONFIG_H
43 #include "config.h"
44 #endif
45
46 #include <helper/time_support.h>
47 #include <jtag/jtag.h>
48 #include <flash/nor/core.h>
49
50 #include "target.h"
51 #include "target_type.h"
52 #include "target_request.h"
53 #include "breakpoints.h"
54 #include "register.h"
55 #include "trace.h"
56 #include "image.h"
57 #include "rtos/rtos.h"
58
59 /* default halt wait timeout (ms) */
60 #define DEFAULT_HALT_TIMEOUT 5000
61
62 static int target_read_buffer_default(struct target *target, uint32_t address,
63 uint32_t count, uint8_t *buffer);
64 static int target_write_buffer_default(struct target *target, uint32_t address,
65 uint32_t count, const uint8_t *buffer);
66 static int target_array2mem(Jim_Interp *interp, struct target *target,
67 int argc, Jim_Obj * const *argv);
68 static int target_mem2array(Jim_Interp *interp, struct target *target,
69 int argc, Jim_Obj * const *argv);
70 static int target_register_user_commands(struct command_context *cmd_ctx);
71 static int target_get_gdb_fileio_info_default(struct target *target,
72 struct gdb_fileio_info *fileio_info);
73 static int target_gdb_fileio_end_default(struct target *target, int retcode,
74 int fileio_errno, bool ctrl_c);
75 static int target_profiling_default(struct target *target, uint32_t *samples,
76 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds);
77
78 /* targets */
79 extern struct target_type arm7tdmi_target;
80 extern struct target_type arm720t_target;
81 extern struct target_type arm9tdmi_target;
82 extern struct target_type arm920t_target;
83 extern struct target_type arm966e_target;
84 extern struct target_type arm946e_target;
85 extern struct target_type arm926ejs_target;
86 extern struct target_type fa526_target;
87 extern struct target_type feroceon_target;
88 extern struct target_type dragonite_target;
89 extern struct target_type xscale_target;
90 extern struct target_type cortexm3_target;
91 extern struct target_type cortexa8_target;
92 extern struct target_type cortexr4_target;
93 extern struct target_type arm11_target;
94 extern struct target_type mips_m4k_target;
95 extern struct target_type avr_target;
96 extern struct target_type dsp563xx_target;
97 extern struct target_type dsp5680xx_target;
98 extern struct target_type testee_target;
99 extern struct target_type avr32_ap7k_target;
100 extern struct target_type hla_target;
101 extern struct target_type nds32_v2_target;
102 extern struct target_type nds32_v3_target;
103 extern struct target_type nds32_v3m_target;
104
105 static struct target_type *target_types[] = {
106 &arm7tdmi_target,
107 &arm9tdmi_target,
108 &arm920t_target,
109 &arm720t_target,
110 &arm966e_target,
111 &arm946e_target,
112 &arm926ejs_target,
113 &fa526_target,
114 &feroceon_target,
115 &dragonite_target,
116 &xscale_target,
117 &cortexm3_target,
118 &cortexa8_target,
119 &cortexr4_target,
120 &arm11_target,
121 &mips_m4k_target,
122 &avr_target,
123 &dsp563xx_target,
124 &dsp5680xx_target,
125 &testee_target,
126 &avr32_ap7k_target,
127 &hla_target,
128 &nds32_v2_target,
129 &nds32_v3_target,
130 &nds32_v3m_target,
131 NULL,
132 };
133
134 struct target *all_targets;
135 static struct target_event_callback *target_event_callbacks;
136 static struct target_timer_callback *target_timer_callbacks;
137 static const int polling_interval = 100;
138
139 static const Jim_Nvp nvp_assert[] = {
140 { .name = "assert", NVP_ASSERT },
141 { .name = "deassert", NVP_DEASSERT },
142 { .name = "T", NVP_ASSERT },
143 { .name = "F", NVP_DEASSERT },
144 { .name = "t", NVP_ASSERT },
145 { .name = "f", NVP_DEASSERT },
146 { .name = NULL, .value = -1 }
147 };
148
149 static const Jim_Nvp nvp_error_target[] = {
150 { .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
151 { .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
152 { .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
153 { .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
154 { .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
155 { .value = ERROR_TARGET_UNALIGNED_ACCESS , .name = "err-unaligned-access" },
156 { .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
157 { .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
158 { .value = ERROR_TARGET_TRANSLATION_FAULT , .name = "err-translation-fault" },
159 { .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
160 { .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
161 { .value = -1, .name = NULL }
162 };
163
164 static const char *target_strerror_safe(int err)
165 {
166 const Jim_Nvp *n;
167
168 n = Jim_Nvp_value2name_simple(nvp_error_target, err);
169 if (n->name == NULL)
170 return "unknown";
171 else
172 return n->name;
173 }
174
175 static const Jim_Nvp nvp_target_event[] = {
176
177 { .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
178 { .value = TARGET_EVENT_HALTED, .name = "halted" },
179 { .value = TARGET_EVENT_RESUMED, .name = "resumed" },
180 { .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
181 { .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },
182
183 { .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
184 { .name = "gdb-end", .value = TARGET_EVENT_GDB_END },
185
186 { .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
187 { .value = TARGET_EVENT_RESET_ASSERT_PRE, .name = "reset-assert-pre" },
188 { .value = TARGET_EVENT_RESET_ASSERT, .name = "reset-assert" },
189 { .value = TARGET_EVENT_RESET_ASSERT_POST, .name = "reset-assert-post" },
190 { .value = TARGET_EVENT_RESET_DEASSERT_PRE, .name = "reset-deassert-pre" },
191 { .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
192 { .value = TARGET_EVENT_RESET_HALT_PRE, .name = "reset-halt-pre" },
193 { .value = TARGET_EVENT_RESET_HALT_POST, .name = "reset-halt-post" },
194 { .value = TARGET_EVENT_RESET_WAIT_PRE, .name = "reset-wait-pre" },
195 { .value = TARGET_EVENT_RESET_WAIT_POST, .name = "reset-wait-post" },
196 { .value = TARGET_EVENT_RESET_INIT, .name = "reset-init" },
197 { .value = TARGET_EVENT_RESET_END, .name = "reset-end" },
198
199 { .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
200 { .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
201
202 { .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
203 { .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },
204
205 { .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
206 { .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },
207
208 { .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
209 { .value = TARGET_EVENT_GDB_FLASH_WRITE_END , .name = "gdb-flash-write-end" },
210
211 { .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
212 { .value = TARGET_EVENT_GDB_FLASH_ERASE_END , .name = "gdb-flash-erase-end" },
213
214 { .name = NULL, .value = -1 }
215 };
216
217 static const Jim_Nvp nvp_target_state[] = {
218 { .name = "unknown", .value = TARGET_UNKNOWN },
219 { .name = "running", .value = TARGET_RUNNING },
220 { .name = "halted", .value = TARGET_HALTED },
221 { .name = "reset", .value = TARGET_RESET },
222 { .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
223 { .name = NULL, .value = -1 },
224 };
225
226 static 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 = "program-exit" , .value = DBG_REASON_EXIT },
234 { .name = "undefined" , .value = DBG_REASON_UNDEFINED },
235 { .name = NULL, .value = -1 },
236 };
237
238 static 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 },
244 };
245
246 static 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 },
252 };
253
254 const char *debug_reason_name(struct target *t)
255 {
256 const char *cp;
257
258 cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
259 t->debug_reason)->name;
260 if (!cp) {
261 LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
262 cp = "(*BUG*unknown*BUG*)";
263 }
264 return cp;
265 }
266
267 const char *target_state_name(struct target *t)
268 {
269 const char *cp;
270 cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
271 if (!cp) {
272 LOG_ERROR("Invalid target state: %d", (int)(t->state));
273 cp = "(*BUG*unknown*BUG*)";
274 }
275 return cp;
276 }
277
278 /* determine the number of the new target */
279 static int new_target_number(void)
280 {
281 struct target *t;
282 int x;
283
284 /* number is 0 based */
285 x = -1;
286 t = all_targets;
287 while (t) {
288 if (x < t->target_number)
289 x = t->target_number;
290 t = t->next;
291 }
292 return x + 1;
293 }
294
295 /* read a uint32_t from a buffer in target memory endianness */
296 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
297 {
298 if (target->endianness == TARGET_LITTLE_ENDIAN)
299 return le_to_h_u32(buffer);
300 else
301 return be_to_h_u32(buffer);
302 }
303
304 /* read a uint24_t from a buffer in target memory endianness */
305 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
306 {
307 if (target->endianness == TARGET_LITTLE_ENDIAN)
308 return le_to_h_u24(buffer);
309 else
310 return be_to_h_u24(buffer);
311 }
312
313 /* read a uint16_t from a buffer in target memory endianness */
314 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
315 {
316 if (target->endianness == TARGET_LITTLE_ENDIAN)
317 return le_to_h_u16(buffer);
318 else
319 return be_to_h_u16(buffer);
320 }
321
322 /* read a uint8_t from a buffer in target memory endianness */
323 static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
324 {
325 return *buffer & 0x0ff;
326 }
327
328 /* write a uint32_t to a buffer in target memory endianness */
329 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
330 {
331 if (target->endianness == TARGET_LITTLE_ENDIAN)
332 h_u32_to_le(buffer, value);
333 else
334 h_u32_to_be(buffer, value);
335 }
336
337 /* write a uint24_t to a buffer in target memory endianness */
338 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
339 {
340 if (target->endianness == TARGET_LITTLE_ENDIAN)
341 h_u24_to_le(buffer, value);
342 else
343 h_u24_to_be(buffer, value);
344 }
345
346 /* write a uint16_t to a buffer in target memory endianness */
347 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
348 {
349 if (target->endianness == TARGET_LITTLE_ENDIAN)
350 h_u16_to_le(buffer, value);
351 else
352 h_u16_to_be(buffer, value);
353 }
354
355 /* write a uint8_t to a buffer in target memory endianness */
356 static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
357 {
358 *buffer = value;
359 }
360
361 /* write a uint32_t array to a buffer in target memory endianness */
362 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf)
363 {
364 uint32_t i;
365 for (i = 0; i < count; i++)
366 dstbuf[i] = target_buffer_get_u32(target, &buffer[i * 4]);
367 }
368
369 /* write a uint16_t array to a buffer in target memory endianness */
370 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf)
371 {
372 uint32_t i;
373 for (i = 0; i < count; i++)
374 dstbuf[i] = target_buffer_get_u16(target, &buffer[i * 2]);
375 }
376
377 /* write a uint32_t array to a buffer in target memory endianness */
378 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, uint32_t *srcbuf)
379 {
380 uint32_t i;
381 for (i = 0; i < count; i++)
382 target_buffer_set_u32(target, &buffer[i * 4], srcbuf[i]);
383 }
384
385 /* write a uint16_t array to a buffer in target memory endianness */
386 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, uint16_t *srcbuf)
387 {
388 uint32_t i;
389 for (i = 0; i < count; i++)
390 target_buffer_set_u16(target, &buffer[i * 2], srcbuf[i]);
391 }
392
393 /* return a pointer to a configured target; id is name or number */
394 struct target *get_target(const char *id)
395 {
396 struct target *target;
397
398 /* try as tcltarget name */
399 for (target = all_targets; target; target = target->next) {
400 if (target_name(target) == NULL)
401 continue;
402 if (strcmp(id, target_name(target)) == 0)
403 return target;
404 }
405
406 /* It's OK to remove this fallback sometime after August 2010 or so */
407
408 /* no match, try as number */
409 unsigned num;
410 if (parse_uint(id, &num) != ERROR_OK)
411 return NULL;
412
413 for (target = all_targets; target; target = target->next) {
414 if (target->target_number == (int)num) {
415 LOG_WARNING("use '%s' as target identifier, not '%u'",
416 target_name(target), num);
417 return target;
418 }
419 }
420
421 return NULL;
422 }
423
424 /* returns a pointer to the n-th configured target */
425 static struct target *get_target_by_num(int num)
426 {
427 struct target *target = all_targets;
428
429 while (target) {
430 if (target->target_number == num)
431 return target;
432 target = target->next;
433 }
434
435 return NULL;
436 }
437
438 struct target *get_current_target(struct command_context *cmd_ctx)
439 {
440 struct target *target = get_target_by_num(cmd_ctx->current_target);
441
442 if (target == NULL) {
443 LOG_ERROR("BUG: current_target out of bounds");
444 exit(-1);
445 }
446
447 return target;
448 }
449
450 int target_poll(struct target *target)
451 {
452 int retval;
453
454 /* We can't poll until after examine */
455 if (!target_was_examined(target)) {
456 /* Fail silently lest we pollute the log */
457 return ERROR_FAIL;
458 }
459
460 retval = target->type->poll(target);
461 if (retval != ERROR_OK)
462 return retval;
463
464 if (target->halt_issued) {
465 if (target->state == TARGET_HALTED)
466 target->halt_issued = false;
467 else {
468 long long t = timeval_ms() - target->halt_issued_time;
469 if (t > DEFAULT_HALT_TIMEOUT) {
470 target->halt_issued = false;
471 LOG_INFO("Halt timed out, wake up GDB.");
472 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
473 }
474 }
475 }
476
477 return ERROR_OK;
478 }
479
480 int target_halt(struct target *target)
481 {
482 int retval;
483 /* We can't poll until after examine */
484 if (!target_was_examined(target)) {
485 LOG_ERROR("Target not examined yet");
486 return ERROR_FAIL;
487 }
488
489 retval = target->type->halt(target);
490 if (retval != ERROR_OK)
491 return retval;
492
493 target->halt_issued = true;
494 target->halt_issued_time = timeval_ms();
495
496 return ERROR_OK;
497 }
498
499 /**
500 * Make the target (re)start executing using its saved execution
501 * context (possibly with some modifications).
502 *
503 * @param target Which target should start executing.
504 * @param current True to use the target's saved program counter instead
505 * of the address parameter
506 * @param address Optionally used as the program counter.
507 * @param handle_breakpoints True iff breakpoints at the resumption PC
508 * should be skipped. (For example, maybe execution was stopped by
509 * such a breakpoint, in which case it would be counterprodutive to
510 * let it re-trigger.
511 * @param debug_execution False if all working areas allocated by OpenOCD
512 * should be released and/or restored to their original contents.
513 * (This would for example be true to run some downloaded "helper"
514 * algorithm code, which resides in one such working buffer and uses
515 * another for data storage.)
516 *
517 * @todo Resolve the ambiguity about what the "debug_execution" flag
518 * signifies. For example, Target implementations don't agree on how
519 * it relates to invalidation of the register cache, or to whether
520 * breakpoints and watchpoints should be enabled. (It would seem wrong
521 * to enable breakpoints when running downloaded "helper" algorithms
522 * (debug_execution true), since the breakpoints would be set to match
523 * target firmware being debugged, not the helper algorithm.... and
524 * enabling them could cause such helpers to malfunction (for example,
525 * by overwriting data with a breakpoint instruction. On the other
526 * hand the infrastructure for running such helpers might use this
527 * procedure but rely on hardware breakpoint to detect termination.)
528 */
529 int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
530 {
531 int retval;
532
533 /* We can't poll until after examine */
534 if (!target_was_examined(target)) {
535 LOG_ERROR("Target not examined yet");
536 return ERROR_FAIL;
537 }
538
539 target_call_event_callbacks(target, TARGET_EVENT_RESUME_START);
540
541 /* note that resume *must* be asynchronous. The CPU can halt before
542 * we poll. The CPU can even halt at the current PC as a result of
543 * a software breakpoint being inserted by (a bug?) the application.
544 */
545 retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution);
546 if (retval != ERROR_OK)
547 return retval;
548
549 target_call_event_callbacks(target, TARGET_EVENT_RESUME_END);
550
551 return retval;
552 }
553
554 static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
555 {
556 char buf[100];
557 int retval;
558 Jim_Nvp *n;
559 n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
560 if (n->name == NULL) {
561 LOG_ERROR("invalid reset mode");
562 return ERROR_FAIL;
563 }
564
565 /* disable polling during reset to make reset event scripts
566 * more predictable, i.e. dr/irscan & pathmove in events will
567 * not have JTAG operations injected into the middle of a sequence.
568 */
569 bool save_poll = jtag_poll_get_enabled();
570
571 jtag_poll_set_enabled(false);
572
573 sprintf(buf, "ocd_process_reset %s", n->name);
574 retval = Jim_Eval(cmd_ctx->interp, buf);
575
576 jtag_poll_set_enabled(save_poll);
577
578 if (retval != JIM_OK) {
579 Jim_MakeErrorMessage(cmd_ctx->interp);
580 command_print(NULL, "%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
581 return ERROR_FAIL;
582 }
583
584 /* We want any events to be processed before the prompt */
585 retval = target_call_timer_callbacks_now();
586
587 struct target *target;
588 for (target = all_targets; target; target = target->next) {
589 target->type->check_reset(target);
590 target->running_alg = false;
591 }
592
593 return retval;
594 }
595
596 static int identity_virt2phys(struct target *target,
597 uint32_t virtual, uint32_t *physical)
598 {
599 *physical = virtual;
600 return ERROR_OK;
601 }
602
603 static int no_mmu(struct target *target, int *enabled)
604 {
605 *enabled = 0;
606 return ERROR_OK;
607 }
608
609 static int default_examine(struct target *target)
610 {
611 target_set_examined(target);
612 return ERROR_OK;
613 }
614
615 /* no check by default */
616 static int default_check_reset(struct target *target)
617 {
618 return ERROR_OK;
619 }
620
621 int target_examine_one(struct target *target)
622 {
623 return target->type->examine(target);
624 }
625
626 static int jtag_enable_callback(enum jtag_event event, void *priv)
627 {
628 struct target *target = priv;
629
630 if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
631 return ERROR_OK;
632
633 jtag_unregister_event_callback(jtag_enable_callback, target);
634
635 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
636
637 int retval = target_examine_one(target);
638 if (retval != ERROR_OK)
639 return retval;
640
641 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
642
643 return retval;
644 }
645
646 /* Targets that correctly implement init + examine, i.e.
647 * no communication with target during init:
648 *
649 * XScale
650 */
651 int target_examine(void)
652 {
653 int retval = ERROR_OK;
654 struct target *target;
655
656 for (target = all_targets; target; target = target->next) {
657 /* defer examination, but don't skip it */
658 if (!target->tap->enabled) {
659 jtag_register_event_callback(jtag_enable_callback,
660 target);
661 continue;
662 }
663
664 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_START);
665
666 retval = target_examine_one(target);
667 if (retval != ERROR_OK)
668 return retval;
669
670 target_call_event_callbacks(target, TARGET_EVENT_EXAMINE_END);
671 }
672 return retval;
673 }
674
675 const char *target_type_name(struct target *target)
676 {
677 return target->type->name;
678 }
679
680 static int target_soft_reset_halt(struct target *target)
681 {
682 if (!target_was_examined(target)) {
683 LOG_ERROR("Target not examined yet");
684 return ERROR_FAIL;
685 }
686 if (!target->type->soft_reset_halt) {
687 LOG_ERROR("Target %s does not support soft_reset_halt",
688 target_name(target));
689 return ERROR_FAIL;
690 }
691 return target->type->soft_reset_halt(target);
692 }
693
694 /**
695 * Downloads a target-specific native code algorithm to the target,
696 * and executes it. * Note that some targets may need to set up, enable,
697 * and tear down a breakpoint (hard or * soft) to detect algorithm
698 * termination, while others may support lower overhead schemes where
699 * soft breakpoints embedded in the algorithm automatically terminate the
700 * algorithm.
701 *
702 * @param target used to run the algorithm
703 * @param arch_info target-specific description of the algorithm.
704 */
705 int target_run_algorithm(struct target *target,
706 int num_mem_params, struct mem_param *mem_params,
707 int num_reg_params, struct reg_param *reg_param,
708 uint32_t entry_point, uint32_t exit_point,
709 int timeout_ms, void *arch_info)
710 {
711 int retval = ERROR_FAIL;
712
713 if (!target_was_examined(target)) {
714 LOG_ERROR("Target not examined yet");
715 goto done;
716 }
717 if (!target->type->run_algorithm) {
718 LOG_ERROR("Target type '%s' does not support %s",
719 target_type_name(target), __func__);
720 goto done;
721 }
722
723 target->running_alg = true;
724 retval = target->type->run_algorithm(target,
725 num_mem_params, mem_params,
726 num_reg_params, reg_param,
727 entry_point, exit_point, timeout_ms, arch_info);
728 target->running_alg = false;
729
730 done:
731 return retval;
732 }
733
734 /**
735 * Downloads a target-specific native code algorithm to the target,
736 * executes and leaves it running.
737 *
738 * @param target used to run the algorithm
739 * @param arch_info target-specific description of the algorithm.
740 */
741 int target_start_algorithm(struct target *target,
742 int num_mem_params, struct mem_param *mem_params,
743 int num_reg_params, struct reg_param *reg_params,
744 uint32_t entry_point, uint32_t exit_point,
745 void *arch_info)
746 {
747 int retval = ERROR_FAIL;
748
749 if (!target_was_examined(target)) {
750 LOG_ERROR("Target not examined yet");
751 goto done;
752 }
753 if (!target->type->start_algorithm) {
754 LOG_ERROR("Target type '%s' does not support %s",
755 target_type_name(target), __func__);
756 goto done;
757 }
758 if (target->running_alg) {
759 LOG_ERROR("Target is already running an algorithm");
760 goto done;
761 }
762
763 target->running_alg = true;
764 retval = target->type->start_algorithm(target,
765 num_mem_params, mem_params,
766 num_reg_params, reg_params,
767 entry_point, exit_point, arch_info);
768
769 done:
770 return retval;
771 }
772
773 /**
774 * Waits for an algorithm started with target_start_algorithm() to complete.
775 *
776 * @param target used to run the algorithm
777 * @param arch_info target-specific description of the algorithm.
778 */
779 int target_wait_algorithm(struct target *target,
780 int num_mem_params, struct mem_param *mem_params,
781 int num_reg_params, struct reg_param *reg_params,
782 uint32_t exit_point, int timeout_ms,
783 void *arch_info)
784 {
785 int retval = ERROR_FAIL;
786
787 if (!target->type->wait_algorithm) {
788 LOG_ERROR("Target type '%s' does not support %s",
789 target_type_name(target), __func__);
790 goto done;
791 }
792 if (!target->running_alg) {
793 LOG_ERROR("Target is not running an algorithm");
794 goto done;
795 }
796
797 retval = target->type->wait_algorithm(target,
798 num_mem_params, mem_params,
799 num_reg_params, reg_params,
800 exit_point, timeout_ms, arch_info);
801 if (retval != ERROR_TARGET_TIMEOUT)
802 target->running_alg = false;
803
804 done:
805 return retval;
806 }
807
808 /**
809 * Executes a target-specific native code algorithm in the target.
810 * It differs from target_run_algorithm in that the algorithm is asynchronous.
811 * Because of this it requires an compliant algorithm:
812 * see contrib/loaders/flash/stm32f1x.S for example.
813 *
814 * @param target used to run the algorithm
815 */
816
817 int target_run_flash_async_algorithm(struct target *target,
818 uint8_t *buffer, uint32_t count, int block_size,
819 int num_mem_params, struct mem_param *mem_params,
820 int num_reg_params, struct reg_param *reg_params,
821 uint32_t buffer_start, uint32_t buffer_size,
822 uint32_t entry_point, uint32_t exit_point, void *arch_info)
823 {
824 int retval;
825 int timeout = 0;
826
827 /* Set up working area. First word is write pointer, second word is read pointer,
828 * rest is fifo data area. */
829 uint32_t wp_addr = buffer_start;
830 uint32_t rp_addr = buffer_start + 4;
831 uint32_t fifo_start_addr = buffer_start + 8;
832 uint32_t fifo_end_addr = buffer_start + buffer_size;
833
834 uint32_t wp = fifo_start_addr;
835 uint32_t rp = fifo_start_addr;
836
837 /* validate block_size is 2^n */
838 assert(!block_size || !(block_size & (block_size - 1)));
839
840 retval = target_write_u32(target, wp_addr, wp);
841 if (retval != ERROR_OK)
842 return retval;
843 retval = target_write_u32(target, rp_addr, rp);
844 if (retval != ERROR_OK)
845 return retval;
846
847 /* Start up algorithm on target and let it idle while writing the first chunk */
848 retval = target_start_algorithm(target, num_mem_params, mem_params,
849 num_reg_params, reg_params,
850 entry_point,
851 exit_point,
852 arch_info);
853
854 if (retval != ERROR_OK) {
855 LOG_ERROR("error starting target flash write algorithm");
856 return retval;
857 }
858
859 while (count > 0) {
860
861 retval = target_read_u32(target, rp_addr, &rp);
862 if (retval != ERROR_OK) {
863 LOG_ERROR("failed to get read pointer");
864 break;
865 }
866
867 LOG_DEBUG("count 0x%" PRIx32 " wp 0x%" PRIx32 " rp 0x%" PRIx32, count, wp, rp);
868
869 if (rp == 0) {
870 LOG_ERROR("flash write algorithm aborted by target");
871 retval = ERROR_FLASH_OPERATION_FAILED;
872 break;
873 }
874
875 if ((rp & (block_size - 1)) || rp < fifo_start_addr || rp >= fifo_end_addr) {
876 LOG_ERROR("corrupted fifo read pointer 0x%" PRIx32, rp);
877 break;
878 }
879
880 /* Count the number of bytes available in the fifo without
881 * crossing the wrap around. Make sure to not fill it completely,
882 * because that would make wp == rp and that's the empty condition. */
883 uint32_t thisrun_bytes;
884 if (rp > wp)
885 thisrun_bytes = rp - wp - block_size;
886 else if (rp > fifo_start_addr)
887 thisrun_bytes = fifo_end_addr - wp;
888 else
889 thisrun_bytes = fifo_end_addr - wp - block_size;
890
891 if (thisrun_bytes == 0) {
892 /* Throttle polling a bit if transfer is (much) faster than flash
893 * programming. The exact delay shouldn't matter as long as it's
894 * less than buffer size / flash speed. This is very unlikely to
895 * run when using high latency connections such as USB. */
896 alive_sleep(10);
897
898 /* to stop an infinite loop on some targets check and increment a timeout
899 * this issue was observed on a stellaris using the new ICDI interface */
900 if (timeout++ >= 500) {
901 LOG_ERROR("timeout waiting for algorithm, a target reset is recommended");
902 return ERROR_FLASH_OPERATION_FAILED;
903 }
904 continue;
905 }
906
907 /* reset our timeout */
908 timeout = 0;
909
910 /* Limit to the amount of data we actually want to write */
911 if (thisrun_bytes > count * block_size)
912 thisrun_bytes = count * block_size;
913
914 /* Write data to fifo */
915 retval = target_write_buffer(target, wp, thisrun_bytes, buffer);
916 if (retval != ERROR_OK)
917 break;
918
919 /* Update counters and wrap write pointer */
920 buffer += thisrun_bytes;
921 count -= thisrun_bytes / block_size;
922 wp += thisrun_bytes;
923 if (wp >= fifo_end_addr)
924 wp = fifo_start_addr;
925
926 /* Store updated write pointer to target */
927 retval = target_write_u32(target, wp_addr, wp);
928 if (retval != ERROR_OK)
929 break;
930 }
931
932 if (retval != ERROR_OK) {
933 /* abort flash write algorithm on target */
934 target_write_u32(target, wp_addr, 0);
935 }
936
937 int retval2 = target_wait_algorithm(target, num_mem_params, mem_params,
938 num_reg_params, reg_params,
939 exit_point,
940 10000,
941 arch_info);
942
943 if (retval2 != ERROR_OK) {
944 LOG_ERROR("error waiting for target flash write algorithm");
945 retval = retval2;
946 }
947
948 return retval;
949 }
950
951 int target_read_memory(struct target *target,
952 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
953 {
954 if (!target_was_examined(target)) {
955 LOG_ERROR("Target not examined yet");
956 return ERROR_FAIL;
957 }
958 return target->type->read_memory(target, address, size, count, buffer);
959 }
960
961 int target_read_phys_memory(struct target *target,
962 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
963 {
964 if (!target_was_examined(target)) {
965 LOG_ERROR("Target not examined yet");
966 return ERROR_FAIL;
967 }
968 return target->type->read_phys_memory(target, address, size, count, buffer);
969 }
970
971 int target_write_memory(struct target *target,
972 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
973 {
974 if (!target_was_examined(target)) {
975 LOG_ERROR("Target not examined yet");
976 return ERROR_FAIL;
977 }
978 return target->type->write_memory(target, address, size, count, buffer);
979 }
980
981 int target_write_phys_memory(struct target *target,
982 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
983 {
984 if (!target_was_examined(target)) {
985 LOG_ERROR("Target not examined yet");
986 return ERROR_FAIL;
987 }
988 return target->type->write_phys_memory(target, address, size, count, buffer);
989 }
990
991 int target_add_breakpoint(struct target *target,
992 struct breakpoint *breakpoint)
993 {
994 if ((target->state != TARGET_HALTED) && (breakpoint->type != BKPT_HARD)) {
995 LOG_WARNING("target %s is not halted", target_name(target));
996 return ERROR_TARGET_NOT_HALTED;
997 }
998 return target->type->add_breakpoint(target, breakpoint);
999 }
1000
1001 int target_add_context_breakpoint(struct target *target,
1002 struct breakpoint *breakpoint)
1003 {
1004 if (target->state != TARGET_HALTED) {
1005 LOG_WARNING("target %s is not halted", target_name(target));
1006 return ERROR_TARGET_NOT_HALTED;
1007 }
1008 return target->type->add_context_breakpoint(target, breakpoint);
1009 }
1010
1011 int target_add_hybrid_breakpoint(struct target *target,
1012 struct breakpoint *breakpoint)
1013 {
1014 if (target->state != TARGET_HALTED) {
1015 LOG_WARNING("target %s is not halted", target_name(target));
1016 return ERROR_TARGET_NOT_HALTED;
1017 }
1018 return target->type->add_hybrid_breakpoint(target, breakpoint);
1019 }
1020
1021 int target_remove_breakpoint(struct target *target,
1022 struct breakpoint *breakpoint)
1023 {
1024 return target->type->remove_breakpoint(target, breakpoint);
1025 }
1026
1027 int target_add_watchpoint(struct target *target,
1028 struct watchpoint *watchpoint)
1029 {
1030 if (target->state != TARGET_HALTED) {
1031 LOG_WARNING("target %s is not halted", target_name(target));
1032 return ERROR_TARGET_NOT_HALTED;
1033 }
1034 return target->type->add_watchpoint(target, watchpoint);
1035 }
1036 int target_remove_watchpoint(struct target *target,
1037 struct watchpoint *watchpoint)
1038 {
1039 return target->type->remove_watchpoint(target, watchpoint);
1040 }
1041 int target_hit_watchpoint(struct target *target,
1042 struct watchpoint **hit_watchpoint)
1043 {
1044 if (target->state != TARGET_HALTED) {
1045 LOG_WARNING("target %s is not halted", target->cmd_name);
1046 return ERROR_TARGET_NOT_HALTED;
1047 }
1048
1049 if (target->type->hit_watchpoint == NULL) {
1050 /* For backward compatible, if hit_watchpoint is not implemented,
1051 * return ERROR_FAIL such that gdb_server will not take the nonsense
1052 * information. */
1053 return ERROR_FAIL;
1054 }
1055
1056 return target->type->hit_watchpoint(target, hit_watchpoint);
1057 }
1058
1059 int target_get_gdb_reg_list(struct target *target,
1060 struct reg **reg_list[], int *reg_list_size,
1061 enum target_register_class reg_class)
1062 {
1063 return target->type->get_gdb_reg_list(target, reg_list, reg_list_size, reg_class);
1064 }
1065 int target_step(struct target *target,
1066 int current, uint32_t address, int handle_breakpoints)
1067 {
1068 return target->type->step(target, current, address, handle_breakpoints);
1069 }
1070
1071 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info)
1072 {
1073 if (target->state != TARGET_HALTED) {
1074 LOG_WARNING("target %s is not halted", target->cmd_name);
1075 return ERROR_TARGET_NOT_HALTED;
1076 }
1077 return target->type->get_gdb_fileio_info(target, fileio_info);
1078 }
1079
1080 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c)
1081 {
1082 if (target->state != TARGET_HALTED) {
1083 LOG_WARNING("target %s is not halted", target->cmd_name);
1084 return ERROR_TARGET_NOT_HALTED;
1085 }
1086 return target->type->gdb_fileio_end(target, retcode, fileio_errno, ctrl_c);
1087 }
1088
1089 int target_profiling(struct target *target, uint32_t *samples,
1090 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
1091 {
1092 if (target->state != TARGET_HALTED) {
1093 LOG_WARNING("target %s is not halted", target->cmd_name);
1094 return ERROR_TARGET_NOT_HALTED;
1095 }
1096 return target->type->profiling(target, samples, max_num_samples,
1097 num_samples, seconds);
1098 }
1099
1100 /**
1101 * Reset the @c examined flag for the given target.
1102 * Pure paranoia -- targets are zeroed on allocation.
1103 */
1104 static void target_reset_examined(struct target *target)
1105 {
1106 target->examined = false;
1107 }
1108
1109 static int err_read_phys_memory(struct target *target, uint32_t address,
1110 uint32_t size, uint32_t count, uint8_t *buffer)
1111 {
1112 LOG_ERROR("Not implemented: %s", __func__);
1113 return ERROR_FAIL;
1114 }
1115
1116 static int err_write_phys_memory(struct target *target, uint32_t address,
1117 uint32_t size, uint32_t count, const uint8_t *buffer)
1118 {
1119 LOG_ERROR("Not implemented: %s", __func__);
1120 return ERROR_FAIL;
1121 }
1122
1123 static int handle_target(void *priv);
1124
1125 static int target_init_one(struct command_context *cmd_ctx,
1126 struct target *target)
1127 {
1128 target_reset_examined(target);
1129
1130 struct target_type *type = target->type;
1131 if (type->examine == NULL)
1132 type->examine = default_examine;
1133
1134 if (type->check_reset == NULL)
1135 type->check_reset = default_check_reset;
1136
1137 assert(type->init_target != NULL);
1138
1139 int retval = type->init_target(cmd_ctx, target);
1140 if (ERROR_OK != retval) {
1141 LOG_ERROR("target '%s' init failed", target_name(target));
1142 return retval;
1143 }
1144
1145 /* Sanity-check MMU support ... stub in what we must, to help
1146 * implement it in stages, but warn if we need to do so.
1147 */
1148 if (type->mmu) {
1149 if (type->write_phys_memory == NULL) {
1150 LOG_ERROR("type '%s' is missing write_phys_memory",
1151 type->name);
1152 type->write_phys_memory = err_write_phys_memory;
1153 }
1154 if (type->read_phys_memory == NULL) {
1155 LOG_ERROR("type '%s' is missing read_phys_memory",
1156 type->name);
1157 type->read_phys_memory = err_read_phys_memory;
1158 }
1159 if (type->virt2phys == NULL) {
1160 LOG_ERROR("type '%s' is missing virt2phys", type->name);
1161 type->virt2phys = identity_virt2phys;
1162 }
1163 } else {
1164 /* Make sure no-MMU targets all behave the same: make no
1165 * distinction between physical and virtual addresses, and
1166 * ensure that virt2phys() is always an identity mapping.
1167 */
1168 if (type->write_phys_memory || type->read_phys_memory || type->virt2phys)
1169 LOG_WARNING("type '%s' has bad MMU hooks", type->name);
1170
1171 type->mmu = no_mmu;
1172 type->write_phys_memory = type->write_memory;
1173 type->read_phys_memory = type->read_memory;
1174 type->virt2phys = identity_virt2phys;
1175 }
1176
1177 if (target->type->read_buffer == NULL)
1178 target->type->read_buffer = target_read_buffer_default;
1179
1180 if (target->type->write_buffer == NULL)
1181 target->type->write_buffer = target_write_buffer_default;
1182
1183 if (target->type->get_gdb_fileio_info == NULL)
1184 target->type->get_gdb_fileio_info = target_get_gdb_fileio_info_default;
1185
1186 if (target->type->gdb_fileio_end == NULL)
1187 target->type->gdb_fileio_end = target_gdb_fileio_end_default;
1188
1189 if (target->type->profiling == NULL)
1190 target->type->profiling = target_profiling_default;
1191
1192 return ERROR_OK;
1193 }
1194
1195 static int target_init(struct command_context *cmd_ctx)
1196 {
1197 struct target *target;
1198 int retval;
1199
1200 for (target = all_targets; target; target = target->next) {
1201 retval = target_init_one(cmd_ctx, target);
1202 if (ERROR_OK != retval)
1203 return retval;
1204 }
1205
1206 if (!all_targets)
1207 return ERROR_OK;
1208
1209 retval = target_register_user_commands(cmd_ctx);
1210 if (ERROR_OK != retval)
1211 return retval;
1212
1213 retval = target_register_timer_callback(&handle_target,
1214 polling_interval, 1, cmd_ctx->interp);
1215 if (ERROR_OK != retval)
1216 return retval;
1217
1218 return ERROR_OK;
1219 }
1220
1221 COMMAND_HANDLER(handle_target_init_command)
1222 {
1223 int retval;
1224
1225 if (CMD_ARGC != 0)
1226 return ERROR_COMMAND_SYNTAX_ERROR;
1227
1228 static bool target_initialized;
1229 if (target_initialized) {
1230 LOG_INFO("'target init' has already been called");
1231 return ERROR_OK;
1232 }
1233 target_initialized = true;
1234
1235 retval = command_run_line(CMD_CTX, "init_targets");
1236 if (ERROR_OK != retval)
1237 return retval;
1238
1239 retval = command_run_line(CMD_CTX, "init_board");
1240 if (ERROR_OK != retval)
1241 return retval;
1242
1243 LOG_DEBUG("Initializing targets...");
1244 return target_init(CMD_CTX);
1245 }
1246
1247 int target_register_event_callback(int (*callback)(struct target *target,
1248 enum target_event event, void *priv), void *priv)
1249 {
1250 struct target_event_callback **callbacks_p = &target_event_callbacks;
1251
1252 if (callback == NULL)
1253 return ERROR_COMMAND_SYNTAX_ERROR;
1254
1255 if (*callbacks_p) {
1256 while ((*callbacks_p)->next)
1257 callbacks_p = &((*callbacks_p)->next);
1258 callbacks_p = &((*callbacks_p)->next);
1259 }
1260
1261 (*callbacks_p) = malloc(sizeof(struct target_event_callback));
1262 (*callbacks_p)->callback = callback;
1263 (*callbacks_p)->priv = priv;
1264 (*callbacks_p)->next = NULL;
1265
1266 return ERROR_OK;
1267 }
1268
1269 int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
1270 {
1271 struct target_timer_callback **callbacks_p = &target_timer_callbacks;
1272 struct timeval now;
1273
1274 if (callback == NULL)
1275 return ERROR_COMMAND_SYNTAX_ERROR;
1276
1277 if (*callbacks_p) {
1278 while ((*callbacks_p)->next)
1279 callbacks_p = &((*callbacks_p)->next);
1280 callbacks_p = &((*callbacks_p)->next);
1281 }
1282
1283 (*callbacks_p) = malloc(sizeof(struct target_timer_callback));
1284 (*callbacks_p)->callback = callback;
1285 (*callbacks_p)->periodic = periodic;
1286 (*callbacks_p)->time_ms = time_ms;
1287
1288 gettimeofday(&now, NULL);
1289 (*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
1290 time_ms -= (time_ms % 1000);
1291 (*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
1292 if ((*callbacks_p)->when.tv_usec > 1000000) {
1293 (*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
1294 (*callbacks_p)->when.tv_sec += 1;
1295 }
1296
1297 (*callbacks_p)->priv = priv;
1298 (*callbacks_p)->next = NULL;
1299
1300 return ERROR_OK;
1301 }
1302
1303 int target_unregister_event_callback(int (*callback)(struct target *target,
1304 enum target_event event, void *priv), void *priv)
1305 {
1306 struct target_event_callback **p = &target_event_callbacks;
1307 struct target_event_callback *c = target_event_callbacks;
1308
1309 if (callback == NULL)
1310 return ERROR_COMMAND_SYNTAX_ERROR;
1311
1312 while (c) {
1313 struct target_event_callback *next = c->next;
1314 if ((c->callback == callback) && (c->priv == priv)) {
1315 *p = next;
1316 free(c);
1317 return ERROR_OK;
1318 } else
1319 p = &(c->next);
1320 c = next;
1321 }
1322
1323 return ERROR_OK;
1324 }
1325
1326 static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1327 {
1328 struct target_timer_callback **p = &target_timer_callbacks;
1329 struct target_timer_callback *c = target_timer_callbacks;
1330
1331 if (callback == NULL)
1332 return ERROR_COMMAND_SYNTAX_ERROR;
1333
1334 while (c) {
1335 struct target_timer_callback *next = c->next;
1336 if ((c->callback == callback) && (c->priv == priv)) {
1337 *p = next;
1338 free(c);
1339 return ERROR_OK;
1340 } else
1341 p = &(c->next);
1342 c = next;
1343 }
1344
1345 return ERROR_OK;
1346 }
1347
1348 int target_call_event_callbacks(struct target *target, enum target_event event)
1349 {
1350 struct target_event_callback *callback = target_event_callbacks;
1351 struct target_event_callback *next_callback;
1352
1353 if (event == TARGET_EVENT_HALTED) {
1354 /* execute early halted first */
1355 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1356 }
1357
1358 LOG_DEBUG("target event %i (%s)", event,
1359 Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
1360
1361 target_handle_event(target, event);
1362
1363 while (callback) {
1364 next_callback = callback->next;
1365 callback->callback(target, event, callback->priv);
1366 callback = next_callback;
1367 }
1368
1369 return ERROR_OK;
1370 }
1371
1372 static int target_timer_callback_periodic_restart(
1373 struct target_timer_callback *cb, struct timeval *now)
1374 {
1375 int time_ms = cb->time_ms;
1376 cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
1377 time_ms -= (time_ms % 1000);
1378 cb->when.tv_sec = now->tv_sec + time_ms / 1000;
1379 if (cb->when.tv_usec > 1000000) {
1380 cb->when.tv_usec = cb->when.tv_usec - 1000000;
1381 cb->when.tv_sec += 1;
1382 }
1383 return ERROR_OK;
1384 }
1385
1386 static int target_call_timer_callback(struct target_timer_callback *cb,
1387 struct timeval *now)
1388 {
1389 cb->callback(cb->priv);
1390
1391 if (cb->periodic)
1392 return target_timer_callback_periodic_restart(cb, now);
1393
1394 return target_unregister_timer_callback(cb->callback, cb->priv);
1395 }
1396
1397 static int target_call_timer_callbacks_check_time(int checktime)
1398 {
1399 keep_alive();
1400
1401 struct timeval now;
1402 gettimeofday(&now, NULL);
1403
1404 struct target_timer_callback *callback = target_timer_callbacks;
1405 while (callback) {
1406 /* cleaning up may unregister and free this callback */
1407 struct target_timer_callback *next_callback = callback->next;
1408
1409 bool call_it = callback->callback &&
1410 ((!checktime && callback->periodic) ||
1411 now.tv_sec > callback->when.tv_sec ||
1412 (now.tv_sec == callback->when.tv_sec &&
1413 now.tv_usec >= callback->when.tv_usec));
1414
1415 if (call_it) {
1416 int retval = target_call_timer_callback(callback, &now);
1417 if (retval != ERROR_OK)
1418 return retval;
1419 }
1420
1421 callback = next_callback;
1422 }
1423
1424 return ERROR_OK;
1425 }
1426
1427 int target_call_timer_callbacks(void)
1428 {
1429 return target_call_timer_callbacks_check_time(1);
1430 }
1431
1432 /* invoke periodic callbacks immediately */
1433 int target_call_timer_callbacks_now(void)
1434 {
1435 return target_call_timer_callbacks_check_time(0);
1436 }
1437
1438 /* Prints the working area layout for debug purposes */
1439 static void print_wa_layout(struct target *target)
1440 {
1441 struct working_area *c = target->working_areas;
1442
1443 while (c) {
1444 LOG_DEBUG("%c%c 0x%08"PRIx32"-0x%08"PRIx32" (%"PRIu32" bytes)",
1445 c->backup ? 'b' : ' ', c->free ? ' ' : '*',
1446 c->address, c->address + c->size - 1, c->size);
1447 c = c->next;
1448 }
1449 }
1450
1451 /* Reduce area to size bytes, create a new free area from the remaining bytes, if any. */
1452 static void target_split_working_area(struct working_area *area, uint32_t size)
1453 {
1454 assert(area->free); /* Shouldn't split an allocated area */
1455 assert(size <= area->size); /* Caller should guarantee this */
1456
1457 /* Split only if not already the right size */
1458 if (size < area->size) {
1459 struct working_area *new_wa = malloc(sizeof(*new_wa));
1460
1461 if (new_wa == NULL)
1462 return;
1463
1464 new_wa->next = area->next;
1465 new_wa->size = area->size - size;
1466 new_wa->address = area->address + size;
1467 new_wa->backup = NULL;
1468 new_wa->user = NULL;
1469 new_wa->free = true;
1470
1471 area->next = new_wa;
1472 area->size = size;
1473
1474 /* If backup memory was allocated to this area, it has the wrong size
1475 * now so free it and it will be reallocated if/when needed */
1476 if (area->backup) {
1477 free(area->backup);
1478 area->backup = NULL;
1479 }
1480 }
1481 }
1482
1483 /* Merge all adjacent free areas into one */
1484 static void target_merge_working_areas(struct target *target)
1485 {
1486 struct working_area *c = target->working_areas;
1487
1488 while (c && c->next) {
1489 assert(c->next->address == c->address + c->size); /* This is an invariant */
1490
1491 /* Find two adjacent free areas */
1492 if (c->free && c->next->free) {
1493 /* Merge the last into the first */
1494 c->size += c->next->size;
1495
1496 /* Remove the last */
1497 struct working_area *to_be_freed = c->next;
1498 c->next = c->next->next;
1499 if (to_be_freed->backup)
1500 free(to_be_freed->backup);
1501 free(to_be_freed);
1502
1503 /* If backup memory was allocated to the remaining area, it's has
1504 * the wrong size now */
1505 if (c->backup) {
1506 free(c->backup);
1507 c->backup = NULL;
1508 }
1509 } else {
1510 c = c->next;
1511 }
1512 }
1513 }
1514
1515 int target_alloc_working_area_try(struct target *target, uint32_t size, struct working_area **area)
1516 {
1517 /* Reevaluate working area address based on MMU state*/
1518 if (target->working_areas == NULL) {
1519 int retval;
1520 int enabled;
1521
1522 retval = target->type->mmu(target, &enabled);
1523 if (retval != ERROR_OK)
1524 return retval;
1525
1526 if (!enabled) {
1527 if (target->working_area_phys_spec) {
1528 LOG_DEBUG("MMU disabled, using physical "
1529 "address for working memory 0x%08"PRIx32,
1530 target->working_area_phys);
1531 target->working_area = target->working_area_phys;
1532 } else {
1533 LOG_ERROR("No working memory available. "
1534 "Specify -work-area-phys to target.");
1535 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1536 }
1537 } else {
1538 if (target->working_area_virt_spec) {
1539 LOG_DEBUG("MMU enabled, using virtual "
1540 "address for working memory 0x%08"PRIx32,
1541 target->working_area_virt);
1542 target->working_area = target->working_area_virt;
1543 } else {
1544 LOG_ERROR("No working memory available. "
1545 "Specify -work-area-virt to target.");
1546 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1547 }
1548 }
1549
1550 /* Set up initial working area on first call */
1551 struct working_area *new_wa = malloc(sizeof(*new_wa));
1552 if (new_wa) {
1553 new_wa->next = NULL;
1554 new_wa->size = target->working_area_size & ~3UL; /* 4-byte align */
1555 new_wa->address = target->working_area;
1556 new_wa->backup = NULL;
1557 new_wa->user = NULL;
1558 new_wa->free = true;
1559 }
1560
1561 target->working_areas = new_wa;
1562 }
1563
1564 /* only allocate multiples of 4 byte */
1565 if (size % 4)
1566 size = (size + 3) & (~3UL);
1567
1568 struct working_area *c = target->working_areas;
1569
1570 /* Find the first large enough working area */
1571 while (c) {
1572 if (c->free && c->size >= size)
1573 break;
1574 c = c->next;
1575 }
1576
1577 if (c == NULL)
1578 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1579
1580 /* Split the working area into the requested size */
1581 target_split_working_area(c, size);
1582
1583 LOG_DEBUG("allocated new working area of %"PRIu32" bytes at address 0x%08"PRIx32, size, c->address);
1584
1585 if (target->backup_working_area) {
1586 if (c->backup == NULL) {
1587 c->backup = malloc(c->size);
1588 if (c->backup == NULL)
1589 return ERROR_FAIL;
1590 }
1591
1592 int retval = target_read_memory(target, c->address, 4, c->size / 4, c->backup);
1593 if (retval != ERROR_OK)
1594 return retval;
1595 }
1596
1597 /* mark as used, and return the new (reused) area */
1598 c->free = false;
1599 *area = c;
1600
1601 /* user pointer */
1602 c->user = area;
1603
1604 print_wa_layout(target);
1605
1606 return ERROR_OK;
1607 }
1608
1609 int target_alloc_working_area(struct target *target, uint32_t size, struct working_area **area)
1610 {
1611 int retval;
1612
1613 retval = target_alloc_working_area_try(target, size, area);
1614 if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
1615 LOG_WARNING("not enough working area available(requested %"PRIu32")", size);
1616 return retval;
1617
1618 }
1619
1620 static int target_restore_working_area(struct target *target, struct working_area *area)
1621 {
1622 int retval = ERROR_OK;
1623
1624 if (target->backup_working_area && area->backup != NULL) {
1625 retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup);
1626 if (retval != ERROR_OK)
1627 LOG_ERROR("failed to restore %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1628 area->size, area->address);
1629 }
1630
1631 return retval;
1632 }
1633
1634 /* Restore the area's backup memory, if any, and return the area to the allocation pool */
1635 static int target_free_working_area_restore(struct target *target, struct working_area *area, int restore)
1636 {
1637 int retval = ERROR_OK;
1638
1639 if (area->free)
1640 return retval;
1641
1642 if (restore) {
1643 retval = target_restore_working_area(target, area);
1644 /* REVISIT: Perhaps the area should be freed even if restoring fails. */
1645 if (retval != ERROR_OK)
1646 return retval;
1647 }
1648
1649 area->free = true;
1650
1651 LOG_DEBUG("freed %"PRIu32" bytes of working area at address 0x%08"PRIx32,
1652 area->size, area->address);
1653
1654 /* mark user pointer invalid */
1655 /* TODO: Is this really safe? It points to some previous caller's memory.
1656 * How could we know that the area pointer is still in that place and not
1657 * some other vital data? What's the purpose of this, anyway? */
1658 *area->user = NULL;
1659 area->user = NULL;
1660
1661 target_merge_working_areas(target);
1662
1663 print_wa_layout(target);
1664
1665 return retval;
1666 }
1667
1668 int target_free_working_area(struct target *target, struct working_area *area)
1669 {
1670 return target_free_working_area_restore(target, area, 1);
1671 }
1672
1673 /* free resources and restore memory, if restoring memory fails,
1674 * free up resources anyway
1675 */
1676 static void target_free_all_working_areas_restore(struct target *target, int restore)
1677 {
1678 struct working_area *c = target->working_areas;
1679
1680 LOG_DEBUG("freeing all working areas");
1681
1682 /* Loop through all areas, restoring the allocated ones and marking them as free */
1683 while (c) {
1684 if (!c->free) {
1685 if (restore)
1686 target_restore_working_area(target, c);
1687 c->free = true;
1688 *c->user = NULL; /* Same as above */
1689 c->user = NULL;
1690 }
1691 c = c->next;
1692 }
1693
1694 /* Run a merge pass to combine all areas into one */
1695 target_merge_working_areas(target);
1696
1697 print_wa_layout(target);
1698 }
1699
1700 void target_free_all_working_areas(struct target *target)
1701 {
1702 target_free_all_working_areas_restore(target, 1);
1703 }
1704
1705 /* Find the largest number of bytes that can be allocated */
1706 uint32_t target_get_working_area_avail(struct target *target)
1707 {
1708 struct working_area *c = target->working_areas;
1709 uint32_t max_size = 0;
1710
1711 if (c == NULL)
1712 return target->working_area_size;
1713
1714 while (c) {
1715 if (c->free && max_size < c->size)
1716 max_size = c->size;
1717
1718 c = c->next;
1719 }
1720
1721 return max_size;
1722 }
1723
1724 int target_arch_state(struct target *target)
1725 {
1726 int retval;
1727 if (target == NULL) {
1728 LOG_USER("No target has been configured");
1729 return ERROR_OK;
1730 }
1731
1732 LOG_USER("target state: %s", target_state_name(target));
1733
1734 if (target->state != TARGET_HALTED)
1735 return ERROR_OK;
1736
1737 retval = target->type->arch_state(target);
1738 return retval;
1739 }
1740
1741 static int target_get_gdb_fileio_info_default(struct target *target,
1742 struct gdb_fileio_info *fileio_info)
1743 {
1744 /* If target does not support semi-hosting function, target
1745 has no need to provide .get_gdb_fileio_info callback.
1746 It just return ERROR_FAIL and gdb_server will return "Txx"
1747 as target halted every time. */
1748 return ERROR_FAIL;
1749 }
1750
1751 static int target_gdb_fileio_end_default(struct target *target,
1752 int retcode, int fileio_errno, bool ctrl_c)
1753 {
1754 return ERROR_OK;
1755 }
1756
1757 static int target_profiling_default(struct target *target, uint32_t *samples,
1758 uint32_t max_num_samples, uint32_t *num_samples, uint32_t seconds)
1759 {
1760 struct timeval timeout, now;
1761
1762 gettimeofday(&timeout, NULL);
1763 timeval_add_time(&timeout, seconds, 0);
1764
1765 LOG_INFO("Starting profiling. Halting and resuming the"
1766 " target as often as we can...");
1767
1768 uint32_t sample_count = 0;
1769 /* hopefully it is safe to cache! We want to stop/restart as quickly as possible. */
1770 struct reg *reg = register_get_by_name(target->reg_cache, "pc", 1);
1771
1772 int retval = ERROR_OK;
1773 for (;;) {
1774 target_poll(target);
1775 if (target->state == TARGET_HALTED) {
1776 uint32_t t = *((uint32_t *)reg->value);
1777 samples[sample_count++] = t;
1778 /* current pc, addr = 0, do not handle breakpoints, not debugging */
1779 retval = target_resume(target, 1, 0, 0, 0);
1780 target_poll(target);
1781 alive_sleep(10); /* sleep 10ms, i.e. <100 samples/second. */
1782 } else if (target->state == TARGET_RUNNING) {
1783 /* We want to quickly sample the PC. */
1784 retval = target_halt(target);
1785 } else {
1786 LOG_INFO("Target not halted or running");
1787 retval = ERROR_OK;
1788 break;
1789 }
1790
1791 if (retval != ERROR_OK)
1792 break;
1793
1794 gettimeofday(&now, NULL);
1795 if ((sample_count >= max_num_samples) ||
1796 ((now.tv_sec >= timeout.tv_sec) && (now.tv_usec >= timeout.tv_usec))) {
1797 LOG_INFO("Profiling completed. %d samples.", sample_count);
1798 break;
1799 }
1800 }
1801
1802 *num_samples = sample_count;
1803 return retval;
1804 }
1805
1806 /* Single aligned words are guaranteed to use 16 or 32 bit access
1807 * mode respectively, otherwise data is handled as quickly as
1808 * possible
1809 */
1810 int target_write_buffer(struct target *target, uint32_t address, uint32_t size, const uint8_t *buffer)
1811 {
1812 LOG_DEBUG("writing buffer of %i byte at 0x%8.8x",
1813 (int)size, (unsigned)address);
1814
1815 if (!target_was_examined(target)) {
1816 LOG_ERROR("Target not examined yet");
1817 return ERROR_FAIL;
1818 }
1819
1820 if (size == 0)
1821 return ERROR_OK;
1822
1823 if ((address + size - 1) < address) {
1824 /* GDB can request this when e.g. PC is 0xfffffffc*/
1825 LOG_ERROR("address + size wrapped(0x%08x, 0x%08x)",
1826 (unsigned)address,
1827 (unsigned)size);
1828 return ERROR_FAIL;
1829 }
1830
1831 return target->type->write_buffer(target, address, size, buffer);
1832 }
1833
1834 static int target_write_buffer_default(struct target *target, uint32_t address, uint32_t count, const uint8_t *buffer)
1835 {
1836 uint32_t size;
1837
1838 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
1839 * will have something to do with the size we leave to it. */
1840 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
1841 if (address & size) {
1842 int retval = target_write_memory(target, address, size, 1, buffer);
1843 if (retval != ERROR_OK)
1844 return retval;
1845 address += size;
1846 count -= size;
1847 buffer += size;
1848 }
1849 }
1850
1851 /* Write the data with as large access size as possible. */
1852 for (; size > 0; size /= 2) {
1853 uint32_t aligned = count - count % size;
1854 if (aligned > 0) {
1855 int retval = target_write_memory(target, address, size, aligned / size, buffer);
1856 if (retval != ERROR_OK)
1857 return retval;
1858 address += aligned;
1859 count -= aligned;
1860 buffer += aligned;
1861 }
1862 }
1863
1864 return ERROR_OK;
1865 }
1866
1867 /* Single aligned words are guaranteed to use 16 or 32 bit access
1868 * mode respectively, otherwise data is handled as quickly as
1869 * possible
1870 */
1871 int target_read_buffer(struct target *target, uint32_t address, uint32_t size, uint8_t *buffer)
1872 {
1873 LOG_DEBUG("reading buffer of %i byte at 0x%8.8x",
1874 (int)size, (unsigned)address);
1875
1876 if (!target_was_examined(target)) {
1877 LOG_ERROR("Target not examined yet");
1878 return ERROR_FAIL;
1879 }
1880
1881 if (size == 0)
1882 return ERROR_OK;
1883
1884 if ((address + size - 1) < address) {
1885 /* GDB can request this when e.g. PC is 0xfffffffc*/
1886 LOG_ERROR("address + size wrapped(0x%08" PRIx32 ", 0x%08" PRIx32 ")",
1887 address,
1888 size);
1889 return ERROR_FAIL;
1890 }
1891
1892 return target->type->read_buffer(target, address, size, buffer);
1893 }
1894
1895 static int target_read_buffer_default(struct target *target, uint32_t address, uint32_t count, uint8_t *buffer)
1896 {
1897 uint32_t size;
1898
1899 /* Align up to maximum 4 bytes. The loop condition makes sure the next pass
1900 * will have something to do with the size we leave to it. */
1901 for (size = 1; size < 4 && count >= size * 2 + (address & size); size *= 2) {
1902 if (address & size) {
1903 int retval = target_read_memory(target, address, size, 1, buffer);
1904 if (retval != ERROR_OK)
1905 return retval;
1906 address += size;
1907 count -= size;
1908 buffer += size;
1909 }
1910 }
1911
1912 /* Read the data with as large access size as possible. */
1913 for (; size > 0; size /= 2) {
1914 uint32_t aligned = count - count % size;
1915 if (aligned > 0) {
1916 int retval = target_read_memory(target, address, size, aligned / size, buffer);
1917 if (retval != ERROR_OK)
1918 return retval;
1919 address += aligned;
1920 count -= aligned;
1921 buffer += aligned;
1922 }
1923 }
1924
1925 return ERROR_OK;
1926 }
1927
1928 int target_checksum_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* crc)
1929 {
1930 uint8_t *buffer;
1931 int retval;
1932 uint32_t i;
1933 uint32_t checksum = 0;
1934 if (!target_was_examined(target)) {
1935 LOG_ERROR("Target not examined yet");
1936 return ERROR_FAIL;
1937 }
1938
1939 retval = target->type->checksum_memory(target, address, size, &checksum);
1940 if (retval != ERROR_OK) {
1941 buffer = malloc(size);
1942 if (buffer == NULL) {
1943 LOG_ERROR("error allocating buffer for section (%d bytes)", (int)size);
1944 return ERROR_COMMAND_SYNTAX_ERROR;
1945 }
1946 retval = target_read_buffer(target, address, size, buffer);
1947 if (retval != ERROR_OK) {
1948 free(buffer);
1949 return retval;
1950 }
1951
1952 /* convert to target endianness */
1953 for (i = 0; i < (size/sizeof(uint32_t)); i++) {
1954 uint32_t target_data;
1955 target_data = target_buffer_get_u32(target, &buffer[i*sizeof(uint32_t)]);
1956 target_buffer_set_u32(target, &buffer[i*sizeof(uint32_t)], target_data);
1957 }
1958
1959 retval = image_calculate_checksum(buffer, size, &checksum);
1960 free(buffer);
1961 }
1962
1963 *crc = checksum;
1964
1965 return retval;
1966 }
1967
1968 int target_blank_check_memory(struct target *target, uint32_t address, uint32_t size, uint32_t* blank)
1969 {
1970 int retval;
1971 if (!target_was_examined(target)) {
1972 LOG_ERROR("Target not examined yet");
1973 return ERROR_FAIL;
1974 }
1975
1976 if (target->type->blank_check_memory == 0)
1977 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
1978
1979 retval = target->type->blank_check_memory(target, address, size, blank);
1980
1981 return retval;
1982 }
1983
1984 int target_read_u32(struct target *target, uint32_t address, uint32_t *value)
1985 {
1986 uint8_t value_buf[4];
1987 if (!target_was_examined(target)) {
1988 LOG_ERROR("Target not examined yet");
1989 return ERROR_FAIL;
1990 }
1991
1992 int retval = target_read_memory(target, address, 4, 1, value_buf);
1993
1994 if (retval == ERROR_OK) {
1995 *value = target_buffer_get_u32(target, value_buf);
1996 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
1997 address,
1998 *value);
1999 } else {
2000 *value = 0x0;
2001 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2002 address);
2003 }
2004
2005 return retval;
2006 }
2007
2008 int target_read_u16(struct target *target, uint32_t address, uint16_t *value)
2009 {
2010 uint8_t value_buf[2];
2011 if (!target_was_examined(target)) {
2012 LOG_ERROR("Target not examined yet");
2013 return ERROR_FAIL;
2014 }
2015
2016 int retval = target_read_memory(target, address, 2, 1, value_buf);
2017
2018 if (retval == ERROR_OK) {
2019 *value = target_buffer_get_u16(target, value_buf);
2020 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%4.4x",
2021 address,
2022 *value);
2023 } else {
2024 *value = 0x0;
2025 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2026 address);
2027 }
2028
2029 return retval;
2030 }
2031
2032 int target_read_u8(struct target *target, uint32_t address, uint8_t *value)
2033 {
2034 if (!target_was_examined(target)) {
2035 LOG_ERROR("Target not examined yet");
2036 return ERROR_FAIL;
2037 }
2038
2039 int retval = target_read_memory(target, address, 1, 1, value);
2040
2041 if (retval == ERROR_OK) {
2042 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
2043 address,
2044 *value);
2045 } else {
2046 *value = 0x0;
2047 LOG_DEBUG("address: 0x%8.8" PRIx32 " failed",
2048 address);
2049 }
2050
2051 return retval;
2052 }
2053
2054 int target_write_u32(struct target *target, uint32_t address, uint32_t value)
2055 {
2056 int retval;
2057 uint8_t value_buf[4];
2058 if (!target_was_examined(target)) {
2059 LOG_ERROR("Target not examined yet");
2060 return ERROR_FAIL;
2061 }
2062
2063 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8" PRIx32 "",
2064 address,
2065 value);
2066
2067 target_buffer_set_u32(target, value_buf, value);
2068 retval = target_write_memory(target, address, 4, 1, value_buf);
2069 if (retval != ERROR_OK)
2070 LOG_DEBUG("failed: %i", retval);
2071
2072 return retval;
2073 }
2074
2075 int target_write_u16(struct target *target, uint32_t address, uint16_t value)
2076 {
2077 int retval;
2078 uint8_t value_buf[2];
2079 if (!target_was_examined(target)) {
2080 LOG_ERROR("Target not examined yet");
2081 return ERROR_FAIL;
2082 }
2083
2084 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%8.8x",
2085 address,
2086 value);
2087
2088 target_buffer_set_u16(target, value_buf, value);
2089 retval = target_write_memory(target, address, 2, 1, value_buf);
2090 if (retval != ERROR_OK)
2091 LOG_DEBUG("failed: %i", retval);
2092
2093 return retval;
2094 }
2095
2096 int target_write_u8(struct target *target, uint32_t address, uint8_t value)
2097 {
2098 int retval;
2099 if (!target_was_examined(target)) {
2100 LOG_ERROR("Target not examined yet");
2101 return ERROR_FAIL;
2102 }
2103
2104 LOG_DEBUG("address: 0x%8.8" PRIx32 ", value: 0x%2.2x",
2105 address, value);
2106
2107 retval = target_write_memory(target, address, 1, 1, &value);
2108 if (retval != ERROR_OK)
2109 LOG_DEBUG("failed: %i", retval);
2110
2111 return retval;
2112 }
2113
2114 static int find_target(struct command_context *cmd_ctx, const char *name)
2115 {
2116 struct target *target = get_target(name);
2117 if (target == NULL) {
2118 LOG_ERROR("Target: %s is unknown, try one of:\n", name);
2119 return ERROR_FAIL;
2120 }
2121 if (!target->tap->enabled) {
2122 LOG_USER("Target: TAP %s is disabled, "
2123 "can't be the current target\n",
2124 target->tap->dotted_name);
2125 return ERROR_FAIL;
2126 }
2127
2128 cmd_ctx->current_target = target->target_number;
2129 return ERROR_OK;
2130 }
2131
2132
2133 COMMAND_HANDLER(handle_targets_command)
2134 {
2135 int retval = ERROR_OK;
2136 if (CMD_ARGC == 1) {
2137 retval = find_target(CMD_CTX, CMD_ARGV[0]);
2138 if (retval == ERROR_OK) {
2139 /* we're done! */
2140 return retval;
2141 }
2142 }
2143
2144 struct target *target = all_targets;
2145 command_print(CMD_CTX, " TargetName Type Endian TapName State ");
2146 command_print(CMD_CTX, "-- ------------------ ---------- ------ ------------------ ------------");
2147 while (target) {
2148 const char *state;
2149 char marker = ' ';
2150
2151 if (target->tap->enabled)
2152 state = target_state_name(target);
2153 else
2154 state = "tap-disabled";
2155
2156 if (CMD_CTX->current_target == target->target_number)
2157 marker = '*';
2158
2159 /* keep columns lined up to match the headers above */
2160 command_print(CMD_CTX,
2161 "%2d%c %-18s %-10s %-6s %-18s %s",
2162 target->target_number,
2163 marker,
2164 target_name(target),
2165 target_type_name(target),
2166 Jim_Nvp_value2name_simple(nvp_target_endian,
2167 target->endianness)->name,
2168 target->tap->dotted_name,
2169 state);
2170 target = target->next;
2171 }
2172
2173 return retval;
2174 }
2175
2176 /* every 300ms we check for reset & powerdropout and issue a "reset halt" if so. */
2177
2178 static int powerDropout;
2179 static int srstAsserted;
2180
2181 static int runPowerRestore;
2182 static int runPowerDropout;
2183 static int runSrstAsserted;
2184 static int runSrstDeasserted;
2185
2186 static int sense_handler(void)
2187 {
2188 static int prevSrstAsserted;
2189 static int prevPowerdropout;
2190
2191 int retval = jtag_power_dropout(&powerDropout);
2192 if (retval != ERROR_OK)
2193 return retval;
2194
2195 int powerRestored;
2196 powerRestored = prevPowerdropout && !powerDropout;
2197 if (powerRestored)
2198 runPowerRestore = 1;
2199
2200 long long current = timeval_ms();
2201 static long long lastPower;
2202 int waitMore = lastPower + 2000 > current;
2203 if (powerDropout && !waitMore) {
2204 runPowerDropout = 1;
2205 lastPower = current;
2206 }
2207
2208 retval = jtag_srst_asserted(&srstAsserted);
2209 if (retval != ERROR_OK)
2210 return retval;
2211
2212 int srstDeasserted;
2213 srstDeasserted = prevSrstAsserted && !srstAsserted;
2214
2215 static long long lastSrst;
2216 waitMore = lastSrst + 2000 > current;
2217 if (srstDeasserted && !waitMore) {
2218 runSrstDeasserted = 1;
2219 lastSrst = current;
2220 }
2221
2222 if (!prevSrstAsserted && srstAsserted)
2223 runSrstAsserted = 1;
2224
2225 prevSrstAsserted = srstAsserted;
2226 prevPowerdropout = powerDropout;
2227
2228 if (srstDeasserted || powerRestored) {
2229 /* Other than logging the event we can't do anything here.
2230 * Issuing a reset is a particularly bad idea as we might
2231 * be inside a reset already.
2232 */
2233 }
2234
2235 return ERROR_OK;
2236 }
2237
2238 /* process target state changes */
2239 static int handle_target(void *priv)
2240 {
2241 Jim_Interp *interp = (Jim_Interp *)priv;
2242 int retval = ERROR_OK;
2243
2244 if (!is_jtag_poll_safe()) {
2245 /* polling is disabled currently */
2246 return ERROR_OK;
2247 }
2248
2249 /* we do not want to recurse here... */
2250 static int recursive;
2251 if (!recursive) {
2252 recursive = 1;
2253 sense_handler();
2254 /* danger! running these procedures can trigger srst assertions and power dropouts.
2255 * We need to avoid an infinite loop/recursion here and we do that by
2256 * clearing the flags after running these events.
2257 */
2258 int did_something = 0;
2259 if (runSrstAsserted) {
2260 LOG_INFO("srst asserted detected, running srst_asserted proc.");
2261 Jim_Eval(interp, "srst_asserted");
2262 did_something = 1;
2263 }
2264 if (runSrstDeasserted) {
2265 Jim_Eval(interp, "srst_deasserted");
2266 did_something = 1;
2267 }
2268 if (runPowerDropout) {
2269 LOG_INFO("Power dropout detected, running power_dropout proc.");
2270 Jim_Eval(interp, "power_dropout");
2271 did_something = 1;
2272 }
2273 if (runPowerRestore) {
2274 Jim_Eval(interp, "power_restore");
2275 did_something = 1;
2276 }
2277
2278 if (did_something) {
2279 /* clear detect flags */
2280 sense_handler();
2281 }
2282
2283 /* clear action flags */
2284
2285 runSrstAsserted = 0;
2286 runSrstDeasserted = 0;
2287 runPowerRestore = 0;
2288 runPowerDropout = 0;
2289
2290 recursive = 0;
2291 }
2292
2293 /* Poll targets for state changes unless that's globally disabled.
2294 * Skip targets that are currently disabled.
2295 */
2296 for (struct target *target = all_targets;
2297 is_jtag_poll_safe() && target;
2298 target = target->next) {
2299 if (!target->tap->enabled)
2300 continue;
2301
2302 if (target->backoff.times > target->backoff.count) {
2303 /* do not poll this time as we failed previously */
2304 target->backoff.count++;
2305 continue;
2306 }
2307 target->backoff.count = 0;
2308
2309 /* only poll target if we've got power and srst isn't asserted */
2310 if (!powerDropout && !srstAsserted) {
2311 /* polling may fail silently until the target has been examined */
2312 retval = target_poll(target);
2313 if (retval != ERROR_OK) {
2314 /* 100ms polling interval. Increase interval between polling up to 5000ms */
2315 if (target->backoff.times * polling_interval < 5000) {
2316 target->backoff.times *= 2;
2317 target->backoff.times++;
2318 }
2319 LOG_USER("Polling target %s failed, GDB will be halted. Polling again in %dms",
2320 target_name(target),
2321 target->backoff.times * polling_interval);
2322
2323 /* Tell GDB to halt the debugger. This allows the user to
2324 * run monitor commands to handle the situation.
2325 */
2326 target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
2327 return retval;
2328 }
2329 /* Since we succeeded, we reset backoff count */
2330 if (target->backoff.times > 0)
2331 LOG_USER("Polling target %s succeeded again", target_name(target));
2332 target->backoff.times = 0;
2333 }
2334 }
2335
2336 return retval;
2337 }
2338
2339 COMMAND_HANDLER(handle_reg_command)
2340 {
2341 struct target *target;
2342 struct reg *reg = NULL;
2343 unsigned count = 0;
2344 char *value;
2345
2346 LOG_DEBUG("-");
2347
2348 target = get_current_target(CMD_CTX);
2349
2350 /* list all available registers for the current target */
2351 if (CMD_ARGC == 0) {
2352 struct reg_cache *cache = target->reg_cache;
2353
2354 count = 0;
2355 while (cache) {
2356 unsigned i;
2357
2358 command_print(CMD_CTX, "===== %s", cache->name);
2359
2360 for (i = 0, reg = cache->reg_list;
2361 i < cache->num_regs;
2362 i++, reg++, count++) {
2363 /* only print cached values if they are valid */
2364 if (reg->valid) {
2365 value = buf_to_str(reg->value,
2366 reg->size, 16);
2367 command_print(CMD_CTX,
2368 "(%i) %s (/%" PRIu32 "): 0x%s%s",
2369 count, reg->name,
2370 reg->size, value,
2371 reg->dirty
2372 ? " (dirty)"
2373 : "");
2374 free(value);
2375 } else {
2376 command_print(CMD_CTX, "(%i) %s (/%" PRIu32 ")",
2377 count, reg->name,
2378 reg->size) ;
2379 }
2380 }
2381 cache = cache->next;
2382 }
2383
2384 return ERROR_OK;
2385 }
2386
2387 /* access a single register by its ordinal number */
2388 if ((CMD_ARGV[0][0] >= '0') && (CMD_ARGV[0][0] <= '9')) {
2389 unsigned num;
2390 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num);
2391
2392 struct reg_cache *cache = target->reg_cache;
2393 count = 0;
2394 while (cache) {
2395 unsigned i;
2396 for (i = 0; i < cache->num_regs; i++) {
2397 if (count++ == num) {
2398 reg = &cache->reg_list[i];
2399 break;
2400 }
2401 }
2402 if (reg)
2403 break;
2404 cache = cache->next;
2405 }
2406
2407 if (!reg) {
2408 command_print(CMD_CTX, "%i is out of bounds, the current target "
2409 "has only %i registers (0 - %i)", num, count, count - 1);
2410 return ERROR_OK;
2411 }
2412 } else {
2413 /* access a single register by its name */
2414 reg = register_get_by_name(target->reg_cache, CMD_ARGV[0], 1);
2415
2416 if (!reg) {
2417 command_print(CMD_CTX, "register %s not found in current target", CMD_ARGV[0]);
2418 return ERROR_OK;
2419 }
2420 }
2421
2422 assert(reg != NULL); /* give clang a hint that we *know* reg is != NULL here */
2423
2424 /* display a register */
2425 if ((CMD_ARGC == 1) || ((CMD_ARGC == 2) && !((CMD_ARGV[1][0] >= '0')
2426 && (CMD_ARGV[1][0] <= '9')))) {
2427 if ((CMD_ARGC == 2) && (strcmp(CMD_ARGV[1], "force") == 0))
2428 reg->valid = 0;
2429
2430 if (reg->valid == 0)
2431 reg->type->get(reg);
2432 value = buf_to_str(reg->value, reg->size, 16);
2433 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2434 free(value);
2435 return ERROR_OK;
2436 }
2437
2438 /* set register value */
2439 if (CMD_ARGC == 2) {
2440 uint8_t *buf = malloc(DIV_ROUND_UP(reg->size, 8));
2441 if (buf == NULL)
2442 return ERROR_FAIL;
2443 str_to_buf(CMD_ARGV[1], strlen(CMD_ARGV[1]), buf, reg->size, 0);
2444
2445 reg->type->set(reg, buf);
2446
2447 value = buf_to_str(reg->value, reg->size, 16);
2448 command_print(CMD_CTX, "%s (/%i): 0x%s", reg->name, (int)(reg->size), value);
2449 free(value);
2450
2451 free(buf);
2452
2453 return ERROR_OK;
2454 }
2455
2456 return ERROR_COMMAND_SYNTAX_ERROR;
2457 }
2458
2459 COMMAND_HANDLER(handle_poll_command)
2460 {
2461 int retval = ERROR_OK;
2462 struct target *target = get_current_target(CMD_CTX);
2463
2464 if (CMD_ARGC == 0) {
2465 command_print(CMD_CTX, "background polling: %s",
2466 jtag_poll_get_enabled() ? "on" : "off");
2467 command_print(CMD_CTX, "TAP: %s (%s)",
2468 target->tap->dotted_name,
2469 target->tap->enabled ? "enabled" : "disabled");
2470 if (!target->tap->enabled)
2471 return ERROR_OK;
2472 retval = target_poll(target);
2473 if (retval != ERROR_OK)
2474 return retval;
2475 retval = target_arch_state(target);
2476 if (retval != ERROR_OK)
2477 return retval;
2478 } else if (CMD_ARGC == 1) {
2479 bool enable;
2480 COMMAND_PARSE_ON_OFF(CMD_ARGV[0], enable);
2481 jtag_poll_set_enabled(enable);
2482 } else
2483 return ERROR_COMMAND_SYNTAX_ERROR;
2484
2485 return retval;
2486 }
2487
2488 COMMAND_HANDLER(handle_wait_halt_command)
2489 {
2490 if (CMD_ARGC > 1)
2491 return ERROR_COMMAND_SYNTAX_ERROR;
2492
2493 unsigned ms = DEFAULT_HALT_TIMEOUT;
2494 if (1 == CMD_ARGC) {
2495 int retval = parse_uint(CMD_ARGV[0], &ms);
2496 if (ERROR_OK != retval)
2497 return ERROR_COMMAND_SYNTAX_ERROR;
2498 }
2499
2500 struct target *target = get_current_target(CMD_CTX);
2501 return target_wait_state(target, TARGET_HALTED, ms);
2502 }
2503
2504 /* wait for target state to change. The trick here is to have a low
2505 * latency for short waits and not to suck up all the CPU time
2506 * on longer waits.
2507 *
2508 * After 500ms, keep_alive() is invoked
2509 */
2510 int target_wait_state(struct target *target, enum target_state state, int ms)
2511 {
2512 int retval;
2513 long long then = 0, cur;
2514 int once = 1;
2515
2516 for (;;) {
2517 retval = target_poll(target);
2518 if (retval != ERROR_OK)
2519 return retval;
2520 if (target->state == state)
2521 break;
2522 cur = timeval_ms();
2523 if (once) {
2524 once = 0;
2525 then = timeval_ms();
2526 LOG_DEBUG("waiting for target %s...",
2527 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2528 }
2529
2530 if (cur-then > 500)
2531 keep_alive();
2532
2533 if ((cur-then) > ms) {
2534 LOG_ERROR("timed out while waiting for target %s",
2535 Jim_Nvp_value2name_simple(nvp_target_state, state)->name);
2536 return ERROR_FAIL;
2537 }
2538 }
2539
2540 return ERROR_OK;
2541 }
2542
2543 COMMAND_HANDLER(handle_halt_command)
2544 {
2545 LOG_DEBUG("-");
2546
2547 struct target *target = get_current_target(CMD_CTX);
2548 int retval = target_halt(target);
2549 if (ERROR_OK != retval)
2550 return retval;
2551
2552 if (CMD_ARGC == 1) {
2553 unsigned wait_local;
2554 retval = parse_uint(CMD_ARGV[0], &wait_local);
2555 if (ERROR_OK != retval)
2556 return ERROR_COMMAND_SYNTAX_ERROR;
2557 if (!wait_local)
2558 return ERROR_OK;
2559 }
2560
2561 return CALL_COMMAND_HANDLER(handle_wait_halt_command);
2562 }
2563
2564 COMMAND_HANDLER(handle_soft_reset_halt_command)
2565 {
2566 struct target *target = get_current_target(CMD_CTX);
2567
2568 LOG_USER("requesting target halt and executing a soft reset");
2569
2570 target_soft_reset_halt(target);
2571
2572 return ERROR_OK;
2573 }
2574
2575 COMMAND_HANDLER(handle_reset_command)
2576 {
2577 if (CMD_ARGC > 1)
2578 return ERROR_COMMAND_SYNTAX_ERROR;
2579
2580 enum target_reset_mode reset_mode = RESET_RUN;
2581 if (CMD_ARGC == 1) {
2582 const Jim_Nvp *n;
2583 n = Jim_Nvp_name2value_simple(nvp_reset_modes, CMD_ARGV[0]);
2584 if ((n->name == NULL) || (n->value == RESET_UNKNOWN))
2585 return ERROR_COMMAND_SYNTAX_ERROR;
2586 reset_mode = n->value;
2587 }
2588
2589 /* reset *all* targets */
2590 return target_process_reset(CMD_CTX, reset_mode);
2591 }
2592
2593
2594 COMMAND_HANDLER(handle_resume_command)
2595 {
2596 int current = 1;
2597 if (CMD_ARGC > 1)
2598 return ERROR_COMMAND_SYNTAX_ERROR;
2599
2600 struct target *target = get_current_target(CMD_CTX);
2601
2602 /* with no CMD_ARGV, resume from current pc, addr = 0,
2603 * with one arguments, addr = CMD_ARGV[0],
2604 * handle breakpoints, not debugging */
2605 uint32_t addr = 0;
2606 if (CMD_ARGC == 1) {
2607 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2608 current = 0;
2609 }
2610
2611 return target_resume(target, current, addr, 1, 0);
2612 }
2613
2614 COMMAND_HANDLER(handle_step_command)
2615 {
2616 if (CMD_ARGC > 1)
2617 return ERROR_COMMAND_SYNTAX_ERROR;
2618
2619 LOG_DEBUG("-");
2620
2621 /* with no CMD_ARGV, step from current pc, addr = 0,
2622 * with one argument addr = CMD_ARGV[0],
2623 * handle breakpoints, debugging */
2624 uint32_t addr = 0;
2625 int current_pc = 1;
2626 if (CMD_ARGC == 1) {
2627 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], addr);
2628 current_pc = 0;
2629 }
2630
2631 struct target *target = get_current_target(CMD_CTX);
2632
2633 return target->type->step(target, current_pc, addr, 1);
2634 }
2635
2636 static void handle_md_output(struct command_context *cmd_ctx,
2637 struct target *target, uint32_t address, unsigned size,
2638 unsigned count, const uint8_t *buffer)
2639 {
2640 const unsigned line_bytecnt = 32;
2641 unsigned line_modulo = line_bytecnt / size;
2642
2643 char output[line_bytecnt * 4 + 1];
2644 unsigned output_len = 0;
2645
2646 const char *value_fmt;
2647 switch (size) {
2648 case 4:
2649 value_fmt = "%8.8x ";
2650 break;
2651 case 2:
2652 value_fmt = "%4.4x ";
2653 break;
2654 case 1:
2655 value_fmt = "%2.2x ";
2656 break;
2657 default:
2658 /* "can't happen", caller checked */
2659 LOG_ERROR("invalid memory read size: %u", size);
2660 return;
2661 }
2662
2663 for (unsigned i = 0; i < count; i++) {
2664 if (i % line_modulo == 0) {
2665 output_len += snprintf(output + output_len,
2666 sizeof(output) - output_len,
2667 "0x%8.8x: ",
2668 (unsigned)(address + (i*size)));
2669 }
2670
2671 uint32_t value = 0;
2672 const uint8_t *value_ptr = buffer + i * size;
2673 switch (size) {
2674 case 4:
2675 value = target_buffer_get_u32(target, value_ptr);
2676 break;
2677 case 2:
2678 value = target_buffer_get_u16(target, value_ptr);
2679 break;
2680 case 1:
2681 value = *value_ptr;
2682 }
2683 output_len += snprintf(output + output_len,
2684 sizeof(output) - output_len,
2685 value_fmt, value);
2686
2687 if ((i % line_modulo == line_modulo - 1) || (i == count - 1)) {
2688 command_print(cmd_ctx, "%s", output);
2689 output_len = 0;
2690 }
2691 }
2692 }
2693
2694 COMMAND_HANDLER(handle_md_command)
2695 {
2696 if (CMD_ARGC < 1)
2697 return ERROR_COMMAND_SYNTAX_ERROR;
2698
2699 unsigned size = 0;
2700 switch (CMD_NAME[2]) {
2701 case 'w':
2702 size = 4;
2703 break;
2704 case 'h':
2705 size = 2;
2706 break;
2707 case 'b':
2708 size = 1;
2709 break;
2710 default:
2711 return ERROR_COMMAND_SYNTAX_ERROR;
2712 }
2713
2714 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2715 int (*fn)(struct target *target,
2716 uint32_t address, uint32_t size_value, uint32_t count, uint8_t *buffer);
2717 if (physical) {
2718 CMD_ARGC--;
2719 CMD_ARGV++;
2720 fn = target_read_phys_memory;
2721 } else
2722 fn = target_read_memory;
2723 if ((CMD_ARGC < 1) || (CMD_ARGC > 2))
2724 return ERROR_COMMAND_SYNTAX_ERROR;
2725
2726 uint32_t address;
2727 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2728
2729 unsigned count = 1;
2730 if (CMD_ARGC == 2)
2731 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[1], count);
2732
2733 uint8_t *buffer = calloc(count, size);
2734
2735 struct target *target = get_current_target(CMD_CTX);
2736 int retval = fn(target, address, size, count, buffer);
2737 if (ERROR_OK == retval)
2738 handle_md_output(CMD_CTX, target, address, size, count, buffer);
2739
2740 free(buffer);
2741
2742 return retval;
2743 }
2744
2745 typedef int (*target_write_fn)(struct target *target,
2746 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
2747
2748 static int target_fill_mem(struct target *target,
2749 uint32_t address,
2750 target_write_fn fn,
2751 unsigned data_size,
2752 /* value */
2753 uint32_t b,
2754 /* count */
2755 unsigned c)
2756 {
2757 /* We have to write in reasonably large chunks to be able
2758 * to fill large memory areas with any sane speed */
2759 const unsigned chunk_size = 16384;
2760 uint8_t *target_buf = malloc(chunk_size * data_size);
2761 if (target_buf == NULL) {
2762 LOG_ERROR("Out of memory");
2763 return ERROR_FAIL;
2764 }
2765
2766 for (unsigned i = 0; i < chunk_size; i++) {
2767 switch (data_size) {
2768 case 4:
2769 target_buffer_set_u32(target, target_buf + i * data_size, b);
2770 break;
2771 case 2:
2772 target_buffer_set_u16(target, target_buf + i * data_size, b);
2773 break;
2774 case 1:
2775 target_buffer_set_u8(target, target_buf + i * data_size, b);
2776 break;
2777 default:
2778 exit(-1);
2779 }
2780 }
2781
2782 int retval = ERROR_OK;
2783
2784 for (unsigned x = 0; x < c; x += chunk_size) {
2785 unsigned current;
2786 current = c - x;
2787 if (current > chunk_size)
2788 current = chunk_size;
2789 retval = fn(target, address + x * data_size, data_size, current, target_buf);
2790 if (retval != ERROR_OK)
2791 break;
2792 /* avoid GDB timeouts */
2793 keep_alive();
2794 }
2795 free(target_buf);
2796
2797 return retval;
2798 }
2799
2800
2801 COMMAND_HANDLER(handle_mw_command)
2802 {
2803 if (CMD_ARGC < 2)
2804 return ERROR_COMMAND_SYNTAX_ERROR;
2805 bool physical = strcmp(CMD_ARGV[0], "phys") == 0;
2806 target_write_fn fn;
2807 if (physical) {
2808 CMD_ARGC--;
2809 CMD_ARGV++;
2810 fn = target_write_phys_memory;
2811 } else
2812 fn = target_write_memory;
2813 if ((CMD_ARGC < 2) || (CMD_ARGC > 3))
2814 return ERROR_COMMAND_SYNTAX_ERROR;
2815
2816 uint32_t address;
2817 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
2818
2819 uint32_t value;
2820 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
2821
2822 unsigned count = 1;
2823 if (CMD_ARGC == 3)
2824 COMMAND_PARSE_NUMBER(uint, CMD_ARGV[2], count);
2825
2826 struct target *target = get_current_target(CMD_CTX);
2827 unsigned wordsize;
2828 switch (CMD_NAME[2]) {
2829 case 'w':
2830 wordsize = 4;
2831 break;
2832 case 'h':
2833 wordsize = 2;
2834 break;
2835 case 'b':
2836 wordsize = 1;
2837 break;
2838 default:
2839 return ERROR_COMMAND_SYNTAX_ERROR;
2840 }
2841
2842 return target_fill_mem(target, address, fn, wordsize, value, count);
2843 }
2844
2845 static COMMAND_HELPER(parse_load_image_command_CMD_ARGV, struct image *image,
2846 uint32_t *min_address, uint32_t *max_address)
2847 {
2848 if (CMD_ARGC < 1 || CMD_ARGC > 5)
2849 return ERROR_COMMAND_SYNTAX_ERROR;
2850
2851 /* a base address isn't always necessary,
2852 * default to 0x0 (i.e. don't relocate) */
2853 if (CMD_ARGC >= 2) {
2854 uint32_t addr;
2855 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
2856 image->base_address = addr;
2857 image->base_address_set = 1;
2858 } else
2859 image->base_address_set = 0;
2860
2861 image->start_address_set = 0;
2862
2863 if (CMD_ARGC >= 4)
2864 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], *min_address);
2865 if (CMD_ARGC == 5) {
2866 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[4], *max_address);
2867 /* use size (given) to find max (required) */
2868 *max_address += *min_address;
2869 }
2870
2871 if (*min_address > *max_address)
2872 return ERROR_COMMAND_SYNTAX_ERROR;
2873
2874 return ERROR_OK;
2875 }
2876
2877 COMMAND_HANDLER(handle_load_image_command)
2878 {
2879 uint8_t *buffer;
2880 size_t buf_cnt;
2881 uint32_t image_size;
2882 uint32_t min_address = 0;
2883 uint32_t max_address = 0xffffffff;
2884 int i;
2885 struct image image;
2886
2887 int retval = CALL_COMMAND_HANDLER(parse_load_image_command_CMD_ARGV,
2888 &image, &min_address, &max_address);
2889 if (ERROR_OK != retval)
2890 return retval;
2891
2892 struct target *target = get_current_target(CMD_CTX);
2893
2894 struct duration bench;
2895 duration_start(&bench);
2896
2897 if (image_open(&image, CMD_ARGV[0], (CMD_ARGC >= 3) ? CMD_ARGV[2] : NULL) != ERROR_OK)
2898 return ERROR_OK;
2899
2900 image_size = 0x0;
2901 retval = ERROR_OK;
2902 for (i = 0; i < image.num_sections; i++) {
2903 buffer = malloc(image.sections[i].size);
2904 if (buffer == NULL) {
2905 command_print(CMD_CTX,
2906 "error allocating buffer for section (%d bytes)",
2907 (int)(image.sections[i].size));
2908 break;
2909 }
2910
2911 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
2912 if (retval != ERROR_OK) {
2913 free(buffer);
2914 break;
2915 }
2916
2917 uint32_t offset = 0;
2918 uint32_t length = buf_cnt;
2919
2920 /* DANGER!!! beware of unsigned comparision here!!! */
2921
2922 if ((image.sections[i].base_address + buf_cnt >= min_address) &&
2923 (image.sections[i].base_address < max_address)) {
2924
2925 if (image.sections[i].base_address < min_address) {
2926 /* clip addresses below */
2927 offset += min_address-image.sections[i].base_address;
2928 length -= offset;
2929 }
2930
2931 if (image.sections[i].base_address + buf_cnt > max_address)
2932 length -= (image.sections[i].base_address + buf_cnt)-max_address;
2933
2934 retval = target_write_buffer(target,
2935 image.sections[i].base_address + offset, length, buffer + offset);
2936 if (retval != ERROR_OK) {
2937 free(buffer);
2938 break;
2939 }
2940 image_size += length;
2941 command_print(CMD_CTX, "%u bytes written at address 0x%8.8" PRIx32 "",
2942 (unsigned int)length,
2943 image.sections[i].base_address + offset);
2944 }
2945
2946 free(buffer);
2947 }
2948
2949 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
2950 command_print(CMD_CTX, "downloaded %" PRIu32 " bytes "
2951 "in %fs (%0.3f KiB/s)", image_size,
2952 duration_elapsed(&bench), duration_kbps(&bench, image_size));
2953 }
2954
2955 image_close(&image);
2956
2957 return retval;
2958
2959 }
2960
2961 COMMAND_HANDLER(handle_dump_image_command)
2962 {
2963 struct fileio fileio;
2964 uint8_t *buffer;
2965 int retval, retvaltemp;
2966 uint32_t address, size;
2967 struct duration bench;
2968 struct target *target = get_current_target(CMD_CTX);
2969
2970 if (CMD_ARGC != 3)
2971 return ERROR_COMMAND_SYNTAX_ERROR;
2972
2973 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], address);
2974 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], size);
2975
2976 uint32_t buf_size = (size > 4096) ? 4096 : size;
2977 buffer = malloc(buf_size);
2978 if (!buffer)
2979 return ERROR_FAIL;
2980
2981 retval = fileio_open(&fileio, CMD_ARGV[0], FILEIO_WRITE, FILEIO_BINARY);
2982 if (retval != ERROR_OK) {
2983 free(buffer);
2984 return retval;
2985 }
2986
2987 duration_start(&bench);
2988
2989 while (size > 0) {
2990 size_t size_written;
2991 uint32_t this_run_size = (size > buf_size) ? buf_size : size;
2992 retval = target_read_buffer(target, address, this_run_size, buffer);
2993 if (retval != ERROR_OK)
2994 break;
2995
2996 retval = fileio_write(&fileio, this_run_size, buffer, &size_written);
2997 if (retval != ERROR_OK)
2998 break;
2999
3000 size -= this_run_size;
3001 address += this_run_size;
3002 }
3003
3004 free(buffer);
3005
3006 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3007 int filesize;
3008 retval = fileio_size(&fileio, &filesize);
3009 if (retval != ERROR_OK)
3010 return retval;
3011 command_print(CMD_CTX,
3012 "dumped %ld bytes in %fs (%0.3f KiB/s)", (long)filesize,
3013 duration_elapsed(&bench), duration_kbps(&bench, filesize));
3014 }
3015
3016 retvaltemp = fileio_close(&fileio);
3017 if (retvaltemp != ERROR_OK)
3018 return retvaltemp;
3019
3020 return retval;
3021 }
3022
3023 static COMMAND_HELPER(handle_verify_image_command_internal, int verify)
3024 {
3025 uint8_t *buffer;
3026 size_t buf_cnt;
3027 uint32_t image_size;
3028 int i;
3029 int retval;
3030 uint32_t checksum = 0;
3031 uint32_t mem_checksum = 0;
3032
3033 struct image image;
3034
3035 struct target *target = get_current_target(CMD_CTX);
3036
3037 if (CMD_ARGC < 1)
3038 return ERROR_COMMAND_SYNTAX_ERROR;
3039
3040 if (!target) {
3041 LOG_ERROR("no target selected");
3042 return ERROR_FAIL;
3043 }
3044
3045 struct duration bench;
3046 duration_start(&bench);
3047
3048 if (CMD_ARGC >= 2) {
3049 uint32_t addr;
3050 COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], addr);
3051 image.base_address = addr;
3052 image.base_address_set = 1;
3053 } else {
3054 image.base_address_set = 0;
3055 image.base_address = 0x0;
3056 }
3057
3058 image.start_address_set = 0;
3059
3060 retval = image_open(&image, CMD_ARGV[0], (CMD_ARGC == 3) ? CMD_ARGV[2] : NULL);
3061 if (retval != ERROR_OK)
3062 return retval;
3063
3064 image_size = 0x0;
3065 int diffs = 0;
3066 retval = ERROR_OK;
3067 for (i = 0; i < image.num_sections; i++) {
3068 buffer = malloc(image.sections[i].size);
3069 if (buffer == NULL) {
3070 command_print(CMD_CTX,
3071 "error allocating buffer for section (%d bytes)",
3072 (int)(image.sections[i].size));
3073 break;
3074 }
3075 retval = image_read_section(&image, i, 0x0, image.sections[i].size, buffer, &buf_cnt);
3076 if (retval != ERROR_OK) {
3077 free(buffer);
3078 break;
3079 }
3080
3081 if (verify) {
3082 /* calculate checksum of image */
3083 retval = image_calculate_checksum(buffer, buf_cnt, &checksum);
3084 if (retval != ERROR_OK) {
3085 free(buffer);
3086 break;
3087 }
3088
3089 retval = target_checksum_memory(target, image.sections[i].base_address, buf_cnt, &mem_checksum);
3090 if (retval != ERROR_OK) {
3091 free(buffer);
3092 break;
3093 }
3094
3095 if (checksum != mem_checksum) {
3096 /* failed crc checksum, fall back to a binary compare */
3097 uint8_t *data;
3098
3099 if (diffs == 0)
3100 LOG_ERROR("checksum mismatch - attempting binary compare");
3101
3102 data = (uint8_t *)malloc(buf_cnt);
3103
3104 /* Can we use 32bit word accesses? */
3105 int size = 1;
3106 int count = buf_cnt;
3107 if ((count % 4) == 0) {
3108 size *= 4;
3109 count /= 4;
3110 }
3111 retval = target_read_memory(target, image.sections[i].base_address, size, count, data);
3112 if (retval == ERROR_OK) {
3113 uint32_t t;
3114 for (t = 0; t < buf_cnt; t++) {
3115 if (data[t] != buffer[t]) {
3116 command_print(CMD_CTX,
3117 "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
3118 diffs,
3119 (unsigned)(t + image.sections[i].base_address),
3120 data[t],
3121 buffer[t]);
3122 if (diffs++ >= 127) {
3123 command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
3124 free(data);
3125 free(buffer);
3126 goto done;
3127 }
3128 }
3129 keep_alive();
3130 }
3131 }
3132 free(data);
3133 }
3134 } else {
3135 command_print(CMD_CTX, "address 0x%08" PRIx32 " length 0x%08zx",
3136 image.sections[i].base_address,
3137 buf_cnt);
3138 }
3139
3140 free(buffer);
3141 image_size += buf_cnt;
3142 }
3143 if (diffs > 0)
3144 command_print(CMD_CTX, "No more differences found.");
3145 done:
3146 if (diffs > 0)
3147 retval = ERROR_FAIL;
3148 if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
3149 command_print(CMD_CTX, "verified %" PRIu32 " bytes "
3150 "in %fs (%0.3f KiB/s)", image_size,
3151 duration_elapsed(&bench), duration_kbps(&bench, image_size));
3152 }
3153
3154 image_close(&image);
3155
3156 return retval;
3157 }
3158
3159 COMMAND_HANDLER(handle_verify_image_command)
3160 {
3161 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 1);
3162 }
3163
3164 COMMAND_HANDLER(handle_test_image_command)
3165 {
3166 return CALL_COMMAND_HANDLER(handle_verify_image_command_internal, 0);
3167 }
3168
3169 static int handle_bp_command_list(struct command_context *cmd_ctx)
3170 {
3171 struct target *target = get_current_target(cmd_ctx);
3172 struct breakpoint *breakpoint = target->breakpoints;
3173 while (breakpoint) {
3174 if (breakpoint->type == BKPT_SOFT) {