target.c 115 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007-2009 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008, Duane Ellis                                       *
 *   openocd@duaneeellis.com                                               *
 *                                                                         *
11
12
13
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
14
15
16
 *   Copyright (C) 2008 by Rick Altherr                                    *
 *   kc8apf@kc8apf.net>                                                    *
 *                                                                         *
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "target.h"
37
#include "target_type.h"
38
#include "target_request.h"
39
40
41
42
#include "time_support.h"
#include "register.h"
#include "trace.h"
#include "image.h"
43
44
45
#include "jtag.h"


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
static int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

static int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_test_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc);
static int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_fast_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_fast_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
70

71
72
static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
73
static int jim_target(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
74

75
76
77
static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);

78
/* targets */
79
80
81
82
83
84
extern target_type_t arm7tdmi_target;
extern target_type_t arm720t_target;
extern target_type_t arm9tdmi_target;
extern target_type_t arm920t_target;
extern target_type_t arm966e_target;
extern target_type_t arm926ejs_target;
85
extern target_type_t fa526_target;
86
extern target_type_t feroceon_target;
87
extern target_type_t dragonite_target;
88
89
extern target_type_t xscale_target;
extern target_type_t cortexm3_target;
90
extern target_type_t cortexa8_target;
oharboe's avatar
oharboe committed
91
extern target_type_t arm11_target;
ntfreak's avatar
ntfreak committed
92
extern target_type_t mips_m4k_target;
93
extern target_type_t avr_target;
94
95
96
97
98
99
100
101
102

target_type_t *target_types[] =
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
	&arm926ejs_target,
103
	&fa526_target,
104
	&feroceon_target,
105
	&dragonite_target,
106
107
	&xscale_target,
	&cortexm3_target,
108
	&cortexa8_target,
oharboe's avatar
oharboe committed
109
	&arm11_target,
ntfreak's avatar
ntfreak committed
110
	&mips_m4k_target,
111
	&avr_target,
112
113
114
	NULL,
};

115
target_t *all_targets = NULL;
116
117
118
target_event_callback_t *target_event_callbacks = NULL;
target_timer_callback_t *target_timer_callbacks = NULL;

119
120
121
122
123
124
125
126
const Jim_Nvp nvp_assert[] = {
	{ .name = "assert", NVP_ASSERT },
	{ .name = "deassert", NVP_DEASSERT },
	{ .name = "T", NVP_ASSERT },
	{ .name = "F", NVP_DEASSERT },
	{ .name = "t", NVP_ASSERT },
	{ .name = "f", NVP_DEASSERT },
	{ .name = NULL, .value = -1 }
127
128
};

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
const Jim_Nvp nvp_error_target[] = {
	{ .value = ERROR_TARGET_INVALID, .name = "err-invalid" },
	{ .value = ERROR_TARGET_INIT_FAILED, .name = "err-init-failed" },
	{ .value = ERROR_TARGET_TIMEOUT, .name = "err-timeout" },
	{ .value = ERROR_TARGET_NOT_HALTED, .name = "err-not-halted" },
	{ .value = ERROR_TARGET_FAILURE, .name = "err-failure" },
	{ .value = ERROR_TARGET_UNALIGNED_ACCESS   , .name = "err-unaligned-access" },
	{ .value = ERROR_TARGET_DATA_ABORT , .name = "err-data-abort" },
	{ .value = ERROR_TARGET_RESOURCE_NOT_AVAILABLE , .name = "err-resource-not-available" },
	{ .value = ERROR_TARGET_TRANSLATION_FAULT  , .name = "err-translation-fault" },
	{ .value = ERROR_TARGET_NOT_RUNNING, .name = "err-not-running" },
	{ .value = ERROR_TARGET_NOT_EXAMINED, .name = "err-not-examined" },
	{ .value = -1, .name = NULL }
};

144
const char *target_strerror_safe(int err)
145
146
147
{
	const Jim_Nvp *n;

148
	n = Jim_Nvp_value2name_simple(nvp_error_target, err);
zwelch's avatar
zwelch committed
149
	if (n->name == NULL) {
150
151
152
153
154
155
		return "unknown";
	} else {
		return n->name;
	}
}

