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
#include "breakpoints.h"
40
41
42
43
#include "time_support.h"
#include "register.h"
#include "trace.h"
#include "image.h"
44
45
46
#include "jtag.h"


47
static int jim_mcrmrc(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
48

Zachary T Welch's avatar
Zachary T Welch committed
49
50
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);
51

52
/* targets */
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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;
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;
Zachary T Welch's avatar
Zachary T Welch committed
68
extern struct target_type testee_target;
69
70

struct target_type *target_types[] =
71
72
73
74
75
76
77
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
	&arm926ejs_target,
78
	&fa526_target,
79
	&feroceon_target,
80
	&dragonite_target,
81
82
	&xscale_target,
	&cortexm3_target,
83
	&cortexa8_target,
oharboe's avatar
oharboe committed
84
	&arm11_target,
ntfreak's avatar
ntfreak committed
85
	&mips_m4k_target,
86
	&avr_target,
Zachary T Welch's avatar
Zachary T Welch committed
87
	&testee_target,
88
89
90
	NULL,
};

Zachary T Welch's avatar
Zachary T Welch committed
91
struct target *all_targets = NULL;
92
struct target_event_callback *target_event_callbacks = NULL;
93
struct target_timer_callback *target_timer_callbacks = NULL;
94

95
96
97
98
99
100
101
102
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 }
103
104
};

105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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 }
};

120
const char *target_strerror_safe(int err)
121
122
123
{
	const Jim_Nvp *n;

124
	n = Jim_Nvp_value2name_simple(nvp_error_target, err);
zwelch's avatar
zwelch committed
125
	if (n->name == NULL) {
126
127
128
129
130
131
		return "unknown";
	} else {
		return n->name;
	}
}

132
static const Jim_Nvp nvp_target_event[] = {
133
134
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
135

136
	{ .value = TARGET_EVENT_GDB_HALT, .name = "gdb-halt" },
137
138
139
140
141
	{ .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" },

142
143
144
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

145
	/* historical name */
146

147
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
148
149

	{ .value = TARGET_EVENT_RESET_ASSERT_PRE,    .name = "reset-assert-pre" },
150
	{ .value = TARGET_EVENT_RESET_ASSERT,        .name = "reset-assert" },
151
152
153
154
155
156
157
	{ .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" },
158
159
	{ .value = TARGET_EVENT_RESET_INIT,          .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END,           .name = "reset-end" },
160

161
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
162
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
163

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
	{ .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 }
181
182
};

183
184
185
186
187
188
189
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 },
190
191
};

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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 },
207
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
208
209
210
	{ .name = NULL,     .value = -1 },
};

211
212
213
214
215
216
217
218
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 },
};

219
const char *
Zachary T Welch's avatar
Zachary T Welch committed
220
target_state_name( struct target *t )
221
222
223
224
225
226
227
228
229
230
{
	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;
}

231
/* determine the number of the new target */
232
static int new_target_number(void)
233
{
Zachary T Welch's avatar
Zachary T Welch committed
234
	struct target *t;
235
236
237
238
239
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
240
241
	while (t) {
		if (x < t->target_number) {
242
243
244
245
			x = t->target_number;
		}
		t = t->next;
	}
zwelch's avatar
zwelch committed
246
	return x + 1;
247
248
}

249
/* read a uint32_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
250
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer)
251
252
253
254
255
256
257
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

zwelch's avatar
zwelch committed
258
/* read a uint16_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
259
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer)
260
261
262
263
264
265
266
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

267
/* read a uint8_t from a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
268
uint8_t target_buffer_get_u8(struct target *target, const uint8_t *buffer)
269
270
271
272
{
	return *buffer & 0x0ff;
}

273
/* write a uint32_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
274
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value)
275
276
277
278
279
280
281
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
282
/* write a uint16_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
283
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value)
284
285
286
287
288
289
290
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

291
/* write a uint8_t to a buffer in target memory endianness */
Zachary T Welch's avatar
Zachary T Welch committed
292
void target_buffer_set_u8(struct target *target, uint8_t *buffer, uint8_t value)
293
294
295
296
{
	*buffer = value;
}

