target.c 127 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_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);
53

54
/* targets */
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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;
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;
extern struct target_type arm11_target;
extern struct target_type mips_m4k_target;
extern struct target_type avr_target;
70
extern struct target_type dsp563xx_target;
Zachary T Welch's avatar
Zachary T Welch committed
71
extern struct target_type testee_target;
72
73

struct target_type *target_types[] =
74
75
76
77
78
79
80
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
	&arm926ejs_target,
81
	&fa526_target,
82
	&feroceon_target,
83
	&dragonite_target,
84
85
	&xscale_target,
	&cortexm3_target,
86
	&cortexa8_target,
oharboe's avatar
oharboe committed
87
	&arm11_target,
ntfreak's avatar
ntfreak committed
88
	&mips_m4k_target,
89
	&avr_target,
90
	&dsp563xx_target,
Zachary T Welch's avatar
Zachary T Welch committed
91
	&testee_target,
92
93
94
	NULL,
};

Zachary T Welch's avatar
Zachary T Welch committed
95
struct target *all_targets = NULL;
96
struct target_event_callback *target_event_callbacks = NULL;
97
struct target_timer_callback *target_timer_callbacks = NULL;
98

99
static const Jim_Nvp nvp_assert[] = {
100
101
102
103
104
105
106
	{ .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 }
107
108
};

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

124
const char *target_strerror_safe(int err)
125
126
127
{
	const Jim_Nvp *n;

128
	n = Jim_Nvp_value2name_simple(nvp_error_target, err);
zwelch's avatar
zwelch committed
129
	if (n->name == NULL) {
130
131
132
133
134
135
		return "unknown";
	} else {
		return n->name;
	}
}

