target.c 130 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
Øyvind Harboe's avatar
Øyvind Harboe committed
5
 *   Copyright (C) 2007-2010 Ø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
 *   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

36
37
#include <helper/time_support.h>
#include <jtag/jtag.h>
38
#include <flash/nor/core.h>
39

40
#include "target.h"
41
#include "target_type.h"
42
#include "target_request.h"
43
#include "breakpoints.h"
44
45
46
#include "register.h"
#include "trace.h"
#include "image.h"
47
48


49
50
51
52
static int target_read_buffer_default(struct target *target, uint32_t address,
		uint32_t size, uint8_t *buffer);
static int target_write_buffer_default(struct target *target, uint32_t address,
		uint32_t size, uint8_t *buffer);
53
54
55
56
static int target_array2mem(Jim_Interp *interp, struct target *target,
		int argc, Jim_Obj *const *argv);
static int target_mem2array(Jim_Interp *interp, struct target *target,
		int argc, Jim_Obj *const *argv);
57
static int target_register_user_commands(struct command_context *cmd_ctx);
58

59
/* targets */
60
61
62
63
64
extern struct target_type arm7tdmi_target;
extern struct target_type arm720t_target;
extern struct target_type arm9tdmi_target;
extern struct target_type arm920t_target;
extern struct target_type arm966e_target;
65
extern struct target_type arm946e_target;
66
67
68
69
70
71
72
extern struct target_type arm926ejs_target;
extern struct target_type fa526_target;
extern struct target_type feroceon_target;
extern struct target_type dragonite_target;
extern struct target_type xscale_target;
extern struct target_type cortexm3_target;
extern struct target_type cortexa8_target;
73
extern struct target_type cortexa9_target;
74
75
76
extern struct target_type arm11_target;
extern struct target_type mips_m4k_target;
extern struct target_type avr_target;
77
extern struct target_type dsp563xx_target;
Zachary T Welch's avatar
Zachary T Welch committed
78
extern struct target_type testee_target;
Oleksandr Tymoshenko's avatar
Oleksandr Tymoshenko committed
79
extern struct target_type avr32_ap7k_target;
80

81
static struct target_type *target_types[] =
82
83
84
85
86
87
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
88
	&arm946e_target,
89
	&arm926ejs_target,
90
	&fa526_target,
91
	&feroceon_target,
92
	&dragonite_target,
93
94
	&xscale_target,
	&cortexm3_target,
95
	&cortexa8_target,
96
	&cortexa9_target,
oharboe's avatar
oharboe committed
97
	&arm11_target,
ntfreak's avatar
ntfreak committed
98
	&mips_m4k_target,
99
	&avr_target,
100
	&dsp563xx_target,
Zachary T Welch's avatar
Zachary T Welch committed
101
	&testee_target,
Oleksandr Tymoshenko's avatar
Oleksandr Tymoshenko committed
102
	&avr32_ap7k_target,
103
104
105
	NULL,
};

Zachary T Welch's avatar
Zachary T Welch committed
106
struct target *all_targets = NULL;
107
108
static struct target_event_callback *target_event_callbacks = NULL;
static struct target_timer_callback *target_timer_callbacks = NULL;
109
static const int polling_interval = 100;
110

111
static const Jim_Nvp nvp_assert[] = {
112
113
114
115
116
117
118
	{ .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 }
119
120
};

121
static const Jim_Nvp nvp_error_target[] = {
122
123
124
125
126
127
128
129
130
131
132
133
134
135
	{ .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 }
};

136
static const char *target_strerror_safe(int err)
137
138
139
{
	const Jim_Nvp *n;

140
	n = Jim_Nvp_value2name_simple(nvp_error_target, err);
zwelch's avatar
zwelch committed
141
	if (n->name == NULL) {
142
143
144
145
146
147
		return "unknown";
	} else {
		return n->name;
	}
}

