target.h 27.1 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
11
12
13
 *   Copyright (C) 2011 by Broadcom Corporation                            *
 *   Evan Hunter - ehunter@broadcom.com                                    *
 *                                                                         *
14
15
16
 *   Copyright (C) ST-Ericsson SA 2011                                     *
 *   michel.jaouen@stericsson.com : smp minimum support                    *
 *                                                                         *
17
18
19
20
21
22
23
24
25
26
27
 *   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     *
28
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
29
 ***************************************************************************/
30

31
32
#ifndef OPENOCD_TARGET_TARGET_H
#define OPENOCD_TARGET_TARGET_H
33

34
35
#include <helper/list.h>

Zachary T Welch's avatar
Zachary T Welch committed
36
struct reg;
Zachary T Welch's avatar
Zachary T Welch committed
37
struct trace;
38
struct command_context;
39
40
struct breakpoint;
struct watchpoint;
41
42
struct mem_param;
struct reg_param;
43
struct target_list;
44
struct gdb_fileio_info;
45

oharboe's avatar
oharboe committed
46
/*
47
48
49
50
51
52
53
 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
 * TARGET_RUNNING = 1: the target is executing user code
 * TARGET_HALTED  = 2: the target is not executing code, and ready to talk to the
 * debugger. on an xscale it means that the debug handler is executing
 * TARGET_RESET   = 3: the target is being held in reset (only a temporary state,
 * not sure how this is used with all the recent changes)
 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
54
 * behalf of the debugger (e.g. algorithm for flashing)
55
56
57
58
 *
 * also see: target_state_name();
 */

59
enum target_state {
60
61
62
63
64
65
66
	TARGET_UNKNOWN = 0,
	TARGET_RUNNING = 1,
	TARGET_HALTED = 2,
	TARGET_RESET = 3,
	TARGET_DEBUG_RUNNING = 4,
};

67
68
69
70
71
enum nvp_assert {
	NVP_DEASSERT,
	NVP_ASSERT,
};

72
enum target_reset_mode {
73
74
75
76
	RESET_UNKNOWN = 0,
	RESET_RUN = 1,		/* reset and let target run */
	RESET_HALT = 2,		/* reset and halt target out of reset */
	RESET_INIT = 3,		/* reset and halt target out of reset, then run init script */
77
78
};

79
enum target_debug_reason {
80
81
82
83
84
	DBG_REASON_DBGRQ = 0,
	DBG_REASON_BREAKPOINT = 1,
	DBG_REASON_WATCHPOINT = 2,
	DBG_REASON_WPTANDBKPT = 3,
	DBG_REASON_SINGLESTEP = 4,
85
	DBG_REASON_NOTHALTED = 5,
86
	DBG_REASON_EXIT = 6,
87
88
	DBG_REASON_EXC_CATCH = 7,
	DBG_REASON_UNDEFINED = 8,
89
90
};

91
enum target_endianness {
zwelch's avatar
zwelch committed
92
	TARGET_ENDIAN_UNKNOWN = 0,
93
	TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
94
95
};

96
struct working_area {
97
	target_addr_t address;
98
	uint32_t size;
99
	bool free;
100
	uint8_t *backup;
101
	struct working_area **user;
102
103
	struct working_area *next;
};
104
105

struct gdb_service {
106
107
108
	struct target *target;
	/*  field for smp display  */
	/*  element 0 coreid currently displayed ( 1 till n) */
109
110
	/*  element 1 coreid to be displayed at next resume 1 till n 0 means resume
	 *  all cores core displayed  */
111
112
	int32_t core[2];
};
113

114
115
116
117
118
119
/* target back off timer */
struct backoff_timer {
	int times;
	int count;
};

120
121
122
123
124
125
/* split target registers into multiple class */
enum target_register_class {
	REG_CLASS_ALL,
	REG_CLASS_GENERAL,
};

