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
111 * Name of the target. Do @b not access this field directly, use
112 * target_get_name() instead.
117 * Indicates whether this target has been examined.
119 * Do @b not access this field directly, use target_was_examined()
120 * target_set_examined(), and target_reset_examined().
124 /* poll current target status */
125 int (*poll)(struct target_s *target);
126 /* Invoked only from target_arch_state().
127 * Issue USER() w/architecture specific status. */
128 int (*arch_state)(struct target_s *target);
130 /* target request support */
131 int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
133 /* halt will log a warning, but return ERROR_OK if the target is already halted. */
134 int (*halt)(struct target_s *target);
135 int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
136 int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
138 /* target reset control. assert reset can be invoked when OpenOCD and
139 * the target is out of sync.
141 * A typical example is that the target was power cycled while OpenOCD
142 * thought the target was halted or running.
144 * assert_reset() can therefore make no assumptions whatsoever about the
145 * state of the target
147 * Before assert_reset() for the target is invoked, a TRST/tms and
148 * chain validation is executed. TRST should not be asserted
149 * during target assert unless there is no way around it due to
150 * the way reset's are configured.
153 int (*assert_reset)(struct target_s *target);
154 int (*deassert_reset)(struct target_s *target);
155 int (*soft_reset_halt_imp)(struct target_s *target);
156 int (*soft_reset_halt)(struct target_s *target);
159 * Target register access for GDB. Do @b not call this function
160 * directly, use target_get_gdb_reg_list() instead.
162 * Danger! this function will succeed even if the target is running
163 * and return a register list with dummy values.
165 * The reason is that GDB connection will fail without a valid register
166 * list, however it is after GDB is connected that monitor commands can
167 * be run to properly initialize the target
169 int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
171 /* target memory access
172 * size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
173 * count: number of items of <size>
175 int (*read_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
177 * Target memory read callback. Do @b not call this function
178 * directly, use target_read_memory() instead.
180 int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
181 int (*write_memory_imp)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
183 * Target memory write callback. Do @b not call this function
184 * directly, use target_write_memory() instead.
186 int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
189 * Write target memory in multiples of 4 bytes, optimized for
190 * writing large quantities of data. Do @b not call this
191 * function directly, use target_bulk_write_memory() instead.
193 int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
195 int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
196 int (*blank_check_memory)(struct target_s *target, u32 address, u32 count, u32* blank);
199 * target break-/watchpoint control
200 * rw: 0 = write, 1 = read, 2 = access
202 * Target must be halted while this is invoked as this
203 * will actually set up breakpoints on target.
205 * The breakpoint hardware will be set up upon adding the first breakpoint.
207 * Upon GDB connection all breakpoints/watchpoints are cleared.
209 int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
211 /* remove breakpoint. hw will only be updated if the target is currently halted.
212 * However, this method can be invoked on unresponsive targets.
214 int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
215 int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
216 /* remove watchpoint. hw will only be updated if the target is currently halted.
217 * However, this method can be invoked on unresponsive targets.
219 int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
221 /* target algorithm support */
222 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);
224 * Target algorithm support. Do @b not call this method directly,
225 * use target_run_algorithm() instead.
227 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);
229 int (*register_commands)(struct command_context_s *cmd_ctx);
231 /* called when target is created */
232 int (*target_create)( struct target_s *target, Jim_Interp *interp );
234 /* called for various config parameters */
235 /* returns JIM_CONTINUE - if option not understood */
236 /* otherwise: JIM_OK, or JIM_ERR, */
237 int (*target_jim_configure)( struct target_s *target, Jim_GetOptInfo *goi );
239 /* target commands specifically handled by the target */
240 /* returns JIM_OK, or JIM_ERR, or JIM_CONTINUE - if option not understood */
241 int (*target_jim_commands)( struct target_s *target, Jim_GetOptInfo *goi );
243 /* invoked after JTAG chain has been examined & validated. During
244 * this stage the target is examined and any additional setup is
247 * invoked every time after the jtag chain has been validated/examined
249 int (*examine)(struct target_s *target);
250 /* Set up structures for target.
252 * It is illegal to talk to the target at this stage as this fn is invoked
253 * before the JTAG chain has been examined/verified
255 int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
258 int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
259 int (*mmu)(struct target_s *target, int *enabled);
263 /* forward decloration */
264 typedef struct target_event_action_s target_event_action_t;
266 typedef struct target_s
268 target_type_t *type; /* target type definition (name, access functions) */
269 const char *cmd_name; /* tcl Name of target */
270 int target_number; /* generaly, target index but may not be in order */
271 jtag_tap_t *tap; /* where on the jtag chain is this */
272 const char *variant; /* what varient of this chip is it? */
273 target_event_action_t *event_action;
275 int reset_halt; /* attempt resetting the CPU into the halted mode? */
276 u32 working_area; /* working area (initialized RAM). Evaluated
277 * upon first allocation from virtual/physical address. */
278 u32 working_area_virt; /* virtual address */
279 u32 working_area_phys; /* physical address */
280 u32 working_area_size; /* size in bytes */
281 u32 backup_working_area; /* whether the content of the working area has to be preserved */
282 struct working_area_s *working_areas;/* list of allocated working areas */
283 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
284 enum target_endianess endianness; /* target endianess */
285 enum target_state state; /* the current backend-state (running, halted, ...) */
286 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
287 struct breakpoint_s *breakpoints; /* list of breakpoints */
288 struct watchpoint_s *watchpoints; /* list of watchpoints */
289 struct trace_s *trace_info; /* generic trace information */
290 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
291 u32 dbg_msg_enabled; /* debug message status */
292 void *arch_info; /* architecture specific information */
293 struct target_s *next; /* next target in list */
295 int display; /* display async info in telnet session. Do not display
296 * lots of halted/resumed info when stepping in debugger. */
301 /* LD historical names
302 * - Prior to the great TCL change
303 * - June/July/Aug 2008
305 TARGET_EVENT_OLD_gdb_program_config,
306 TARGET_EVENT_OLD_pre_reset,
307 TARGET_EVENT_OLD_post_reset,
308 TARGET_EVENT_OLD_pre_resume,
310 /* allow GDB to do stuff before others handle the halted event,
311 * this is in lieu of defining ordering of invocation of events,
312 * which would be more complicated */
313 TARGET_EVENT_EARLY_HALTED,
314 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
315 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
316 TARGET_EVENT_RESUME_START,
317 TARGET_EVENT_RESUME_END,
319 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
320 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
322 TARGET_EVENT_RESET_START,
323 TARGET_EVENT_RESET_ASSERT_PRE,
324 TARGET_EVENT_RESET_ASSERT_POST,
325 TARGET_EVENT_RESET_DEASSERT_PRE,
326 TARGET_EVENT_RESET_DEASSERT_POST,
327 TARGET_EVENT_RESET_HALT_PRE,
328 TARGET_EVENT_RESET_HALT_POST,
329 TARGET_EVENT_RESET_WAIT_PRE,
330 TARGET_EVENT_RESET_WAIT_POST,
331 TARGET_EVENT_RESET_INIT,
332 TARGET_EVENT_RESET_END,
334 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
335 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
337 TARGET_EVENT_EXAMINE_START,
338 TARGET_EVENT_EXAMINE_END,
340 TARGET_EVENT_GDB_ATTACH,
341 TARGET_EVENT_GDB_DETACH,
343 TARGET_EVENT_GDB_FLASH_ERASE_START,
344 TARGET_EVENT_GDB_FLASH_ERASE_END,
345 TARGET_EVENT_GDB_FLASH_WRITE_START,
346 TARGET_EVENT_GDB_FLASH_WRITE_END,
349 struct target_event_action_s {
350 enum target_event event;
353 target_event_action_t *next;
356 typedef struct target_event_callback_s
358 int (*callback)(struct target_s *target, enum target_event event, void *priv);
360 struct target_event_callback_s *next;
361 } target_event_callback_t;
363 typedef struct target_timer_callback_s
365 int (*callback)(void *priv);
370 struct target_timer_callback_s *next;
371 } target_timer_callback_t;
373 extern int target_register_commands(struct command_context_s *cmd_ctx);
374 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
375 extern int target_init(struct command_context_s *cmd_ctx);
376 extern int target_examine(void);
377 extern int handle_target(void *priv);
378 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
380 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
381 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
382 extern int target_poll(target_t *target);
383 extern int target_resume(target_t *target, int current, u32 address, int handle_breakpoints, int debug_execution);
384 extern int target_halt(target_t *target);
385 extern int target_call_event_callbacks(target_t *target, enum target_event event);
387 /* The period is very approximate, the callback can happen much more often
388 * or much more rarely than specified
390 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
391 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
392 extern int target_call_timer_callbacks(void);
393 /* invoke this to ensure that e.g. polling timer callbacks happen before
394 * a syncrhonous command completes.
396 extern int target_call_timer_callbacks_now(void);
398 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
399 extern int get_num_by_target(target_t *query_target);
400 extern target_t *get_target(const char *id);
403 * Get the target name.
405 * This routine is a wrapper for the target->type->name field.
407 extern const char *target_get_name(struct target_s *target);
409 /// @returns @c true if the target has been examined.
410 extern bool target_was_examined(struct target_s *target);
411 /// Sets the @c examined flag for the given target.
412 extern void target_set_examined(struct target_s *target);
413 /// Reset the @c examined flag for the given target.
414 extern void target_reset_examined(struct target_s *target);
417 * Obtain the registers for GDB.
419 * This routine is a wrapper for target->type->get_gdb_reg_list.
421 extern int target_get_gdb_reg_list(struct target_s *target,
422 struct reg_s **reg_list[], int *reg_list_size);
427 * This routine is a wrapper for target->type->step.
429 int target_step(struct target_s *target,
430 int current, u32 address, int handle_breakpoints);
432 * Run an algorithm on the @a target given.
434 * This routine is a wrapper for target->type->run_algorithm.
436 extern int target_run_algorithm(struct target_s *target,
437 int num_mem_params, mem_param_t *mem_params,
438 int num_reg_params, reg_param_t *reg_param,
439 u32 entry_point, u32 exit_point,
440 int timeout_ms, void *arch_info);
443 * Read @count items of @a size bytes from the memory of @a target at
444 * the @a address given.
446 * This routine is a wrapper for target->type->read_memory.
448 extern int target_read_memory(struct target_s *target,
449 u32 address, u32 size, u32 count, u8 *buffer);
451 * Write @count items of @a size bytes to the memory of @a target at
452 * the @a address given.
454 * This routine is wrapper for target->type->write_memory.
456 extern int target_write_memory(struct target_s *target,
457 u32 address, u32 size, u32 count, u8 *buffer);
460 * Write @count items of 4 bytes to the memory of @a target at
461 * the @a address given. Because it operates only on whole words,
462 * this should be faster than target_write_memory().
464 * This routine is wrapper for target->type->bulk_write_memory.
466 extern int target_bulk_write_memory(struct target_s *target,
467 u32 address, u32 count, u8 *buffer);
469 extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
470 extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
471 extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
472 extern int target_blank_check_memory(struct target_s *target, u32 address, u32 size, u32* blank);
473 extern int target_wait_state(target_t *target, enum target_state state, int ms);
477 * if "area" passed in to target_alloc_working_area() points to a memory
478 * location that goes out of scope (e.g. a pointer on the stack), then
479 * the caller of target_alloc_working_area() is responsible for invoking
480 * target_free_working_area() before "area" goes out of scope.
482 * target_free_all_working_areas() will NULL out the "area" pointer
483 * upon resuming or resetting the CPU.
486 extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
487 extern int target_free_working_area(struct target_s *target, working_area_t *area);
488 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
489 extern void target_free_all_working_areas(struct target_s *target);
490 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
492 extern target_t *all_targets;
494 extern target_event_callback_t *target_event_callbacks;
495 extern target_timer_callback_t *target_timer_callbacks;
497 extern u32 target_buffer_get_u32(target_t *target, const u8 *buffer);
498 extern u16 target_buffer_get_u16(target_t *target, const u8 *buffer);
499 extern u8 target_buffer_get_u8 (target_t *target, const u8 *buffer);
500 extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
501 extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
502 extern void target_buffer_set_u8 (target_t *target, u8 *buffer, u8 value);
504 int target_read_u32(struct target_s *target, u32 address, u32 *value);
505 int target_read_u16(struct target_s *target, u32 address, u16 *value);
506 int target_read_u8(struct target_s *target, u32 address, u8 *value);
507 int target_write_u32(struct target_s *target, u32 address, u32 value);
508 int target_write_u16(struct target_s *target, u32 address, u16 value);
509 int target_write_u8(struct target_s *target, u32 address, u8 value);
511 /* Issues USER() statements with target state information */
512 int target_arch_state(struct target_s *target);
514 void target_handle_event( target_t *t, enum target_event e);
515 void target_all_handle_event( enum target_event e );
517 #define ERROR_TARGET_INVALID (-300)
518 #define ERROR_TARGET_INIT_FAILED (-301)
519 #define ERROR_TARGET_TIMEOUT (-302)
520 #define ERROR_TARGET_NOT_HALTED (-304)
521 #define ERROR_TARGET_FAILURE (-305)
522 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
523 #define ERROR_TARGET_DATA_ABORT (-307)
524 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
525 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
526 #define ERROR_TARGET_NOT_RUNNING (-310)
527 #define ERROR_TARGET_NOT_EXAMINED (-311)
529 extern const Jim_Nvp nvp_error_target[];
530 extern const char *target_strerror_safe( int err );
532 #endif /* TARGET_H */