156
static const Jim_Nvp nvp_target_event[] = {
157
158
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
159

160
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
161
162
163
164
165
	{ .value = TARGET_EVENT_HALTED, .name = "halted" },
	{ .value = TARGET_EVENT_RESUMED, .name = "resumed" },
	{ .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
	{ .value = TARGET_EVENT_RESUME_END, .name = "resume-end" },

166
167
168
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

169
	/* historical name */
170

171
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
172
173
174
175
176
177
178
179
180

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
	{ .value = TARGET_EVENT_RESET_ASSERT_POST,   .name = "reset-assert-post" },
	{ .value = TARGET_EVENT_RESET_DEASSERT_PRE,  .name = "reset-deassert-pre" },
	{ .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
	{ .value = TARGET_EVENT_RESET_HALT_PRE,      .name = "reset-halt-pre" },
	{ .value = TARGET_EVENT_RESET_HALT_POST,     .name = "reset-halt-post" },
	{ .value = TARGET_EVENT_RESET_WAIT_PRE,      .name = "reset-wait-pre" },
	{ .value = TARGET_EVENT_RESET_WAIT_POST,     .name = "reset-wait-post" },
181
182
183
	{ .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END, .name = "reset-end" },

184
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
185
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
186

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
	{ .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
	{ .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },

	{ .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
	{ .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },

	{ .value = TARGET_EVENT_GDB_FLASH_WRITE_START, .name = "gdb-flash-write-start" },
	{ .value = TARGET_EVENT_GDB_FLASH_WRITE_END  , .name = "gdb-flash-write-end"   },

	{ .value = TARGET_EVENT_GDB_FLASH_ERASE_START, .name = "gdb-flash-erase-start" },
	{ .value = TARGET_EVENT_GDB_FLASH_ERASE_END  , .name = "gdb-flash-erase-end" },

	{ .value = TARGET_EVENT_RESUME_START, .name = "resume-start" },
	{ .value = TARGET_EVENT_RESUMED     , .name = "resume-ok" },
	{ .value = TARGET_EVENT_RESUME_END  , .name = "resume-end" },

	{ .name = NULL, .value = -1 }
204
205
};

206
207
208
209
210
211
212
const Jim_Nvp nvp_target_state[] = {
	{ .name = "unknown", .value = TARGET_UNKNOWN },
	{ .name = "running", .value = TARGET_RUNNING },
	{ .name = "halted",  .value = TARGET_HALTED },
	{ .name = "reset",   .value = TARGET_RESET },
	{ .name = "debug-running", .value = TARGET_DEBUG_RUNNING },
	{ .name = NULL, .value = -1 },
213
214
};

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
const Jim_Nvp nvp_target_debug_reason [] = {
	{ .name = "debug-request"            , .value = DBG_REASON_DBGRQ },
	{ .name = "breakpoint"               , .value = DBG_REASON_BREAKPOINT },
	{ .name = "watchpoint"               , .value = DBG_REASON_WATCHPOINT },
	{ .name = "watchpoint-and-breakpoint", .value = DBG_REASON_WPTANDBKPT },
	{ .name = "single-step"              , .value = DBG_REASON_SINGLESTEP },
	{ .name = "target-not-halted"        , .value = DBG_REASON_NOTHALTED  },
	{ .name = "undefined"                , .value = DBG_REASON_UNDEFINED },
	{ .name = NULL, .value = -1 },
};

const Jim_Nvp nvp_target_endian[] = {
	{ .name = "big",    .value = TARGET_BIG_ENDIAN },
	{ .name = "little", .value = TARGET_LITTLE_ENDIAN },
	{ .name = "be",     .value = TARGET_BIG_ENDIAN },
230
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
231
232
233
	{ .name = NULL,     .value = -1 },
};

234
235
236
237
238
239
240
241
const Jim_Nvp nvp_reset_modes[] = {
	{ .name = "unknown", .value = RESET_UNKNOWN },
	{ .name = "run"    , .value = RESET_RUN },
	{ .name = "halt"   , .value = RESET_HALT },
	{ .name = "init"   , .value = RESET_INIT },
	{ .name = NULL     , .value = -1 },
};

242
243
244
245
246
247
248
249
250
251
252
253
const char *
target_state_name( target_t *t )
{
	const char *cp;
	cp = Jim_Nvp_value2name_simple(nvp_target_state, t->state)->name;
	if( !cp ){
		LOG_ERROR("Invalid target state: %d", (int)(t->state));
		cp = "(*BUG*unknown*BUG*)";
	}
	return cp;
}

254
/* determine the number of the new target */
255
static int new_target_number(void)
256
257
258
259
260
261
262
{
	target_t *t;
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
263
264
	while (t) {
		if (x < t->target_number) {
265
266
267
268
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
269
	return x + 1;
270
271
}

272
273
/* read a uint32_t from a buffer in target memory endianness */
uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer)
274
275
276
277
278
279
280
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

zwelch's avatar
zwelch committed
281
282
/* read a uint16_t from a buffer in target memory endianness */
uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer)
283
284
285
286
287
288
289
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

290
291
/* read a uint8_t from a buffer in target memory endianness */
uint8_t target_buffer_get_u8(target_t *target, const uint8_t *buffer)
292
293
294
295
{
	return *buffer & 0x0ff;
}

296
297
/* write a uint32_t to a buffer in target memory endianness */
void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value)
298
299
300
301
302
303
304
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
305
306
/* write a uint16_t to a buffer in target memory endianness */
void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value)
307
308
309
310
311
312
313
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

314
315
/* write a uint8_t to a buffer in target memory endianness */
void target_buffer_set_u8(target_t *target, uint8_t *buffer, uint8_t value)
316
317
318
319
{
	*buffer = value;
}

320
321
322
323
324
325
326
327
328
329
330
331
332
/* return a pointer to a configured target; id is name or number */
target_t *get_target(const char *id)
{
	target_t *target;

	/* try as tcltarget name */
	for (target = all_targets; target; target = target->next) {
		if (target->cmd_name == NULL)
			continue;
		if (strcmp(id, target->cmd_name) == 0)
			return target;
	}

333
334
	/* It's OK to remove this fallback sometime after August 2010 or so */

335
	/* no match, try as number */
336
337
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
338
339
340
		return NULL;

	for (target = all_targets; target; target = target->next) {
341
342
343
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
344
			return target;
345
		}
346
347
348
349
350
	}

	return NULL;
}

351
/* returns a pointer to the n-th configured target */
352
static target_t *get_target_by_num(int num)
353
{
354
	target_t *target = all_targets;
355

zwelch's avatar
zwelch committed
356
357
	while (target) {
		if (target->target_number == num) {
358
			return target;
359
		}
360
361
362
363
364
365
366
367
368
		target = target->next;
	}

	return NULL;
}

target_t* get_current_target(command_context_t *cmd_ctx)
{
	target_t *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
369

370
371
	if (target == NULL)
	{
372
		LOG_ERROR("BUG: current_target out of bounds");
373
374
375
		exit(-1);
	}

oharboe's avatar
oharboe committed
376
	return target;
377
378
}

379
380
381
int target_poll(struct target_s *target)
{
	/* We can't poll until after examine */
382
	if (!target_was_examined(target))
383
384
385
386
387
388
389
390
391
392
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
	return target->type->poll(target);
}

int target_halt(struct target_s *target)
{
	/* We can't poll until after examine */
393
	if (!target_was_examined(target))
394
395
396
397
398
399
400
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->halt(target);
}

401
int target_resume(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
402
{
403
	int retval;
oharboe's avatar
oharboe committed
404

405
	/* We can't poll until after examine */
406
	if (!target_was_examined(target))
407
408
409
410
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
411

oharboe's avatar
oharboe committed
412
413
414
415
	/* note that resume *must* be asynchronous. The CPU can halt before we poll. The CPU can
	 * even halt at the current PC as a result of a software breakpoint being inserted by (a bug?)
	 * the application.
	 */
416
417
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
418

419
	return retval;
420
421
}

oharboe's avatar
oharboe committed
422
int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
423
424
{
	char buf[100];
425
	int retval;
426
	Jim_Nvp *n;
427
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
428
	if (n->name == NULL) {
429
430
431
432
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

433
434
435
436
	/* disable polling during reset to make reset event scripts
	 * more predictable, i.e. dr/irscan & pathmove in events will
	 * not have JTAG operations injected into the middle of a sequence.
	 */
437
438
439
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
440

441
442
	sprintf(buf, "ocd_process_reset %s", n->name);
	retval = Jim_Eval(interp, buf);
443

444
	jtag_poll_set_enabled(save_poll);
445

zwelch's avatar
zwelch committed
446
	if (retval != JIM_OK) {
447
		Jim_PrintErrorMessage(interp);
448
449
		return ERROR_FAIL;
	}
450
451

	/* We want any events to be processed before the prompt */
452
	retval = target_call_timer_callbacks_now();
453

454
	return retval;
455
456
}

457
static int default_virt2phys(struct target_s *target, uint32_t virtual, uint32_t *physical)
458
459
460
461
462
463
464
465
466
467
468
{
	*physical = virtual;
	return ERROR_OK;
}

static int default_mmu(struct target_s *target, int *enabled)
{
	*enabled = 0;
	return ERROR_OK;
}

469
static int default_examine(struct target_s *target)
470
{
471
	target_set_examined(target);
472
473
474
	return ERROR_OK;
}

zwelch's avatar
zwelch committed
475
476
477
478
479
int target_examine_one(struct target_s *target)
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
480
481
482
483
484
485
486
487
488
489
490
491
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
	target_t *target = priv;

	if (event != JTAG_TAP_EVENT_ENABLE || !target->tap->enabled)
		return ERROR_OK;

	jtag_unregister_event_callback(jtag_enable_callback, target);
	return target_examine_one(target);
}


zwelch's avatar
zwelch committed
492
/* Targets that correctly implement init + examine, i.e.
493
 * no communication with target during init:
oharboe's avatar
oharboe committed
494
495
 *
 * XScale
496
 */
ntfreak's avatar
ntfreak committed
497
int target_examine(void)
498
499
{
	int retval = ERROR_OK;
zwelch's avatar
zwelch committed
500
501
502
	target_t *target;

	for (target = all_targets; target; target = target->next)
503
	{
zwelch's avatar
zwelch committed
504
505
506
507
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
508
			continue;
zwelch's avatar
zwelch committed
509
		}
zwelch's avatar
zwelch committed
510
		if ((retval = target_examine_one(target)) != ERROR_OK)
511
512
513
514
			return retval;
	}
	return retval;
}
zwelch's avatar
zwelch committed
515
516
517
518
const char *target_get_name(struct target_s *target)
{
	return target->type->name;
}
519

520
static int target_write_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
521
{
522
	if (!target_was_examined(target))
523
524
525
526
527
528
529
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->write_memory_imp(target, address, size, count, buffer);
}

530
static int target_read_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
531
{
532
	if (!target_was_examined(target))
533
534
535
536
537
538
539
540
541
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->read_memory_imp(target, address, size, count, buffer);
}

static int target_soft_reset_halt_imp(struct target_s *target)
{
542
	if (!target_was_examined(target))
543
544
545
546
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
547
548
549
550
551
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
				target->cmd_name);
		return ERROR_FAIL;
	}