126
/* target_type.h contains the full definition of struct target_type */
127
128
struct target {
	struct target_type *type;			/* target type definition (name, access functions) */
Marc Schink's avatar
Marc Schink committed
129
	char *cmd_name;				/* tcl Name of target */
130
	int target_number;					/* DO NOT USE!  field to be removed in 2010 */
131
132
	struct jtag_tap *tap;				/* where on the jtag chain is this */
	int32_t coreid;						/* which device on the TAP? */
133

134
135
136
	/** Should we defer examine to later */
	bool defer_examine;

137
138
139
140
141
142
143
144
	/**
	 * Indicates whether this target has been examined.
	 *
	 * Do @b not access this field directly, use target_was_examined()
	 * or target_set_examined().
	 */
	bool examined;

145
146
147
148
149
150
	/**
	 * true if the  target is currently running a downloaded
	 * "algorithm" instead of arbitrary user code. OpenOCD code
	 * invoking algorithms is trusted to maintain correctness of
	 * any cached state (e.g. for flash status), which arbitrary
	 * code will have no reason to know about.
151
152
153
	 */
	bool running_alg;

154
	struct target_event_action *event_action;
155

oharboe's avatar
   
oharboe committed
156
	int reset_halt;						/* attempt resetting the CPU into the halted mode? */
157
	target_addr_t working_area;				/* working area (initialised RAM). Evaluated
158
										 * upon first allocation from virtual/physical address. */
159
	bool working_area_virt_spec;		/* virtual address specified? */
160
	target_addr_t working_area_virt;			/* virtual address */
161
	bool working_area_phys_spec;		/* physical address specified? */
162
	target_addr_t working_area_phys;			/* physical address */
163
	uint32_t working_area_size;			/* size in bytes */
164
	uint32_t backup_working_area;		/* whether the content of the working area has to be preserved */
165
	struct working_area *working_areas;/* list of allocated working areas */
166
	enum target_debug_reason debug_reason;/* reason why the target entered debug state */
Uwe Hermann's avatar
Uwe Hermann committed
167
	enum target_endianness endianness;	/* target endianness */
168
	/* also see: target_state_name() */
169
	enum target_state state;			/* the current backend-state (running, halted, ...) */
170
	struct reg_cache *reg_cache;		/* the first register cache of the target (core regs) */
171
172
	struct breakpoint *breakpoints;		/* list of breakpoints */
	struct watchpoint *watchpoints;		/* list of watchpoints */
Zachary T Welch's avatar
Zachary T Welch committed
173
	struct trace *trace_info;			/* generic trace information */
174
175
	struct debug_msg_receiver *dbgmsg;	/* list of debug message receivers */
	uint32_t dbg_msg_enabled;			/* debug message status */
176
	void *arch_info;					/* architecture specific information */
177
	void *private_config;				/* pointer to target specific config data (for jim_configure hook) */
Zachary T Welch's avatar
Zachary T Welch committed
178
	struct target *next;				/* next target in list */
179

180
	bool verbose_halt_msg;				/* display async info in telnet session. Do not display
181
										 * lots of halted/resumed info when stepping in debugger. */
182
	bool halt_issued;					/* did we transition to halted state? */
Andreas Färber's avatar
Andreas Färber committed
183
	int64_t halt_issued_time;			/* Note time when halt was issued */
184

185
										/* ARM v7/v8 targets with ADIv5 interface */
186
187
	bool dbgbase_set;					/* By default the debug base is not set */
	uint32_t dbgbase;					/* Really a Cortex-A specific option, but there is no
188
189
										 * system in place to support target specific options
										 * currently. */
190
191
192
193
	bool has_dap;						/* set to true if target has ADIv5 support */
	bool dap_configured;				/* set to true if ADIv5 DAP is configured */
	bool tap_configured;				/* set to true if JTAG tap has been configured
										 * through -chain-position */
194

195
	struct rtos *rtos;					/* Instance of Real Time Operating System support */
196
197
	bool rtos_auto_detect;				/* A flag that indicates that the RTOS has been specified as "auto"
										 * and must be detected when symbols are offered */
198
	struct backoff_timer backoff;
199
	int smp;							/* add some target attributes for smp support */
200
	struct target_list *head;
201
202
203
204
	/* the gdb service is there in case of smp, we have only one gdb server
	 * for all smp target
	 * the target attached to the gdb is changing dynamically by changing
	 * gdb_service->target pointer */
205
	struct gdb_service *gdb_service;
206
207
208

