target.h 16.8 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
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 *   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 "register.h"
#include "breakpoints.h"
#include "algorithm.h"
29
#include "trace.h"
30
31
32
33
34
35
36
37
38

#include "command.h"
#include "types.h"

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

struct reg_s;
struct command_context_s;
oharboe's avatar
oharboe committed
39
40
41
42
43
44
45
46
47
48
/*
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)
*/
49
50
51
52
53
54
55
56
57
enum target_state
{
	TARGET_UNKNOWN = 0,
	TARGET_RUNNING = 1,
	TARGET_HALTED = 2,
	TARGET_RESET = 3,
	TARGET_DEBUG_RUNNING = 4,
};

58
59
60
61
62
63
64
65
extern const Jim_Nvp nvp_target_state[];

enum nvp_assert {
	NVP_DEASSERT,
	NVP_ASSERT,
};

extern const Jim_Nvp nvp_assert[];
66
67
68

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

75
76
extern const Jim_Nvp nvp_reset_mode[];

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

88
extern const Jim_Nvp nvp_target_debug_reason[];
89
90
91

enum target_endianess
{
92
93
	TARGET_ENDIAN_UNKNOWN=0,
	TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
94
95
};

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

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;
113
114
	
	int examined;
115
116

	/* poll current target status */
117
118
119
120
	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);
121

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

oharboe's avatar
   
oharboe committed
125
	/* halt will log a warning, but return ERROR_OK if the target is already halted. */
126
127
128
129
	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);
	
oharboe's avatar
   
oharboe committed
130
131
132
133
134
135
136
137
138
	/* target reset control. assert reset can be invoked when OpenOCD and
	 * the target is out of sync.
	 * 
	 * A typical example is that the target was power cycled while OpenOCD
	 * thought the target was halted or running.
	 * 
	 * assert_reset() can therefore make no assumptions whatsoever about the
	 * state of the target 
	 * 
139
140
141
142
143
	 * 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.
	 * 
oharboe's avatar
   
oharboe committed
144
	 */
145
146
	int (*assert_reset)(struct target_s *target);
	int (*deassert_reset)(struct target_s *target);
147
	int (*soft_reset_halt_imp)(struct target_s *target);
148
149
	int (*soft_reset_halt)(struct target_s *target);
	
150
151
152
153
154
155
156
157
158
	/* target register access for gdb.
	 * 
	 * Danger! this function will succeed even if the target is running
	 * and return a register list with dummy values.
	 * 
	 * 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
	 */
159
160
161
162
163
164
	int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
	
	/* target memory access 
	* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
	* count: number of items of <size>
	*/
165
	int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
166
	int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
167
	int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
168
169
170
171
172
	int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
	
	/* 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);
	
ntfreak's avatar
ntfreak committed
173
	int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
174
	int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
ntfreak's avatar
ntfreak committed
175
	
oharboe's avatar
oharboe committed
176
177
178
179
180
181
182
183
184
185
186
	/* 
	 * target break-/watchpoint control 
	 * rw: 0 = write, 1 = read, 2 = access
	 * 
	 * Target must be halted while this is invoked as this
	 * will actually set up breakpoints on target.
	 * 
	 * The breakpoint hardware will be set up upon adding the first breakpoint.
	 * 
	 * Upon GDB connection all breakpoints/watchpoints are cleared.
	 */
187
	int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
oharboe's avatar
oharboe committed
188
189
190
191
	
	/* remove breakpoint. hw will only be updated if the target is currently halted.
	 * However, this method can be invoked on unresponsive targets.
	 */
192
	int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
193
	int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
oharboe's avatar
oharboe committed
194
195
196
	/* remove watchpoint. hw will only be updated if the target is currently halted.
	 * However, this method can be invoked on unresponsive targets.
	 */
197
198
199
	int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);

	/* target algorithm support */
200
	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);
201
202
203
	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);
	
	int (*register_commands)(struct command_context_s *cmd_ctx);
204
205
206
207
208
209
210
211
212
213
214
215
216
	/* called when target is created */
	int (*target_jim_create)( struct target_s *target, Jim_Interp *interp );

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

	/* old init function */
217
	int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
218
219
220
221
222
223
	/* invoked after JTAG chain has been examined & validated. During
	 * this stage the target is examined and any additional setup is
	 * performed.
	 * 
	 * invoked every time after the jtag chain has been validated/examined
	 */
224
	int (*examine)(struct target_s *target);
225
226
227
228
229
	/* Set up structures for target.
	 *  
	 * It is illegal to talk to the target at this stage as this fn is invoked
	 * before the JTAG chain has been examined/verified
     */
230
231
232
	int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
	int (*quit)(void);
	
ntfreak's avatar
ntfreak committed
233
234
235
	int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
	int (*mmu)(struct target_s *target, int *enabled);
	
