target.c 113 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 �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
72
static int jim_array2mem(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
static int jim_mem2array(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
73
static int jim_target(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
74

75
76
77
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);

78
/* targets */
79
80
81
82
83
84
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;
85
extern target_type_t fa526_target;
86
87
88
extern target_type_t feroceon_target;
extern target_type_t xscale_target;
extern target_type_t cortexm3_target;
89
extern target_type_t cortexa8_target;
oharboe's avatar
oharboe committed
90
extern target_type_t arm11_target;
ntfreak's avatar
ntfreak committed
91
extern target_type_t mips_m4k_target;
92
extern target_type_t avr_target;
93
94
95
96
97
98
99
100
101

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

113
target_t *all_targets = NULL;
114
115
116
target_event_callback_t *target_event_callbacks = NULL;
target_timer_callback_t *target_timer_callbacks = NULL;

117
118
119
120
121
122
123
124
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 }
125
126
};

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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 }
};

142
const char *target_strerror_safe(int err)
143
144
145
{
	const Jim_Nvp *n;

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

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

158
	{ .value = TARGET_EVENT_EARLY_HALTED, .name = "early-halted" },
159
160
161
162
163
	{ .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" },

164
165
166
	{ .name = "gdb-start", .value = TARGET_EVENT_GDB_START },
	{ .name = "gdb-end", .value = TARGET_EVENT_GDB_END },

167
	/* historical name */
168

169
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
170
171
172
173
174
175
176
177
178

	{ .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" },
179
180
181
	{ .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END, .name = "reset-end" },

182
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
183
	{ .value = TARGET_EVENT_EXAMINE_END, .name = "examine-end" },
184

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

204
205
206
207
208
209
210
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 },
211
212
};

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
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 },
228
	{ .name = "le",     .value = TARGET_LITTLE_ENDIAN },
229
230
231
	{ .name = NULL,     .value = -1 },
};

232
233
234
235
236
237
238
239
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 },
};

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

252
static int max_target_number(void)
253
254
255
256
257
258
{
	target_t *t;
	int x;

	x = -1;
	t = all_targets;
zwelch's avatar
zwelch committed
259
260
	while (t) {
		if (x < t->target_number) {
zwelch's avatar
zwelch committed
261
			x = (t->target_number) + 1;
262
263
264
265
266
		}
		t = t->next;
	}
	return x;
}
267
268

/* determine the number of the new target */
269
static int new_target_number(void)
270
271
272
273
274
275
276
{
	target_t *t;
	int x;

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

zwelch's avatar
zwelch committed
286
static int target_continuous_poll = 1;
287

288
289
/* read a uint32_t from a buffer in target memory endianness */
uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer)
290
291
292
293
294
295
296
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

zwelch's avatar
zwelch committed
297
298
/* read a uint16_t from a buffer in target memory endianness */
uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer)
299
300
301
302
303
304
305
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

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

312
313
/* 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)
314
315
316
317
318
319
320
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

zwelch's avatar
zwelch committed
321
322
/* 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)
323
324
325
326
327
328
329
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

330
331
/* 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)
332
333
334
335
{
	*buffer = value;
}

336
337
338
339
340
341
342
343
344
345
346
347
348
349
/* 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;
	}

	/* no match, try as number */
350
351
	unsigned num;
	if (parse_uint(id, &num) != ERROR_OK)
352
353
354
		return NULL;

	for (target = all_targets; target; target = target->next) {
355
		if (target->target_number == (int)num)
356
357
358
359
360
361
			return target;
	}

	return NULL;
}

362
/* returns a pointer to the n-th configured target */
363
static target_t *get_target_by_num(int num)
364
{
365
	target_t *target = all_targets;
366

zwelch's avatar
zwelch committed
367
368
	while (target) {
		if (target->target_number == num) {
369
			return target;
370
		}
371
372
373
374
375
376
377
378
		target = target->next;
	}

	return NULL;
}

int get_num_by_target(target_t *query_target)
{
379
	return query_target->target_number;
380
381
382
383
384
}

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
385

386
387
	if (target == NULL)
	{
388
		LOG_ERROR("BUG: current_target out of bounds");
389
390
391
		exit(-1);
	}

oharboe's avatar
oharboe committed
392
	return target;
393
394
}

395
396
397
int target_poll(struct target_s *target)
{
	/* We can't poll until after examine */
398
	if (!target_was_examined(target))
399
400
401
402
403
404
405
406
407
408
	{
		/* Fail silently lest we pollute the log */
		return ERROR_FAIL;
	}
	return target->type->poll(target);
}

int target_halt(struct target_s *target)
{
	/* We can't poll until after examine */
409
	if (!target_was_examined(target))
410
411
412
413
414
415
416
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->halt(target);
}