297
/* return a pointer to a configured target; id is name or number */
Zachary T Welch's avatar
Zachary T Welch committed
298
struct target *get_target(const char *id)
299
{
Zachary T Welch's avatar
Zachary T Welch committed
300
	struct target *target;
301
302
303
304
305
306
307
308
309

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

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

312
	/* no match, try as number */
313
314
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
315
316
317
		return NULL;

	for (target = all_targets; target; target = target->next) {
318
319
320
		if (target->target_number == (int)num) {
			LOG_WARNING("use '%s' as target identifier, not '%u'",
					target->cmd_name, num);
321
			return target;
322
		}
323
324
325
326
327
	}

	return NULL;
}

328
/* returns a pointer to the n-th configured target */
Zachary T Welch's avatar
Zachary T Welch committed
329
static struct target *get_target_by_num(int num)
330
{
Zachary T Welch's avatar
Zachary T Welch committed
331
	struct target *target = all_targets;
332

zwelch's avatar
zwelch committed
333
334
	while (target) {
		if (target->target_number == num) {
335
			return target;
336
		}
337
338
339
340
341
342
		target = target->next;
	}

	return NULL;
}

343
struct target* get_current_target(struct command_context *cmd_ctx)
344
{
Zachary T Welch's avatar
Zachary T Welch committed
345
	struct target *target = get_target_by_num(cmd_ctx->current_target);
oharboe's avatar
oharboe committed
346

347
348
	if (target == NULL)
	{
349
		LOG_ERROR("BUG: current_target out of bounds");
350
351
352
		exit(-1);
	}

oharboe's avatar
oharboe committed
353
	return target;
354
355
}

Zachary T Welch's avatar
Zachary T Welch committed
356
int target_poll(struct target *target)
357
{
358
359
	int retval;

360
	/* We can't poll until after examine */
361
	if (!target_was_examined(target))
362
363
364
365
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388

	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;
389
390
}

Zachary T Welch's avatar
Zachary T Welch committed
391
int target_halt(struct target *target)
392
{
393
	int retval;
394
	/* We can't poll until after examine */
395
	if (!target_was_examined(target))
396
397
398
399
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
400
401
402
403
404
405
406
407
408

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

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

	return ERROR_OK;
409
410
}