	/* file-I/O information for host to do syscall */
	struct gdb_fileio_info *fileio_info;
Liviu Ionescu's avatar
Liviu Ionescu committed
209

210
211
	char *gdb_port_override;			/* target-specific override for gdb_port */

Liviu Ionescu's avatar
Liviu Ionescu committed
212
213
	/* The semihosting information, extracted from the target. */
	struct semihosting *semihosting;
214
215
216
217
218
};

struct target_list {
	struct target *target;
	struct target_list *next;
Zachary T Welch's avatar
Zachary T Welch committed
219
};
220

221
222
struct gdb_fileio_info {
	char *identifier;
Liviu Ionescu's avatar
Liviu Ionescu committed
223
224
225
226
	uint64_t param_1;
	uint64_t param_2;
	uint64_t param_3;
	uint64_t param_4;
227
228
};

229
230
231
232
233
234
235
/** Returns a description of the endianness for the specified target. */
static inline const char *target_endianness(struct target *target)
{
	return (target->endianness == TARGET_ENDIAN_UNKNOWN) ? "unknown" :
			(target->endianness == TARGET_BIG_ENDIAN) ? "big endian" : "little endian";
}

236
237
238
239
240
241
/** Returns the instance-specific name of the specified target. */
static inline const char *target_name(struct target *target)
{
	return target->cmd_name;
}

242
243
const char *debug_reason_name(struct target *t);

244
enum target_event {
245

246
	/* allow GDB to do stuff before others handle the halted event,
247
	 * this is in lieu of defining ordering of invocation of events,
248
249
250
251
252
253
254
255
	 * which would be more complicated
	 *
	 * Telling GDB to halt does not mean that the target stopped running,
	 * simply that we're dropping out of GDB's waiting for step or continue.
	 *
	 * This can be useful when e.g. detecting power dropout.
	 */
	TARGET_EVENT_GDB_HALT,
256
257
	TARGET_EVENT_HALTED,		/* target entered debug state from normal execution or reset */
	TARGET_EVENT_RESUMED,		/* target resumed to normal execution */
258
259
260
	TARGET_EVENT_RESUME_START,
	TARGET_EVENT_RESUME_END,

261
262
263
	TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
	TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */

264
	TARGET_EVENT_RESET_START,
265
	TARGET_EVENT_RESET_ASSERT_PRE,
266
	TARGET_EVENT_RESET_ASSERT,	/* C code uses this instead of SRST */
267
268
269
	TARGET_EVENT_RESET_ASSERT_POST,
	TARGET_EVENT_RESET_DEASSERT_PRE,
	TARGET_EVENT_RESET_DEASSERT_POST,
270
271
272
	TARGET_EVENT_RESET_INIT,
	TARGET_EVENT_RESET_END,

273
274
	TARGET_EVENT_DEBUG_HALTED,	/* target entered debug state, but was executing on behalf of the debugger */
	TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
275

276
277
	TARGET_EVENT_EXAMINE_START,
	TARGET_EVENT_EXAMINE_END,
278

279
280
281
282
283
284
285
	TARGET_EVENT_GDB_ATTACH,
	TARGET_EVENT_GDB_DETACH,

	TARGET_EVENT_GDB_FLASH_ERASE_START,
	TARGET_EVENT_GDB_FLASH_ERASE_END,
	TARGET_EVENT_GDB_FLASH_WRITE_START,
	TARGET_EVENT_GDB_FLASH_WRITE_END,
286
287

	TARGET_EVENT_TRACE_CONFIG,
288
289
};

