target.c 100 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
6
7
 *   Copyright (C) 2007,2008 yvind Harboe                                      *
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008, Duane Ellis                                       *
 *   openocd@duaneeellis.com                                               *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 *   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 "replacements.h"
#include "target.h"
#include "target_request.h"

#include "log.h"
#include "configuration.h"
#include "binarybuffer.h"
#include "jtag.h"

#include <string.h>
#include <stdlib.h>
#include <inttypes.h>

#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <errno.h>

#include <sys/time.h>
#include <time.h>

#include <time_support.h>

#include <fileio.h>
#include <image.h>

56
57
static int USE_OLD_RESET = 0; // temp

58
59
int cli_target_callback_event_handler(struct target_s *target, enum target_event event, void *priv);

60

61
62
63
64
65
66
67
68
int handle_targets_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

int handle_working_area_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);

int handle_reg_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_poll_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_wait_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
69
int handle_NEWreset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
70
71
72
73
74
75
76
77
78
79
80
81
82
83
int handle_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_soft_reset_halt_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_resume_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_step_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_md_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_mw_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_load_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_dump_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_verify_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_bp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_rbp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_wp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_rwp_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
int handle_virt2phys_command(command_context_t *cmd_ctx, char *cmd, char **args, int argc);
84
int handle_profile_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
85
86
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);
87
static int jim_target( Jim_Interp *interp, int argc, Jim_Obj *const *argv);
88

89
90
91
92
93
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);



94
/* targets */
95
96
97
98
99
100
101
102
103
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;
extern target_type_t feroceon_target;
extern target_type_t xscale_target;
extern target_type_t cortexm3_target;
oharboe's avatar
oharboe committed
104
extern target_type_t arm11_target;
ntfreak's avatar
ntfreak committed
105
extern target_type_t mips_m4k_target;
106
107
108
109
110
111
112
113
114
115
116
117

target_type_t *target_types[] =
{
	&arm7tdmi_target,
	&arm9tdmi_target,
	&arm920t_target,
	&arm720t_target,
	&arm966e_target,
	&arm926ejs_target,
	&feroceon_target,
	&xscale_target,
	&cortexm3_target,
oharboe's avatar
oharboe committed
118
	&arm11_target,
ntfreak's avatar
ntfreak committed
119
	&mips_m4k_target,
120
121
122
	NULL,
};

123
target_t *all_targets = NULL;
124
125
126
target_event_callback_t *target_event_callbacks = NULL;
target_timer_callback_t *target_timer_callbacks = NULL;

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

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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 }
};

const char *target_strerror_safe( int err )
{
	const Jim_Nvp *n;

	n = Jim_Nvp_value2name_simple( nvp_error_target, err );
	if( n->name == NULL ){
		return "unknown";
	} else {
		return n->name;
	}
}

164
const Jim_Nvp nvp_target_event[] = {
165
166
167
168
	{ .value = TARGET_EVENT_OLD_pre_reset          , .name = "old-pre_reset" },
	{ .value = TARGET_EVENT_OLD_gdb_program_config , .name = "old-gdb_program_config" },
	{ .value = TARGET_EVENT_OLD_post_reset         , .name = "old-post_reset" },
	{ .value = TARGET_EVENT_OLD_pre_resume         , .name = "old-pre_resume" },
169

170

171
172
173
174
175
176
	{ .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" },

	/* historical name */
177

178
	{ .value = TARGET_EVENT_RESET_START, .name = "reset-start" },
179
180
181
182
183
184
185
186
187

	{ .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" },
188
189
190
	{ .value = TARGET_EVENT_RESET_INIT , .name = "reset-init" },
	{ .value = TARGET_EVENT_RESET_END, .name = "reset-end" },

191
192
193
194
195
196




	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-start" },
	{ .value = TARGET_EVENT_EXAMINE_START, .name = "examine-end" },
197

198

199
200
201
202
203
204
	{ .value = TARGET_EVENT_DEBUG_HALTED, .name = "debug-halted" },
	{ .value = TARGET_EVENT_DEBUG_RESUMED, .name = "debug-resumed" },

	{ .value = TARGET_EVENT_GDB_ATTACH, .name = "gdb-attach" },
	{ .value = TARGET_EVENT_GDB_DETACH, .name = "gdb-detach" },

205

206
207
208
209
210
211
212
213
214
215
216
	{ .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 }
217
218
};

219
220
221
222
223
224
225
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 },
226
227
};

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

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 },
        { .name = "le",     .value = TARGET_LITTLE_ENDIAN },
	{ .name = NULL,     .value = -1 },
};

