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
108
// Disabled for now, it generates warnings
//	&dsp5680xx_target,
Zachary T Welch's avatar
Zachary T Welch committed
109
	&testee_target,
Oleksandr Tymoshenko's avatar
Oleksandr Tymoshenko committed
110
	&avr32_ap7k_target,
111
112
113
	NULL,
};

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

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

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

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

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

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

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

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

169
	/* historical name */
170

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

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
174
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
175
176
177
178
179
180
181
	{ .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" },
182
183
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
184

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

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
	{ .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 }
205
206
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return NULL;
}

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

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

	return NULL;
}

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

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

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

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

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

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

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

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

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

	return ERROR_OK;
464
465
}

David Brownell's avatar
David Brownell committed
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
495
/**
 * 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
496
int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
497
{
498
	int retval;
oharboe's avatar
oharboe committed
499

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

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

514
	return retval;
515
516
}

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

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

	jtag_poll_set_enabled(false);
535

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

539
	jtag_poll_set_enabled(save_poll);
540

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

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

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

555
	return retval;
556
557
}

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

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

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

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

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

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

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

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

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

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

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

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

done:
	return retval;
702
}
703

704

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

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

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

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

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

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

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

zwelch's avatar
zwelch committed
776

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

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

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

802
803
static int handle_target(void *priv);

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

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

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

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

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

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

837
838
	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
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
864
	/* 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
	{
865
866
867
868
		/* 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.
		 */
869
870
871
872
		if (type->write_phys_memory || type->read_phys_memory
				|| type->virt2phys)
		{
			LOG_WARNING("type '%s' has bad MMU hooks", type->name);
873
		}
874
875
876
877
878

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

	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;

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

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

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

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

914
915
916
	return ERROR_OK;
}

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

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

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

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

955
956
957
958
959
	return ERROR_OK;
}

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

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

968
969
970
971
972
973
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
974

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

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

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

993
994
995
	return ERROR_OK;
}

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

1001
1002
1003
1004
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
1005

1006
1007
	while (c)
	{
1008
		struct target_event_callback *next = c->next;
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
		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
1019

1020
1021
1022
	return ERROR_OK;
}

1023
static int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
1024
{
1025
1026
	struct target_timer_callback **p = &target_timer_callbacks;
	struct target_timer_callback *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
1027