136
static const Jim_Nvp nvp_target_event[] = {
137
138
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
139

140
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
141
142
143
144
145
	{ .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" },

146
147
148
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

149
	/* historical name */
150

151
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
152
153

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
154
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
155
156
157
158
159
160
161
	{ .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" },
162
163
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
164

165
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
166
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
167

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
	{ .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 }
185
186
};

187
static const Jim_Nvp nvp_target_state[] = {
188
189
190
191
192
193
	{ .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 },
194
195
};

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

207
static const Jim_Nvp nvp_target_endian[] = {
208
209
210
	{ .name = "big",    .value = TARGET_BIG_ENDIAN },
	{ .name = "little", .value = TARGET_LITTLE_ENDIAN },
	{ .name = "be",     .value = TARGET_BIG_ENDIAN },
211
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
212
213
214
	{ .name = NULL,     .value = -1 },
};

215
static const Jim_Nvp nvp_reset_modes[] = {
216
217
218
219
220
221
222
	{ .name = "unknown", .value = RESET_UNKNOWN },
	{ .name = "run"    , .value = RESET_RUN },
	{ .name = "halt"   , .value = RESET_HALT },
	{ .name = "init"   , .value = RESET_INIT },
	{ .name = NULL     , .value = -1 },
};

223
224
225
226
227
228
229
230
231
232
233
234
235
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;
}

236
const char *
Zachary T Welch's avatar
Zachary T Welch committed
237
target_state_name( struct target *t )
238
239
240
241
242
243
244
245
246
247
{
	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;
}

248
/* determine the number of the new target */
249
static int new_target_number(void)
250
{
Zachary T Welch's avatar
Zachary T Welch committed
251
	struct target *t;
252
253
254
255
256
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
257
258
	while (t) {
		if (x < t->target_number) {
259
260
261
262
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
263
	return x + 1;
264
265
}

266
/* read a uint32_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
267
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
268
269
270
271
272
273
274
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

zwelch's avatar
zwelch committed
275
/* read a uint16_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
276
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
277
278
279
280
281
282
283
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

284
/* read a uint8_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
285
uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
286
287
288
289
{
	return *buffer & 0x0ff;
}

290
/* write a uint32_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
291
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
292
293
294
295
296
297
298
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
299
/* write a uint16_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
300
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
301
302
303
304
305
306
307
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

308
/* write a uint8_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
309
void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
310
311
312
313
{
	*buffer = value;
}

314
/* return a pointer to a configured target; id is name or number */
Zachary T Welch's avatar
Zachary T Welch committed
315
struct target *get_target(const char *id)
316
{
Zachary T Welch's avatar
Zachary T Welch committed
317
	struct target *target;
318
319
320
321
322
323
324
325
326

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

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

329
	/* no match, try as number */
330
331
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
332
333
334
		return NULL;

	for (target = all_targets; target; target = target->next) {
335
336
337
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
338
			return target;
339
		}
340
341
342
343
344
	}

	return NULL;
}

345
/* returns a pointer to the n-th configured target */
Zachary T Welch's avatar
Zachary T Welch committed
346
static struct target *get_target_by_num(int num)
347
{
Zachary T Welch's avatar
Zachary T Welch committed
348
	struct target *target = all_targets;
349

zwelch's avatar
zwelch committed
350
351
	while (target) {
		if (target->target_number == num) {
352
			return target;
353
		}
354
355
356
357
358
359
		target = target->next;
	}

	return NULL;
}

360
struct target* get_current_target(struct command_context *cmd_ctx)
361
{
Zachary T Welch's avatar
Zachary T Welch committed
362
	struct target *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
363

364
365
	if (target == NULL)
	{
366
		LOG_ERROR("BUG: current_target out of bounds");
367
368
369
		exit(-1);
	}

oharboe's avatar
oharboe committed
370
	return target;
371
372
}

Zachary T Welch's avatar
Zachary T Welch committed
373
int target_poll(struct target *target)
374
{
375
376
	int retval;

377
	/* We can't poll until after examine */
378
	if (!target_was_examined(target))
379
380
381
382
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

	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;
406
407
}

Zachary T Welch's avatar
Zachary T Welch committed
408
int target_halt(struct target *target)
409
{
410
	int retval;
411
	/* We can't poll until after examine */
412
	if (!target_was_examined(target))
413
414
415
416
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
417
418
419
420
421
422
423
424
425

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

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

	return ERROR_OK;
426
427
}

David Brownell's avatar
David Brownell committed
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
/**
 * 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
458
int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
459
{
460
	int retval;
oharboe's avatar
oharboe committed
461

462
	/* We can't poll until after examine */
463
	if (!target_was_examined(target))
464
465
466
467
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
468

David Brownell's avatar
David Brownell committed
469
470
471
	/* 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
472
	 */
473
474
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
475

476
477
478
479
480
481
482
483
	/* Invalidate any cached protect/erase/... flash status, since
	 * almost all targets will now be able modify the flash by
	 * themselves.  We want flash drivers and infrastructure to
	 * be able to rely on (non-invalidated) cached state.
	 *
	 * REVISIT do the same for NAND ; maybe other flash flavors too...
	 */
	nor_resume(target);
484
	return retval;
485
486
}

487
int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
488
489
{
	char buf[100];
490
	int retval;
491
	Jim_Nvp *n;
492
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
493
	if (n->name == NULL) {
494
495
496
497
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

498
499
500
501
	/* 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.
	 */
502
503
504
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
505

506
	sprintf(buf, "ocd_process_reset %s", n->name);
507
	retval = Jim_Eval(cmd_ctx->interp, buf);
508

509
	jtag_poll_set_enabled(save_poll);
510

zwelch's avatar
zwelch committed
511
	if (retval != JIM_OK) {
512
		Jim_PrintErrorMessage(cmd_ctx->interp);
513
514
		return ERROR_FAIL;
	}
515
516

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

Øyvind Harboe's avatar
Øyvind Harboe committed
519
520
521
522
523
	struct target *target;
	for (target = all_targets; target; target = target->next) {
		target->type->check_reset(target);
	}

524
	return retval;
525
526
}

Zachary T Welch's avatar
Zachary T Welch committed
527
static int identity_virt2phys(struct target *target,
David Brownell's avatar
David Brownell committed
528
		uint32_t virtual, uint32_t *physical)
529
530
531
532
533
{
	*physical = virtual;
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
534
static int no_mmu(struct target *target, int *enabled)
535
{
536
	*enabled = 0;
537
538
539
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
540
static int default_examine(struct target *target)
541
{
542
	target_set_examined(target);
543
544
545
	return ERROR_OK;
}

Øyvind Harboe's avatar
Øyvind Harboe committed
546
547
548
549
550
551
/* no check by default */
static int default_check_reset(struct target *target)
{
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
552
int target_examine_one(struct target *target)
zwelch's avatar
zwelch committed
553
554
555
556
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
557
558
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
Zachary T Welch's avatar
Zachary T Welch committed
559
	struct target *target = priv;
zwelch's avatar
zwelch committed
560
561
562
563
564
565
566
567
568

	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
569
/* Targets that correctly implement init + examine, i.e.
570
 * no communication with target during init:
oharboe's avatar
oharboe committed
571
572
 *
 * XScale
573
 */
ntfreak's avatar
ntfreak committed
574
int target_examine(void)
575
576
{
	int retval = ERROR_OK;
Zachary T Welch's avatar
Zachary T Welch committed
577
	struct target *target;
zwelch's avatar
zwelch committed
578
579

	for (target = all_targets; target; target = target->next)
580
	{
zwelch's avatar
zwelch committed
581
582
583
584
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
585
			continue;
zwelch's avatar
zwelch committed
586
		}
zwelch's avatar
zwelch committed
587
		if ((retval = target_examine_one(target)) != ERROR_OK)
588
589
590
591
			return retval;
	}
	return retval;
}
592
const char *target_type_name(struct target *target)
zwelch's avatar
zwelch committed
593
594
595
{
	return target->type->name;
}
596

Zachary T Welch's avatar
Zachary T Welch committed
597
static int target_write_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
598
{
599
	if (!target_was_examined(target))
600
601
602
603
604
605
606
	{
		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
607
static int target_read_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
608
{
609
	if (!target_was_examined(target))
610
611
612
613
614
615
616
	{
		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
617
static int target_soft_reset_halt_imp(struct target *target)
618
{
619
	if (!target_was_examined(target))
620
621
622
623
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
624
625
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
626
				target_name(target));
627
628
		return ERROR_FAIL;
	}
629
630
631
	return target->type->soft_reset_halt_imp(target);
}

632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
/**
 * 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)
648
{
649
650
	int retval = ERROR_FAIL;

651
	if (!target_was_examined(target))
652
653
	{
		LOG_ERROR("Target not examined yet");
654
		goto done;
655
	}
656
657
658
659
660
661
662
663
664
665
666
667
668
	if (target->type->run_algorithm) {
		LOG_ERROR("Target type '%s' does not support %s",
				target_type_name(target), __func__);
		goto done;
	}

	retval = target->type->run_algorithm(target,
			num_mem_params, mem_params,
			num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);

done:
	return retval;
669
}
670

671

Zachary T Welch's avatar
Zachary T Welch committed
672
int target_read_memory(struct target *target,
673
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
674
675
676
677
{
	return target->type->read_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
678
int target_read_phys_memory(struct target *target,
679
680
681
682
683
		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
684
int target_write_memory(struct target *target,
685
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
686
687
688
{
	return target->type->write_memory(target, address, size, count, buffer);
}
689

Zachary T Welch's avatar
Zachary T Welch committed
690
int target_write_phys_memory(struct target *target,
691
692
693
694
695
		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
696
int target_bulk_write_memory(struct target *target,
697
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
698
699
700
701
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
702
int target_add_breakpoint(struct target *target,
703
		struct breakpoint *breakpoint)
704
{
705
706
707
708
	if (target->state != TARGET_HALTED) {
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
709
710
	return target->type->add_breakpoint(target, breakpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
711
int target_remove_breakpoint(struct target *target,
712
		struct breakpoint *breakpoint)
713
714
715
716
{
	return target->type->remove_breakpoint(target, breakpoint);
}

Zachary T Welch's avatar
Zachary T Welch committed
717
int target_add_watchpoint(struct target *target,
718
		struct watchpoint *watchpoint)
719
{
720
721
722
723
	if (target->state != TARGET_HALTED) {
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
724
725
	return target->type->add_watchpoint(target, watchpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
726
int target_remove_watchpoint(struct target *target,
727
		struct watchpoint *watchpoint)
728
729
730
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
731

Zachary T Welch's avatar
Zachary T Welch committed
732
int target_get_gdb_reg_list(struct target *target,
Zachary T Welch's avatar
Zachary T Welch committed
733
		struct reg **reg_list[], int *reg_list_size)
zwelch's avatar
zwelch committed
734
735
736
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
Zachary T Welch's avatar
Zachary T Welch committed
737
int target_step(struct target *target,
738
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
739
740
741
742
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
743

744
745
746
747
748
/**
 * Reset the @c examined flag for the given target.
 * Pure paranoia -- targets are zeroed on allocation.
 */
static void target_reset_examined(struct target *target)
749
{
750
	target->examined = false;
751
752
}

753
static int
Zachary T Welch's avatar
Zachary T Welch committed
754
err_read_phys_memory(struct target *target, uint32_t address,
755
		uint32_t size, uint32_t count, uint8_t *buffer)
756
{
757
	LOG_ERROR("Not implemented: %s", __func__);
758
	return ERROR_FAIL;
759
760
}

761
static int
Zachary T Welch's avatar
Zachary T Welch committed
762
err_write_phys_memory(struct target *target, uint32_t address,
763
		uint32_t size, uint32_t count, uint8_t *buffer)
764
{
765
	LOG_ERROR("Not implemented: %s", __func__);
766
	return ERROR_FAIL;
767
768
}

769
770
static int handle_target(void *priv);

771
772
static int target_init_one(struct command_context *cmd_ctx,
		struct target *target)
773
{
774
	target_reset_examined(target);
oharboe's avatar
oharboe committed
775

776
777
778
	struct target_type *type = target->type;
	if (type->examine == NULL)
		type->examine = default_examine;
779

Øyvind Harboe's avatar
Øyvind Harboe committed
780
781
782
	if (type->check_reset== NULL)
		type->check_reset = default_check_reset;

783
784
785
786
787
788
	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
789

790
791
792
793
794
795
796
797
798
799
	/**
	 * @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
800

801
802
	type->read_memory_imp = target->type->read_memory;
	type->read_memory = target_read_memory_imp;
803

804
805
	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
806

807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
	/* 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
	{
832
833
834
835
		/* 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.
		 */
836
837
838
839
		if (type->write_phys_memory || type->read_phys_memory
				|| type->virt2phys)
		{
			LOG_WARNING("type '%s' has bad MMU hooks", type->name);
840
		}
841
842
843
844
845

		type->mmu = no_mmu;
		type->write_phys_memory = type->write_memory;
		type->read_phys_memory = type->read_memory;
		type->virt2phys = identity_virt2phys;
846
	}
847
848
	return ERROR_OK;
}
oharboe's avatar
oharboe committed
849

850
851
852
853
854
855
int target_init(struct command_context *cmd_ctx)
{
	struct target *target;
	int retval;

	for (target = all_targets; target; target = target->next)
856
	{
857
858
		retval = target_init_one(cmd_ctx, target);
		if (ERROR_OK != retval)
859
			return retval;
860
	}
oharboe's avatar
oharboe committed
861

862
863
864
865
866
867
868
869
870
871
872
873
	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,
			100, 1, cmd_ctx->interp);
	if (ERROR_OK != retval)
		return retval;

874
875
876
	return ERROR_OK;
}

877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
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
894
int target_register_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
895
{
896
	struct target_event_callback **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
897

898
899
900
901
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
902

903
904
905
906
907
908
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
909

910
	(*callbacks_p) = malloc(sizeof(struct target_event_callback));
911
912
913
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
914

915
916
917
918
919
	return ERROR_OK;
}

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

923
924
925
926
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
927

928
929
930
931
932
933
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
934

935
	(*callbacks_p) = malloc(sizeof(struct target_timer_callback));
936
937
938
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
939

940
941
942
943
944
945
946
947
948
	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
949

950
951
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
952

953
954
955
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
956
int target_unregister_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
957
{
958
959
	struct target_event_callback **p = &target_event_callbacks;
	struct target_event_callback *c = target_event_callbacks;
oharboe's avatar
oharboe committed
960

961
962
963
964
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
965

966
967
	while (c)
	{
968
		struct target_event_callback *next = c->next;
969
970
971
972
973
974
975
976
977
978
		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
979

980
981
982
983
984
	return ERROR_OK;
}

int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
{
985
986
	struct target_timer_callback **p = &target_timer_callbacks;
	struct target_timer_callback *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
987

988
989
990
991
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
992

993
994
	while (c)
	{
995
		struct target_timer_callback *next = c->next;
996
997
998
999
1000
		if ((c->callback == callback) && (c->priv == priv))
		{
			*p = next;
			free(c);
			return ERROR_OK;