148
static const Jim_Nvp nvp_target_event[] = {
149
150
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
151

152
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
153
154
155
156
157
	{ .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" },

158
159
160
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

161
	/* historical name */
162

163
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
164
165

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
166
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
167
168
169
170
171
172
173
	{ .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" },
174
175
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
176

177
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
178
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
179

180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
	{ .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 }
197
198
};

199
static const Jim_Nvp nvp_target_state[] = {
200
201
202
203
204
205
	{ .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 },
206
207
};

208
static const Jim_Nvp nvp_target_debug_reason [] = {
209
210
211
212
213
214
215
216
217
218
	{ .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 },
};

219
static const Jim_Nvp nvp_target_endian[] = {
220
221
222
	{ .name = "big",    .value = TARGET_BIG_ENDIAN },
	{ .name = "little", .value = TARGET_LITTLE_ENDIAN },
	{ .name = "be",     .value = TARGET_BIG_ENDIAN },
223
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
224
225
226
	{ .name = NULL,     .value = -1 },
};

227
static const Jim_Nvp nvp_reset_modes[] = {
228
229
230
231
232
233
234
	{ .name = "unknown", .value = RESET_UNKNOWN },
	{ .name = "run"    , .value = RESET_RUN },
	{ .name = "halt"   , .value = RESET_HALT },
	{ .name = "init"   , .value = RESET_INIT },
	{ .name = NULL     , .value = -1 },
};

235
236
237
238
239
240
241
242
243
244
245
246
247
const char *debug_reason_name(struct target *t)
{
	const char *cp;

	cp = Jim_Nvp_value2name_simple(nvp_target_debug_reason,
			t->debug_reason)->name;
	if (!cp) {
		LOG_ERROR("Invalid debug reason: %d", (int)(t->debug_reason));
		cp = "(*BUG*unknown*BUG*)";
	}
	return cp;
}

248
const char *
Zachary T Welch's avatar
Zachary T Welch committed
249
target_state_name( struct target *t )
250
251
252
253
254
255
256
257
258
259
{
	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;
}

260
/* determine the number of the new target */
261
static int new_target_number(void)
262
{
Zachary T Welch's avatar
Zachary T Welch committed
263
	struct target *t;
264
265
266
267
268
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
269
270
	while (t) {
		if (x < t->target_number) {
271
272
273
274
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
275
	return x + 1;
276
277
}

278
/* read a uint32_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
279
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
280
281
282
283
284
285
286
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

Mathias K's avatar
Mathias K committed
287
288
289
290
291
292
293
294
295
/* read a uint24_t from a buffer in target memory endianness */
uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u24(buffer);
	else
		return be_to_h_u24(buffer);
}

zwelch's avatar
zwelch committed
296
/* read a uint16_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
297
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
298
299
300
301
302
303
304
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

305
/* read a uint8_t from a buffer in target memory endianness */
306
static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
307
308
309
310
{
	return *buffer & 0x0ff;
}

311
/* write a uint32_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
312
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
313
314
315
316
317
318
319
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

Mathias K's avatar
Mathias K committed
320
321
322
323
324
325
326
327
328
/* write a uint24_t to a buffer in target memory endianness */
void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u24_to_le(buffer, value);
	else
		h_u24_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
329
/* write a uint16_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
330
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
331
332
333
334
335
336
337
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

338
/* write a uint8_t to a buffer in target memory endianness */
339
static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
340
341
342
343
{
	*buffer = value;
}

344
/* return a pointer to a configured target; id is name or number */
Zachary T Welch's avatar
Zachary T Welch committed
345
struct target *get_target(const char *id)
346
{
Zachary T Welch's avatar
Zachary T Welch committed
347
	struct target *target;
348
349
350
351
352
353
354
355
356

	/* 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;
	}

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

359
	/* no match, try as number */
360
361
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
362
363
364
		return NULL;

	for (target = all_targets; target; target = target->next) {
365
366
367
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
368
			return target;
369
		}
370
371
372
373
374
	}

	return NULL;
}

375
/* returns a pointer to the n-th configured target */
Zachary T Welch's avatar
Zachary T Welch committed
376
static struct target *get_target_by_num(int num)
377
{
Zachary T Welch's avatar
Zachary T Welch committed
378
	struct target *target = all_targets;
379

zwelch's avatar
zwelch committed
380
381
	while (target) {
		if (target->target_number == num) {
382
			return target;
383
		}
384
385
386
387
388
389
		target = target->next;
	}

	return NULL;
}

390
struct target* get_current_target(struct command_context *cmd_ctx)
391
{
Zachary T Welch's avatar
Zachary T Welch committed
392
	struct target *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
393

394
395
	if (target == NULL)
	{
396
		LOG_ERROR("BUG: current_target out of bounds");
397
398
399
		exit(-1);
	}

oharboe's avatar
oharboe committed
400
	return target;
401
402
}

Zachary T Welch's avatar
Zachary T Welch committed
403
int target_poll(struct target *target)
404
{
405
406
	int retval;

407
	/* We can't poll until after examine */
408
	if (!target_was_examined(target))
409
410
411
412
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435

	retval = target->type->poll(target);
	if (retval != ERROR_OK)
		return retval;

	if (target->halt_issued)
	{
		if (target->state == TARGET_HALTED)
		{
			target->halt_issued = false;
		} else
		{
			long long t = timeval_ms() - target->halt_issued_time;
			if (t>1000)
			{
				target->halt_issued = false;
				LOG_INFO("Halt timed out, wake up GDB.");
				target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
			}
		}
	}

	return ERROR_OK;
436
437
}

Zachary T Welch's avatar
Zachary T Welch committed
438
int target_halt(struct target *target)
439
{
440
	int retval;
441
	/* We can't poll until after examine */
442
	if (!target_was_examined(target))
443
444
445
446
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
447
448
449
450
451
452
453
454
455

	retval = target->type->halt(target);
	if (retval != ERROR_OK)
		return retval;

	target->halt_issued = true;
	target->halt_issued_time = timeval_ms();

	return ERROR_OK;
456
457
}

David Brownell's avatar
David Brownell committed
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
/**
 * Make the target (re)start executing using its saved execution
 * context (possibly with some modifications).
 *
 * @param target Which target should start executing.
 * @param current True to use the target's saved program counter instead
 *	of the address parameter
 * @param address Optionally used as the program counter.
 * @param handle_breakpoints True iff breakpoints at the resumption PC
 *	should be skipped.  (For example, maybe execution was stopped by
 *	such a breakpoint, in which case it would be counterprodutive to
 *	let it re-trigger.
 * @param debug_execution False if all working areas allocated by OpenOCD
 *	should be released and/or restored to their original contents.
 *	(This would for example be true to run some downloaded "helper"
 *	algorithm code, which resides in one such working buffer and uses
 *	another for data storage.)
 *
 * @todo Resolve the ambiguity about what the "debug_execution" flag
 * signifies.  For example, Target implementations don't agree on how
 * it relates to invalidation of the register cache, or to whether
 * breakpoints and watchpoints should be enabled.  (It would seem wrong
 * to enable breakpoints when running downloaded "helper" algorithms
 * (debug_execution true), since the breakpoints would be set to match
 * target firmware being debugged, not the helper algorithm.... and
 * enabling them could cause such helpers to malfunction (for example,
 * by overwriting data with a breakpoint instruction.  On the other
 * hand the infrastructure for running such helpers might use this
 * procedure but rely on hardware breakpoint to detect termination.)
 */
Zachary T Welch's avatar
Zachary T Welch committed
488
int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
489
{
490
	int retval;
oharboe's avatar
oharboe committed
491

492
	/* We can't poll until after examine */
493
	if (!target_was_examined(target))
494
495
496
497
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
498

David Brownell's avatar
David Brownell committed
499
500
501
	/* 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.
oharboe's avatar
oharboe committed
502
	 */
503
504
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
505

506
	return retval;
507
508
}

509
static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
510
511
{
	char buf[100];
512
	int retval;
513
	Jim_Nvp *n;
514
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
515
	if (n->name == NULL) {
516
517
518
519
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

520
521
522
523
	/* 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.
	 */
524
525
526
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
527

528
	sprintf(buf, "ocd_process_reset %s", n->name);
529
	retval = Jim_Eval(cmd_ctx->interp, buf);
530

531
	jtag_poll_set_enabled(save_poll);
532

zwelch's avatar
zwelch committed
533
	if (retval != JIM_OK) {
Øyvind Harboe's avatar
Øyvind Harboe committed
534
535
		Jim_MakeErrorMessage(cmd_ctx->interp);
		command_print(NULL,"%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
536
537
		return ERROR_FAIL;
	}
538
539

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

Øyvind Harboe's avatar
Øyvind Harboe committed
542
543
544
545
546
	struct target *target;
	for (target = all_targets; target; target = target->next) {
		target->type->check_reset(target);
	}

547
	return retval;
548
549
}

Zachary T Welch's avatar
Zachary T Welch committed
550
static int identity_virt2phys(struct target *target,
David Brownell's avatar
David Brownell committed
551
		uint32_t virtual, uint32_t *physical)
552
553
554
555
556
{
	*physical = virtual;
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
557
static int no_mmu(struct target *target, int *enabled)
558
{
559
	*enabled = 0;
560
561
562
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
563
static int default_examine(struct target *target)
564
{
565
	target_set_examined(target);
566
567
568
	return ERROR_OK;
}

Øyvind Harboe's avatar
Øyvind Harboe committed
569
570
571
572
573
574
/* no check by default */
static int default_check_reset(struct target *target)
{
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
575
int target_examine_one(struct target *target)
zwelch's avatar
zwelch committed
576
577
578
579
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
580
581
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
Zachary T Welch's avatar
Zachary T Welch committed
582
	struct target *target = priv;
zwelch's avatar
zwelch committed
583
584
585
586
587
588
589
590
591

	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
592
/* Targets that correctly implement init + examine, i.e.
593
 * no communication with target during init:
oharboe's avatar
oharboe committed
594
595
 *
 * XScale
596
 */
ntfreak's avatar
ntfreak committed
597
int target_examine(void)
598
599
{
	int retval = ERROR_OK;
Zachary T Welch's avatar
Zachary T Welch committed
600
	struct target *target;
zwelch's avatar
zwelch committed
601
602

	for (target = all_targets; target; target = target->next)
603
	{
zwelch's avatar
zwelch committed
604
605
606
607
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
608
			continue;
zwelch's avatar
zwelch committed
609
		}
zwelch's avatar
zwelch committed
610
		if ((retval = target_examine_one(target)) != ERROR_OK)
611
612
613
614
			return retval;
	}
	return retval;
}
615
const char *target_type_name(struct target *target)
zwelch's avatar
zwelch committed
616
617
618
{
	return target->type->name;
}
619

Zachary T Welch's avatar
Zachary T Welch committed
620
static int target_write_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
621
{
622
	if (!target_was_examined(target))
623
624
625
626
627
628
629
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->write_memory_imp(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
630
static int target_read_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
631
{
632
	if (!target_was_examined(target))
633
634
635
636
637
638
639
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->read_memory_imp(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
640
static int target_soft_reset_halt_imp(struct target *target)
641
{
642
	if (!target_was_examined(target))
643
644
645
646
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
647
648
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
649
				target_name(target));
650
651
		return ERROR_FAIL;
	}
652
653
654
	return target->type->soft_reset_halt_imp(target);
}

655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
/**
 * Downloads a target-specific native code algorithm to the target,
 * and executes it.  * Note that some targets may need to set up, enable,
 * and tear down a breakpoint (hard or * soft) to detect algorithm
 * termination, while others may support  lower overhead schemes where
 * soft breakpoints embedded in the algorithm automatically terminate the
 * algorithm.
 *
 * @param target used to run the algorithm
 * @param arch_info target-specific description of the algorithm.
 */
int target_run_algorithm(struct target *target,
		int num_mem_params, struct mem_param *mem_params,
		int num_reg_params, struct reg_param *reg_param,
		uint32_t entry_point, uint32_t exit_point,
		int timeout_ms, void *arch_info)
671
{
672
673
	int retval = ERROR_FAIL;

674
	if (!target_was_examined(target))
675
676
	{
		LOG_ERROR("Target not examined yet");
677
		goto done;
678
	}
David Brownell's avatar
David Brownell committed
679
	if (!target->type->run_algorithm) {
680
681
682
683
684
		LOG_ERROR("Target type '%s' does not support %s",
				target_type_name(target), __func__);
		goto done;
	}

685
	target->running_alg = true;
686
687
688
689
	retval = target->type->run_algorithm(target,
			num_mem_params, mem_params,
			num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);
690
	target->running_alg = false;
691
692
693

done:
	return retval;
694
}
695

696

Zachary T Welch's avatar
Zachary T Welch committed
697
int target_read_memory(struct target *target,
698
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
699
700
701
702
{
	return target->type->read_memory(target, address, size, count, buffer);
}

703
static int target_read_phys_memory(struct target *target,
704
705
706
707
708
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
	return target->type->read_phys_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
709
int target_write_memory(struct target *target,
710
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
711
712
713
{
	return target->type->write_memory(target, address, size, count, buffer);
}
714

715
static int target_write_phys_memory(struct target *target,
716
717
718
719
720
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
	return target->type->write_phys_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
721
int target_bulk_write_memory(struct target *target,
722
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
723
724
725
726
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
727
int target_add_breakpoint(struct target *target,
728
		struct breakpoint *breakpoint)
729
{
730
731
732
733
	if (target->state != TARGET_HALTED) {
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
734
735
	return target->type->add_breakpoint(target, breakpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
736
int target_remove_breakpoint(struct target *target,
737
		struct breakpoint *breakpoint)
738
739
740
741
{
	return target->type->remove_breakpoint(target, breakpoint);
}

Zachary T Welch's avatar
Zachary T Welch committed
742
int target_add_watchpoint(struct target *target,
743
		struct watchpoint *watchpoint)
744
{
745
746
747
748
	if (target->state != TARGET_HALTED) {
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
749
750
	return target->type->add_watchpoint(target, watchpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
751
int target_remove_watchpoint(struct target *target,
752
		struct watchpoint *watchpoint)
753
754
755
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
756

Zachary T Welch's avatar
Zachary T Welch committed
757
int target_get_gdb_reg_list(struct target *target,
Zachary T Welch's avatar
Zachary T Welch committed
758
		struct reg **reg_list[], int *reg_list_size)
zwelch's avatar
zwelch committed
759
760
761
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
Zachary T Welch's avatar
Zachary T Welch committed
762
int target_step(struct target *target,
763
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
764
765
766
767
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
768

769
770
771
772
773
/**
 * Reset the @c examined flag for the given target.
 * Pure paranoia -- targets are zeroed on allocation.
 */
static void target_reset_examined(struct target *target)
774
{
775
	target->examined = false;
776
777
}

778
static int
Zachary T Welch's avatar
Zachary T Welch committed
779
err_read_phys_memory(struct target *target, uint32_t address,
780
		uint32_t size, uint32_t count, uint8_t *buffer)
781
{
782
	LOG_ERROR("Not implemented: %s", __func__);
783
	return ERROR_FAIL;
784
785
}

786
static int
Zachary T Welch's avatar
Zachary T Welch committed
787
err_write_phys_memory(struct target *target, uint32_t address,
788
		uint32_t size, uint32_t count, uint8_t *buffer)
789
{
790
	LOG_ERROR("Not implemented: %s", __func__);
791
	return ERROR_FAIL;
792
793
}

794
795
static int handle_target(void *priv);

796
797
static int target_init_one(struct command_context *cmd_ctx,
		struct target *target)
798
{
799
	target_reset_examined(target);
oharboe's avatar
oharboe committed
800

801
802
803
	struct target_type *type = target->type;
	if (type->examine == NULL)
		type->examine = default_examine;
804

Øyvind Harboe's avatar
Øyvind Harboe committed
805
806
807
	if (type->check_reset== NULL)
		type->check_reset = default_check_reset;

808
809
810
811
812
813
	int retval = type->init_target(cmd_ctx, target);
	if (ERROR_OK != retval)
	{
		LOG_ERROR("target '%s' init failed", target_name(target));
		return retval;
	}
oharboe's avatar
oharboe committed
814

815
816
817
818
819
820
821
822
823
824
	/**
	 * @todo get rid of those *memory_imp() methods, now that all
	 * callers are using target_*_memory() accessors ... and make
	 * sure the "physical" paths handle the same issues.
	 */
	/* a non-invasive way(in terms of patches) to add some code that
	 * runs before the type->write/read_memory implementation
	 */
	type->write_memory_imp = target->type->write_memory;
	type->write_memory = target_write_memory_imp;
oharboe's avatar
oharboe committed
825

826
827
	type->read_memory_imp = target->type->read_memory;
	type->read_memory = target_read_memory_imp;
828

829
830
	type->soft_reset_halt_imp = target->type->soft_reset_halt;
	type->soft_reset_halt = target_soft_reset_halt_imp;
David Brownell's avatar
David Brownell committed
831

832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
	/* Sanity-check MMU support ... stub in what we must, to help
	 * implement it in stages, but warn if we need to do so.
	 */
	if (type->mmu)
	{
		if (type->write_phys_memory == NULL)
		{
			LOG_ERROR("type '%s' is missing write_phys_memory",
					type->name);
			type->write_phys_memory = err_write_phys_memory;
		}
		if (type->read_phys_memory == NULL)
		{
			LOG_ERROR("type '%s' is missing read_phys_memory",
					type->name);
			type->read_phys_memory = err_read_phys_memory;
		}
		if (type->virt2phys == NULL)
		{
			LOG_ERROR("type '%s' is missing virt2phys", type->name);
			type->virt2phys = identity_virt2phys;
		}
	}
	else
	{
857
858
859
860
		/* Make sure no-MMU targets all behave the same:  make no
		 * distinction between physical and virtual addresses, and
		 * ensure that virt2phys() is always an identity mapping.
		 */
861
862
863
864
		if (type->write_phys_memory || type->read_phys_memory
				|| type->virt2phys)
		{
			LOG_WARNING("type '%s' has bad MMU hooks", type->name);
865
		}
866
867
868
869
870

		type->mmu = no_mmu;
		type->write_phys_memory = type->write_memory;
		type->read_phys_memory = type->read_memory;
		type->virt2phys = identity_virt2phys;
871
	}
872
873
874
875
876
877
878

	if (target->type->read_buffer == NULL)
		target->type->read_buffer = target_read_buffer_default;

	if (target->type->write_buffer == NULL)
		target->type->write_buffer = target_write_buffer_default;

879
880
	return ERROR_OK;
}
oharboe's avatar
oharboe committed
881

882
static int target_init(struct command_context *cmd_ctx)
883
884
885
886
887
{
	struct target *target;
	int retval;

	for (target = all_targets; target; target = target->next)
888
	{
889
890
		retval = target_init_one(cmd_ctx, target);
		if (ERROR_OK != retval)
891
			return retval;
892
	}
oharboe's avatar
oharboe committed
893

894
895
896
897
898
899
900
901
	if (!all_targets)
		return ERROR_OK;

	retval = target_register_user_commands(cmd_ctx);
	if (ERROR_OK != retval)
		return retval;

	retval = target_register_timer_callback(&handle_target,
902
			polling_interval, 1, cmd_ctx->interp);
903
904
905
	if (ERROR_OK != retval)
		return retval;

906
907
908
	return ERROR_OK;
}

909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
COMMAND_HANDLER(handle_target_init_command)
{
	if (CMD_ARGC != 0)
		return ERROR_COMMAND_SYNTAX_ERROR;

	static bool target_initialized = false;
	if (target_initialized)
	{
		LOG_INFO("'target init' has already been called");
		return ERROR_OK;
	}
	target_initialized = true;

	LOG_DEBUG("Initializing targets...");
	return target_init(CMD_CTX);
}

Zachary T Welch's avatar
Zachary T Welch committed
926
int target_register_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
927
{
928
	struct target_event_callback **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
929

930
931
932
933
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
934

935
936
937
938
939
940
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
941

942
	(*callbacks_p) = malloc(sizeof(struct target_event_callback));
943
944
945
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
946

947
948
949
950
951
	return ERROR_OK;
}

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

955
956
957
958
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
959

960
961
962
963
964
965
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
966

967
	(*callbacks_p) = malloc(sizeof(struct target_timer_callback));
968
969
970
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
971

972
973
974
975
976
977
978
979
980
	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
981

982
983
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
984

985
986
987
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
988
int target_unregister_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
989
{
990
991
	struct target_event_callback **p = &target_event_callbacks;
	struct target_event_callback *c = target_event_callbacks;
oharboe's avatar
oharboe committed
992

993
994
995
996
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
997

998
999
	while (c)
	{
1000
		struct target_event_callback *next = c->next;
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
		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
1011

1012
1013
1014
	return ERROR_OK;
}

1015
static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1016
{
1017
1018
	struct target_timer_callback **p = &target_timer_callbacks;
	struct target_timer_callback *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
1019

1020
1021
1022
1023
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
1024

1025
1026
	while (c)
	{
1027
		struct target_timer_callback *next = c->next;
1028
1029
1030
1031
1032
1033
1034