target.c 133 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
 *   Copyright (C) 2011 by Broadcom Corporation                            *
 *   Evan Hunter - ehunter@broadcom.com                                    *
 *                                                                         *
20
21
22
 *   Copyright (C) ST-Ericsson SA 2011                                     *
 *   michel.jaouen@stericsson.com : smp minimum support                    *
 *                                                                         *
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 *   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

42
43
#include <helper/time_support.h>
#include <jtag/jtag.h>
44
#include <flash/nor/core.h>
45

46
#include "target.h"
47
#include "target_type.h"
48
#include "target_request.h"
49
#include "breakpoints.h"
50
51
52
#include "register.h"
#include "trace.h"
#include "image.h"
53
#include "rtos/rtos.h"
54
55


56
57
58
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,
59
		uint32_t size, const uint8_t *buffer);
60
61
62
63
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);
64
static int target_register_user_commands(struct command_context *cmd_ctx);
65

66
/* targets */
67
68
69
70
71
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;
72
extern struct target_type arm946e_target;
73
74
75
76
77
78
79
80
81
82
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;
83
extern struct target_type dsp563xx_target;
84
extern struct target_type dsp5680xx_target;
Zachary T Welch's avatar
Zachary T Welch committed
85
extern struct target_type testee_target;
Oleksandr Tymoshenko's avatar
Oleksandr Tymoshenko committed
86
extern struct target_type avr32_ap7k_target;
87

88
static struct target_type *target_types[] =
89
90
91
92
93
94
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
95
	&arm946e_target,
96
	&arm926ejs_target,
97
	&fa526_target,
98
	&feroceon_target,
99
	&dragonite_target,
100
101
	&xscale_target,
	&cortexm3_target,
102
	&cortexa8_target,
oharboe's avatar
oharboe committed
103
	&arm11_target,
ntfreak's avatar
ntfreak committed
104
	&mips_m4k_target,
105
	&avr_target,
106
	&dsp563xx_target,
107
	&dsp5680xx_target,
Zachary T Welch's avatar
Zachary T Welch committed
108
	&testee_target,
Oleksandr Tymoshenko's avatar
Oleksandr Tymoshenko committed
109
	&avr32_ap7k_target,
110
111
112
	NULL,
};

Zachary T Welch's avatar
Zachary T Welch committed
113
struct target *all_targets = NULL;
114
115
static struct target_event_callback *target_event_callbacks = NULL;
static struct target_timer_callback *target_timer_callbacks = NULL;
116
static const int polling_interval = 100;
117

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

128
static const Jim_Nvp nvp_error_target[] = {
129
130
131
132
133
134
135
136
137
138
139
140
141
142
	{ .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 }
};

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

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

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

159
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
160
161
162
163
164
	{ .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" },

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

168
	/* historical name */
169

170
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
171
172

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
173
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
174
175
176
177
178
179
180
	{ .value = TARGET_EVENT_RESET_ASSERT_POST,   .name = "reset-assert-post" },
	{ .value = TARGET_EVENT_RESET_DEASSERT_PRE,  .name = "reset-deassert-pre" },
	{ .value = TARGET_EVENT_RESET_DEASSERT_POST, .name = "reset-deassert-post" },
	{ .value = TARGET_EVENT_RESET_HALT_PRE,      .name = "reset-halt-pre" },
	{ .value = TARGET_EVENT_RESET_HALT_POST,     .name = "reset-halt-post" },
	{ .value = TARGET_EVENT_RESET_WAIT_PRE,      .name = "reset-wait-pre" },
	{ .value = TARGET_EVENT_RESET_WAIT_POST,     .name = "reset-wait-post" },
181
182
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
183

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

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

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

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

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

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

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

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

215
static const Jim_Nvp nvp_target_debug_reason [] = {
216
217
218
219
220
221
222
223
224
225
	{ .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 },
};

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

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

242
243
244
245
246
247
248
249
250
251
252
253
254
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;
}

255
const char *
Zachary T Welch's avatar
Zachary T Welch committed
256
target_state_name( struct target *t )
257
258
259
260
261
262
263
264
265
266
{
	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;
}