249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
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 },
};

static int
max_target_number( void )
{
	target_t *t;
	int x;

	x = -1;
	t = all_targets;
	while( t ){
		if( x < t->target_number ){
			x = (t->target_number)+1;
		}
		t = t->next;
	}
	return x;
}
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292

/* determine the number of the new target */
static int
new_target_number( void )
{
	target_t *t;
	int x;

	/* number is 0 based */
	x = -1;
	t = all_targets;
	while(t){
		if( x < t->target_number ){
			x = t->target_number;
		}
		t = t->next;
	}
	return x+1;
}

293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
static int target_continous_poll = 1;

/* read a u32 from a buffer in target memory endianness */
u32 target_buffer_get_u32(target_t *target, u8 *buffer)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u32(buffer);
	else
		return be_to_h_u32(buffer);
}

/* read a u16 from a buffer in target memory endianness */
u16 target_buffer_get_u16(target_t *target, u8 *buffer)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		return le_to_h_u16(buffer);
	else
		return be_to_h_u16(buffer);
}

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

319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/* write a u32 to a buffer in target memory endianness */
void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u32_to_le(buffer, value);
	else
		h_u32_to_be(buffer, value);
}

/* write a u16 to a buffer in target memory endianness */
void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value)
{
	if (target->endianness == TARGET_LITTLE_ENDIAN)
		h_u16_to_le(buffer, value);
	else
		h_u16_to_be(buffer, value);
}

337
338
339
340
341
342
/* write a u8 to a buffer in target memory endianness */
void target_buffer_set_u8(target_t *target, u8 *buffer, u8 value)
{
	*buffer = value;
}

343
344
345
/* returns a pointer to the n-th configured target */
target_t* get_target_by_num(int num)
{
346
	target_t *target = all_targets;
347

348
349
	while (target){
		if( target->target_number == num ){
350
			return target;
351
		}
352
353
354
355
356
357
358
359
		target = target->next;
	}

	return NULL;
}

int get_num_by_target(target_t *query_target)
{
360
	return query_target->target_number;
361
362
363
364
365
}

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
366

367
368
	if (target == NULL)
	{
369
		LOG_ERROR("BUG: current_target out of bounds");
370
371
372
		exit(-1);
	}

oharboe's avatar
oharboe committed
373
	return target;
374
375
376
}


