target.c 131 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
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 *   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

39
40
#include <helper/time_support.h>
#include <jtag/jtag.h>
41
#include <flash/nor/core.h>
42

43
#include "target.h"
44
#include "target_type.h"
45
#include "target_request.h"
46
#include "breakpoints.h"
47
48
49
#include "register.h"
#include "trace.h"
#include "image.h"
50
#include "rtos/rtos.h"
51
52


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

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

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

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

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

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

138
static const char *target_strerror_safe(int err)
139
140
141
{
	const Jim_Nvp *n;

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

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

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

160
161
162
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

163
	/* historical name */
164

165
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
166
167

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

179
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
180
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
181

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

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

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

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

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

237
238
239
240
241
242
243
244
245
246
247
248
249
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;
}

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

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

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

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

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

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

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

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

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

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

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

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

	return NULL;
}

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

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

	return NULL;
}

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

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

oharboe's avatar
oharboe committed
402
	return target;
403
404
}

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

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

	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;
438
439
}

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

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

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

	return ERROR_OK;
458
459
}

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

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

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

508
	return retval;
509
510
}

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

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

	jtag_poll_set_enabled(false);
529

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

533
	jtag_poll_set_enabled(save_poll);
534

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

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

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

549
	return retval;
550
551
}

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

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

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

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

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

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

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

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

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

657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
/**
 * 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)
673
{
674
675
	int retval = ERROR_FAIL;

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

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

done:
	return retval;
696
}
697

698

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

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

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

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

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

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

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

zwelch's avatar
zwelch committed
770

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

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

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

796
797
static int handle_target(void *priv);

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

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

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

810
811
812
813
814
815
	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
816

817
818
819
820
821
822
823
824
825
826
	/**
	 * @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
827

828
829
	type->read_memory_imp = target->type->read_memory;
	type->read_memory = target_read_memory_imp;
830

831
832
	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
833

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

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

	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;

881
882
	return ERROR_OK;
}
oharboe's avatar
oharboe committed
883

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

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

896
897
898
899
900
901
902
903
	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,
904
			polling_interval, 1, cmd_ctx->interp);
905
906
907
	if (ERROR_OK != retval)
		return retval;

908
909
910
	return ERROR_OK;
}

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

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

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

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

949
950
951
952
953
	return ERROR_OK;
}

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

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

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

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

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

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

987
988
989
	return ERROR_OK;
}

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

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

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

1014
1015
1016
	return ERROR_OK;
}

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

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

1027
1028
	while (c)
	{
1029
		struct target_timer_callback *next = c->next;