1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
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. *
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. *
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 ***************************************************************************/
29 #include "breakpoints.h"
30 #include "algorithm.h"
35 struct command_context_s;
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) */
53 TARGET_DEBUG_RUNNING = 4,
56 extern const Jim_Nvp nvp_target_state[];
63 extern const Jim_Nvp nvp_assert[];
65 enum target_reset_mode
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 */
73 extern const Jim_Nvp nvp_reset_mode[];
75 enum target_debug_reason
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
86 extern const Jim_Nvp nvp_target_debug_reason[];
90 TARGET_ENDIAN_UNKNOWN=0,
91 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
94 extern const Jim_Nvp nvp_target_endian[];
98 typedef struct working_area_s
104 struct working_area_s **user;
105 struct working_area_s *next;
108 typedef struct target_type_s
113 * Indicates whether this target has been examined.
115 * Do @b not access this field directly, use target_was_examined()
116 * target_set_examined(), and target_reset_examined().
120 /* poll current target status */
121 int (*poll)(struct target_s *target);
122 /* Invoked only from target_arch_state().
123 * Issue USER() w/architecture specific status. */
124 int (*arch_state)(struct target_s *target);
126 /* target request support */
127 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
129 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
130 int (*halt)(struct target_s *target);
131 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
132 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
134 /* target reset control. assert reset can be invoked when OpenOCD and
135 * the target is out of sync.
137 * A typical example is that the target was power cycled while OpenOCD
138 * thought the target was halted or running.
140 * assert_reset() can therefore make no assumptions whatsoever about the
141 * state of the target
143 * Before assert_reset() for the target is invoked, a TRST/tms and
144 * chain validation is executed. TRST should not be asserted
145 * during target assert unless there is no way around it due to
146 * the way reset's are configured.
149 int (*assert_reset)(struct target_s *target);
150 int (*deassert_reset)(struct target_s *target);
151 int (*soft_reset_halt_imp)(struct target_s *target);
152 int (*soft_reset_halt)(struct target_s *target);
155 * Target register access for GDB. Do @b not call this function
156 * directly, use target_get_gdb_reg_list() instead.
158 * Danger! this function will succeed even if the target is running
159 * and return a register list with dummy values.
161 * The reason is that GDB connection will fail without a valid register
162 * list, however it is after GDB is connected that monitor commands can
163 * be run to properly initialize the target
165 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
167 /* target memory access
168 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
169 * count: number of items of <size>
171 int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
173 * Target memory read callback. Do @b not call this function
174 * directly, use target_read_memory() instead.
176 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
177 int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
179 * Target memory write callback. Do @b not call this function
180 * directly, use target_write_memory() instead.
182 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
185 * Write target memory in multiples of 4 bytes, optimized for
186 * writing large quantities of data. Do @b not call this
187 * function directly, use target_bulk_write_memory() instead.
189 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
191 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
192 int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
195 * target break-/watchpoint control
196 * rw: 0 = write, 1 = read, 2 = access
198 * Target must be halted while this is invoked as this
199 * will actually set up breakpoints on target.
201 * The breakpoint hardware will be set up upon adding the first breakpoint.
203 * Upon GDB connection all breakpoints/watchpoints are cleared.
205 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
207 /* remove breakpoint. hw will only be updated if the target is currently halted.
208 * However, this method can be invoked on unresponsive targets.
210 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
211 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
212 /* remove watchpoint. hw will only be updated if the target is currently halted.
213 * However, this method can be invoked on unresponsive targets.
215 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
217 /* target algorithm support */
218 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);
220 * Target algorithm support. Do @b not call this method directly,
221 * use target_run_algorithm() instead.
223 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);
225 int (*register_commands)(struct command_context_s *cmd_ctx);
227 /* called when target is created */
228 int (*target_create)( struct target_s *target, Jim_Interp *interp );
230 /* called for various config parameters */
231 /* returns JIM_CONTINUE - if option not understood */
232 /* otherwise: JIM_OK, or JIM_ERR, */
233 int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
235 /* target commands specifically handled by the target */
236 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
237 int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
239 /* invoked after JTAG chain has been examined & validated. During
240 * this stage the target is examined and any additional setup is
243 * invoked every time after the jtag chain has been validated/examined
245 int (*examine)(struct target_s *target);
246 /* Set up structures for target.
248 * It is illegal to talk to the target at this stage as this fn is invoked
249 * before the JTAG chain has been examined/verified
251 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
254 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
255 int (*mmu)(struct target_s *target, int *enabled);
259 /* forward decloration */
260 typedef struct target_event_action_s target_event_action_t;
262 typedef struct target_s
264 target_type_t *type; /* target type definition (name, access functions) */
265 const char *cmd_name; /* tcl Name of target */
266 int target_number; /* generaly, target index but may not be in order */
267 jtag_tap_t *tap; /* where on the jtag chain is this */
268 const char *variant; /* what varient of this chip is it? */
269 target_event_action_t *event_action;
271 int reset_halt; /* attempt resetting the CPU into the halted mode? */
272 u32 working_area; /* working area (initialized RAM). Evaluated
273 * upon first allocation from virtual/physical address. */
274 u32 working_area_virt; /* virtual address */
275 u32 working_area_phys; /* physical address */
276 u32 working_area_size; /* size in bytes */
277 u32 backup_working_area; /* whether the content of the working area has to be preserved */
278 struct working_area_s *working_areas;/* list of allocated working areas */
279 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
280 enum target_endianess endianness; /* target endianess */
281 enum target_state state; /* the current backend-state (running, halted, ...) */
282 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
283 struct breakpoint_s *breakpoints; /* list of breakpoints */
284 struct watchpoint_s *watchpoints; /* list of watchpoints */
285 struct trace_s *trace_info; /* generic trace information */
286 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
287 u32 dbg_msg_enabled; /* debug message status */
288 void *arch_info; /* architecture specific information */
289 struct target_s *next; /* next target in list */
291 int display; /* display async info in telnet session. Do not display
292 * lots of halted/resumed info when stepping in debugger. */
297 /* LD historical names
298 * - Prior to the great TCL change
299 * - June/July/Aug 2008
301 TARGET_EVENT_OLD_gdb_program_config,
302 TARGET_EVENT_OLD_pre_reset,
303 TARGET_EVENT_OLD_post_reset,
304 TARGET_EVENT_OLD_pre_resume,
306 /* allow GDB to do stuff before others handle the halted event,
307 * this is in lieu of defining ordering of invocation of events,
308 * which would be more complicated */
309 TARGET_EVENT_EARLY_HALTED,
310 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
311 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
312 TARGET_EVENT_RESUME_START,
313 TARGET_EVENT_RESUME_END,
315 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
316 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
318 TARGET_EVENT_RESET_START,
319 TARGET_EVENT_RESET_ASSERT_PRE,
320 TARGET_EVENT_RESET_ASSERT_POST,
321 TARGET_EVENT_RESET_DEASSERT_PRE,
322 TARGET_EVENT_RESET_DEASSERT_POST,
323 TARGET_EVENT_RESET_HALT_PRE,
324 TARGET_EVENT_RESET_HALT_POST,
325 TARGET_EVENT_RESET_WAIT_PRE,
326 TARGET_EVENT_RESET_WAIT_POST,
327 TARGET_EVENT_RESET_INIT,
328 TARGET_EVENT_RESET_END,
330 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
331 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
333 TARGET_EVENT_EXAMINE_START,
334 TARGET_EVENT_EXAMINE_END,
336 TARGET_EVENT_GDB_ATTACH,
337 TARGET_EVENT_GDB_DETACH,
339 TARGET_EVENT_GDB_FLASH_ERASE_START,
340 TARGET_EVENT_GDB_FLASH_ERASE_END,
341 TARGET_EVENT_GDB_FLASH_WRITE_START,
342 TARGET_EVENT_GDB_FLASH_WRITE_END,
345 struct target_event_action_s {
346 enum target_event event;
349 target_event_action_t *next;
352 typedef struct target_event_callback_s
354 int (*callback)(struct target_s *target, enum target_event event, void *priv);
356 struct target_event_callback_s *next;
357 } target_event_callback_t;
359 typedef struct target_timer_callback_s
361 int (*callback)(void *priv);
366 struct target_timer_callback_s *next;
367 } target_timer_callback_t;
369 extern int target_register_commands(struct command_context_s *cmd_ctx);
370 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
371 extern int target_init(struct command_context_s *cmd_ctx);
372 extern int target_examine(void);
373 extern int handle_target(void *priv);
374 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
376 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
377 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
378 extern int target_poll(target_t *target);
379 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
380 extern int target_halt(target_t *target);
381 extern int target_call_event_callbacks(target_t *target, enum target_event event);
383 /* The period is very approximate, the callback can happen much more often
384 * or much more rarely than specified
386 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
387 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
388 extern int target_call_timer_callbacks(void);
389 /* invoke this to ensure that e.g. polling timer callbacks happen before
390 * a syncrhonous command completes.
392 extern int target_call_timer_callbacks_now(void);
394 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
395 extern int get_num_by_target(target_t *query_target);
396 extern target_t *get_target(const char *id);
398 /// @returns @c true if the target has been examined.
399 extern bool target_was_examined(struct target_s *target);
400 /// Sets the @c examined flag for the given target.
401 extern void target_set_examined(struct target_s *target);
402 /// Reset the @c examined flag for the given target.
403 extern void target_reset_examined(struct target_s *target);
406 * Obtain the registers for GDB.
408 * This routine is a wrapper for target->type->get_gdb_reg_list.
410 extern int target_get_gdb_reg_list(struct target_s *target,
411 struct reg_s **reg_list[], int *reg_list_size);
414 * Run an algorithm on the @a target given.
416 * This routine is a wrapper for target->type->run_algorithm.
418 extern int target_run_algorithm(struct target_s *target,
419 int num_mem_params, mem_param_t *mem_params,
420 int num_reg_params, reg_param_t *reg_param,
421 u32 entry_point, u32 exit_point,
422 int timeout_ms, void *arch_info);
425 * Read @count items of @a size bytes from the memory of @a target at
426 * the @a address given.
428 * This routine is a wrapper for target->type->read_memory.
430 extern int target_read_memory(struct target_s *target,
431 u32 address, u32 size, u32 count, u8 *buffer);
433 * Write @count items of @a size bytes to the memory of @a target at
434 * the @a address given.
436 * This routine is wrapper for target->type->write_memory.
438 extern int target_write_memory(struct target_s *target,
439 u32 address, u32 size, u32 count, u8 *buffer);
442 * Write @count items of 4 bytes to the memory of @a target at
443 * the @a address given. Because it operates only on whole words,
444 * this should be faster than target_write_memory().
446 * This routine is wrapper for target->type->bulk_write_memory.
448 extern int target_bulk_write_memory(struct target_s *target,
449 u32 address, u32 count, u8 *buffer);
451 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
452 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
453 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
454 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
455 extern int target_wait_state(target_t *target, enum target_state state, int ms);
459 * if "area" passed in to target_alloc_working_area() points to a memory
460 * location that goes out of scope (e.g. a pointer on the stack), then
461 * the caller of target_alloc_working_area() is responsible for invoking
462 * target_free_working_area() before "area" goes out of scope.
464 * target_free_all_working_areas() will NULL out the "area" pointer
465 * upon resuming or resetting the CPU.
468 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
469 extern int target_free_working_area(struct target_s *target, working_area_t *area);
470 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
471 extern void target_free_all_working_areas(struct target_s *target);
472 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
474 extern target_t *all_targets;
476 extern target_event_callback_t *target_event_callbacks;
477 extern target_timer_callback_t *target_timer_callbacks;
479 extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
480 extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
481 extern u8 target_buffer_get_u8 (target_t *target, const u8 *buffer);
482 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
483 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
484 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value);
486 int target_read_u32(struct target_s *target, u32 address, u32 *value);
487 int target_read_u16(struct target_s *target, u32 address, u16 *value);
488 int target_read_u8(struct target_s *target, u32 address, u8 *value);
489 int target_write_u32(struct target_s *target, u32 address, u32 value);
490 int target_write_u16(struct target_s *target, u32 address, u16 value);
491 int target_write_u8(struct target_s *target, u32 address, u8 value);
493 /* Issues USER() statements with target state information */
494 int target_arch_state(struct target_s *target);
496 void target_handle_event( target_t *t, enum target_event e);
497 void target_all_handle_event( enum target_event e );
499 #define ERROR_TARGET_INVALID (-300)
500 #define ERROR_TARGET_INIT_FAILED (-301)
501 #define ERROR_TARGET_TIMEOUT (-302)
502 #define ERROR_TARGET_NOT_HALTED (-304)
503 #define ERROR_TARGET_FAILURE (-305)
504 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
505 #define ERROR_TARGET_DATA_ABORT (-307)
506 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
507 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
508 #define ERROR_TARGET_NOT_RUNNING (-310)
509 #define ERROR_TARGET_NOT_EXAMINED (-311)
511 extern const Jim_Nvp nvp_error_target[];
512 extern const char *target_strerror_safe( int err );
514 #endif /* TARGET_H */