290
struct target_event_action {
291
	enum target_event event;
292
	struct Jim_Interp *interp;
293
	struct Jim_Obj *body;
294
	struct target_event_action *next;
295
296
297
};

bool target_has_event_action(struct target *target, enum target_event event);
298

299
struct target_event_callback {
Zachary T Welch's avatar
Zachary T Welch committed
300
	int (*callback)(struct target *target, enum target_event event, void *priv);
301
	void *priv;
302
303
	struct target_event_callback *next;
};
304

305
306
307
308
309
310
struct target_reset_callback {
	struct list_head list;
	void *priv;
	int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
};

Austin Morton's avatar
Austin Morton committed
311
312
313
314
315
316
struct target_trace_callback {
	struct list_head list;
	void *priv;
	int (*callback)(struct target *target, size_t len, uint8_t *data, void *priv);
};

317
318
319
320
321
enum target_timer_type {
	TARGET_TIMER_TYPE_ONESHOT,
	TARGET_TIMER_TYPE_PERIODIC
};

322
struct target_timer_callback {
323
	int (*callback)(void *priv);
324
325
	unsigned int time_ms;
	enum target_timer_type type;
326
	bool removed;
327
328
	struct timeval when;
	void *priv;
329
330
	struct target_timer_callback *next;
};
331

332
333
334
335
336
337
struct target_memory_check_block {
	target_addr_t address;
	uint32_t size;
	uint32_t result;
};

338
int target_register_commands(struct command_context *cmd_ctx);
339
340
341
int target_examine(void);

int target_register_event_callback(
Zachary T Welch's avatar
Zachary T Welch committed
342
		int (*callback)(struct target *target,
343
		enum target_event event, void *priv),
344
345
		void *priv);
int target_unregister_event_callback(
Zachary T Welch's avatar
Zachary T Welch committed
346
		int (*callback)(struct target *target,
347
		enum target_event event, void *priv),
348
		void *priv);
349

350
351
352
353
354
355
356
357
358
int target_register_reset_callback(
		int (*callback)(struct target *target,
		enum target_reset_mode reset_mode, void *priv),
		void *priv);
int target_unregister_reset_callback(
		int (*callback)(struct target *target,
		enum target_reset_mode reset_mode, void *priv),
		void *priv);

Austin Morton's avatar
Austin Morton committed
359
360
361
362
363
364
365
366
367
int target_register_trace_callback(
		int (*callback)(struct target *target,
		size_t len, uint8_t *data, void *priv),
		void *priv);
int target_unregister_trace_callback(
		int (*callback)(struct target *target,
		size_t len, uint8_t *data, void *priv),
		void *priv);

368
369
370
371
372
373
374
375
376
377
/* Poll the status of the target, detect any error conditions and report them.
 *
 * Also note that this fn will clear such error conditions, so a subsequent
 * invocation will then succeed.
 *
 * These error conditions can be "sticky" error conditions. E.g. writing
 * to memory could be implemented as an open loop and if memory writes
 * fails, then a note is made of it, the error is sticky, but the memory
 * write loop still runs to completion. This improves performance in the
 * normal case as there is no need to verify that every single write succeed,
378
 * yet it is possible to detect error conditions.
379
 */
Zachary T Welch's avatar
Zachary T Welch committed
380
int target_poll(struct target *target);
381
int target_resume(struct target *target, int current, target_addr_t address,
382
		int handle_breakpoints, int debug_execution);
Zachary T Welch's avatar
Zachary T Welch committed
383
384
int target_halt(struct target *target);
int target_call_event_callbacks(struct target *target, enum target_event event);
385
int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
Austin Morton's avatar
Austin Morton committed
386
int target_call_trace_callbacks(struct target *target, size_t len, uint8_t *data);
387
388
389

/**
 * The period is very approximate, the callback can happen much more often
390
391
 * or much more rarely than specified
 */
392
int target_register_timer_callback(int (*callback)(void *priv),
393
		unsigned int time_ms, enum target_timer_type type, void *priv);
