target.h 17.7 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 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 *   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.             *
 ***************************************************************************/
#ifndef TARGET_H
#define TARGET_H

#include "breakpoints.h"
#include "algorithm.h"
#include "command.h"

struct reg_s;
34
struct trace_s;
35
struct command_context_s;
36

oharboe's avatar
oharboe committed
37
/*
38
39
40
41
42
43
44
45
46
 * 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
 * behalf of the debugger (e.g. algorithm for flashing) */

47
48
49
50
51
52
53
54
55
enum target_state
{
	TARGET_UNKNOWN = 0,
	TARGET_RUNNING = 1,
	TARGET_HALTED = 2,
	TARGET_RESET = 3,
	TARGET_DEBUG_RUNNING = 4,
};

56
57
58
59
60
61
62
63
extern const Jim_Nvp nvp_target_state[];

enum nvp_assert {
	NVP_DEASSERT,
	NVP_ASSERT,
};

extern const Jim_Nvp nvp_assert[];
64
65
66

enum target_reset_mode
{
67
68
69
70
	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 */
71
72
};

73
74
extern const Jim_Nvp nvp_reset_mode[];

75
76
77
78
79
80
81
enum target_debug_reason
{
	DBG_REASON_DBGRQ = 0,
	DBG_REASON_BREAKPOINT = 1,
	DBG_REASON_WATCHPOINT = 2,
	DBG_REASON_WPTANDBKPT = 3,
	DBG_REASON_SINGLESTEP = 4,
82
83
	DBG_REASON_NOTHALTED = 5,
	DBG_REASON_UNDEFINED = 6
84
85
};

86
extern const Jim_Nvp nvp_target_debug_reason[];
87
88
89

enum target_endianess
{
90
91
	TARGET_ENDIAN_UNKNOWN=0,
	TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
92
93
};

94
extern const Jim_Nvp nvp_target_endian[];
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

struct target_s;

typedef struct working_area_s
{
	u32 address;
	u32 size;
	int free;
	u8 *backup;
	struct working_area_s **user;
	struct working_area_s *next;
} working_area_t;

typedef struct target_type_s
{
	char *name;
111

112
	int examined;
113
114

	/* poll current target status */
115
116
117
118
	int (*poll)(struct target_s *target);
	/* Invoked only from target_arch_state().
	 * Issue USER() w/architecture specific status.  */
	int (*arch_state)(struct target_s *target);
119

120
121
122
	/* target request support */
	int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);

oharboe's avatar
   
oharboe committed
123
	/* halt will log a warning, but return ERROR_OK if the target is already halted. */
124
125
126
	int (*halt)(struct target_s *target);
	int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
	int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
127

oharboe's avatar
   
oharboe committed
128
129
	/* target reset control. assert reset can be invoked when OpenOCD and
	 * the target is out of sync.
130
	 *
oharboe's avatar
   
oharboe committed
131
132
	 * A typical example is that the target was power cycled while OpenOCD
	 * thought the target was halted or running.
133
	 *
oharboe's avatar
   
oharboe committed
134
	 * assert_reset() can therefore make no assumptions whatsoever about the
135
136
	 * state of the target
	 *
137
138
139
140
	 * Before assert_reset() for the target is invoked, a TRST/tms and
	 * chain validation is executed. TRST should not be asserted
	 * during target assert unless there is no way around it due to
	 * the way reset's are configured.
141
	 *
oharboe's avatar
   
oharboe committed
142
	 */
143
144
	int (*assert_reset)(struct target_s *target);
	int (*deassert_reset)(struct target_s *target);
145
	int (*soft_reset_halt_imp)(struct target_s *target);
146
	int (*soft_reset_halt)(struct target_s *target);
147

148
	/* target register access for gdb.
149
	 *
150
151
	 * Danger! this function will succeed even if the target is running
	 * and return a register list with dummy values.
152
	 *
153
154
155
156
	 * The reason is that GDB connection will fail without a valid register
	 * list, however it is after GDB is connected that monitor commands can
	 * be run to properly initialize the target
	 */
157
	int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
158
159

	/* target memory access
160
161
162
	* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
	* count: number of items of <size>
	*/
163
	int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
164
	int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
165
	int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
166
	int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
167

168
169
	/* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
	int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
170

ntfreak's avatar
ntfreak committed
171
	int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
172
	int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
173
174
175

	/*
	 * target break-/watchpoint control
oharboe's avatar
oharboe committed
176
	 * rw: 0 = write, 1 = read, 2 = access
177
	 *
oharboe's avatar
oharboe committed
178
179
	 * Target must be halted while this is invoked as this
	 * will actually set up breakpoints on target.
180
	 *
oharboe's avatar
oharboe committed
181
	 * The breakpoint hardware will be set up upon adding the first breakpoint.
182
	 *
oharboe's avatar
oharboe committed
183
184
	 * Upon GDB connection all breakpoints/watchpoints are cleared.
	 */
