Audit and remove redundant uses of replacements.h in the tree.
[openocd.git] / src / target / target.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef TARGET_H
27 #define TARGET_H
28
29 #include "breakpoints.h"
30 #include "algorithm.h"
31 #include "command.h"
32
33 struct reg_s;
34 struct trace_s;
35 struct command_context_s;
36
37 /*
38 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
39 * TARGET_RUNNING = 1: the target is executing user code
40 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
41 * debugger. on an xscale it means that the debug handler is executing
42 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
43 * not sure how this is used with all the recent changes)
44 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
45 * behalf of the debugger (e.g. algorithm for flashing) */
46
47 enum target_state
48 {
49 TARGET_UNKNOWN = 0,
50 TARGET_RUNNING = 1,
51 TARGET_HALTED = 2,
52 TARGET_RESET = 3,
53 TARGET_DEBUG_RUNNING = 4,
54 };
55
56 extern const Jim_Nvp nvp_target_state[];
57
58 enum nvp_assert {
59 NVP_DEASSERT,
60 NVP_ASSERT,
61 };
62
63 extern const Jim_Nvp nvp_assert[];
64
65 enum target_reset_mode
66 {
67 RESET_UNKNOWN = 0,
68 RESET_RUN = 1, /* reset and let target run */
69 RESET_HALT = 2, /* reset and halt target out of reset */
70 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
71 };
72
73 extern const Jim_Nvp nvp_reset_mode[];
74
75 enum target_debug_reason
76 {
77 DBG_REASON_DBGRQ = 0,
78 DBG_REASON_BREAKPOINT = 1,
79 DBG_REASON_WATCHPOINT = 2,
80 DBG_REASON_WPTANDBKPT = 3,
81 DBG_REASON_SINGLESTEP = 4,
82 DBG_REASON_NOTHALTED = 5,
83 DBG_REASON_UNDEFINED = 6
84 };
85
86 extern const Jim_Nvp nvp_target_debug_reason[];
87
88 enum target_endianess
89 {
90 TARGET_ENDIAN_UNKNOWN=0,
91 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
92 };
93
94 extern const Jim_Nvp nvp_target_endian[];
95
96 struct target_s;
97
98 typedef struct working_area_s
99 {
100 u32 address;
101 u32 size;
102 int free;
103 u8 *backup;
104 struct working_area_s **user;
105 struct working_area_s *next;
106 } working_area_t;
107
108 typedef struct target_type_s
109 {
110 char *name;
111
112 int examined;
113
114 /* poll current target status */
115 int (*poll)(struct target_s *target);
116 /* Invoked only from target_arch_state().
117 * Issue USER() w/architecture specific status. */
118 int (*arch_state)(struct target_s *target);
119
120 /* target request support */
121 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
122
123 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
124 int (*halt)(struct target_s *target);
125 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
126 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
127
128 /* target reset control. assert reset can be invoked when OpenOCD and
129 * the target is out of sync.
130 *
131 * A typical example is that the target was power cycled while OpenOCD
132 * thought the target was halted or running.
133 *
134 * assert_reset() can therefore make no assumptions whatsoever about the
135 * state of the target
136 *
137 * Before assert_reset() for the target is invoked, a TRST/tms and
138 * chain validation is executed. TRST should not be asserted
139 * during target assert unless there is no way around it due to
140 * the way reset's are configured.
141 *
142 */
143 int (*assert_reset)(struct target_s *target);
144 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 * Danger! this function will succeed even if the target is running
151 * and return a register list with dummy values.
152 *
153 * The reason is that GDB connection will fail without a valid register
154 * list, however it is after GDB is connected that monitor commands can
155 * be run to properly initialize the target
156 */
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 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
161 * count: number of items of <size>
162 */
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 /* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
169 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
170
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
176 * rw: 0 = write, 1 = read, 2 = access
177 *
178 * Target must be halted while this is invoked as this
179 * will actually set up breakpoints on target.
180 *
181 * The breakpoint hardware will be set up upon adding the first breakpoint.
182 *
183 * Upon GDB connection all breakpoints/watchpoints are cleared.
184 */
185 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
186
187 /* remove breakpoint. hw will only be updated if the target is currently halted.
188 * However, this method can be invoked on unresponsive targets.
189 */
190 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
191 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
192 /* remove watchpoint. hw will only be updated if the target is currently halted.
193 * However, this method can be invoked on unresponsive targets.
194 */
195 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
196
197 /* 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 /* called for various config parameters */
207 /* returns JIM_CONTINUE - if option not understood */
208 /* otherwise: JIM_OK, or JIM_ERR, */
209 int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
210
211 /* target commands specifically handled by the target */
212 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
213 int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
214
215 /* invoked after JTAG chain has been examined & validated. During
216 * this stage the target is examined and any additional setup is
217 * performed.
218 *
219 * invoked every time after the jtag chain has been validated/examined
220 */
221 int (*examine)(struct target_s *target);
222 /* Set up structures for target.
223 *
224 * It is illegal to talk to the target at this stage as this fn is invoked
225 * before the JTAG chain has been examined/verified
226 * */
227 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
228 int (*quit)(void);
229
230 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
231 int (*mmu)(struct target_s *target, int *enabled);
232
233 } target_type_t;
234
235 /* forward decloration */
236 typedef struct target_event_action_s target_event_action_t;
237
238 typedef struct target_s
239 {
240 target_type_t *type; /* target type definition (name, access functions) */
241 const char *cmd_name; /* tcl Name of target */
242 int target_number; /* generaly, target index but may not be in order */
243 jtag_tap_t *tap; /* where on the jtag chain is this */
244 const char *variant; /* what varient of this chip is it? */
245 target_event_action_t *event_action;
246
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. */
250 u32 working_area_virt; /* virtual address */
251 u32 working_area_phys; /* physical address */
252 u32 working_area_size; /* size in bytes */
253 u32 backup_working_area; /* whether the content of the working area has to be preserved */
254 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 enum target_endianess endianness; /* target endianess */
257 enum target_state state; /* the current backend-state (running, halted, ...) */
258 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
259 struct breakpoint_s *breakpoints; /* list of breakpoints */
260 struct watchpoint_s *watchpoints; /* list of watchpoints */
261 struct trace_s *trace_info; /* generic trace information */
262 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
263 u32 dbg_msg_enabled; /* debug message status */
264 void *arch_info; /* architecture specific information */
265 struct target_s *next; /* next target in list */
266
267 int display; /* display async info in telnet session. Do not display
268 * lots of halted/resumed info when stepping in debugger. */
269 } target_t;
270
271 enum target_event
272 {
273 /* LD historical names
274 * - Prior to the great TCL change
275 * - June/July/Aug 2008
276 * - Duane Ellis */
277 TARGET_EVENT_OLD_gdb_program_config,
278 TARGET_EVENT_OLD_pre_reset,
279 TARGET_EVENT_OLD_post_reset,
280 TARGET_EVENT_OLD_pre_resume,
281
282 /* allow GDB to do stuff before others handle the halted event,
283 * this is in lieu of defining ordering of invocation of events,
284 * which would be more complicated */
285 TARGET_EVENT_EARLY_HALTED,
286 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
287 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
288 TARGET_EVENT_RESUME_START,
289 TARGET_EVENT_RESUME_END,
290
291 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
292 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
293
294 TARGET_EVENT_RESET_START,
295 TARGET_EVENT_RESET_ASSERT_PRE,
296 TARGET_EVENT_RESET_ASSERT_POST,
297 TARGET_EVENT_RESET_DEASSERT_PRE,
298 TARGET_EVENT_RESET_DEASSERT_POST,
299 TARGET_EVENT_RESET_HALT_PRE,
300 TARGET_EVENT_RESET_HALT_POST,
301 TARGET_EVENT_RESET_WAIT_PRE,
302 TARGET_EVENT_RESET_WAIT_POST,
303 TARGET_EVENT_RESET_INIT,
304 TARGET_EVENT_RESET_END,
305
306 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
307 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
308
309 TARGET_EVENT_EXAMINE_START,
310 TARGET_EVENT_EXAMINE_END,
311
312 TARGET_EVENT_GDB_ATTACH,
313 TARGET_EVENT_GDB_DETACH,
314
315 TARGET_EVENT_GDB_FLASH_ERASE_START,
316 TARGET_EVENT_GDB_FLASH_ERASE_END,
317 TARGET_EVENT_GDB_FLASH_WRITE_START,
318 TARGET_EVENT_GDB_FLASH_WRITE_END,
319 };
320
321 extern const Jim_Nvp nvp_target_event[];
322
323 struct target_event_action_s {
324 enum target_event event;
325 Jim_Obj *body;
326 int has_percent;
327 target_event_action_t *next;
328 };
329
330 typedef struct target_event_callback_s
331 {
332 int (*callback)(struct target_s *target, enum target_event event, void *priv);
333 void *priv;
334 struct target_event_callback_s *next;
335 } target_event_callback_t;
336
337 typedef struct target_timer_callback_s
338 {
339 int (*callback)(void *priv);
340 int time_ms;
341 int periodic;
342 struct timeval when;
343 void *priv;
344 struct target_timer_callback_s *next;
345 } target_timer_callback_t;
346
347 extern int target_register_commands(struct command_context_s *cmd_ctx);
348 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
349 extern int target_init(struct command_context_s *cmd_ctx);
350 extern int target_examine(void);
351 extern int handle_target(void *priv);
352 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
353
354 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
355 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
356 extern int target_poll(target_t *target);
357 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
358 extern int target_halt(target_t *target);
359 extern int target_call_event_callbacks(target_t *target, enum target_event event);
360
361 /* The period is very approximate, the callback can happen much more often
362 * or much more rarely than specified
363 */
364 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
365 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
366 extern int target_call_timer_callbacks(void);
367 /* invoke this to ensure that e.g. polling timer callbacks happen before
368 * a syncrhonous command completes.
369 */
370 extern int target_call_timer_callbacks_now(void);
371
372 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
373 extern int get_num_by_target(target_t *query_target);
374 extern target_t* get_target_by_num(int num);
375
376 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
377 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
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
382 /* DANGER!!!!!
383 *
384 * if "area" passed in to target_alloc_working_area() points to a memory
385 * location that goes out of scope (e.g. a pointer on the stack), then
386 * the caller of target_alloc_working_area() is responsible for invoking
387 * target_free_working_area() before "area" goes out of scope.
388 *
389 * target_free_all_working_areas() will NULL out the "area" pointer
390 * upon resuming or resetting the CPU.
391 *
392 */
393 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
394 extern int target_free_working_area(struct target_s *target, working_area_t *area);
395 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
396 extern void target_free_all_working_areas(struct target_s *target);
397 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
398
399 extern target_t *all_targets;
400
401 extern target_event_callback_t *target_event_callbacks;
402 extern target_timer_callback_t *target_timer_callbacks;
403
404 extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
405 extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
406 extern u8 target_buffer_get_u8 (target_t *target, u8 *buffer);
407 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
408 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
411 int target_read_u32(struct target_s *target, u32 address, u32 *value);
412 int target_read_u16(struct target_s *target, u32 address, u16 *value);
413 int target_read_u8(struct target_s *target, u32 address, u8 *value);
414 int target_write_u32(struct target_s *target, u32 address, u32 value);
415 int target_write_u16(struct target_s *target, u32 address, u16 value);
416 int target_write_u8(struct target_s *target, u32 address, u8 value);
417
418 /* Issues USER() statements with target state information */
419 int target_arch_state(struct target_s *target);
420
421 void target_handle_event( target_t *t, enum target_event e);
422 void target_all_handle_event( enum target_event e );
423
424 #define ERROR_TARGET_INVALID (-300)
425 #define ERROR_TARGET_INIT_FAILED (-301)
426 #define ERROR_TARGET_TIMEOUT (-302)
427 #define ERROR_TARGET_NOT_HALTED (-304)
428 #define ERROR_TARGET_FAILURE (-305)
429 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
430 #define ERROR_TARGET_DATA_ABORT (-307)
431 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
432 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
433 #define ERROR_TARGET_NOT_RUNNING (-310)
434 #define ERROR_TARGET_NOT_EXAMINED (-311)
435
436 extern const Jim_Nvp nvp_error_target[];
437 extern const char *target_strerror_safe( int err );
438
439 #endif /* TARGET_H */