394
int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
395
396
397
int target_call_timer_callbacks(void);
/**
 * Invoke this to ensure that e.g. polling timer callbacks happen before
398
 * a synchronous command completes.
399
 */
400
int target_call_timer_callbacks_now(void);
401

402
struct target *get_target_by_num(int num);
403
struct target *get_current_target(struct command_context *cmd_ctx);
404
struct target *get_current_target_or_null(struct command_context *cmd_ctx);
Zachary T Welch's avatar
Zachary T Welch committed
405
struct target *get_target(const char *id);
406

zwelch's avatar
zwelch committed
407
/**
408
 * Get the target type name.
zwelch's avatar
zwelch committed
409
410
 *
 * This routine is a wrapper for the target->type->name field.
411
 * Note that this is not an instance-specific name for his target.
zwelch's avatar
zwelch committed
412
 */
413
const char *target_type_name(struct target *target);
zwelch's avatar
zwelch committed
414

zwelch's avatar
zwelch committed
415
/**
416
 * Examine the specified @a target, letting it perform any
417
 * Initialisation that requires JTAG access.
zwelch's avatar
zwelch committed
418
419
420
 *
 * This routine is a wrapper for target->type->examine.
 */
Zachary T Welch's avatar
Zachary T Welch committed
421
int target_examine_one(struct target *target);
422

423
/** @returns @c true if target_set_examined() has been called. */
424
425
426
427
428
static inline bool target_was_examined(struct target *target)
{
	return target->examined;
}

429
430
/** Sets the @c examined flag for the given target. */
/** Use in target->type->examine() after one-time setup is done. */
431
432
433
434
static inline void target_set_examined(struct target *target)
{
	target->examined = true;
}
435
436
437
438
439
440

/**
 * Add the @a breakpoint for @a target.
 *
 * This routine is a wrapper for target->type->add_breakpoint.
 */
Zachary T Welch's avatar
Zachary T Welch committed
441
int target_add_breakpoint(struct target *target,
442
		struct breakpoint *breakpoint);
443
444
445
446
447
448
449
450
451
452
453
454
455
456
/**
 * Add the @a ContextID breakpoint  for @a target.
 *
 * This routine is a wrapper for target->type->add_context_breakpoint.
 */
int target_add_context_breakpoint(struct target *target,
		struct breakpoint *breakpoint);
/**
 * Add the @a ContextID & IVA breakpoint  for @a target.
 *
 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
 */
int target_add_hybrid_breakpoint(struct target *target,
		struct breakpoint *breakpoint);
457
458
459
460
461
/**
 * Remove the @a breakpoint for @a target.
 *
 * This routine is a wrapper for target->type->remove_breakpoint.
 */
462

Zachary T Welch's avatar
Zachary T Welch committed
463
int target_remove_breakpoint(struct target *target,
464
		struct breakpoint *breakpoint);
465
466
467
468
469
/**
 * Add the @a watchpoint for @a target.
 *
 * This routine is a wrapper for target->type->add_watchpoint.
 */
Zachary T Welch's avatar
Zachary T Welch committed
470
int target_add_watchpoint(struct target *target,
471
		struct watchpoint *watchpoint);
472
473
474
475
476
/**
 * Remove the @a watchpoint for @a target.
 *
 * This routine is a wrapper for target->type->remove_watchpoint.
 */
Zachary T Welch's avatar
Zachary T Welch committed
477
int target_remove_watchpoint(struct target *target,
478
		struct watchpoint *watchpoint);
479

480
481
482
483
484
485
486
487
/**
 * Find out the just hit @a watchpoint for @a target.
 *
 * This routine is a wrapper for target->type->hit_watchpoint.
 */
int target_hit_watchpoint(struct target *target,
		struct watchpoint **watchpoint);

488
489
490
491
492
493
494
/**
 * Obtain the architecture for GDB.
 *
 * This routine is a wrapper for target->type->get_gdb_arch.
 */
const char *target_get_gdb_arch(struct target *target);