417
int target_resume(struct target_s *target, int current, uint32_t address, int handle_breakpoints, int debug_execution)
418
{
419
	int retval;
oharboe's avatar
oharboe committed
420

421
	/* We can't poll until after examine */
422
	if (!target_was_examined(target))
423
424
425
426
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
427

oharboe's avatar
oharboe committed
428
429
430
431
	/* 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.
	 */
432
433
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
434

435
	return retval;
436
437
}

oharboe's avatar
oharboe committed
438
int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
439
440
{
	char buf[100];
441
	int retval;
442
	Jim_Nvp *n;
443
	n = Jim_Nvp_value2name_simple(nvp_reset_modes, reset_mode);
zwelch's avatar
zwelch committed
444
	if (n->name == NULL) {
445
446
447
448
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

449
450
451
452
	/* 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.
	 */
zwelch's avatar
zwelch committed
453
454
	int save_poll = target_continuous_poll;
	target_continuous_poll = 0;
455

456
457
	sprintf(buf, "ocd_process_reset %s", n->name);
	retval = Jim_Eval(interp, buf);
458

zwelch's avatar
zwelch committed
459
	target_continuous_poll = save_poll;
460

zwelch's avatar
zwelch committed
461
	if (retval != JIM_OK) {
462
		Jim_PrintErrorMessage(interp);
463
464
		return ERROR_FAIL;
	}
465
466

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

469
	return retval;
470
471
}

472
static int default_virt2phys(struct target_s *target, uint32_t virtual, uint32_t *physical)
473
474
475
476
477
478
479
480
481
482
483
{
	*physical = virtual;
	return ERROR_OK;
}

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

484
static int default_examine(struct target_s *target)
485
{
486
	target_set_examined(target);
487
488
489
	return ERROR_OK;
}

zwelch's avatar
zwelch committed
490
491
492
493
494
int target_examine_one(struct target_s *target)
{
	return target->type->examine(target);
}

zwelch's avatar
zwelch committed
495
496
497
498
499
500
501
502
503
504
505
506
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
507
/* Targets that correctly implement init + examine, i.e.
508
 * no communication with target during init:
oharboe's avatar
oharboe committed
509
510
 *
 * XScale
511
 */
ntfreak's avatar
ntfreak committed
512
int target_examine(void)
513
514
{
	int retval = ERROR_OK;
zwelch's avatar
zwelch committed
515
516
517
	target_t *target;

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

535
static int target_write_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
536
{
537
	if (!target_was_examined(target))
538
539
540
541
542
543
544
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->write_memory_imp(target, address, size, count, buffer);
}

545
static int target_read_memory_imp(struct target_s *target, uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
546
{
547
	if (!target_was_examined(target))
548
549
550
551
552
553
554
555
556
	{
		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)
{
557
	if (!target_was_examined(target))
558
559
560
561
562
563
564
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->soft_reset_halt_imp(target);
}

565
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)
566
{
567
	if (!target_was_examined(target))
568
569
570
571
572
573
	{
		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);
}
574

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

zwelch's avatar
zwelch committed
581
int target_write_memory(struct target_s *target,
582
		uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
583
584
585
{
	return target->type->write_memory(target, address, size, count, buffer);
}
zwelch's avatar
zwelch committed
586
int target_bulk_write_memory(struct target_s *target,
587
		uint32_t address, uint32_t count, uint8_t *buffer)
zwelch's avatar
zwelch committed
588
589
590
591
{
	return target->type->bulk_write_memory(target, address, count, buffer);
}

592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
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
613

zwelch's avatar
zwelch committed
614
615
616
617
618
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
619
int target_step(struct target_s *target,
620
		int current, uint32_t address, int handle_breakpoints)
zwelch's avatar
zwelch committed
621
622
623
624
{
	return target->type->step(target, current, address, handle_breakpoints);
}

zwelch's avatar
zwelch committed
625

zwelch's avatar
zwelch committed
626
627
628
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,
629
		uint32_t entry_point, uint32_t exit_point,
zwelch's avatar
zwelch committed
630
631
632
633
634
635
636
		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);
}

637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
/// @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
653

654
655
int target_init(struct command_context_s *cmd_ctx)
{
656
	target_t *target = all_targets;
657
	int retval;
oharboe's avatar
oharboe committed
658

659
660
	while (target)
	{
661
		target_reset_examined(target);
662
663
664
665
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
666

667
		if ((retval = target->type->init_target(cmd_ctx, target)) != ERROR_OK)
668
		{
zwelch's avatar
zwelch committed
669
			LOG_ERROR("target '%s' init failed", target_get_name(target));
670
			return retval;
671
		}
oharboe's avatar
oharboe committed
672

673
674
675
676
677
		/* Set up default functions if none are provided by target */
		if (target->type->virt2phys == NULL)
		{
			target->type->virt2phys = default_virt2phys;
		}
678
679
680
681
682
683
684
685
686
687
688
689
690
		target->type->virt2phys = default_virt2phys;
		/* 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;

691
692
693
694
695
696
		if (target->type->mmu == NULL)
		{
			target->type->mmu = default_mmu;
		}
		target = target->next;
	}
oharboe's avatar
oharboe committed
697

698
	if (all_targets)
699
	{
zwelch's avatar
zwelch committed
700
		if ((retval = target_register_user_commands(cmd_ctx)) != ERROR_OK)
701
			return retval;
zwelch's avatar
zwelch committed
702
		if ((retval = target_register_timer_callback(handle_target, 100, 1, NULL)) != ERROR_OK)
703
			return retval;
704
	}
oharboe's avatar
oharboe committed
705

706
707
708
709
710
711
	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
712

713
714
715
716
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
717

718
719
720
721
722
723
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
724

725
726
727
728
	(*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
729

730
731
732
733
734
735
736
	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
737

738
739
740
741
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
742

743
744
745
746
747
748
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
749

750
751
752
753
	(*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
754

755
756
757
758
759
760
761
762
763
	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
764

765
766
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
767

768
769
770
771
772
773
774
	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
775

776
777
778
779
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
780

781
782
783
784
785
786
787
788
789
790
791
792
793
	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
794

795
796
797
798
799
800
801
	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
802

803
804
805
806
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
807

808
809
810
811
812
813
814
815
816
817
818
819
820
	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
821

822
823
824
825
826
827
828
	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
829

830
831
832
833
834
835
	if (event == TARGET_EVENT_HALTED)
	{
		/* execute early halted first */
		target_call_event_callbacks(target, TARGET_EVENT_EARLY_HALTED);
	}

836
837
	LOG_DEBUG("target event %i (%s)",
			  event,
838
			  Jim_Nvp_value2name_simple(nvp_target_event, event)->name);
oharboe's avatar
oharboe committed
839

840
	target_handle_event(target, event);
841

842
843
844
845
846
847
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
848

849
850
851
	return ERROR_OK;
}

852
853
static int target_timer_callback_periodic_restart(
		target_timer_callback_t *cb, struct timeval *now)
854
{
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
	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);
871

872
873
874
875
876
877
878
879
	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
880
881
	keep_alive();

882
	struct timeval now;
883
	gettimeofday(&now, NULL);
oharboe's avatar
oharboe committed
884

885
	target_timer_callback_t *callback = target_timer_callbacks;
886
887
	while (callback)
	{
888
889
890
891
892
893
894
895
		// 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
896

897
		if (call_it)
898
		{
899
900
901
			int retval = target_call_timer_callback(callback, &now);
			if (retval != ERROR_OK)
				return retval;
902
		}
oharboe's avatar
oharboe committed
903

904
905
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
906

907
908
909
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
910
int target_call_timer_callbacks(void)
911
912
913
914
915
{
	return target_call_timer_callbacks_check_time(1);
}

/* invoke periodic callbacks immediately */
oharboe's avatar
oharboe committed
916
int target_call_timer_callbacks_now(void)
917
{
oharboe's avatar
   
oharboe committed
918
	return target_call_timer_callbacks_check_time(0);
919
920
}

921
int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area)
922
923
924
{
	working_area_t *c = target->working_areas;
	working_area_t *new_wa = NULL;
oharboe's avatar
oharboe committed
925

926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
	/* Reevaluate working area address based on MMU state*/
	if (target->working_areas == NULL)
	{
		int retval;
		int enabled;
		retval = target->type->mmu(target, &enabled);
		if (retval != ERROR_OK)
		{
			return retval;
		}
		if (enabled)
		{
			target->working_area = target->working_area_virt;
		}
		else
		{
			target->working_area = target->working_area_phys;
		}
	}
oharboe's avatar
oharboe committed
945

946
947
948
	/* only allocate multiples of 4 byte */
	if (size % 4)
	{
duane's avatar
duane committed
949
950
		LOG_ERROR("BUG: code tried to allocate unaligned number of bytes (0x%08x), padding", ((unsigned)(size)));
		size = (size + 3) & (~3);
951
	}
oharboe's avatar
oharboe committed
952

953
954
955
956
957
958
959
960
961
962
	/* 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
963

964
965
966
967
	/* if not, allocate a new one */
	if (!new_wa)
	{
		working_area_t **p = &target->working_areas;
968
969
		uint32_t first_free = target->working_area;
		uint32_t free_size = target->working_area_size;
oharboe's avatar
oharboe committed
970

971
		LOG_DEBUG("allocating new working area");
oharboe's avatar
oharboe committed
972

973
974
975
976
977
978
979
980
		c = target->working_areas;
		while (c)
		{
			first_free += c->size;
			free_size -= c->size;
			p = &c->next;
			c = c->next;
		}
oharboe's avatar
oharboe committed
981

982
983
		if (free_size < size)
		{
984
			LOG_WARNING("not enough working area available(requested %u, free %u)",
duane's avatar
duane committed
985
				    (unsigned)(size), (unsigned)(free_size));
986
987
			return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
		}
oharboe's avatar
oharboe committed
988

989
990
991
992
		new_wa = malloc(sizeof(working_area_t));
		new_wa->next = NULL;
		new_wa->size = size;
		new_wa->address = first_free;
oharboe's avatar
oharboe committed
993

994
995
		if (target->backup_working_area)
		{
996
			int retval;
997
			new_wa->backup = malloc(new_wa->size);
zwelch's avatar
zwelch committed
998
			if ((retval = target_read_memory(target, new_wa->address, 4, new_wa->size / 4, new_wa->backup)) != ERROR_OK)
999
1000
1001
1002
1003
			{
				free(new_wa->backup);
				free(new_wa);
				return retval;
			}
1004
1005
1006
1007
1008
		}
		else
		{
			new_wa->backup = NULL;
		}
oharboe's avatar
oharboe committed
1009

1010
1011
1012
		/* put new entry in list */
		*p = new_wa;
	}
oharboe's avatar
oharboe committed
1013

1014
1015
1016
	/* mark as used, and return the new (reused) area */
	new_wa->free = 0;
	*area = new_wa;
oharboe's avatar
oharboe committed
1017

1018
1019
	/* user pointer */
	new_wa->user = area;
oharboe's avatar
oharboe committed
1020

1021
1022
1023
	return ERROR_OK;
}

oharboe's avatar
   
oharboe committed
1024
int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore)
1025
1026
1027
{
	if (area->free)
		return ERROR_OK;
oharboe's avatar
oharboe committed
1028

zwelch's avatar
zwelch committed
1029
	if (restore && target->backup_working_area)
1030
1031
	{
		int retval;
zwelch's avatar
zwelch committed
1032
		if ((retval = target_write_memory(target, area->address, 4, area->size / 4, area->backup)) != ERROR_OK)
1033
1034
			return retval;
	}
oharboe's avatar
oharboe committed
1035

1036
	area->free = 1;
oharboe's avatar
oharboe committed
1037

1038
1039
1040
	/* mark user pointer invalid */
	*area->user = NULL;
	area->user = NULL;
oharboe's avatar
oharboe committed
1041

1042
1043
1044
	return ERROR_OK;
}

oharboe's avatar
   
oharboe committed
1045
1046
1047
1048
1049
int target_free_working_area(struct target_s *target, working_area_t *area)
{
	return target_free_working_area_restore(target, area, 1);
}

1050
1051
1052
1053
/* free resources and restore memory, if restoring memory fails,
 * free up resources anyway
 */
void target_free_all_working_areas_restore(struct target_s *target, int restore)
1054
1055
1056
1057
1058
1059
{
	working_area_t *c = target->working_areas;

	while (c)
	{
		working_area_t *next = c->next;
oharboe's avatar
   
oharboe committed
1060
		target_free_working_area_restore(target, c, restore);
oharboe's avatar
oharboe committed
1061

1062
1063
		if (c->backup)
			free(c->backup);
oharboe's avatar
oharboe committed
1064

1065
		free(c);
oharboe's avatar
oharboe committed
1066

1067
1068
		c = next;
	}
oharboe's avatar
oharboe committed
1069

1070
1071
1072
	target->working_areas = NULL;
}

1073
void target_free_all_working_areas(struct target_s *target)
oharboe's avatar
   
oharboe committed
1074
{
1075
	target_free_all_working_areas_restore(target, 1);
oharboe's avatar
   
oharboe committed
1076
1077
}

1078
1079
int target_register_commands(struct command_context_s *cmd_ctx)
{
1080

oharboe's avatar
oharboe committed
1081
	register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, "change the current command line target (one parameter) or lists targets (with no parameter)");
1082

1083
1084
1085



1086
	register_jim(cmd_ctx, "target", jim_target, "configure target");
1087

1088
1089
1090
1091
1092
1093
	return ERROR_OK;
}

int target_arch_state(struct target_s *target)
{
	int retval;
zwelch's avatar
zwelch committed
1094
	if (target == NULL)
1095
	{
1096
		LOG_USER("No target has been configured");
1097
1098
		return ERROR_OK;
	}
oharboe's avatar
oharboe committed
1099

1100
	LOG_USER("target state: %s", target_state_name( target ));