185
	int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
186

oharboe's avatar
oharboe committed
187
188
189
	/* remove breakpoint. hw will only be updated if the target is currently halted.
	 * However, this method can be invoked on unresponsive targets.
	 */
190
	int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
191
	int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
oharboe's avatar
oharboe committed
192
193
194
	/* remove watchpoint. hw will only be updated if the target is currently halted.
	 * However, this method can be invoked on unresponsive targets.
	 */
195
196
197
	int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);

	/* target algorithm support */
198
	int (*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);
199
	int (*run_algorithm)(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);
200

201
	int (*register_commands)(struct command_context_s *cmd_ctx);
202

203
	/* called when target is created */
204
	int (*target_create)( struct target_s *target, Jim_Interp *interp );
205
206
207
208
209
210
211
212
213
214

	/* called for various config parameters */
	/* returns JIM_CONTINUE - if option not understood */
	/* otherwise: JIM_OK, or JIM_ERR, */
	int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );

	/* target commands specifically handled by the target */
	/* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
	int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );

215
216
217
	/* invoked after JTAG chain has been examined & validated. During
	 * this stage the target is examined and any additional setup is
	 * performed.
218
	 *
219
220
	 * invoked every time after the jtag chain has been validated/examined
	 */
221
	int (*examine)(struct target_s *target);
222
	/* Set up structures for target.
223
	 *
224
225
	 * It is illegal to talk to the target at this stage as this fn is invoked
	 * before the JTAG chain has been examined/verified
226
	 * */
227
228
	int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
	int (*quit)(void);
229

ntfreak's avatar
ntfreak committed
230
231
	int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
	int (*mmu)(struct target_s *target, int *enabled);
232

233
234
} target_type_t;

235
/* forward decloration */
236
237
typedef struct target_event_action_s target_event_action_t;

238
239
240
typedef struct target_s
{
	target_type_t *type;				/* target type definition (name, access functions) */
241
242
243
244
	const char *cmd_name;				/* tcl Name of target */
	int target_number;					/* generaly, target index but may not be in order */
	jtag_tap_t *tap;					/* where on the jtag chain is this */
	const char *variant;				/* what varient of this chip is it? */
245
246
	target_event_action_t *event_action;

oharboe's avatar
   
oharboe committed
247
	int reset_halt;						/* attempt resetting the CPU into the halted mode? */
248
	u32 working_area;					/* working area (initialized RAM). Evaluated
249
										 * upon first allocation from virtual/physical address. */
ntfreak's avatar
ntfreak committed
250
251
	u32 working_area_virt;				/* virtual address */
	u32 working_area_phys;				/* physical address */
252
253
254
	u32 working_area_size;				/* size in bytes */
	u32 backup_working_area;			/* whether the content of the working area has to be preserved */
	struct working_area_s *working_areas;/* list of allocated working areas */
255
	enum target_debug_reason debug_reason;/* reason why the target entered debug state */
256
257
258
259
260
	enum target_endianess endianness;	/* target endianess */
	enum target_state state;			/* the current backend-state (running, halted, ...) */
	struct reg_cache_s *reg_cache;		/* the first register cache of the target (core regs) */
	struct breakpoint_s *breakpoints;	/* list of breakpoints */
	struct watchpoint_s *watchpoints;	/* list of watchpoints */
261
262
	struct trace_s *trace_info;			/* generic trace information */
	struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
263
	u32 dbg_msg_enabled;				/* debug message status */
264
265
	void *arch_info;					/* architecture specific information */
	struct target_s *next;				/* next target in list */
266

267
268
	int display;						/* display async info in telnet session. Do not display
										 * lots of halted/resumed info when stepping in debugger. */
269
270
271
272
} target_t;

enum target_event
{
273
274
275
276
	/* LD historical names
	 * - Prior to the great TCL change
	 * - June/July/Aug 2008
	 * - Duane Ellis */
277
278
279
280
281
	TARGET_EVENT_OLD_gdb_program_config,
	TARGET_EVENT_OLD_pre_reset,
	TARGET_EVENT_OLD_post_reset,
	TARGET_EVENT_OLD_pre_resume,

282
	/* allow GDB to do stuff before others handle the halted event,
283
284
285
286
287
	 * this is in lieu of defining ordering of invocation of events,
	 * which would be more complicated */
	TARGET_EVENT_EARLY_HALTED,
	TARGET_EVENT_HALTED,		/* target entered debug state from normal execution or reset */
	TARGET_EVENT_RESUMED,		/* target resumed to normal execution */
288
289
290
	TARGET_EVENT_RESUME_START,
	TARGET_EVENT_RESUME_END,

291
292
293
	TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
	TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */

294
	TARGET_EVENT_RESET_START,
295
296
297
298
299
300
301
302
	TARGET_EVENT_RESET_ASSERT_PRE,
	TARGET_EVENT_RESET_ASSERT_POST,
	TARGET_EVENT_RESET_DEASSERT_PRE,
	TARGET_EVENT_RESET_DEASSERT_POST,
	TARGET_EVENT_RESET_HALT_PRE,
	TARGET_EVENT_RESET_HALT_POST,
	TARGET_EVENT_RESET_WAIT_PRE,
	TARGET_EVENT_RESET_WAIT_POST,
303
304
305
	TARGET_EVENT_RESET_INIT,
	TARGET_EVENT_RESET_END,

306
307
	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 */
308

309
310
	TARGET_EVENT_EXAMINE_START,
	TARGET_EVENT_EXAMINE_END,
311

312
313
314
315
316
317
318
	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,
319
320
};