267
/* determine the number of the new target */
268
static int new_target_number(void)
269
{
Zachary T Welch's avatar
Zachary T Welch committed
270
	struct target *t;
271
272
273
274
275
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
276
277
	while (t) {
		if (x < t->target_number) {
278
279
280
281
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
282
	return x + 1;
283
284
}

285
/* read a uint32_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
286
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
287
288
289
290
291
292
293
{
	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
294
295
296
297
298
299
300
301
302
/* 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
303
/* read a uint16_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
304
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
305
306
307
308
309
310
311
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

312
/* read a uint8_t from a buffer in target memory endianness */
313
static uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
314
315
316
317
{
	return *buffer & 0x0ff;
}

318
/* write a uint32_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
319
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
320
321
322
323
324
325
326
{
	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
327
328
329
330
331
332
333
334
335
/* 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
336
/* write a uint16_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
337
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
338
339
340
341
342
343
344
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

345
/* write a uint8_t to a buffer in target memory endianness */
346
static void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
347
348
349
350
{
	*buffer = value;
}

351
/* return a pointer to a configured target; id is name or number */
Zachary T Welch's avatar
Zachary T Welch committed
352
struct target *get_target(const char *id)
353
{
Zachary T Welch's avatar
Zachary T Welch committed
354
	struct target *target;
355
356
357
358
359
360
361
362
363

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

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

366
	/* no match, try as number */
367
368
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
369
370
371
		return NULL;

	for (target = all_targets; target; target = target->next) {
372
373
374
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
375
			return target;
376
		}
377
378
379
380
381
	}

	return NULL;
}

382
/* returns a pointer to the n-th configured target */
Zachary T Welch's avatar
Zachary T Welch committed
383
static struct target *get_target_by_num(int num)
384
{
Zachary T Welch's avatar
Zachary T Welch committed
385
	struct target *target = all_targets;
386

zwelch's avatar
zwelch committed
387
388
	while (target) {
		if (target->target_number == num) {
389
			return target;
390
		}
391
392
393
394
395
396
		target = target->next;
	}

	return NULL;
}

397
struct target* get_current_target(struct command_context *cmd_ctx)
398
{
Zachary T Welch's avatar
Zachary T Welch committed
399
	struct target *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
400

401
402
	if (target == NULL)
	{
403
		LOG_ERROR("BUG: current_target out of bounds");
404
405
406
		exit(-1);
	}

oharboe's avatar
oharboe committed
407
	return target;
408
409
}

Zachary T Welch's avatar
Zachary T Welch committed
410
int target_poll(struct target *target)
411
{
412
413
	int retval;

414
	/* We can't poll until after examine */
415
	if (!target_was_examined(target))
416
417
418
419
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442

	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;
443
444
}

Zachary T Welch's avatar
Zachary T Welch committed
445
int target_halt(struct target *target)
446
{
447
	int retval;
448
	/* We can't poll until after examine */
449
	if (!target_was_examined(target))
450
451
452
453
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
454
455
456
457
458
459
460
461
462

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

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

	return ERROR_OK;
463
464
}

David Brownell's avatar
David Brownell committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
/**
 * 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
495
int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
496
{
497
	int retval;
oharboe's avatar
oharboe committed
498

499
	/* We can't poll until after examine */
500
	if (!target_was_examined(target))
501
502
503
504
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
505

David Brownell's avatar
David Brownell committed
506
507
508
	/* 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
509
	 */
510
511
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
512

513
	return retval;
514
515
}