Zachary T Welch's avatar
Zachary T Welch committed
411
int target_resume(struct target *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
412
{
413
	int retval;
oharboe's avatar
oharboe committed
414

415
	/* We can't poll until after examine */
416
	if (!target_was_examined(target))
417
418
419
420
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
421

oharboe's avatar
oharboe committed
422
423
424
425
	/* 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.
	 */
426
427
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
428

429
	return retval;
430
431
}

432
int target_process_reset(struct command_context *cmd_ctx, enum target_reset_mode reset_mode)
433
434
{
	char buf[100];
435
	int retval;
436
	Jim_Nvp *n;
437
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
438
	if (n->name == NULL) {
439
440
441
442
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

443
444
445
446
	/* 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.
	 */
447
448
449
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
450

451
452
	sprintf(buf, "ocd_process_reset %s", n->name);
	retval = Jim_Eval(interp, buf);
453

454
	jtag_poll_set_enabled(save_poll);
455

zwelch's avatar
zwelch committed
456
	if (retval != JIM_OK) {
457
		Jim_PrintErrorMessage(interp);
458
459
		return ERROR_FAIL;
	}
460
461

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

464
	return retval;
465
466
}

Zachary T Welch's avatar
Zachary T Welch committed
467
static int identity_virt2phys(struct target *target,
David Brownell's avatar
David Brownell committed
468
		uint32_t virtual, uint32_t *physical)
469
470
471
472
473
{
	*physical = virtual;
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
474
static int no_mmu(struct target *target, int *enabled)
475
{
476
	*enabled = 0;
477
478
479
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
480
static int default_examine(struct target *target)
481
{
482
	target_set_examined(target);
483
484
485
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
486
int target_examine_one(struct target *target)
zwelch's avatar
zwelch committed
487
488
489
490
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
491
492
static int jtag_enable_callback(enum jtag_event event, void *priv)
{
Zachary T Welch's avatar
Zachary T Welch committed
493
	struct target *target = priv;
zwelch's avatar
zwelch committed
494
495
496
497
498
499
500
501
502

	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
503
/* Targets that correctly implement init + examine, i.e.
504
 * no communication with target during init:
oharboe's avatar
oharboe committed
505
506
 *
 * XScale
507
 */
ntfreak's avatar
ntfreak committed
508
int target_examine(void)
509
510
{
	int retval = ERROR_OK;
Zachary T Welch's avatar
Zachary T Welch committed
511
	struct target *target;
zwelch's avatar
zwelch committed
512
513

	for (target = all_targets; target; target = target->next)
514
	{
zwelch's avatar
zwelch committed
515
516
517
518
		/* defer examination, but don't skip it */
		if (!target->tap->enabled) {
			jtag_register_event_callback(jtag_enable_callback,
					target);
zwelch's avatar
zwelch committed
519
			continue;
zwelch's avatar
zwelch committed
520
		}
zwelch's avatar
zwelch committed
521
		if ((retval = target_examine_one(target)) != ERROR_OK)
522
523
524
525
			return retval;
	}
	return retval;
}
526
const char *target_type_name(struct target *target)
zwelch's avatar
zwelch committed
527
528
529
{
	return target->type->name;
}
530

Zachary T Welch's avatar
Zachary T Welch committed
531
static int target_write_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
532
{
533
	if (!target_was_examined(target))
534
535
536
537
538
539
540
	{
		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
541
static int target_read_memory_imp(struct target *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
542
{
543
	if (!target_was_examined(target))
544
545
546
547
548
549
550
	{
		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
551
static int target_soft_reset_halt_imp(struct target *target)
552
{
553
	if (!target_was_examined(target))
554
555
556
557
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
558
559
	if (!target->type->soft_reset_halt_imp) {
		LOG_ERROR("Target %s does not support soft_reset_halt",
560
				target_name(target));
561
562
		return ERROR_FAIL;
	}
563
564
565
	return target->type->soft_reset_halt_imp(target);
}

Zachary T Welch's avatar
Zachary T Welch committed
566
static int target_run_algorithm_imp(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)
567
{
568
	if (!target_was_examined(target))
569
570
571
572
573
574
	{
		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);
}
575

Zachary T Welch's avatar
Zachary T Welch committed
576
int target_read_memory(struct target *target,
577
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
578
579
580
581
{
	return target->type->read_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
582
int target_read_phys_memory(struct target *target,
583
584
585
586
587
		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
588
int target_write_memory(struct target *target,
589
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
590
591
592
{
	return target->type->write_memory(target, address, size, count, buffer);
}
593

Zachary T Welch's avatar
Zachary T Welch committed
594
int target_write_phys_memory(struct target *target,
595
596
597
598
599
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
{
	return target->type->write_phys_memory(target, address, size, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
600
int target_bulk_write_memory(struct target *target,
601
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
602
603
604
605
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

Zachary T Welch's avatar
Zachary T Welch committed
606
int target_add_breakpoint(struct target *target,
607
		struct breakpoint *breakpoint)
608
609
610
{
	return target->type->add_breakpoint(target, breakpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
611
int target_remove_breakpoint(struct target *target,
612
		struct breakpoint *breakpoint)
613
614
615
616
{
	return target->type->remove_breakpoint(target, breakpoint);
}

Zachary T Welch's avatar
Zachary T Welch committed
617
int target_add_watchpoint(struct target *target,
618
		struct watchpoint *watchpoint)
619
620
621
{
	return target->type->add_watchpoint(target, watchpoint);
}
Zachary T Welch's avatar
Zachary T Welch committed
622
int target_remove_watchpoint(struct target *target,
623
		struct watchpoint *watchpoint)
624
625
626
{
	return target->type->remove_watchpoint(target, watchpoint);
}
zwelch's avatar
zwelch committed
627

Zachary T Welch's avatar
Zachary T Welch committed
628
int target_get_gdb_reg_list(struct target *target,
Zachary T Welch's avatar
Zachary T Welch committed
629
		struct reg **reg_list[], int *reg_list_size)
zwelch's avatar
zwelch committed
630
631
632
{
	return target->type->get_gdb_reg_list(target, reg_list, reg_list_size);
}
Zachary T Welch's avatar
Zachary T Welch committed
633
int target_step(struct target *target,
634
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
635
636
637
638
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
639

Zachary T Welch's avatar
Zachary T Welch committed
640
int target_run_algorithm(struct target *target,
641
		int num_mem_params, struct mem_param *mem_params,
642
		int num_reg_params, struct reg_param *reg_param,
643
		uint32_t entry_point, uint32_t exit_point,
zwelch's avatar
zwelch committed
644
645
646
647
648
649
650
		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);
}

651
652
653
654
655
/**
 * Reset the @c examined flag for the given target.
 * Pure paranoia -- targets are zeroed on allocation.
 */
static void target_reset_examined(struct target *target)
656
{
657
	target->examined = false;
658
659
}

zwelch's avatar
zwelch committed
660

661

Zachary T Welch's avatar
Zachary T Welch committed
662
static int default_mrc(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
663
{
664
	LOG_ERROR("Not implemented: %s", __func__);
665
666
667
	return ERROR_FAIL;
}

Zachary T Welch's avatar
Zachary T Welch committed
668
static int default_mcr(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
669
{
670
	LOG_ERROR("Not implemented: %s", __func__);
671
672
673
	return ERROR_FAIL;
}

Zachary T Welch's avatar
Zachary T Welch committed
674
static int arm_cp_check(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
675
676
677
678
679
680
681
682
683
684
685
686
687
688
{
	/* 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;
	}

689
	if (op1 > 7)
690
691
692
693
694
	{
		LOG_ERROR("Illegal op1");
		return ERROR_FAIL;
	}

695
	if (op2 > 7)
696
697
698
699
700
	{
		LOG_ERROR("Illegal op2");
		return ERROR_FAIL;
	}

701
	if (CRn > 15)
702
703
704
705
706
	{
		LOG_ERROR("Illegal CRn");
		return ERROR_FAIL;
	}

707
	if (CRm > 15)
708
709
710
711
712
	{
		LOG_ERROR("Illegal CRm");
		return ERROR_FAIL;
	}

713
714
715
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
716
int target_mrc(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
717
718
719
720
721
722
723
724
725
726
{
	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);
}

Zachary T Welch's avatar
Zachary T Welch committed
727
int target_mcr(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
728
729
730
731
732
733
734
735
736
737
{
	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);
}

738
static int
Zachary T Welch's avatar
Zachary T Welch committed
739
err_read_phys_memory(struct target *target, uint32_t address,
740
		uint32_t size, uint32_t count, uint8_t *buffer)
741
{
742
	LOG_ERROR("Not implemented: %s", __func__);
743
	return ERROR_FAIL;
744
745
}

746
static int
Zachary T Welch's avatar
Zachary T Welch committed
747
err_write_phys_memory(struct target *target, uint32_t address,
748
		uint32_t size, uint32_t count, uint8_t *buffer)
749
{
750
	LOG_ERROR("Not implemented: %s", __func__);
751
	return ERROR_FAIL;
752
753
}

754
int target_init(struct command_context *cmd_ctx)
755
{
Zachary T Welch's avatar
Zachary T Welch committed
756
	struct target *target;
757
	int retval;
oharboe's avatar
oharboe committed
758

759
	for (target = all_targets; target; target = target->next) {
760
		struct target_type *type = target->type;
761

762
		target_reset_examined(target);
763
764
765
766
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
767

768
		if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
769
		{
770
			LOG_ERROR("target '%s' init failed", target_name(target));
771
			return retval;
772
		}
oharboe's avatar
oharboe committed
773

David Brownell's avatar
David Brownell committed
774
775
776
777
		/**
		 * @todo MCR/MRC are ARM-specific; don't require them in
		 * all targets, or for ARMs without coprocessors.
		 */
778
779
780
		if (target->type->mcr == NULL)
		{
			target->type->mcr = default_mcr;
781
782
		} else
		{
783
784
785
786
787
788
789
790
			const struct command_registration mcr_cmd = {
				.name = "mcr",
				.mode = COMMAND_EXEC,
				.jim_handler = &jim_mcrmrc,
				.help = "write coprocessor",
				.usage = "<cpnum> <op1> <op2> <CRn> <CRm> <value>",
			};
			register_command(cmd_ctx, NULL, &mcr_cmd);
791
792
793
794
795
		}

		if (target->type->mrc == NULL)
		{
			target->type->mrc = default_mrc;
796
797
		} else
		{
798
799
800
801
802
803
804
			const struct command_registration mrc_cmd = {
				.name = "mrc",
				.jim_handler = &jim_mcrmrc,
				.help = "read coprocessor",
				.usage = "<cpnum> <op1> <op2> <CRn> <CRm>",
			};
			register_command(cmd_ctx, NULL, &mrc_cmd);
805
806
807
		}


David Brownell's avatar
David Brownell committed
808
809
810
811
812
813
		/**
		 * @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.
		 */

814
815
816
817
818
819
820
821
822
823
824
825
		/* 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;

826
827
828
829
830
831
832
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
859
860
861
862
863
		/* Sanity-check MMU support ... stub in what we must, to help
		 * implement it in stages, but warn if we need to do so.
		 */
		if (type->mmu) {
			if (type->write_phys_memory == NULL) {
				LOG_ERROR("type '%s' is missing %s",
						type->name,
						"write_phys_memory");
				type->write_phys_memory = err_write_phys_memory;
			}
			if (type->read_phys_memory == NULL) {
				LOG_ERROR("type '%s' is missing %s",
						type->name,
						"read_phys_memory");
				type->read_phys_memory = err_read_phys_memory;
			}
			if (type->virt2phys == NULL) {
				LOG_ERROR("type '%s' is missing %s",
						type->name,
						"virt2phys");
				type->virt2phys = identity_virt2phys;
			}

		/* 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.
		 */
		} else {
			if (type->write_phys_memory
					|| type->read_phys_memory
					|| type->virt2phys)
				LOG_WARNING("type '%s' has broken MMU hooks",
						type->name);

			type->mmu = no_mmu;
			type->write_phys_memory = type->write_memory;
			type->read_phys_memory = type->read_memory;
			type->virt2phys = identity_virt2phys;
864
865
		}
	}
oharboe's avatar
oharboe committed
866

867
	if (all_targets)
868
	{
zwelch's avatar
zwelch committed
869
		if ((retval = target_register_user_commands(cmd_ctx)) != ERROR_OK)
870
			return retval;
zwelch's avatar
zwelch committed
871
		if ((retval = target_register_timer_callback(handle_target, 100, 1, NULL)) != ERROR_OK)
872
			return retval;
873
	}
oharboe's avatar
oharboe committed
874

875
876
877
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
878
int target_register_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
879
{
880
	struct target_event_callback **callbacks_p = &target_event_callbacks;
oharboe's avatar
oharboe committed
881

882
883
884
885
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
886

887
888
889
890
891
892
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
893

894
	(*callbacks_p) = malloc(sizeof(struct target_event_callback));
895
896
897
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
898

899
900
901
902
903
	return ERROR_OK;
}

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

907
908
909
910
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
911

912
913
914
915
916
917
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
918

919
	(*callbacks_p) = malloc(sizeof(struct target_timer_callback));
920
921
922
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
923

924
925
926
927
928
929
930
931
932
	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
933

934
935
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
936

937
938
939
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
940
int target_unregister_event_callback(int (*callback)(struct target *target, enum target_event event, void *priv), void *priv)
941
{
942
943
	struct target_event_callback **p = &target_event_callbacks;
	struct target_event_callback *c = target_event_callbacks;
oharboe's avatar
oharboe committed
944

945
946
947
948
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
949

950
951
	while (c)
	{
952
		struct target_event_callback *next = c->next;
953
954
955
956
957
958
959
960
961
962
		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
963

964
965
966
967
968
	return ERROR_OK;
}

int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
{
969
970
	struct target_timer_callback **p = &target_timer_callbacks;
	struct target_timer_callback *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
971

972
973
974
975
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
976

977
978
	while (c)
	{
979
		struct target_timer_callback *next = c->next;
980
981
982
983
984
985
986
987
988
989
		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
990

991
992
993
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
994
int target_call_event_callbacks(struct target *target, enum target_event event)
995
{
996
997
	struct target_event_callback *callback = target_event_callbacks;
	struct target_event_callback *next_callback;
oharboe's avatar
oharboe committed
998

999
1000
1001
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
1002
		target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1003
1004
	}

1005
1006
	LOG_DEBUG("target event %i (%s)",
			  event,
1007
			  Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
oharboe's avatar
oharboe committed
1008

1009
	target_handle_event(target, event);
1010

1011
1012
1013
1014
1015
1016
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}