zwelch's avatar
zwelch committed
495
496
497
498
499
/**
 * Obtain the registers for GDB.
 *
 * This routine is a wrapper for target->type->get_gdb_reg_list.
 */
Zachary T Welch's avatar
Zachary T Welch committed
500
int target_get_gdb_reg_list(struct target *target,
501
502
		struct reg **reg_list[], int *reg_list_size,
		enum target_register_class reg_class);
zwelch's avatar
zwelch committed
503

504
505
506
507
508
509
510
/**
 * Check if @a target allows GDB connections.
 *
 * Some target do not implement the necessary code required by GDB.
 */
bool target_supports_gdb_connection(struct target *target);

zwelch's avatar
zwelch committed
511
512
513
514
515
/**
 * Step the target.
 *
 * This routine is a wrapper for target->type->step.
 */
Zachary T Welch's avatar
Zachary T Welch committed
516
int target_step(struct target *target,
517
		int current, target_addr_t address, int handle_breakpoints);
zwelch's avatar
zwelch committed
518
519
520
521
522
/**
 * Run an algorithm on the @a target given.
 *
 * This routine is a wrapper for target->type->run_algorithm.
 */
Zachary T Welch's avatar
Zachary T Welch committed
523
int target_run_algorithm(struct target *target,
524
		int num_mem_params, struct mem_param *mem_params,
525
		int num_reg_params, struct reg_param *reg_param,
526
		uint32_t entry_point, uint32_t exit_point,
zwelch's avatar
zwelch committed
527
528
		int timeout_ms, void *arch_info);

529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
/**
 * Starts an algorithm in the background on the @a target given.
 *
 * This routine is a wrapper for target->type->start_algorithm.
 */
int target_start_algorithm(struct target *target,
		int num_mem_params, struct mem_param *mem_params,
		int num_reg_params, struct reg_param *reg_params,
		uint32_t entry_point, uint32_t exit_point,
		void *arch_info);

/**
 * Wait for an algorithm on the @a target given.
 *
 * This routine is a wrapper for target->type->wait_algorithm.
 */
int target_wait_algorithm(struct target *target,
		int num_mem_params, struct mem_param *mem_params,
		int num_reg_params, struct reg_param *reg_params,
		uint32_t exit_point, int timeout_ms,
		void *arch_info);

551
552
553
554
555
/**
 * This routine is a wrapper for asynchronous algorithms.
 *
 */
int target_run_flash_async_algorithm(struct target *target,
556
		const uint8_t *buffer, uint32_t count, int block_size,
557
558
559
560
561
562
		int num_mem_params, struct mem_param *mem_params,
		int num_reg_params, struct reg_param *reg_params,
		uint32_t buffer_start, uint32_t buffer_size,
		uint32_t entry_point, uint32_t exit_point,
		void *arch_info);

zwelch's avatar
zwelch committed
563
/**
564
 * Read @a count items of @a size bytes from the memory of @a target at
zwelch's avatar
zwelch committed
565
566
567
568
 * the @a address given.
 *
 * This routine is a wrapper for target->type->read_memory.
 */
