target.c 128 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
static int target_register_user_commands(struct command_context *cmd_ctx);
54

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

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

Zachary T Welch's avatar
Zachary T Welch committed
100
struct target *all_targets = NULL;
101
102
static struct target_event_callback *target_event_callbacks = NULL;
static struct target_timer_callback *target_timer_callbacks = NULL;
103
static const int polling_interval = 100;
104

105
static const Jim_Nvp nvp_assert[] = {
106
107
108
109
110
111
112
	{ .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 }
113
114
};

115
static const Jim_Nvp nvp_error_target[] = {
116
117
118
119
120
121
122
123
124
125
126
127
128
129
	{ .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 }
};

130
static const char *target_strerror_safe(int err)
131
132
133
{
	const Jim_Nvp *n;

134
	n = Jim_Nvp_value2name_simple(nvp_error_target, err);
zwelch's avatar
zwelch committed
135
	if (n->name == NULL) {
136
137
138
139
140
141
		return "unknown";
	} else {
		return n->name;
	}
}

142
static const Jim_Nvp nvp_target_event[] = {
143
144
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
145

146
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
147
148
149
150
151
	{ .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" },

152
153
154
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

155
	/* historical name */
156

157
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
158
159

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
160
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
161
162
163
164
165
166
167
	{ .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" },
168
169
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
170

171
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
172
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
173

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
	{ .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 }
191
192
};

193
static const Jim_Nvp nvp_target_state[] = {
194
195
196
197
198
199
	{ .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 },
200
201
};

202
static const Jim_Nvp nvp_target_debug_reason [] = {
203
204
205
206
207
208
209
210
211
212
	{ .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 },
};

213
static const Jim_Nvp nvp_target_endian[] = {
214
215
216
	{ .name = "big",    .value = TARGET_BIG_ENDIAN },
	{ .name = "little", .value = TARGET_LITTLE_ENDIAN },
	{ .name = "be",     .value = TARGET_BIG_ENDIAN },
217
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
218
219
220
	{ .name = NULL,     .value = -1 },
};

221
static const Jim_Nvp nvp_reset_modes[] = {
222
223
224
225
226
227
228
	{ .name = "unknown", .value = RESET_UNKNOWN },
	{ .name = "run"    , .value = RESET_RUN },
	{ .name = "halt"   , .value = RESET_HALT },
	{ .name = "init"   , .value = RESET_INIT },
	{ .name = NULL     , .value = -1 },
};

229
230
231
232
233
234
235
236
237
238
239
240
241
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;
}

242
const char *
Zachary T Welch's avatar
Zachary T Welch committed
243
target_state_name( struct target *t )
244
245
246
247
248
249
250
251
252
253
{
	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
{
Zachary T Welch's avatar
Zachary T Welch committed
257
	struct target *t;
258
259
260
261
262
	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
/* read a uint32_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
273
uint32_t target_buffer_get_u32(struct target *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
/* read a uint16_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
282
uint16_t target_buffer_get_u16(struct target *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
/* read a uint8_t from a buffer in target memory endianness */
291
static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
292
293
294
295
{
	return *buffer & 0x0ff;
}

296
/* write a uint32_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
297
void target_buffer_set_u32(struct target *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
/* write a uint16_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
306
void target_buffer_set_u16(struct target *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
/* write a uint8_t to a buffer in target memory endianness */
315
static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
316
317
318
319
{
	*buffer = value;
}

320
/* return a pointer to a configured target; id is name or number */
Zachary T Welch's avatar
Zachary T Welch committed
321
struct target *get_target(const char *id)
322
{
Zachary T Welch's avatar
Zachary T Welch committed
323
	struct target *target;
324
325
326
327
328
329
330
331
332

	/* 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 */
Zachary T Welch's avatar
Zachary T Welch committed
352
static struct target *get_target_by_num(int num)
353
{
Zachary T Welch's avatar
Zachary T Welch committed
354
	struct target *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
		target = target->next;
	}

	return NULL;
}

366
struct target* get_current_target(struct command_context *cmd_ctx)
367
{
Zachary T Welch's avatar
Zachary T Welch committed
368
	struct target *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
}

Zachary T Welch's avatar
Zachary T Welch committed
379
int target_poll(struct target *target)
380
{
381
382
	int retval;

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

	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;
412
413
}

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

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

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

	return ERROR_OK;
432
433
}

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

468
	/* We can't poll until after examine */
469
	if (!target_was_examined(target))
470
471
472
473
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
474

David Brownell's avatar
David Brownell committed
475
476
477
	/* 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
478
	 */
479
480
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
481

482
	return retval;
483
484
}

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

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

	jtag_poll_set_enabled(false);
503

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

507
	jtag_poll_set_enabled(save_poll);
508

zwelch's avatar
zwelch committed
509
	if (retval != JIM_OK) {
Øyvind Harboe's avatar
Øyvind Harboe committed
510
511
		Jim_MakeErrorMessage(cmd_ctx->interp);
		command_print(NULL,"%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
512
513
		return ERROR_FAIL;
	}
514
515

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

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

523
	return retval;
524
525
}

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

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

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

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

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

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

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

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

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

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

650
	if (!target_was_examined(target))
651
652
	{
		LOG_ERROR("Target not examined yet");
653
		goto done;
654
	}
David Brownell's avatar
David Brownell committed
655
	if (!target->type->run_algorithm) {
656
657
658
659
660
		LOG_ERROR("Target type '%s' does not support %s",
				target_type_name(target), __func__);
		goto done;
	}

661
	target->running_alg = true;
662
663
664
665
	retval = target->type->run_algorithm(target,
			num_mem_params, mem_params,
			num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);
666
	target->running_alg = false;
667
668
669

done:
	return retval;
670
}
671

672

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

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

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

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

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

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

zwelch's avatar
zwelch committed
744

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

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

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

770
771
static int handle_target(void *priv);

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

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

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

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

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

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

805
806
	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
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
832
	/* 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
	{
833
834
835
836
		/* 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.
		 */
837
838
839
840
		if (type->write_phys_memory || type->read_phys_memory
				|| type->virt2phys)
		{
			LOG_WARNING("type '%s' has bad MMU hooks", type->name);
841
		}
842
843
844
845
846

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

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

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

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

875
876
877
	return ERROR_OK;
}

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

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

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

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

916
917
918
919
920
	return ERROR_OK;
}

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

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

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

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

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

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

954
955
956
	return ERROR_OK;
}

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

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

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

981
982
983
	return ERROR_OK;
}

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

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

994
995
	while (c)
	{
996
		struct target_timer_callback *next = c->next;
997
998
999
1000
1001
1002
1003
1004
1005
1006
		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
1007

1008
1009
1010
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
1011
int target_call_event_callbacks(struct target *target, enum target_event event)
1012
{
1013
1014
	struct target_event_callback *callback = target_event_callbacks;
	struct target_event_callback *next_callback;
oharboe's avatar
oharboe committed
1015

1016
1017
1018
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
1019
		target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1020
1021
	}