516
static int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
517
518
{
	char buf[100];
519
	int retval;
520
	Jim_Nvp *n;
521
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
522
	if (n->name == NULL) {
523
524
525
526
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

527
528
529
530
	/* 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.
	 */
531
532
533
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
534

535
	sprintf(buf, "ocd_process_reset %s", n->name);
536
	retval = Jim_Eval(cmd_ctx->interp, buf);
537

538
	jtag_poll_set_enabled(save_poll);
539

zwelch's avatar
zwelch committed
540
	if (retval != JIM_OK) {
Øyvind Harboe's avatar
Øyvind Harboe committed
541
542
		Jim_MakeErrorMessage(cmd_ctx->interp);
		command_print(NULL,"%s\n", Jim_GetString(Jim_GetResult(cmd_ctx->interp), NULL));
543
544
		return ERROR_FAIL;
	}
545
546

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

Øyvind Harboe's avatar
Øyvind Harboe committed
549
550
551
552
553
	struct target *target;
	for (target = all_targets; target; target = target->next) {
		target->type->check_reset(target);
	}

554
	return retval;
555
556
}

Zachary T Welch's avatar
Zachary T Welch committed
557
static int identity_virt2phys(struct target *target,
David Brownell's avatar
David Brownell committed
558
		uint32_t virtual, uint32_t *physical)
559
560
561
562
563
{
	*physical = virtual;
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
564
static int no_mmu(struct target *target, int *enabled)
565
{
566
	*enabled = 0;
567
568
569
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
570
static int default_examine(struct target *target)
571
{
572
	target_set_examined(target);
573
574
575
	return ERROR_OK;
}

Øyvind Harboe's avatar
Øyvind Harboe committed
576
577
578
579
580
581
/* no check by default */
static int default_check_reset(struct target *target)
{
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
582
int target_examine_one(struct target *target)
zwelch's avatar
zwelch committed
583
584
585
586
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
587
588
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
Zachary T Welch's avatar
Zachary T Welch committed
589
	struct target *target = priv;
zwelch's avatar
zwelch committed
590
591
592
593
594
595
596
597
598

	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
599
/* Targets that correctly implement init + examine, i.e.
600
 * no communication with target during init:
oharboe's avatar
oharboe committed
601
602
 *
 * XScale
603
 */
ntfreak's avatar
ntfreak committed
604
int target_examine(void)
605
606
{
	int retval = ERROR_OK;
Zachary T Welch's avatar
Zachary T Welch committed
607
	struct target *target;
zwelch's avatar
zwelch committed
608
609

	for (target = all_targets; target; target = target->next)
610
	{
zwelch's avatar
zwelch committed
611
612
613
614
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
615
			continue;
zwelch's avatar
zwelch committed
616
		}
zwelch's avatar
zwelch committed
617
		if ((retval = target_examine_one(target)) != ERROR_OK)
618
619
620
621
			return retval;
	}
	return retval;
}
622
const char *target_type_name(struct target *target)
zwelch's avatar
zwelch committed
623
624
625
{
	return target->type->name;
}
626

627
static int target_write_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
628
{
629
	if (!target_was_examined(target))
630
631
632
633
634
635
636
	{
		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
637
static int target_read_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
638
{
639
	if (!target_was_examined(target))
640
641
642
643
644
645
646
	{
		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
647
static int target_soft_reset_halt_imp(struct target *target)
648
{
649
	if (!target_was_examined(target))
650
651
652
653
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
654
655
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
656
				target_name(target));
657
658
		return ERROR_FAIL;
	}
659
660
661
	return target->type->soft_reset_halt_imp(target);
}

662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
/**
 * 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)
678
{
679
680
	int retval = ERROR_FAIL;

681
	if (!target_was_examined(target))
682
683
	{
		LOG_ERROR("Target not examined yet");
684
		goto done;
685
	}
David Brownell's avatar
David Brownell committed
686
	if (!target->type->run_algorithm) {
687
688
689
690
691
		LOG_ERROR("Target type '%s' does not support %s",
				target_type_name(target), __func__);
		goto done;
	}

692
	target->running_alg = true;
693
694
695
696
	retval = target->type->run_algorithm(target,
			num_mem_params, mem_params,
			num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);
697
	target->running_alg = false;
698
699
700

done:
	return retval;
701
}
702

703

Zachary T Welch's avatar
Zachary T Welch committed
704
int target_read_memory(struct target *target,
705
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
706
707
708
709
{
	return target->type->read_memory(target, address, size, count, buffer);
}

710
static int target_read_phys_memory(struct target *target,
711
712
713
714
715
		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
716
int target_write_memory(struct target *target,
717
		uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
zwelch's avatar
zwelch committed
718
719
720
{
	return target->type->write_memory(target, address, size, count, buffer);
}
721

722
static int target_write_phys_memory(struct target *target,
723
		uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer)
724
725
726
727
{
	return target->type->write_phys_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
728
int target_bulk_write_memory(struct target *target,
729
		uint32_t address, uint32_t count, const uint8_t *buffer)
zwelch's avatar
zwelch committed
730
731
732
733
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
734
int target_add_breakpoint(struct target *target,
735
		struct breakpoint *breakpoint)
736
{
737
	if ((target->state != TARGET_HALTED)&&(breakpoint->type!=BKPT_HARD)) {
738
739
740
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
741
742
	return target->type->add_breakpoint(target, breakpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
743
int target_remove_breakpoint(struct target *target,
744
		struct breakpoint *breakpoint)
745
746
747
748
{
	return target->type->remove_breakpoint(target, breakpoint);
}

Zachary T Welch's avatar
Zachary T Welch committed
749
int target_add_watchpoint(struct target *target,
750
		struct watchpoint *watchpoint)
751
{
752
753
754
755
	if (target->state != TARGET_HALTED) {
		LOG_WARNING("target %s is not halted", target->cmd_name);
		return ERROR_TARGET_NOT_HALTED;
	}
756
757
	return target->type->add_watchpoint(target, watchpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
758
int target_remove_watchpoint(struct target *target,
759
		struct watchpoint *watchpoint)
760
761
762
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
763

Zachary T Welch's avatar
Zachary T Welch committed
764
int target_get_gdb_reg_list(struct target *target,
Zachary T Welch's avatar
Zachary T Welch committed
765
		struct reg **reg_list[], int *reg_list_size)
zwelch's avatar
zwelch committed
766
767
768
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
Zachary T Welch's avatar
Zachary T Welch committed
769
int target_step(struct target *target,
770
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
771
772
773
774
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
775

776
777
778
779
780
/**
 * Reset the @c examined flag for the given target.
 * Pure paranoia -- targets are zeroed on allocation.
 */
static void target_reset_examined(struct target *target)
781
{
782
	target->examined = false;
783
784
}

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

793
static int
Zachary T Welch's avatar
Zachary T Welch committed
794
err_write_phys_memory(struct target *target, uint32_t address,
795
		uint32_t size, uint32_t count, const uint8_t *buffer)
796
{
797
	LOG_ERROR("Not implemented: %s", __func__);
798
	return ERROR_FAIL;
799
800
}

801
802
static int handle_target(void *priv);

803
804
static int target_init_one(struct command_context *cmd_ctx,
		struct target *target)
805
{
806
	target_reset_examined(target);
oharboe's avatar
oharboe committed
807

808
809
810
	struct target_type *type = target->type;
	if (type->examine == NULL)
		type->examine = default_examine;
811

Øyvind Harboe's avatar
Øyvind Harboe committed
812
813
814
	if (type->check_reset== NULL)
		type->check_reset = default_check_reset;

815
816
817
818
819
820
	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
821

822
823
824
825
826
827
828
829
830
831
	/**
	 * @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
832

833
834
	type->read_memory_imp = target->type->read_memory;
	type->read_memory = target_read_memory_imp;
835

836
837
	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
838

839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
	/* 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
	{
864
865
866
867
		/* 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.
		 */
868
869
870
871
		if (type->write_phys_memory || type->read_phys_memory
				|| type->virt2phys)
		{
			LOG_WARNING("type '%s' has bad MMU hooks", type->name);
872
		}
873
874
875
876
877

		type->mmu = no_mmu;
		type->write_phys_memory = type->write_memory;
		type->read_phys_memory = type->read_memory;
		type->virt2phys = identity_virt2phys;
878
	}
879
880
881
882
883
884
885

	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;

886
887
	return ERROR_OK;
}
oharboe's avatar
oharboe committed
888

889
static int target_init(struct command_context *cmd_ctx)
890
891
892
893
894
{
	struct target *target;
	int retval;

	for (target = all_targets; target; target = target->next)
895
	{
896
897
		retval = target_init_one(cmd_ctx, target);
		if (ERROR_OK != retval)
898
			return retval;
899
	}
oharboe's avatar
oharboe committed
900

901
902
903
904
905
906
907
908
	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,
909
			polling_interval, 1, cmd_ctx->interp);
910
911
912
	if (ERROR_OK != retval)
		return retval;

913
914
915
	return ERROR_OK;
}

916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
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
933
int target_register_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
934
{
935
	struct target_event_callback **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
936

937
938
939
940
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
941

942
943
944
945
946
947
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
948

949
	(*callbacks_p) = malloc(sizeof(struct target_event_callback));
950
951
952
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
953

954
955
956
957
958
	return ERROR_OK;
}

int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv)
{
959
	struct target_timer_callback **callbacks_p = &target_timer_callbacks;
960
	struct timeval now;
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
969
970
971
972
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
973

974
	(*callbacks_p) = malloc(sizeof(struct target_timer_callback));
975
976
977
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
978

979
980
981
982
983
984
985
986
987
	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
988

989
990
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
991

992
993
994
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
995
int target_unregister_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
996
{
997
998
	struct target_event_callback **p = &target_event_callbacks;
	struct target_event_callback *c = target_event_callbacks;
oharboe's avatar
oharboe committed
999

1000
	if (callback == NULL)