552
553
554
	return target->type->soft_reset_halt_imp(target);
}

555
static int target_run_algorithm_imp(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info)
556
{
557
	if (!target_was_examined(target))
558
559
560
561
562
563
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->run_algorithm_imp(target, num_mem_params, mem_params, num_reg_params, reg_param, entry_point, exit_point, timeout_ms, arch_info);
}
564

zwelch's avatar
zwelch committed
565
int target_read_memory(struct target_s *target,
566
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
567
568
569
570
{
	return target->type->read_memory(target, address, size, count, buffer);
}

zwelch's avatar
zwelch committed
571
int target_write_memory(struct target_s *target,
572
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
573
574
575
{
	return target->type->write_memory(target, address, size, count, buffer);
}
zwelch's avatar
zwelch committed
576
int target_bulk_write_memory(struct target_s *target,
577
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
578
579
580
581
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
int target_add_breakpoint(struct target_s *target,
		struct breakpoint_s *breakpoint)
{
	return target->type->add_breakpoint(target, breakpoint);
}
int target_remove_breakpoint(struct target_s *target,
		struct breakpoint_s *breakpoint)
{
	return target->type->remove_breakpoint(target, breakpoint);
}

int target_add_watchpoint(struct target_s *target,
		struct watchpoint_s *watchpoint)
{
	return target->type->add_watchpoint(target, watchpoint);
}
int target_remove_watchpoint(struct target_s *target,
		struct watchpoint_s *watchpoint)
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
603

zwelch's avatar
zwelch committed
604
605
606
607
608
int target_get_gdb_reg_list(struct target_s *target,
		struct reg_s **reg_list[], int *reg_list_size)
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
zwelch's avatar
zwelch committed
609
int target_step(struct target_s *target,
610
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
611
612
613
614
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
615

zwelch's avatar
zwelch committed
616
617
618
int target_run_algorithm(struct target_s *target,
		int num_mem_params, mem_param_t *mem_params,
		int num_reg_params, reg_param_t *reg_param,
619
		uint32_t entry_point, uint32_t exit_point,
zwelch's avatar
zwelch committed
620
621
622
623
624
625
626
		int timeout_ms, void *arch_info)
{
	return target->type->run_algorithm(target,
			num_mem_params, mem_params, num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);
}

627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
/// @returns @c true if the target has been examined.
bool target_was_examined(struct target_s *target)
{
	return target->type->examined;
}
/// Sets the @c examined flag for the given target.
void target_set_examined(struct target_s *target)
{
	target->type->examined = true;
}
// Reset the @c examined flag for the given target.
void target_reset_examined(struct target_s *target)
{
	target->type->examined = false;
}

zwelch's avatar
zwelch committed
643

644
645
int target_init(struct command_context_s *cmd_ctx)
{
646
	target_t *target = all_targets;
647
	int retval;
oharboe's avatar
oharboe committed
648

649
650
	while (target)
	{
651
		target_reset_examined(target);
652
653
654
655
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
656

657
		if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
658
		{
zwelch's avatar
zwelch committed
659
			LOG_ERROR("target '%s' init failed", target_get_name(target));
660
			return retval;
661
		}
oharboe's avatar
oharboe committed
662

663
664
665
666
667
		/* Set up default functions if none are provided by target */
		if (target->type->virt2phys == NULL)
		{
			target->type->virt2phys = default_virt2phys;
		}
668
669
670
671
672
673
674
675
676
677
678
679
680
		target->type->virt2phys = default_virt2phys;
		/* a non-invasive way(in terms of patches) to add some code that
		 * runs before the type->write/read_memory implementation
		 */
		target->type->write_memory_imp = target->type->write_memory;
		target->type->write_memory = target_write_memory_imp;
		target->type->read_memory_imp = target->type->read_memory;
		target->type->read_memory = target_read_memory_imp;
		target->type->soft_reset_halt_imp = target->type->soft_reset_halt;
		target->type->soft_reset_halt = target_soft_reset_halt_imp;
		target->type->run_algorithm_imp = target->type->run_algorithm;
		target->type->run_algorithm = target_run_algorithm_imp;

681
682
683
684
685
686
		if (target->type->mmu == NULL)
		{
			target->type->mmu = default_mmu;
		}
		target = target->next;
	}
oharboe's avatar
oharboe committed
687

688
	if (all_targets)
689
	{
zwelch's avatar
zwelch committed
690
		if ((retval = target_register_user_commands(cmd_ctx)) != ERROR_OK)
691
			return retval;
zwelch's avatar
zwelch committed
692
		if ((retval = target_register_timer_callback(handle_target, 100, 1, NULL)) != ERROR_OK)
693
			return retval;
694
	}
oharboe's avatar
oharboe committed
695

696
697
698
699
700
701
	return ERROR_OK;
}

int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
{
	target_event_callback_t **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
702

703
704
705
706
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
707

708
709
710
711
712
713
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
714

715
716
717
718
	(*callbacks_p) = malloc(sizeof(target_event_callback_t));
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
719

720
721
722
723
724
725
726
	return ERROR_OK;
}

int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
{
	target_timer_callback_t **callbacks_p = &target_timer_callbacks;
	struct timeval now;
oharboe's avatar
oharboe committed
727

728
729
730
731
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
732

733
734
735
736
737
738
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
739

740
741
742
743
	(*callbacks_p) = malloc(sizeof(target_timer_callback_t));
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
744

745
746
747
748
749
750
751
752
753
	gettimeofday(&now, NULL);
	(*callbacks_p)->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
	time_ms -= (time_ms % 1000);
	(*callbacks_p)->when.tv_sec = now.tv_sec + (time_ms / 1000);
	if ((*callbacks_p)->when.tv_usec > 1000000)
	{
		(*callbacks_p)->when.tv_usec = (*callbacks_p)->when.tv_usec - 1000000;
		(*callbacks_p)->when.tv_sec += 1;
	}
oharboe's avatar
oharboe committed
754

755
756
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
757

758
759
760
761
762
763
764
	return ERROR_OK;
}

int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
{
	target_event_callback_t **p = &target_event_callbacks;
	target_event_callback_t *c = target_event_callbacks;
oharboe's avatar
oharboe committed
765

766
767
768
769
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
770

771
772
773
774
775
776
777
778
779
780
781
782
783
	while (c)
	{
		target_event_callback_t *next = c->next;
		if ((c->callback == callback) && (c->priv == priv))
		{
			*p = next;
			free(c);
			return ERROR_OK;
		}
		else
			p = &(c->next);
		c = next;
	}
oharboe's avatar
oharboe committed
784

785
786
787
788
789
790
791
	return ERROR_OK;
}

int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
{
	target_timer_callback_t **p = &target_timer_callbacks;
	target_timer_callback_t *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
792

793
794
795
796
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
797

798
799
800
801
802
803
804
805
806
807
808
809
810
	while (c)
	{
		target_timer_callback_t *next = c->next;
		if ((c->callback == callback) && (c->priv == priv))
		{
			*p = next;
			free(c);
			return ERROR_OK;
		}
		else
			p = &(c->next);
		c = next;
	}
oharboe's avatar
oharboe committed
811

812
813
814
815
816
817
818
	return ERROR_OK;
}

int target_call_event_callbacks(target_t *target, enum target_event event)
{
	target_event_callback_t *callback = target_event_callbacks;
	target_event_callback_t *next_callback;
oharboe's avatar
oharboe committed
819

820
821
822
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
823
		target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
824
825
	}

826
827
	LOG_DEBUG("target event %i (%s)",
			  event,
828
			  Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
oharboe's avatar
oharboe committed
829

830
	target_handle_event(target, event);
831

832
833
834
835
836
837
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
838

839
840
841
	return ERROR_OK;
}

842
843
static int target_timer_callback_periodic_restart(
		target_timer_callback_t *cb, struct timeval *now)
844
{
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
	int time_ms = cb->time_ms;
	cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
	time_ms -= (time_ms % 1000);
	cb->when.tv_sec = now->tv_sec + time_ms / 1000;
	if (cb->when.tv_usec > 1000000)
	{
		cb->when.tv_usec = cb->when.tv_usec - 1000000;
		cb->when.tv_sec += 1;
	}
	return ERROR_OK;
}

static int target_call_timer_callback(target_timer_callback_t *cb,
		struct timeval *now)
{
	cb->callback(cb->priv);
861

862
863
864
865
866
867
868
869
	if (cb->periodic)
		return target_timer_callback_periodic_restart(cb, now);

	return target_unregister_timer_callback(cb->callback, cb->priv);
}

static int target_call_timer_callbacks_check_time(int checktime)
{
oharboe's avatar
   
oharboe committed
870
871
	keep_alive();

872
	struct timeval now;
873
	gettimeofday(&now, NULL);
oharboe's avatar
oharboe committed
874

875
	target_timer_callback_t *callback = target_timer_callbacks;
876
877
	while (callback)
	{
878
879
880
881
882
883
884
885
		// cleaning up may unregister and free this callback
		target_timer_callback_t *next_callback = callback->next;

		bool call_it = callback->callback &&
			((!checktime && callback->periodic) ||
			  now.tv_sec > callback->when.tv_sec ||
			 (now.tv_sec == callback->when.tv_sec &&
			  now.tv_usec >= callback->when.tv_usec));
oharboe's avatar
oharboe committed
886

887
		if (call_it)
888
		{
889
890
891
			int retval = target_call_timer_callback(callback, &now);
			if (retval != ERROR_OK)
				return retval;
892
		}
oharboe's avatar
oharboe committed
893

894
895
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
896

897
898
899
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
900
int target_call_timer_callbacks(void)
901
902
903
904
905
{
	return target_call_timer_callbacks_check_time(1);
}

/* invoke periodic callbacks immediately */
oharboe's avatar
oharboe committed
906
int target_call_timer_callbacks_now(void)
907
{
oharboe's avatar
   
oharboe committed
908
	return target_call_timer_callbacks_check_time(0);
909
910
}

911
int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area)
912
913
914
{
	working_area_t *c = target->working_areas;
	working_area_t *new_wa = NULL;
oharboe's avatar
oharboe committed
915

916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
	/* Reevaluate working area address based on MMU state*/
	if (target->working_areas == NULL)
	{
		int retval;
		int enabled;
		retval = target->type->mmu(target, &enabled);
		if (retval != ERROR_OK)
		{
			return retval;
		}
		if (enabled)
		{
			target->working_area = target->working_area_virt;
		}
		else
		{
			target->working_area = target->working_area_phys;
		}
	}
oharboe's avatar
oharboe committed
935

936
937
938
	/* only allocate multiples of 4 byte */
	if (size % 4)
	{
duane's avatar
duane committed
939
940
		LOG_ERROR("BUG: code tried to allocate unaligned number of bytes (0x%08x), padding", ((unsigned)(size)));
		size = (size + 3) & (~3);
941
	}
oharboe's avatar
oharboe committed
942

943
944
945
946
947
948
949
950
951
952
	/* see if there's already a matching working area */
	while (c)
	{
		if ((c->free) && (c->size == size))
		{
			new_wa = c;
			break;
		}
		c = c->next;
	}
oharboe's avatar
oharboe committed
953

954
955
956
957
	/* if not, allocate a new one */
	if (!new_wa)
	{
		working_area_t **p = &target->working_areas;
958
959
		uint32_t first_free = target->working_area;
		uint32_t free_size = target->working_area_size;
oharboe's avatar
oharboe committed
960

961
		LOG_DEBUG("allocating new working area");
oharboe's avatar
oharboe committed
962

963
964
965
966
967
968
969
970
		c = target->working_areas;
		while (c)
		{
			first_free += c->size;
			free_size -= c->size;
			p = &c->next;
			c = c->next;
		}
oharboe's avatar
oharboe committed
971

972
973
		if (free_size < size)
		{
974
			LOG_WARNING("not enough working area available(requested %u, free %u)",
duane's avatar
duane committed
975
				    (unsigned)(size), (unsigned)(free_size));
976
977
			return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
		}
oharboe's avatar
oharboe committed
978

979
980
981
982
		new_wa = malloc(sizeof(working_area_t));
		new_wa->next = NULL;
		new_wa->size = size;
		new_wa->address = first_free;
oharboe's avatar
oharboe committed
983

984
985
		if (target->backup_working_area)
		{
986
			int retval;
987
			new_wa->backup = malloc(new_wa->size);
zwelch's avatar
zwelch committed
988
			if ((retval = target_read_memory(target, new_wa->address, 4, new_wa->size / 4, new_wa->backup)) != ERROR_OK)
989
990
991
992
993
			{
				free(new_wa->backup);
				free(new_wa);
				return retval;
			}
994
995
996
997
998
		}
		else
		{
			new_wa->backup = NULL;
		}
oharboe's avatar
oharboe committed
999

1000
		/* put new entry in list */
For faster browsing, not all history is shown. View entire blame