target.c 119 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
68
69
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;

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

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

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

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

118
const char *target_strerror_safe(int err)
119
120
121
{
	const Jim_Nvp *n;

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

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

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

140
141
142
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

143
	/* historical name */
144

145
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
146
147
148
149
150
151
152
153
154

	{ .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" },
155
156
157
	{ .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END, .name = "reset-end" },

158
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
159
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
160

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

180
181
182
183
184
185
186
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 },
187
188
};

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

208
209
210
211
212
213
214
215
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 },
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	return NULL;
}

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

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

	return NULL;
}

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

344
345
	if (target == NULL)
	{
346
		LOG_ERROR("BUG: current_target out of bounds");
347
348
349
		exit(-1);
	}

oharboe's avatar
oharboe committed
350
	return target;
351
352
}

Zachary T Welch's avatar
Zachary T Welch committed
353
int target_poll(struct target *target)
354
{
355
356
	int retval;

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

	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;
386
387
}

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

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

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

	return ERROR_OK;
406
407
}

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

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

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

426
	return retval;
427
428
}

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

440
441
442
443
	/* 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.
	 */
444
445
446
	bool save_poll = jtag_poll_get_enabled();

	jtag_poll_set_enabled(false);
447

448
449
	sprintf(buf, "ocd_process_reset %s", n->name);
	retval = Jim_Eval(interp, buf);
450

451
	jtag_poll_set_enabled(save_poll);
452

zwelch's avatar
zwelch committed
453
	if (retval != JIM_OK) {
454
		Jim_PrintErrorMessage(interp);
455
456
		return ERROR_FAIL;
	}
457
458

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

461
	return retval;
462
463
}

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

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

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

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

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

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

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

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

Zachary T Welch's avatar
Zachary T Welch committed
563
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)
564
{
565
	if (!target_was_examined(target))
566
567
568
569
570
571
	{
		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);
}
572

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

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

Zachary T Welch's avatar
Zachary T Welch committed
591
int target_write_phys_memory(struct target *target,
592
593
594
595
596
		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
597
int target_bulk_write_memory(struct target *target,
598
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
599
600
601
602
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

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

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

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

zwelch's avatar
zwelch committed
636

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

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

zwelch's avatar
zwelch committed
657

658

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

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

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

686
	if (op1 > 7)
687
688
689
690
691
	{
		LOG_ERROR("Illegal op1");
		return ERROR_FAIL;
	}

692
	if (op2 > 7)
693
694
695
696
697
	{
		LOG_ERROR("Illegal op2");
		return ERROR_FAIL;
	}

698
	if (CRn > 15)
699
700
701
702
703
	{
		LOG_ERROR("Illegal CRn");
		return ERROR_FAIL;
	}

704
	if (CRm > 15)
705
706
707
708
709
	{
		LOG_ERROR("Illegal CRm");
		return ERROR_FAIL;
	}

710
711
712
	return ERROR_OK;
}

Zachary T Welch's avatar
Zachary T Welch committed
713
int target_mrc(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t *value)
714
715
716
717
718
719
720
721
722
723
{
	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
724
int target_mcr(struct target *target, int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm, uint32_t value)
725
726
727
728
729
730
731
732
733
734
{
	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);
}

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

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

751
int target_init(struct command_context *cmd_ctx)
752
{
Zachary T Welch's avatar
Zachary T Welch committed
753
	struct target *target;
754
	int retval;
oharboe's avatar
oharboe committed
755

756
	for (target = all_targets; target; target = target->next) {
757
		struct target_type *type = target->type;
758

759
		target_reset_examined(target);
760
761
762
763
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
764

765
		if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
766
		{
zwelch's avatar
zwelch committed
767
			LOG_ERROR("target '%s' init failed", target_get_name(target));
768
			return retval;
769
		}
oharboe's avatar
oharboe committed
770

David Brownell's avatar
David Brownell committed
771
772
773
774
		/**
		 * @todo MCR/MRC are ARM-specific; don't require them in
		 * all targets, or for ARMs without coprocessors.
		 */
775
776
777
		if (target->type->mcr == NULL)
		{
			target->type->mcr = default_mcr;
778
779
		} else
		{
780
781
782
783
784
785
786
787
			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);
788
789
790
791
792
		}

		if (target->type->mrc == NULL)
		{
			target->type->mrc = default_mrc;
793
794
		} else
		{
795
796
797
798
799
800
801
			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);
802
803
804
		}


David Brownell's avatar
David Brownell committed
805
806
807
808
809
810
		/**
		 * @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.
		 */

811
812
813
814
815
816
817
818
819
820
821
822
		/* 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;

823
824
825
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
		/* 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;
861
862
		}
	}
oharboe's avatar
oharboe committed
863

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

872
873
874
	return ERROR_OK;
}

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

879
880
881
882
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
883

884
885
886
887
888
889
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
890

891
	(*callbacks_p) = malloc(sizeof(struct target_event_callback));
892
893
894
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
895

896
897
898
899
900
	return ERROR_OK;
}

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

904
905
906
907
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
908

909
910
911
912
913
914
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
915

916
	(*callbacks_p) = malloc(sizeof(struct target_timer_callback));
917
918
919
	(*callbacks_p)->callback = callback;
	(*callbacks_p)->periodic = periodic;
	(*callbacks_p)->time_ms = time_ms;
oharboe's avatar
oharboe committed
920

921
922
923
924
925
926
927
928
929
	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
930

931
932
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
933

934
935
936
	return ERROR_OK;
}

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

942
943
944
945
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
946

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

961
962
963
964
965
	return ERROR_OK;
}

int target_unregister_timer_callback(int (*callback)(void *priv), void *priv)
{
966
967
	struct target_timer_callback **p = &target_timer_callbacks;
	struct target_timer_callback *c = target_timer_callbacks;
oharboe's avatar
oharboe committed
968

969
970
971
972
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
973

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

988
989
990
	return ERROR_OK;
}

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

996
997
998
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
999
		target_call_event_callbacks(target, TARGET_EVENT_GDB_HALT);
1000
1001
	}

1002
1003
	LOG_DEBUG("target event %i (%s)",
			  event,
1004
			  Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
oharboe's avatar
oharboe committed
1005

1006
	target_handle_event(target, event);
1007

1008
1009
1010
1011
1012
1013
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
1014

1015
1016
1017
	return ERROR_OK;
}

1018
static int target_timer_callback_periodic_restart(
1019
		struct target_timer_callback *cb, struct timeval *now)
1020
{
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
	int time_ms = cb->time_ms;
	cb->when.tv_usec = now->tv_usec