321
322
323
324
325
extern const Jim_Nvp nvp_target_event[];

struct target_event_action_s {
	enum target_event event;
	Jim_Obj *body;
326
	int has_percent;
327
328
329
	target_event_action_t *next;
 };

330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
typedef struct target_event_callback_s
{
	int (*callback)(struct target_s *target, enum target_event event, void *priv);
	void *priv;
	struct target_event_callback_s *next;
} target_event_callback_t;

typedef struct target_timer_callback_s
{
	int (*callback)(void *priv);
	int time_ms;
	int periodic;
	struct timeval when;
	void *priv;
	struct target_timer_callback_s *next;
} target_timer_callback_t;

extern int target_register_commands(struct command_context_s *cmd_ctx);
extern int target_register_user_commands(struct command_context_s *cmd_ctx);
extern int target_init(struct command_context_s *cmd_ctx);
ntfreak's avatar
ntfreak committed
350
extern int target_examine(void);
351
extern int handle_target(void *priv);
ntfreak's avatar
ntfreak committed
352
extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
353
354
355

extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
356
357
358
extern int target_poll(target_t *target);
extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
extern int target_halt(target_t *target);
359
360
extern int target_call_event_callbacks(target_t *target, enum target_event event);

361
/* The period is very approximate, the callback can happen much more often
362
363
 * or much more rarely than specified
 */
364
365
extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
oharboe's avatar
oharboe committed
366
extern int target_call_timer_callbacks(void);
367
368
369
/* invoke this to ensure that e.g. polling timer callbacks happen before
 * a syncrhonous command completes.
 */
oharboe's avatar
oharboe committed
370
extern int target_call_timer_callbacks_now(void);
371
372
373

extern target_t* get_current_target(struct command_context_s *cmd_ctx);
extern int get_num_by_target(target_t *query_target);
374
extern target_t *get_target(const char *id);
375
376
377

extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
ntfreak's avatar
ntfreak committed
378
extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
379
extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
380
extern int target_wait_state(target_t *target, enum target_state state, int ms);
381

oharboe's avatar
   
oharboe committed
382
/* DANGER!!!!!
383
 *
oharboe's avatar
   
oharboe committed
384
385
386
387
 * 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.
388
 *
oharboe's avatar
   
oharboe committed
389
390
 * target_free_all_working_areas() will NULL out the "area" pointer
 * upon resuming or resetting the CPU.
391
 *
oharboe's avatar
   
oharboe committed
392
 */
393
394
extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
extern int target_free_working_area(struct target_s *target, working_area_t *area);
oharboe's avatar
   
oharboe committed
395
extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
396
397
extern void target_free_all_working_areas(struct target_s *target);
extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
oharboe's avatar
   
oharboe committed
398

399
extern target_t *all_targets;
400
401
402
403

extern target_event_callback_t *target_event_callbacks;
extern target_timer_callback_t *target_timer_callbacks;

404
405
406
extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
extern u8  target_buffer_get_u8 (target_t *target, const u8 *buffer);
407
408
extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
409
extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8  value);
410

drath's avatar
drath committed
411
412
413
414
415
416
int target_read_u32(struct target_s *target, u32 address, u32 *value);
int target_read_u16(struct target_s *target, u32 address, u16 *value);
int target_read_u8(struct target_s *target, u32 address, u8 *value);
int target_write_u32(struct target_s *target, u32 address, u32 value);
int target_write_u16(struct target_s *target, u32 address, u16 value);
int target_write_u8(struct target_s *target, u32 address, u8 value);
417

oharboe's avatar
   
oharboe committed
418
419
420
/* Issues USER() statements with target state information */
int target_arch_state(struct target_s *target);

421
422
void target_handle_event( target_t *t, enum target_event e);
void target_all_handle_event( enum target_event e );
oharboe's avatar
oharboe committed
423

424
425
426
427
428
429
430
431
432
#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
433
#define ERROR_TARGET_NOT_RUNNING (-310)
434
#define ERROR_TARGET_NOT_EXAMINED (-311)
435

436
437
438
extern const Jim_Nvp nvp_error_target[];
extern const char *target_strerror_safe( int err );

439
#endif /* TARGET_H */