Zachary T Welch's avatar
Zachary T Welch committed
569
int target_read_memory(struct target *target,
570
		target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
571
int target_read_phys_memory(struct target *target,
572
		target_addr_t address, uint32_t size, uint32_t count, uint8_t *buffer);
zwelch's avatar
zwelch committed
573
/**
574
 * Write @a count items of @a size bytes to the memory of @a target at
575
576
577
578
579
580
581
582
583
584
585
586
 * the @a address given. @a address must be aligned to @a size
 * in target memory.
 *
 * The endianness is the same in the host and target memory for this
 * function.
 *
 * \todo TODO:
 * Really @a buffer should have been defined as "const void *" and
 * @a buffer should have been aligned to @a size in the host memory.
 *
 * This is not enforced via e.g. assert's today and e.g. the
 * target_write_buffer fn breaks this assumption.
zwelch's avatar
zwelch committed
587
588
589
 *
 * This routine is wrapper for target->type->write_memory.
 */
Zachary T Welch's avatar
Zachary T Welch committed
590
int target_write_memory(struct target *target,
591
		target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
592
int target_write_phys_memory(struct target *target,
593
		target_addr_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
zwelch's avatar
zwelch committed
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
/*
 * Write to target memory using the virtual address.
 *
 * Note that this fn is used to implement software breakpoints. Targets
 * can implement support for software breakpoints to memory marked as read
 * only by making this fn write to ram even if it is read only(MMU or
 * MPUs).
 *
 * It is sufficient to implement for writing a single word(16 or 32 in
 * ARM32/16 bit case) to write the breakpoint to ram.
 *
 * The target should also take care of "other things" to make sure that
 * software breakpoints can be written using this function. E.g.
 * when there is a separate instruction and data cache, this fn must
 * make sure that the instruction cache is synced up to the potential
 * code change that can happen as a result of the memory write(typically
 * by invalidating the cache).
 *
 * The high level wrapper fn in target.c will break down this memory write
 * request to multiple write requests to the target driver to e.g. guarantee
 * that writing 4 bytes to an aligned address happens with a single 32 bit
 * write operation, thus making this fn suitable to e.g. write to special
 * peripheral registers which do not support byte operations.
 */
Zachary T Welch's avatar
Zachary T Welch committed
619
int target_write_buffer(struct target *target,
620
		target_addr_t address, uint32_t size, const uint8_t *buffer);
Zachary T Welch's avatar
Zachary T Welch committed
621
int target_read_buffer(struct target *target,
622
		target_addr_t address, uint32_t size, uint8_t *buffer);
Zachary T Welch's avatar
Zachary T Welch committed
623
int target_checksum_memory(struct target *target,
624
		target_addr_t address, uint32_t size, uint32_t *crc);
Zachary T Welch's avatar
Zachary T Welch committed
625
int target_blank_check_memory(struct target *target,
626
627
		struct target_memory_check_block *blocks, int num_blocks,
		uint8_t erased_value);
Zachary T Welch's avatar
Zachary T Welch committed
628
int target_wait_state(struct target *target, enum target_state state, int ms);
629

630
631
632
633
634
635
636
637
638
639
640
641
642
643
/**
 * Obtain file-I/O information from target for GDB to do syscall.
 *
 * This routine is a wrapper for target->type->get_gdb_fileio_info.
 */
int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);

/**
 * Pass GDB file-I/O response to target after finishing host syscall.
 *
 * This routine is a wrapper for target->type->gdb_fileio_end.
 */
int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);

644
645
646
647
/**
 * Return the highest accessible address for this target.
 */
target_addr_t target_address_max(struct target *target);
648

649
650
651
652
653
654
/**
 * Return the number of address bits this target supports.
 *
 * This routine is a wrapper for target->type->address_bits.
 */
unsigned target_address_bits(struct target *target);
655

656
/** Return the *name* of this targets current state */
657
const char *target_state_name(struct target *target);
658

659
660
661
662
663
664
/** Return the *name* of a target event enumeration value */
const char *target_event_name(enum target_event event);

/** Return the *name* of a target reset reason enumeration value */
const char *target_reset_mode_name(enum target_reset_mode reset_mode);

oharboe's avatar
   
oharboe committed
665
/* DANGER!!!!!
666
 *
oharboe's avatar
   
oharboe committed
667
668
669
670
 * if "area" passed in to target_alloc_working_area() points to a memory
 * location that goes out of scope (e.g. a pointer on the stack), then
 * the caller of target_alloc_working_area() is responsible for invoking
 * target_free_working_area() before "area" goes out of scope.
671
 *
oharboe's avatar
   
oharboe committed
672
673
 * target_free_all_working_areas() will NULL out the "area" pointer
 * upon resuming or resetting the CPU.
674
 *
oharboe's avatar
   
oharboe committed
675
 */
Zachary T Welch's avatar
Zachary T Welch committed
676
int target_alloc_working_area(struct target *target,
677
		uint32_t size, struct working_area **area);
678
679
680
681
/* Same as target_alloc_working_area, except that no error is logged
 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
 *
 * This allows the calling code to *try* to allocate target memory
682
 * and have a fallback to another behaviour(slower?).
683
684
685
 */
int target_alloc_working_area_try(struct target *target,
		uint32_t size, struct working_area **area);
Zachary T Welch's avatar
Zachary T Welch committed
686
687
int target_free_working_area(struct target *target, struct working_area *area);
void target_free_all_working_areas(struct target *target);
688
uint32_t target_get_working_area_avail(struct target *target);
oharboe's avatar
   
oharboe committed
689

690
691
692
693
694
/**
 * Free all the resources allocated by targets and the target layer
 */
void target_quit(void);

Zachary T Welch's avatar
Zachary T Welch committed
695
extern struct target *all_targets;
696

697
uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
Zachary T Welch's avatar
Zachary T Welch committed
698
uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
Mathias K's avatar
Mathias K committed
699
uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
Zachary T Welch's avatar
Zachary T Welch committed
700
uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
701
void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
Zachary T Welch's avatar
Zachary T Welch committed
702
void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
Mathias K's avatar
Mathias K committed
703
void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
Zachary T Welch's avatar
Zachary T Welch committed
704
void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
705

706
void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
707
708
void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
709
void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
710
711
void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
712

713
714
715
716
717
718
719
720
721
722
723
724
725
int target_read_u64(struct target *target, target_addr_t address, uint64_t *value);
int target_read_u32(struct target *target, target_addr_t address, uint32_t *value);
int target_read_u16(struct target *target, target_addr_t address, uint16_t *value);
int target_read_u8(struct target *target, target_addr_t address, uint8_t *value);
int target_write_u64(struct target *target, target_addr_t address, uint64_t value);
int target_write_u32(struct target *target, target_addr_t address, uint32_t value);
int target_write_u16(struct target *target, target_addr_t address, uint16_t value);
int target_write_u8(struct target *target, target_addr_t address, uint8_t value);

int target_write_phys_u64(struct target *target, target_addr_t address, uint64_t value);
int target_write_phys_u32(struct target *target, target_addr_t address, uint32_t value);
int target_write_phys_u16(struct target *target, target_addr_t address, uint16_t value);
int target_write_phys_u8(struct target *target, target_addr_t address, uint8_t value);
726

oharboe's avatar
   
oharboe committed
727
/* Issues USER() statements with target state information */
Zachary T Welch's avatar
Zachary T Welch committed
728
int target_arch_state(struct target *target);
oharboe's avatar
   
oharboe committed
729

Zachary T Welch's avatar
Zachary T Welch committed
730
void target_handle_event(struct target *t, enum target_event e);
oharboe's avatar
oharboe committed
731

732
733
734
735
736
737
738
739
740
#define ERROR_TARGET_INVALID	(-300)
#define ERROR_TARGET_INIT_FAILED (-301)
#define ERROR_TARGET_TIMEOUT	(-302)
#define ERROR_TARGET_NOT_HALTED (-304)
#define ERROR_TARGET_FAILURE	(-305)
#define ERROR_TARGET_UNALIGNED_ACCESS	(-306)
#define ERROR_TARGET_DATA_ABORT	(-307)
#define ERROR_TARGET_RESOURCE_NOT_AVAILABLE	(-308)
#define ERROR_TARGET_TRANSLATION_FAULT	(-309)
oharboe's avatar
oharboe committed
741
#define ERROR_TARGET_NOT_RUNNING (-310)
742
#define ERROR_TARGET_NOT_EXAMINED (-311)
743
#define ERROR_TARGET_DUPLICATE_BREAKPOINT (-312)
744

Øyvind Harboe's avatar
Øyvind Harboe committed
745
746
extern bool get_target_reset_nag(void);

747
#endif /* OPENOCD_TARGET_TARGET_H */