236
237
} target_type_t;

238
239
240
// forward decloration
typedef struct target_event_action_s target_event_action_t;

241
242
243
typedef struct target_s
{
	target_type_t *type;				/* target type definition (name, access functions) */
244
245
246
247
248
249
250
	const char *cmd_name;               /* tcl Name of target */
	int target_number;                  /* generaly, target index but may not be in order */
	int chain_position;                 /* where on the jtag chain is this */
	const char *variant;                /* what varient of this chip is it? */
	enum target_reset_mode reset_mode;  /* how should this target be reset */
	target_event_action_t *event_action;

oharboe's avatar
   
oharboe committed
251
	int reset_halt;						/* attempt resetting the CPU into the halted mode? */
ntfreak's avatar
ntfreak committed
252
	u32 working_area;					/* working area (initialized RAM). Evaluated 
253
										   upon first allocation from virtual/physical address. */
ntfreak's avatar
ntfreak committed
254
255
	u32 working_area_virt;				/* virtual address */
	u32 working_area_phys;				/* physical address */
256
257
258
	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 */
259
	enum target_debug_reason debug_reason;/* reason why the target entered debug state */
260
261
262
263
264
	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 */
265
266
	struct trace_s *trace_info;			/* generic trace information */
	struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
267
	u32 dbg_msg_enabled;				/* debug message status */
268
269
270
271
272
273
	void *arch_info;					/* architecture specific information */
	struct target_s *next;				/* next target in list */
} target_t;

enum target_event
{
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 	TARGET_EVENT_HALTED,		/* target entered debug state from normal execution or reset */
 	TARGET_EVENT_RESUMED,		/* target resumed to normal execution */
	TARGET_EVENT_RESUME_START,
	TARGET_EVENT_RESUME_END,

	TARGET_EVENT_RESET_START,
 	TARGET_EVENT_RESET,			/* target entered reset */
	TARGET_EVENT_RESET_INIT,
	TARGET_EVENT_RESET_END,

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

	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,
294
295
};

296
297
298
299
300
301
302
303
extern const Jim_Nvp nvp_target_event[];

struct target_event_action_s {
	enum target_event event;
	Jim_Obj *body;
	target_event_action_t *next;
 };

304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
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
324
extern int target_examine(void);
325
extern int handle_target(void *priv);
oharboe's avatar
   
oharboe committed
326
extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
327
328
329

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);
330
331
332
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);
333
334
extern int target_call_event_callbacks(target_t *target, enum target_event event);

335
336
337
/* The period is very approximate, the callback can happen much more often 
 * or much more rarely than specified
 */
338
339
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
340
extern int target_call_timer_callbacks(void);
341
342
343
/* invoke this to ensure that e.g. polling timer callbacks happen before
 * a syncrhonous command completes.
 */
oharboe's avatar
oharboe committed
344
extern int target_call_timer_callbacks_now(void);
345
346
347
348
349
350
351

extern target_t* get_current_target(struct command_context_s *cmd_ctx);
extern int get_num_by_target(target_t *query_target);
extern target_t* get_target_by_num(int num);

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
352
extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
353
extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
354
extern int target_wait_state(target_t *target, enum target_state state, int ms);
355

oharboe's avatar
   
oharboe committed
356
357
358
359
360
361
362
363
364
365
366
/* DANGER!!!!!
 * 
 * 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.
 * 
 * target_free_all_working_areas() will NULL out the "area" pointer
 * upon resuming or resetting the CPU.
 * 
 */
367
368
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
369
extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
370
extern int target_free_all_working_areas(struct target_s *target);
oharboe's avatar
   
oharboe committed
371
372
extern int target_free_all_working_areas_restore(struct target_s *target, int restore);

373
extern target_t *all_targets;
374
375
376
377

extern target_event_callback_t *target_event_callbacks;
extern target_timer_callback_t *target_timer_callbacks;

378
379
extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
380
extern u8  target_buffer_get_u8 (target_t *target, u8 *buffer);
381
382
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);
383
extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8  value);
384

drath's avatar
drath committed
385
386
387
388
389
390
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);
391

oharboe's avatar
   
oharboe committed
392
393
394
/* Issues USER() statements with target state information */
int target_arch_state(struct target_s *target);

oharboe's avatar
oharboe committed
395
396
int target_invoke_script(struct command_context_s *cmd_ctx, target_t *target, char *name);

397

398
399
400
401
402
403
404
405
406
#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
407
#define ERROR_TARGET_NOT_RUNNING (-310)
408
#define ERROR_TARGET_NOT_EXAMINED (-311)
409
410

#endif /* TARGET_H */
411
412
413
414
415
416
417
418


/*
 * Local Variables: ***
 * c-basic-offset: 4 ***
 * tab-width: 4 ***
 * End: ***
 */