377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
int target_poll(struct target_s *target)
{
	/* We can't poll until after examine */
	if (!target->type->examined)
	{
		/* 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 */
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->halt(target);
}

int target_resume(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution)
{
401
	int retval;
oharboe's avatar
oharboe committed
402

403
404
405
406
407
408
	/* We can't poll until after examine */
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
409

oharboe's avatar
oharboe committed
410
411
412
413
	/* 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.
	 */
414
415
	if ((retval = target->type->resume(target, current, address, handle_breakpoints, debug_execution)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
416

417
	return retval;
418
419
}

420
421
422
423
424
425
426
427
428
429
430
431
432

static int NEW_target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
{
	char buf[100];
	Jim_Nvp *n;
	n = Jim_Nvp_value2name_simple( nvp_reset_modes, reset_mode );
	if( n->name == NULL ){
		LOG_ERROR("invalid reset mode");
		return ERROR_FAIL;
	}

	sprintf( buf, "ocd_process_reset %s", n->name );
	Jim_Eval( interp, buf );
433
434
435
436

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

437
438
439
	return ERROR_OK;
}

440
// Next patch - this turns into TCL...
441
static int OLD_target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
442
443
444
{
	int retval = ERROR_OK;
	target_t *target;
445

446
	target = all_targets;
447
448

	target_all_handle_event( TARGET_EVENT_OLD_pre_reset );
oharboe's avatar
oharboe committed
449

450
451
	if ((retval = jtag_init_reset(cmd_ctx)) != ERROR_OK)
		return retval;
oharboe's avatar
oharboe committed
452

453
	keep_alive(); /* we might be running on a very slow JTAG clk */
oharboe's avatar
oharboe committed
454
455

	/* First time this is executed after launching OpenOCD, it will read out
456
	 * the type of CPU, etc. and init Embedded ICE registers in host
oharboe's avatar
oharboe committed
457
458
	 * memory.
	 *
459
	 * It will also set up ICE registers in the target.
oharboe's avatar
oharboe committed
460
461
462
	 *
	 * However, if we assert TRST later, we need to set up the registers again.
	 *
463
464
	 * For the "reset halt/init" case we must only set up the registers here.
	 */
465
	if ((retval = target_examine()) != ERROR_OK)
466
		return retval;
oharboe's avatar
oharboe committed
467

468
	keep_alive(); /* we might be running on a very slow JTAG clk */
oharboe's avatar
oharboe committed
469

470
	target = all_targets;
471
472
	while (target)
	{
oharboe's avatar
   
oharboe committed
473
474
475
476
		/* we have no idea what state the target is in, so we
		 * have to drop working areas
		 */
		target_free_all_working_areas_restore(target, 0);
oharboe's avatar
   
oharboe committed
477
		target->reset_halt=((reset_mode==RESET_HALT)||(reset_mode==RESET_INIT));
478
479
		if ((retval = target->type->assert_reset(target))!=ERROR_OK)
			return retval;
480
481
		target = target->next;
	}
oharboe's avatar
oharboe committed
482

483
	target = all_targets;
484
	while (target)
oharboe's avatar
   
oharboe committed
485
	{
486
487
488
		if ((retval = target->type->deassert_reset(target))!=ERROR_OK)
			return retval;
		target = target->next;
oharboe's avatar
   
oharboe committed
489
	}
oharboe's avatar
oharboe committed
490

491
	target = all_targets;
492
493
	while (target)
	{
494
		/* We can fail to bring the target into the halted state, try after reset has been deasserted  */
495
		if (target->reset_halt)
oharboe's avatar
   
oharboe committed
496
		{
497
498
499
500
501
			/* wait up to 1 second for halt. */
			target_wait_state(target, TARGET_HALTED, 1000);
			if (target->state != TARGET_HALTED)
			{
				LOG_WARNING("Failed to reset target into halted mode - issuing halt");
502
503
				if ((retval = target->type->halt(target))!=ERROR_OK)
					return retval;
504
			}
oharboe's avatar
   
oharboe committed
505
		}
oharboe's avatar
oharboe committed
506

507
508
		target = target->next;
	}
oharboe's avatar
oharboe committed
509
510


ntfreak's avatar
ntfreak committed
511
	LOG_DEBUG("Waiting for halted stated as appropriate");
oharboe's avatar
oharboe committed
512
513

	if ((reset_mode == RESET_HALT) || (reset_mode == RESET_INIT))
514
	{
515
		target = all_targets;
oharboe's avatar
oharboe committed
516
		while (target)
517
		{
oharboe's avatar
oharboe committed
518
519
520
			/* Wait for reset to complete, maximum 5 seconds. */
			if (((retval=target_wait_state(target, TARGET_HALTED, 5000)))==ERROR_OK)
			{
521
522
523
				if (reset_mode == RESET_INIT){
					target_handle_event( target, TARGET_EVENT_OLD_post_reset );
				}
524

oharboe's avatar
oharboe committed
525
526
			}
			target = target->next;
527
528
		}
	}
oharboe's avatar
oharboe committed
529

530
	/* We want any events to be processed before the prompt */
531
532
	target_call_timer_callbacks_now();

533
534
535
	return retval;
}

536
537
538
539
540
541
542
543
544
545
int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode)
{
	if( USE_OLD_RESET ){
		return OLD_target_process_reset( cmd_ctx, reset_mode );
	} else {
		return NEW_target_process_reset( cmd_ctx, reset_mode );
	}
}


546
547
548
549
550
551
552
553
554
555
556
557
static int default_virt2phys(struct target_s *target, u32 virtual, u32 *physical)
{
	*physical = virtual;
	return ERROR_OK;
}

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

558
static int default_examine(struct target_s *target)
559
{
560
	target->type->examined = 1;
561
562
563
564
	return ERROR_OK;
}


565
566
/* Targets that correctly implement init+examine, i.e.
 * no communication with target during init:
oharboe's avatar
oharboe committed
567
568
 *
 * XScale
569
 */
ntfreak's avatar
ntfreak committed
570
int target_examine(void)
571
572
{
	int retval = ERROR_OK;
573
	target_t *target = all_targets;
574
575
	while (target)
	{
576
		if ((retval = target->type->examine(target))!=ERROR_OK)
577
578
579
580
581
			return retval;
		target = target->next;
	}
	return retval;
}
582

583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
static int target_write_memory_imp(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer)
{
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->write_memory_imp(target, address, size, count, buffer);
}

static int target_read_memory_imp(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer)
{
	if (!target->type->examined)
	{
		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)
{
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
	return target->type->soft_reset_halt_imp(target);
}

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, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info)
{
	if (!target->type->examined)
	{
		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);
}
622

623
624
int target_init(struct command_context_s *cmd_ctx)
{
625
	target_t *target = all_targets;
oharboe's avatar
oharboe committed
626

627
628
	while (target)
	{
629
630
631
632
633
		target->type->examined = 0;
		if (target->type->examine == NULL)
		{
			target->type->examine = default_examine;
		}
oharboe's avatar
oharboe committed
634

635
636
		if (target->type->init_target(cmd_ctx, target) != ERROR_OK)
		{
637
			LOG_ERROR("target '%s' init failed", target->type->name);
638
639
			exit(-1);
		}
oharboe's avatar
oharboe committed
640

641
642
643
644
645
		/* Set up default functions if none are provided by target */
		if (target->type->virt2phys == NULL)
		{
			target->type->virt2phys = default_virt2phys;
		}
646
647
648
649
650
651
652
653
654
655
656
657
658
		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;

oharboe's avatar
oharboe committed
659

660
661
662
663
664
665
		if (target->type->mmu == NULL)
		{
			target->type->mmu = default_mmu;
		}
		target = target->next;
	}
oharboe's avatar
oharboe committed
666

667
	if (all_targets)
668
669
670
671
	{
		target_register_user_commands(cmd_ctx);
		target_register_timer_callback(handle_target, 100, 1, NULL);
	}
oharboe's avatar
oharboe committed
672

673
674
675
676
677
678
	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
679

680
681
682
683
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
684

685
686
687
688
689
690
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
691

692
693
694
695
	(*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
696

697
698
699
700
701
702
703
	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
704

705
706
707
708
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
709

710
711
712
713
714
715
	if (*callbacks_p)
	{
		while ((*callbacks_p)->next)
			callbacks_p = &((*callbacks_p)->next);
		callbacks_p = &((*callbacks_p)->next);
	}
oharboe's avatar
oharboe committed
716

717
718
719
720
	(*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
721

722
723
724
725
726
727
728
729
730
	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
731

732
733
	(*callbacks_p)->priv = priv;
	(*callbacks_p)->next = NULL;
oharboe's avatar
oharboe committed
734

735
736
737
738
739
740
741
	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
742

743
744
745
746
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
747

748
749
750
751
752
753
754
755
756
757
758
759
760
	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
761

762
763
764
765
766
767
768
	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
769

770
771
772
773
	if (callback == NULL)
	{
		return ERROR_INVALID_ARGUMENTS;
	}
oharboe's avatar
oharboe committed
774

775
776
777
778
779
780
781
782
783
784
785
786
787
	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
788

789
790
791
792
793
794
795
	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
796

797
798
	LOG_DEBUG("target event %i (%s)",
			  event,
799
			  Jim_Nvp_value2name_simple( nvp_target_event, event )->name );
oharboe's avatar
oharboe committed
800

801
	target_handle_event( target, event );
802

803
804
805
806
807
808
	while (callback)
	{
		next_callback = callback->next;
		callback->callback(target, event, callback->priv);
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
809

810
811
812
	return ERROR_OK;
}

813
static int target_call_timer_callbacks_check_time(int checktime)
814
815
816
817
818
{
	target_timer_callback_t *callback = target_timer_callbacks;
	target_timer_callback_t *next_callback;
	struct timeval now;

oharboe's avatar
   
oharboe committed
819
820
	keep_alive();

821
	gettimeofday(&now, NULL);
oharboe's avatar
oharboe committed
822

823
824
825
	while (callback)
	{
		next_callback = callback->next;
oharboe's avatar
oharboe committed
826

827
828
829
		if ((!checktime&&callback->periodic)||
				(((now.tv_sec >= callback->when.tv_sec) && (now.tv_usec >= callback->when.tv_usec))
						|| (now.tv_sec > callback->when.tv_sec)))
830
		{
831
			if(callback->callback != NULL)
832
			{
833
834
				callback->callback(callback->priv);
				if (callback->periodic)
835
				{
836
837
838
839
840
841
842
843
844
					int time_ms = callback->time_ms;
					callback->when.tv_usec = now.tv_usec + (time_ms % 1000) * 1000;
					time_ms -= (time_ms % 1000);
					callback->when.tv_sec = now.tv_sec + time_ms / 1000;
					if (callback->when.tv_usec > 1000000)
					{
						callback->when.tv_usec = callback->when.tv_usec - 1000000;
						callback->when.tv_sec += 1;
					}
845
				}
846
847
				else
					target_unregister_timer_callback(callback->callback, callback->priv);
848
849
			}
		}
oharboe's avatar
oharboe committed
850

851
852
		callback = next_callback;
	}
oharboe's avatar
oharboe committed
853

854
855
856
	return ERROR_OK;
}

oharboe's avatar
oharboe committed
857
int target_call_timer_callbacks(void)
858
859
860
861
862
{
	return target_call_timer_callbacks_check_time(1);
}

/* invoke periodic callbacks immediately */
oharboe's avatar
oharboe committed
863
int target_call_timer_callbacks_now(void)
864
{
oharboe's avatar
   
oharboe committed
865
	return target_call_timer_callbacks_check_time(0);
866
867
}

868
869
870
871
int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area)
{
	working_area_t *c = target->working_areas;
	working_area_t *new_wa = NULL;
oharboe's avatar
oharboe committed
872

873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
	/* 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
892

893
894
895
	/* only allocate multiples of 4 byte */
	if (size % 4)
	{
896
		LOG_ERROR("BUG: code tried to allocate unaligned number of bytes, padding");
897
898
		size = CEIL(size, 4);
	}
oharboe's avatar
oharboe committed
899

900
901
902
903
904
905
906
907
908
909
	/* 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
910

911
912
913
914
915
916
	/* if not, allocate a new one */
	if (!new_wa)
	{
		working_area_t **p = &target->working_areas;
		u32 first_free = target->working_area;
		u32 free_size = target->working_area_size;
oharboe's avatar
oharboe committed
917

918
		LOG_DEBUG("allocating new working area");
oharboe's avatar
oharboe committed
919

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

929
930
		if (free_size < size)
		{
931
			LOG_WARNING("not enough working area available(requested %d, free %d)", size, free_size);
932
933
			return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
		}
oharboe's avatar
oharboe committed
934

935
936
937
938
		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
939

940
941
942
943
944
945
946
947
948
		if (target->backup_working_area)
		{
			new_wa->backup = malloc(new_wa->size);
			target->type->read_memory(target, new_wa->address, 4, new_wa->size / 4, new_wa->backup);
		}
		else
		{
			new_wa->backup = NULL;
		}
oharboe's avatar
oharboe committed
949

950
951
952
		/* put new entry in list */
		*p = new_wa;
	}
oharboe's avatar
oharboe committed
953

954
955
956
	/* mark as used, and return the new (reused) area */
	new_wa->free = 0;
	*area = new_wa;
oharboe's avatar
oharboe committed
957

958
959
	/* user pointer */
	new_wa->user = area;
oharboe's avatar
oharboe committed
960

961
962
963
	return ERROR_OK;
}

oharboe's avatar
   
oharboe committed
964
int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore)
965
966
967
{
	if (area->free)
		return ERROR_OK;
oharboe's avatar
oharboe committed
968

oharboe's avatar
   
oharboe committed
969
	if (restore&&target->backup_working_area)
970
		target->type->write_memory(target, area->address, 4, area->size / 4, area->backup);
oharboe's avatar
oharboe committed
971

972
	area->free = 1;
oharboe's avatar
oharboe committed
973

974
975
976
	/* mark user pointer invalid */
	*area->user = NULL;
	area->user = NULL;
oharboe's avatar
oharboe committed
977

978
979
980
	return ERROR_OK;
}

oharboe's avatar
   
oharboe committed
981
982
983
984
985
986
int target_free_working_area(struct target_s *target, working_area_t *area)
{
	return target_free_working_area_restore(target, area, 1);
}

int target_free_all_working_areas_restore(struct target_s *target, int restore)
987
988
989
990
991
992
{
	working_area_t *c = target->working_areas;

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

995
996
		if (c->backup)
			free(c->backup);
oharboe's avatar
oharboe committed
997

998
		free(c);
oharboe's avatar
oharboe committed
999

1000
1001
		c = next;
	}
oharboe's avatar
oharboe committed
1002

1003
	target->working_areas = NULL;
oharboe's avatar
oharboe committed
1004

1005
1006
1007
	return ERROR_OK;
}

oharboe's avatar
   
oharboe committed
1008
1009
int target_free_all_working_areas(struct target_s *target)
{
oharboe's avatar
oharboe committed
1010
	return target_free_all_working_areas_restore(target, 1);
oharboe's avatar
   
oharboe committed
1011
1012
}

1013
1014
int target_register_commands(struct command_context_s *cmd_ctx)
{
1015

1016
1017
1018
	register_command(cmd_ctx, NULL, "targets", handle_targets_command, COMMAND_EXEC, NULL);
	register_command(cmd_ctx, NULL, "working_area", handle_working_area_command, COMMAND_ANY, "working_area <target#> <address> <size> <'backup'|'nobackup'> [virtual address]");
	register_command(cmd_ctx, NULL, "virt2phys", handle_virt2phys_command, COMMAND_ANY, "virt2phys <virtual address>");
1019
	register_command(cmd_ctx, NULL, "profile", handle_profile_command, COMMAND_EXEC, "PRELIMINARY! - profile <seconds> <gmon.out>");
1020

1021
	register_jim(cmd_ctx, "target", jim_target, "configure target" );
1022

1023

1024
	/* script procedures */
1025
1026
	register_jim(cmd_ctx, "ocd_mem2array", jim_mem2array, "read memory and return as a TCL array for script processing");
	register_jim(cmd_ctx, "ocd_array2mem", jim_array2mem, "convert a TCL array to memory locations and write the values");
1027
1028
1029
1030
1031
1032
1033
1034
	return ERROR_OK;
}

int target_arch_state(struct target_s *target)
{
	int retval;
	if (target==NULL)
	{
1035
		LOG_USER("No target has been configured");
1036
1037
		return ERROR_OK;
	}
oharboe's avatar
oharboe committed
1038

1039
	LOG_USER("target state: %s",
1040
		 Jim_Nvp_value2name_simple(nvp_target_state,target->state)->name);
oharboe's avatar
oharboe committed
1041

1042
1043
	if (target->state!=TARGET_HALTED)
		return ERROR_OK;
oharboe's avatar
oharboe committed
1044

1045
1046
1047
1048
	retval=target->type->arch_state(target);
	return retval;
}

oharboe's avatar
oharboe committed
1049
1050
/* Single aligned words are guaranteed to use 16 or 32 bit access
 * mode respectively, otherwise data is handled as quickly as
1051
1052
1053
1054
1055
 * possible
 */
int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer)
{
	int retval;
1056
1057
	LOG_DEBUG("writing buffer of %i byte at 0x%8.8x", size, address);

1058
1059
1060
1061
1062
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
1063

1064
	if ((address + size - 1) < address)
1065
1066
1067
1068
1069
	{
		/* GDB can request this when e.g. PC is 0xfffffffc*/
		LOG_ERROR("address+size wrapped(0x%08x, 0x%08x)", address, size);
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
1070

1071
1072
1073
1074
	if (((address % 2) == 0) && (size == 2))
	{
		return target->type->write_memory(target, address, 2, 1, buffer);
	}
oharboe's avatar
oharboe committed
1075

1076
1077
1078
1079
	/* handle unaligned head bytes */
	if (address % 4)
	{
		int unaligned = 4 - (address % 4);
oharboe's avatar
oharboe committed
1080

1081
1082
1083
1084
1085
		if (unaligned > size)
			unaligned = size;

		if ((retval = target->type->write_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
			return retval;
oharboe's avatar
oharboe committed
1086

1087
1088
1089
1090
		buffer += unaligned;
		address += unaligned;
		size -= unaligned;
	}
oharboe's avatar
oharboe committed
1091

1092
1093
1094
1095
	/* handle aligned words */
	if (size >= 4)
	{
		int aligned = size - (size % 4);
oharboe's avatar
oharboe committed
1096

1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
		/* use bulk writes above a certain limit. This may have to be changed */
		if (aligned > 128)
		{
			if ((retval = target->type->bulk_write_memory(target, address, aligned / 4, buffer)) != ERROR_OK)
				return retval;
		}
		else
		{
			if ((retval = target->type->write_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
				return retval;
		}
oharboe's avatar
oharboe committed
1108

1109
1110
1111
1112
		buffer += aligned;
		address += aligned;
		size -= aligned;
	}
oharboe's avatar
oharboe committed
1113

1114
1115
1116
1117
1118
1119
	/* handle tail writes of less than 4 bytes */
	if (size > 0)
	{
		if ((retval = target->type->write_memory(target, address, 1, size, buffer)) != ERROR_OK)
			return retval;
	}
oharboe's avatar
oharboe committed
1120

1121
1122
1123
1124
	return ERROR_OK;
}


oharboe's avatar
oharboe committed
1125
1126
/* Single aligned words are guaranteed to use 16 or 32 bit access
 * mode respectively, otherwise data is handled as quickly as
1127
1128
1129
1130
1131
 * possible
 */
int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer)
{
	int retval;
1132
1133
	LOG_DEBUG("reading buffer of %i byte at 0x%8.8x", size, address);

1134
1135
1136
1137
1138
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
1139

1140
	if ((address + size - 1) < address)
1141
1142
1143
1144
1145
	{
		/* GDB can request this when e.g. PC is 0xfffffffc*/
		LOG_ERROR("address+size wrapped(0x%08x, 0x%08x)", address, size);
		return ERROR_FAIL;
	}
oharboe's avatar
oharboe committed
1146

1147
1148
1149
1150
	if (((address % 2) == 0) && (size == 2))
	{
		return target->type->read_memory(target, address, 2, 1, buffer);
	}
oharboe's avatar
oharboe committed
1151

1152
1153
1154
1155
	/* handle unaligned head bytes */
	if (address % 4)
	{
		int unaligned = 4 - (address % 4);
oharboe's avatar
oharboe committed
1156

1157
1158
1159
1160
1161
		if (unaligned > size)
			unaligned = size;

		if ((retval = target->type->read_memory(target, address, 1, unaligned, buffer)) != ERROR_OK)
			return retval;
oharboe's avatar
oharboe committed
1162

1163
1164
1165
1166
		buffer += unaligned;
		address += unaligned;
		size -= unaligned;
	}
oharboe's avatar
oharboe committed
1167

1168
1169
1170
1171
	/* handle aligned words */
	if (size >= 4)
	{
		int aligned = size - (size % 4);
oharboe's avatar
oharboe committed
1172

1173
1174
		if ((retval = target->type->read_memory(target, address, 4, aligned / 4, buffer)) != ERROR_OK)
			return retval;
oharboe's avatar
oharboe committed
1175

1176
1177
1178
1179
		buffer += aligned;
		address += aligned;
		size -= aligned;
	}
oharboe's avatar
oharboe committed
1180

1181
1182
1183
1184
1185
1186
	/* handle tail writes of less than 4 bytes */
	if (size > 0)
	{
		if ((retval = target->type->read_memory(target, address, 1, size, buffer)) != ERROR_OK)
			return retval;
	}
oharboe's avatar
oharboe committed
1187

1188
1189
1190
1191
1192
1193
1194
1195
1196
	return ERROR_OK;
}

int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc)
{
	u8 *buffer;
	int retval;
	int i;
	u32 checksum = 0;
1197
1198
1199
1200
1201
	if (!target->type->examined)
	{
		LOG_ERROR("Target not examined yet");
		return ERROR_FAIL;
	}