target.c 120 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007-2009 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008, Duane Ellis                                       *
 *   openocd@duaneeellis.com                                               *
 *                                                                         *
11
12
13
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
14
15
16
 *   Copyright (C) 2008 by Rick Altherr                                    *
 *   kc8apf@kc8apf.net>                                                    *
 *                                                                         *
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 *   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

#include "target.h"
37
#include "target_type.h"
38
#include "target_request.h"
39
40
41
42
#include "time_support.h"
#include "register.h"
#include "trace.h"
#include "image.h"
43
44
45
#include "jtag.h"


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
static int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

static int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_test_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc);
static int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_fast_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int handle_fast_load_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
70

71
static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
72
static int jim_mcrmrc(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
73
static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
74
static int jim_target(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
75

76
77
78
static int target_array2mem(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);
static int target_mem2array(Jim_Interp *interp, target_t *target, int argc, Jim_Obj *const *argv);

79
/* targets */
80
81
82
83
84
85
extern target_type_t arm7tdmi_target;
extern target_type_t arm720t_target;
extern target_type_t arm9tdmi_target;
extern target_type_t arm920t_target;
extern target_type_t arm966e_target;
extern target_type_t arm926ejs_target;
86
extern target_type_t fa526_target;
87
extern target_type_t feroceon_target;
88
extern target_type_t dragonite_target;
89
90
extern target_type_t xscale_target;
extern target_type_t cortexm3_target;
91
extern target_type_t cortexa8_target;
oharboe's avatar
oharboe committed
92
extern target_type_t arm11_target;
ntfreak's avatar
ntfreak committed
93
extern target_type_t mips_m4k_target;
94
extern target_type_t avr_target;
95
96
97
98
99
100
101
102
103

target_type_t *target_types[] =
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
	&arm926ejs_target,
104
	&fa526_target,
105
	&feroceon_target,
106
	&dragonite_target,
107
108
	&xscale_target,
	&cortexm3_target,
109
	&cortexa8_target,
oharboe's avatar
oharboe committed
110
	&arm11_target,
ntfreak's avatar
ntfreak committed
111
	&mips_m4k_target,
112
	&avr_target,
113
114
115
	NULL,
};

116
target_t *all_targets = NULL;
117
118
119
target_event_callback_t *target_event_callbacks = NULL;
target_timer_callback_t *target_timer_callbacks = NULL;

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

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

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

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

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

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

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

170
	/* historical name */
171

172
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
173
174
175
176
177
178
179
180
181

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
	{ .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
184
	{ .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END, .name = "reset-end" },

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
208
209
210
211
212
213
const Jim_Nvp nvp_target_state[] = {
	{ .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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
const Jim_Nvp nvp_target_debug_reason [] = {
	{ .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 },
};

const Jim_Nvp nvp_target_endian[] = {
	{ .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
236
237
238
239
240
241
242
const Jim_Nvp nvp_reset_modes[] = {
	{ .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
const char *
target_state_name( target_t *t )
{
	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;
}

255
/* determine the number of the new target */
256
static int new_target_number(void)
257
258
259
260
261
262
263
{
	target_t *t;
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
264
265
	while (t) {
		if (x < t->target_number) {
266
267
268
269
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
270
	return x + 1;
271
272
}

273
274
/* read a uint32_t from a buffer in target memory endianness */
uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer)
275
276
277
278
279
280
281
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

zwelch's avatar
zwelch committed
282
283
/* read a uint16_t from a buffer in target memory endianness */
uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer)
284
285
286
287
288
289
290
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

291
292
/* read a uint8_t from a buffer in target memory endianness */
uint8_t target_buffer_get_u8(target_t *target, const uint8_t *buffer)
293
294
295
296
{
	return *buffer & 0x0ff;
}

297
298
/* write a uint32_t to a buffer in target memory endianness */
void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value)
299
300
301
302
303
304
305
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
306
307
/* write a uint16_t to a buffer in target memory endianness */
void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value)
308
309
310
311
312
313
314
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

315
316
/* write a uint8_t to a buffer in target memory endianness */
void target_buffer_set_u8(target_t *target, uint8_t *buffer, uint8_t value)
317
318
319
320
{
	*buffer = value;
}

321
322
323
324
325
326
327
328
329
330
331
332
333
/* return a pointer to a configured target; id is name or number */
target_t *get_target(const char *id)
{
	target_t *target;

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

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

336
	/* no match, try as number */
337
338
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
339
340
341
		return NULL;

	for (target = all_targets; target; target = target->next) {
342
343
344
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
345
			return target;
346
		}
347
348
349
350
351
	}

	return NULL;
}

352
/* returns a pointer to the n-th configured target */
353
static target_t *get_target_by_num(int num)
354
{
355
	target_t *target = all_targets;
356

zwelch's avatar
zwelch committed
357
358
	while (target) {
		if (target->target_number == num) {
359
			return target;
360
		}
361
362
363
364
365
366
367
368
369
		target = target->next;
	}

	return NULL;
}

target_t* get_current_target(command_context_t *cmd_ctx)
{
	target_t *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
370

371
372
	if (target == NULL)
	{
373
		LOG_ERROR("BUG: current_target out of bounds");
374
375
376
		exit(-1);
	}

oharboe's avatar
oharboe committed
377
	return target;
378
379
}

380
381
int target_poll(struct target_s *target)
{
382
383
	int retval;

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

	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;
413
414
415
416
}

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

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

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

	return ERROR_OK;
433
434
}

435
int target_resume(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
436
{
437
	int retval;
oharboe's avatar
oharboe committed
438

439
	/* We can't poll until after examine */
440
	if (!target_was_examined(target))
441
442
443
444
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
445

oharboe's avatar
oharboe committed
446
447
448
449
	/* 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.
	 */
450
451
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
452

453
	return retval;
454
455
}

oharboe's avatar
oharboe committed
456
int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
457
458
{
	char buf[100];
459
	int retval;
460
	Jim_Nvp *n;
461
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
462
	if (n->name == NULL) {
463
464
465
466
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

467
468
469
470
	/* 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.
	 */
471
472
473
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
474

475
476
	sprintf(buf, "ocd_process_reset %s", n->name);
	retval = Jim_Eval(interp, buf);
477

478
	jtag_poll_set_enabled(save_poll);
479

zwelch's avatar
zwelch committed
480
	if (retval != JIM_OK) {
481
		Jim_PrintErrorMessage(interp);
482
483
		return ERROR_FAIL;
	}
484
485

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

488
	return retval;
489
490
}

491
static int default_virt2phys(struct target_s *target, uint32_t virtual, uint32_t *physical)
492
493
494
495
496
497
498
{
	*physical = virtual;
	return ERROR_OK;
}

static int default_mmu(struct target_s *target, int *enabled)
{
499
	*enabled = 0;
500
501
502
	return ERROR_OK;
}

503
static int default_examine(struct target_s *target)
504
{
505
	target_set_examined(target);
506
507
508
	return ERROR_OK;
}

zwelch's avatar
zwelch committed
509
510
511
512
513
int target_examine_one(struct target_s *target)
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
514
515
516
517
518
519
520
521
522
523
524
525
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
	target_t *target = priv;

	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
526
/* Targets that correctly implement init + examine, i.e.
527
 * no communication with target during init:
oharboe's avatar
oharboe committed
528
529
 *
 * XScale
530
 */
ntfreak's avatar
ntfreak committed
531
int target_examine(void)
532
533
{
	int retval = ERROR_OK;
zwelch's avatar
zwelch committed
534
535
536
	target_t *target;

	for (target = all_targets; target; target = target->next)
537
	{
zwelch's avatar
zwelch committed
538
539
540
541
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
542
			continue;
zwelch's avatar
zwelch committed
543
		}
zwelch's avatar
zwelch committed
544
		if ((retval = target_examine_one(target)) != ERROR_OK)
545
546
547
548
			return retval;
	}
	return retval;
}
zwelch's avatar
zwelch committed
549
550
551
552
const char *target_get_name(struct target_s *target)
{
	return target->type->name;
}
553

554
static int target_write_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
555
{
556
	if (!target_was_examined(target))
557
558
559
560
561
562
563
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->write_memory_imp(target, address, size, count, buffer);
}

564
static int target_read_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
565
{
566
	if (!target_was_examined(target))
567
568
569
570
571
572
573
574
575
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->read_memory_imp(target, address, size, count, buffer);
}

static int target_soft_reset_halt_imp(struct target_s *target)
{
576
	if (!target_was_examined(target))
577
578
579
580
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
581
582
583
584
585
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
				target->cmd_name);
		return ERROR_FAIL;
	}
586
587
588
	return target->type->soft_reset_halt_imp(target);
}

589
static int target_run_algorithm_imp(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, uint32_t entry_point, uint32_t exit_point, int timeout_ms, void *arch_info)
590
{
591
	if (!target_was_examined(target))
592
593
594
595
596
597
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->run_algorithm_imp(target, num_mem_params, mem_params, num_reg_params, reg_param, entry_point, exit_point, timeout_ms, arch_info);
}
598

zwelch's avatar
zwelch committed
599
int target_read_memory(struct target_s *target,
600
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
601
602
603
604
{
	return target->type->read_memory(target, address, size, count, buffer);
}

605
606
607
608
609
610
int target_read_phys_memory(struct target_s *target,
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
	return target->type->read_phys_memory(target, address, size, count, buffer);
}

zwelch's avatar
zwelch committed
611
int target_write_memory(struct target_s *target,
612
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
613
614
615
{
	return target->type->write_memory(target, address, size, count, buffer);
}
616
617
618
619
620
621
622

int target_write_phys_memory(struct target_s *target,
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
	return target->type->write_phys_memory(target, address, size, count, buffer);
}

zwelch's avatar
zwelch committed
623
int target_bulk_write_memory(struct target_s *target,
624
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
625
626
627
628
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
int target_add_breakpoint(struct target_s *target,
		struct breakpoint_s *breakpoint)
{
	return target->type->add_breakpoint(target, breakpoint);
}
int target_remove_breakpoint(struct target_s *target,
		struct breakpoint_s *breakpoint)
{
	return target->type->remove_breakpoint(target, breakpoint);
}

int target_add_watchpoint(struct target_s *target,
		struct watchpoint_s *watchpoint)
{
	return target->type->add_watchpoint(target, watchpoint);
}
int target_remove_watchpoint(struct target_s *target,
		struct watchpoint_s *watchpoint)
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
650

zwelch's avatar
zwelch committed
651
652
653
654
655
int target_get_gdb_reg_list(struct target_s *target,
		struct reg_s **reg_list[], int *reg_list_size)
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
zwelch's avatar
zwelch committed
656
int target_step(struct target_s *target,
657
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
658
659
660
661
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
662

zwelch's avatar
zwelch committed
663
664
665
int target_run_algorithm(struct target_s *target,
		int num_mem_params, mem_param_t *mem_params,
		int num_reg_params, reg_param_t *reg_param,
666
		uint32_t entry_point, uint32_t exit_point,
zwelch's avatar
zwelch committed
667
668
669
670
671
672
673
		int timeout_ms, void *arch_info)
{
	return target->type->run_algorithm(target,
			num_mem_params, mem_params, num_reg_params, reg_param,
			entry_point, exit_point, timeout_ms, arch_info);
}

674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
/// @returns @c true if the target has been examined.
bool target_was_examined(struct target_s *target)
{
	return target->type->examined;
}
/// Sets the @c examined flag for the given target.
void target_set_examined(struct target_s *target)
{
	target->type->examined = true;
}
// Reset the @c examined flag for the given target.
void target_reset_examined(struct target_s *target)
{
	target->type->examined = false;
}

zwelch's avatar
zwelch committed
690

691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718

static int default_mrc(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
{
	LOG_ERROR("Not implemented");
	return ERROR_FAIL;
}

static int default_mcr(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
{
	LOG_ERROR("Not implemented");
	return ERROR_FAIL;
}

static int arm_cp_check(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
{
	/* basic check */
	if (!target_was_examined(target))
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}

	if ((cpnum <0) || (cpnum > 15))
	{
		LOG_ERROR("Illegal co-processor %d", cpnum);
		return ERROR_FAIL;
	}

719
	if (op1 > 7)
720
721
722
723
724
	{
		LOG_ERROR("Illegal op1");
		return ERROR_FAIL;
	}

725
	if (op2 > 7)
726
727
728
729
730
	{
		LOG_ERROR("Illegal op2");
		return ERROR_FAIL;
	}

731
	if (CRn > 15)
732
733
734
735
736
	{
		LOG_ERROR("Illegal CRn");
		return ERROR_FAIL;
	}

737
	if (CRm > 15)
738
739
740
741
742
	{
		LOG_ERROR("Illegal CRm");
		return ERROR_FAIL;
	}

743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
	return ERROR_OK;
}

int target_mrc(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
{
	int retval;

	retval = arm_cp_check(target, cpnum, op1, op2, CRn, CRm);
	if (retval != ERROR_OK)
		return retval;

	return target->type->mrc(target, cpnum, op1, op2, CRn, CRm, value);
}

int target_mcr(struct target_s *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
{
	int retval;

	retval = arm_cp_check(target, cpnum, op1, op2, CRn, CRm);
	if (retval != ERROR_OK)
		return retval;

	return target->type->mcr(target, cpnum, op1, op2, CRn, CRm, value);
}

768
769
static int default_read_phys_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
770
771
	LOG_ERROR("Not implemented");
	return ERROR_FAIL;
772
773
774
775
}

static int default_write_phys_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
776
777
	LOG_ERROR("Not implemented");
	return ERROR_FAIL;
778
779
}

780

781
782
int target_init(struct command_context_s *cmd_ctx)
{
783
	target_t *target = all_targets;
784
	int retval;
oharboe's avatar
oharboe committed
785

786
787
	while (target)
	{
788
		target_reset_examined(target);
789
790
791
792
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
793

794
		if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
795
		{
zwelch's avatar
zwelch committed
796
			LOG_ERROR("target '%s' init failed", target_get_name(target));
797
			return retval;
798
		}
oharboe's avatar
oharboe committed
799

800
801
802
803
804
		/* Set up default functions if none are provided by target */
		if (target->type->virt2phys == NULL)
		{
			target->type->virt2phys = default_virt2phys;
		}
805
806
807

		if (target->type->read_phys_memory == NULL)
		{
808
			target->type->read_phys_memory = default_read_phys_memory;
809
810
811
812
		}

		if (target->type->write_phys_memory == NULL)
		{
813
			target->type->write_phys_memory = default_write_phys_memory;
814
815
		}

816
817
818
		if (target->type->mcr == NULL)
		{
			target->type->mcr = default_mcr;
819
820
821
822
823
824
825
826
		} else
		{
			/* FIX! multiple targets will generally register global commands
			 * multiple times. Only register this one if *one* of the
			 * targets need the command. Hmm... make it a command on the
			 * Jim Tcl target object?
			 */
			register_jim(cmd_ctx, "mcr", jim_mcrmrc, "write coprocessor <cpnum> <op1> <op2> <CRn> <CRm> <value>");
827
828
829
830
831
		}

		if (target->type->mrc == NULL)
		{
			target->type->mrc = default_mrc;
832
833
834
		} else
		{
			register_jim(cmd_ctx, "mrc", jim_mcrmrc, "read coprocessor <cpnum> <op1> <op2> <CRn> <CRm>");
835
836
837
		}


838
839
840
841
842
843
844
845
846
847
848
849
		/* a non-invasive way(in terms of patches) to add some code that
		 * runs before the type->write/read_memory implementation
		 */
		target->type->write_memory_imp = target->type->write_memory;
		target->type->write_memory = target_write_memory_imp;
		target->type->read_memory_imp = target->type->read_memory;
		target->type->read_memory = target_read_memory_imp;
		target->type->soft_reset_halt_imp = target->type->soft_reset_halt;
		target->type->soft_reset_halt = target_soft_reset_halt_imp;
		target->type->run_algorithm_imp = target->type->run_algorithm;
		target->type->run_algorithm = target_run_algorithm_imp;

850
851
852
853
854
855
		if (target->type->mmu == NULL)
		{
			target->type->mmu = default_mmu;
		}
		target = target->next;
	}
oharboe's avatar
oharboe committed
856

857
	if (all_targets)
858
	{
zwelch's avatar
zwelch committed
859
		if ((retval = target_register_user_commands(cmd_ctx)) != ERROR_OK)
860
			return retval;
zwelch's avatar
zwelch committed
861
		if ((retval = target_register_timer_callback(handle_target, 100, 1, NULL)) != ERROR_OK)
862
			return retval;
863
	}
oharboe's avatar
oharboe committed
864

865
866
867
868
869
870
	return ERROR_OK;
}

int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
{
	target_event_callback_t **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
871

872
873
874
875
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
876

877
878
879
880
881
882
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
883

884
885
886
887
	(*callbacks_p) = malloc(sizeof(target_event_callback_t));
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
888

889
890
891
892
893
894
895
	return ERROR_OK;
}

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

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

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

909
910
911
912
	(*callbacks_p) = malloc(sizeof(target_timer_callback_t));
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
913

914
915
916
917
918
919
920
921
922
	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
923

924
925
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
926

927
928
929
930
931
932
933
	return ERROR_OK;
}

int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv)
{
	target_event_callback_t **p = &target_event_callbacks;
	target_event_callback_t *c = target_event_callbacks;
oharboe's avatar
oharboe committed
934

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

940
941
942
943
944
945
946
947
948
949
950
951
952
	while (c)
	{
		target_event_callback_t *next = c->next;
		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
953

954
955
956
957
958
959
960
	return ERROR_OK;
}

int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
{
	target_timer_callback_t **p = &target_timer_callbacks;
	target_timer_callback_t *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
961

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

967
968
969
970
971
972
973
974
975
976
977
978
979
	while (c)
	{
		target_timer_callback_t *next = c->next;
		if ((c->callback == callback) && (c->priv == priv))
		{
			*p = next;
			free(c);
			return ERROR_OK;
		}
		else
			p = &(c->next);
		c = next;
	}
oharboe's avatar
oharboe committed
980

981
982
983
984
985
986
987
	return ERROR_OK;
}

int target_call_event_callbacks(target_t *target, enum target_event event)
{
	target_event_callback_t *callback = target_event_callbacks;
	target_event_callback_t *next_callback;
oharboe's avatar
oharboe committed
988

989
990
991
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
992
		target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
993
994
	}

995
996
	LOG_DEBUG("target event %i (%s)",
			  event,
997
			  Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
oharboe's avatar
oharboe committed
998

999
	target_handle_event(target, event);
1000

1001
1002
1003
1004
1005
1006
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
1007

1008
1009
1010
	return ERROR_OK;
}

1011
1012
static int target_timer_callback_periodic_restart(
		target_timer_callback_t *cb, struct timeval *now)
1013
{
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
	int time_ms = cb->time_ms;
	cb->when.tv_usec = now->tv_usec + (time_ms % 1000) * 1000;
	time_ms -= (time_ms % 1000);
	cb->when.tv_sec = now->tv_sec + time_ms / 1000;
	if (cb->when.tv_usec > 1000000)
	{
		cb->when.tv_usec = cb->when.tv_usec - 1000000;
		cb->when.tv_sec += 1;
	}
	return ERROR_OK;
}

static int target_call_timer_callback(target_timer_callback_t *cb,
		struct timeval *now)
{
	cb->callback(cb->priv);
1030

1031
1032
1033
1034
1035
1036
1037
1038
	if (cb->periodic)
		return target_timer_callback_periodic_restart(cb, now);

	return target_unregister_timer_callback(cb->callback, cb->priv);
}

static int target_call_timer_callbacks_check_time(int checktime)
{
oharboe's avatar
   
oharboe committed
1039
1040
	keep_alive();

1041
	struct timeval now;
1042
	gettimeofday(&now, NULL);
oharboe's avatar
oharboe committed
1043

1044
	target_timer_callback_t *callback = target_timer_callbacks;
1045
1046
	while (callback)
	{
1047
1048
1049
1050
1051
1052
1053
1054
		// cleaning up may unregister and free this callback
		target_timer_callback_t *next_callback = callback->next;

		bool call_it = callback->callback &&
			((!checktime && callback->periodic) ||
			  now.tv_sec > callback->when.tv_sec ||
			 (now.tv_sec == callback->when.tv_sec &&
			  now.tv_usec >= callback->when.tv_usec));
oharboe's avatar
oharboe committed
1055

1056
		if (call_it)
1057
		{
1058
1059
1060
			int retval = target_call_timer_callback(callback, &now);
			if (retval != ERROR_OK)
				return retval;
1061
		}
oharboe's avatar
oharboe committed
1062

1063
1064
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
1065

1066
1067
1068
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
1069
int target_call_timer_callbacks(void)
1070
1071
1072
1073
1074
{
	return target_call_timer_callbacks_check_time(1);
}

/* invoke periodic callbacks immediately */
oharboe's avatar
oharboe committed
1075
int target_call_timer_callbacks_now(void)
1076
{
oharboe's avatar
   
oharboe committed
1077
	return target_call_timer_callbacks_check_time(0);
1078
1079
}

1080
int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area)
1081
1082
1083
{
	working_area_t *c = target->working_areas;
	working_area_t *new_wa = NULL;
oharboe's avatar
oharboe committed
1084

1085
1086
1087
1088
1089
	/* Reevaluate working area address based on MMU state*/
	if (target->working_areas == NULL)
	{
		int retval;
		int enabled;
1090

1091
1092
1093
1094
1095
		retval = target->type->mmu(target, &enabled);
		if (retval != ERROR_OK)
		{
			return retval;
		}
1096

1097
1098
1099
1100
1101
		if (!enabled) {
			if (target->working_area_phys_spec) {
				LOG_DEBUG("MMU disabled, using physical "
					"address for working memory 0x%08x",
					(unsigned)target->working_area_phys);
1102
				target->working_area = target->working_area_phys;
1103
1104
1105
			} else {
				LOG_ERROR("No working memory available. "
					"Specify -work-area-phys to target.");
1106
1107
				return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
			}
1108
1109
1110
1111
1112
		} else {
			if (target->working_area_virt_spec) {
				LOG_DEBUG("MMU enabled, using virtual "
					"address for working memory 0x%08x",
					(unsigned)target->working_area_virt);
1113
				target->working_area = target->working_area_virt;
1114
1115
1116
			} else {
				LOG_ERROR("No working memory available. "
					"Specify -work-area-virt to target.");
1117
1118
				return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
			}
1119
1120
		}
	}
oharboe's avatar
oharboe committed
1121

1122
1123
1124
	/* only allocate multiples of 4 byte */
	if (size % 4)
	{
duane's avatar
duane committed
1125
1126
		LOG_ERROR("BUG: code tried to allocate unaligned number of bytes (0x%08x), padding", ((unsigned)(size)));
		size = (size + 3) & (~3);
1127
	}
oharboe's avatar
oharboe committed
1128

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
	/* see if there's already a matching working area */
	while (c)
	{
		if ((c->free) && (c->size == size))
		{
			new_wa = c;
			break;
		}
		c = c->next;
	}
oharboe's avatar
oharboe committed
1139

1140
1141
1142
1143
	/* if not, allocate a new one */
	if (!new_wa)
	{
		working_area_t **p = &target->working_areas;
1144
1145
		uint32_t first_free = target->working_area;
		uint32_t free_size = target->working_area_size;
oharboe's avatar
oharboe committed
1146

1147
1148