1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008,2009 Ø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)
47 * also see: target_state_name();
57 TARGET_DEBUG_RUNNING
= 4,
60 extern const Jim_Nvp nvp_target_state
[];
67 extern const Jim_Nvp nvp_assert
[];
69 enum target_reset_mode
72 RESET_RUN
= 1, /* reset and let target run */
73 RESET_HALT
= 2, /* reset and halt target out of reset */
74 RESET_INIT
= 3, /* reset and halt target out of reset, then run init script */
77 extern const Jim_Nvp nvp_reset_mode
[];
79 enum target_debug_reason
82 DBG_REASON_BREAKPOINT
= 1,
83 DBG_REASON_WATCHPOINT
= 2,
84 DBG_REASON_WPTANDBKPT
= 3,
85 DBG_REASON_SINGLESTEP
= 4,
86 DBG_REASON_NOTHALTED
= 5,
87 DBG_REASON_UNDEFINED
= 6
90 extern const Jim_Nvp nvp_target_debug_reason
[];
94 TARGET_ENDIAN_UNKNOWN
= 0,
95 TARGET_BIG_ENDIAN
= 1, TARGET_LITTLE_ENDIAN
= 2
98 extern const Jim_Nvp nvp_target_endian
[];
102 typedef struct working_area_s
108 struct working_area_s
**user
;
109 struct working_area_s
*next
;
112 // target_type.h contains the full definitionof struct target_type_s
113 struct target_type_s
;
114 typedef struct target_type_s target_type_t
;
116 /* forward decloration */
117 typedef struct target_event_action_s target_event_action_t
;
119 typedef struct target_s
121 target_type_t
*type
; /* target type definition (name, access functions) */
122 const char *cmd_name
; /* tcl Name of target */
123 int target_number
; /* DO NOT USE! field to be removed in 2010 */
124 jtag_tap_t
*tap
; /* where on the jtag chain is this */
125 const char *variant
; /* what varient of this chip is it? */
126 target_event_action_t
*event_action
;
128 int reset_halt
; /* attempt resetting the CPU into the halted mode? */
129 uint32_t working_area
; /* working area (initialized RAM). Evaluated
130 * upon first allocation from virtual/physical address. */
131 bool working_area_virt_spec
; /* virtual address specified? */
132 uint32_t working_area_virt
; /* virtual address */
133 bool working_area_phys_spec
; /* virtual address specified? */
134 uint32_t working_area_phys
; /* physical address */
135 uint32_t working_area_size
; /* size in bytes */
136 uint32_t backup_working_area
; /* whether the content of the working area has to be preserved */
137 struct working_area_s
*working_areas
;/* list of allocated working areas */
138 enum target_debug_reason debug_reason
;/* reason why the target entered debug state */
139 enum target_endianess endianness
; /* target endianess */
140 // also see: target_state_name()
141 enum target_state state
; /* the current backend-state (running, halted, ...) */
142 struct reg_cache_s
*reg_cache
; /* the first register cache of the target (core regs) */
143 struct breakpoint_s
*breakpoints
; /* list of breakpoints */
144 struct watchpoint_s
*watchpoints
; /* list of watchpoints */
145 struct trace_s
*trace_info
; /* generic trace information */
146 struct debug_msg_receiver_s
*dbgmsg
;/* list of debug message receivers */
147 uint32_t dbg_msg_enabled
; /* debug message status */
148 void *arch_info
; /* architecture specific information */
149 struct target_s
*next
; /* next target in list */
151 int display
; /* display async info in telnet session. Do not display
152 * lots of halted/resumed info when stepping in debugger. */
153 bool halt_issued
; /* did we transition to halted state? */
154 long long halt_issued_time
; /* Note time when halt was issued */
159 /* LD historical names
160 * - Prior to the great TCL change
161 * - June/July/Aug 2008
163 TARGET_EVENT_OLD_gdb_program_config
,
164 TARGET_EVENT_OLD_pre_reset
,
165 TARGET_EVENT_OLD_post_reset
,
166 TARGET_EVENT_OLD_pre_resume
,
168 /* allow GDB to do stuff before others handle the halted event,
169 * this is in lieu of defining ordering of invocation of events,
170 * which would be more complicated
172 * Telling GDB to halt does not mean that the target stopped running,
173 * simply that we're dropping out of GDB's waiting for step or continue.
175 * This can be useful when e.g. detecting power dropout.
177 TARGET_EVENT_GDB_HALT
,
178 TARGET_EVENT_HALTED
, /* target entered debug state from normal execution or reset */
179 TARGET_EVENT_RESUMED
, /* target resumed to normal execution */
180 TARGET_EVENT_RESUME_START
,
181 TARGET_EVENT_RESUME_END
,
183 TARGET_EVENT_GDB_START
, /* debugger started execution (step/run) */
184 TARGET_EVENT_GDB_END
, /* debugger stopped execution (step/run) */
186 TARGET_EVENT_RESET_START
,
187 TARGET_EVENT_RESET_ASSERT_PRE
,
188 TARGET_EVENT_RESET_ASSERT_POST
,
189 TARGET_EVENT_RESET_DEASSERT_PRE
,
190 TARGET_EVENT_RESET_DEASSERT_POST
,
191 TARGET_EVENT_RESET_HALT_PRE
,
192 TARGET_EVENT_RESET_HALT_POST
,
193 TARGET_EVENT_RESET_WAIT_PRE
,
194 TARGET_EVENT_RESET_WAIT_POST
,
195 TARGET_EVENT_RESET_INIT
,
196 TARGET_EVENT_RESET_END
,
198 TARGET_EVENT_DEBUG_HALTED
, /* target entered debug state, but was executing on behalf of the debugger */
199 TARGET_EVENT_DEBUG_RESUMED
, /* target resumed to execute on behalf of the debugger */
201 TARGET_EVENT_EXAMINE_START
,
202 TARGET_EVENT_EXAMINE_END
,
204 TARGET_EVENT_GDB_ATTACH
,
205 TARGET_EVENT_GDB_DETACH
,
207 TARGET_EVENT_GDB_FLASH_ERASE_START
,
208 TARGET_EVENT_GDB_FLASH_ERASE_END
,
209 TARGET_EVENT_GDB_FLASH_WRITE_START
,
210 TARGET_EVENT_GDB_FLASH_WRITE_END
,
213 struct target_event_action_s
{
214 enum target_event event
;
217 target_event_action_t
*next
;
220 typedef struct target_event_callback_s
222 int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
);
224 struct target_event_callback_s
*next
;
225 } target_event_callback_t
;
227 typedef struct target_timer_callback_s
229 int (*callback
)(void *priv
);
234 struct target_timer_callback_s
*next
;
235 } target_timer_callback_t
;
237 extern int target_register_commands(struct command_context_s
*cmd_ctx
);
238 extern int target_register_user_commands(struct command_context_s
*cmd_ctx
);
239 extern int target_init(struct command_context_s
*cmd_ctx
);
240 extern int target_examine(void);
241 extern int handle_target(void *priv
);
242 extern int target_process_reset(struct command_context_s
*cmd_ctx
, enum target_reset_mode reset_mode
);
244 extern int target_register_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
245 extern int target_unregister_event_callback(int (*callback
)(struct target_s
*target
, enum target_event event
, void *priv
), void *priv
);
246 extern int target_poll(target_t
*target
);
247 extern int target_resume(target_t
*target
, int current
, uint32_t address
, int handle_breakpoints
, int debug_execution
);
248 extern int target_halt(target_t
*target
);
249 extern int target_call_event_callbacks(target_t
*target
, enum target_event event
);
251 /* The period is very approximate, the callback can happen much more often
252 * or much more rarely than specified
254 extern int target_register_timer_callback(int (*callback
)(void *priv
), int time_ms
, int periodic
, void *priv
);
255 extern int target_unregister_timer_callback(int (*callback
)(void *priv
), void *priv
);
256 extern int target_call_timer_callbacks(void);
257 /* invoke this to ensure that e.g. polling timer callbacks happen before
258 * a syncrhonous command completes.
260 extern int target_call_timer_callbacks_now(void);
262 extern target_t
* get_current_target(struct command_context_s
*cmd_ctx
);
263 extern target_t
*get_target(const char *id
);
266 * Get the target name.
268 * This routine is a wrapper for the target->type->name field.
270 extern const char *target_get_name(struct target_s
*target
);
273 * Examine the specified @a target.
275 * This routine is a wrapper for target->type->examine.
277 extern int target_examine_one(struct target_s
*target
);
278 /// @returns @c true if the target has been examined.
279 extern bool target_was_examined(struct target_s
*target
);
280 /// Sets the @c examined flag for the given target.
281 extern void target_set_examined(struct target_s
*target
);
282 /// Reset the @c examined flag for the given target.
283 extern void target_reset_examined(struct target_s
*target
);
287 * Add the @a breakpoint for @a target.
289 * This routine is a wrapper for target->type->add_breakpoint.
291 extern int target_add_breakpoint(struct target_s
*target
,
292 struct breakpoint_s
*breakpoint
);
294 * Remove the @a breakpoint for @a target.
296 * This routine is a wrapper for target->type->remove_breakpoint.
298 extern int target_remove_breakpoint(struct target_s
*target
,
299 struct breakpoint_s
*breakpoint
);
301 * Add the @a watchpoint for @a target.
303 * This routine is a wrapper for target->type->add_watchpoint.
305 extern int target_add_watchpoint(struct target_s
*target
,
306 struct watchpoint_s
*watchpoint
);
308 * Remove the @a watchpoint for @a target.
310 * This routine is a wrapper for target->type->remove_watchpoint.
312 extern int target_remove_watchpoint(struct target_s
*target
,
313 struct watchpoint_s
*watchpoint
);
316 * Obtain the registers for GDB.
318 * This routine is a wrapper for target->type->get_gdb_reg_list.
320 extern int target_get_gdb_reg_list(struct target_s
*target
,
321 struct reg_s
**reg_list
[], int *reg_list_size
);
326 * This routine is a wrapper for target->type->step.
328 int target_step(struct target_s
*target
,
329 int current
, uint32_t address
, int handle_breakpoints
);
331 * Run an algorithm on the @a target given.
333 * This routine is a wrapper for target->type->run_algorithm.
335 extern int target_run_algorithm(struct target_s
*target
,
336 int num_mem_params
, mem_param_t
*mem_params
,
337 int num_reg_params
, reg_param_t
*reg_param
,
338 uint32_t entry_point
, uint32_t exit_point
,
339 int timeout_ms
, void *arch_info
);
342 * Read @a count items of @a size bytes from the memory of @a target at
343 * the @a address given.
345 * This routine is a wrapper for target->type->read_memory.
347 extern int target_read_memory(struct target_s
*target
,
348 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
350 * Write @a count items of @a size bytes to the memory of @a target at
351 * the @a address given.
353 * This routine is wrapper for target->type->write_memory.
355 extern int target_write_memory(struct target_s
*target
,
356 uint32_t address
, uint32_t size
, uint32_t count
, uint8_t *buffer
);
359 * Write @a count items of 4 bytes to the memory of @a target at
360 * the @a address given. Because it operates only on whole words,
361 * this should be faster than target_write_memory().
363 * This routine is wrapper for target->type->bulk_write_memory.
365 extern int target_bulk_write_memory(struct target_s
*target
,
366 uint32_t address
, uint32_t count
, uint8_t *buffer
);
369 * Write to target memory using the virtual address.
371 * Note that this fn is used to implement software breakpoints. Targets
372 * can implement support for software breakpoints to memory marked as read
373 * only by making this fn write to ram even if it is read only(MMU or
376 * It is sufficient to implement for writing a single word(16 or 32 in
377 * ARM32/16 bit case) to write the breakpoint to ram.
379 * The target should also take care of "other things" to make sure that
380 * software breakpoints can be written using this function. E.g.
381 * when there is a separate instruction and data cache, this fn must
382 * make sure that the instruction cache is synced up to the potential
383 * code change that can happen as a result of the memory write(typically
384 * by invalidating the cache).
386 * The high level wrapper fn in target.c will break down this memory write
387 * request to multiple write requests to the target driver to e.g. guarantee
388 * that writing 4 bytes to an aligned address happens with a single 32 bit
389 * write operation, thus making this fn suitable to e.g. write to special
390 * peripheral registers which do not support byte operations.
392 extern int target_write_buffer(struct target_s
*target
, uint32_t address
, uint32_t size
, uint8_t *buffer
);
393 extern int target_read_buffer(struct target_s
*target
, uint32_t address
, uint32_t size
, uint8_t *buffer
);
394 extern int target_checksum_memory(struct target_s
*target
, uint32_t address
, uint32_t size
, uint32_t* crc
);
395 extern int target_blank_check_memory(struct target_s
*target
, uint32_t address
, uint32_t size
, uint32_t* blank
);
396 extern int target_wait_state(target_t
*target
, enum target_state state
, int ms
);
398 /** Return the *name* of this targets current state */
399 const char *target_state_name( target_t
*target
);
403 * if "area" passed in to target_alloc_working_area() points to a memory
404 * location that goes out of scope (e.g. a pointer on the stack), then
405 * the caller of target_alloc_working_area() is responsible for invoking
406 * target_free_working_area() before "area" goes out of scope.
408 * target_free_all_working_areas() will NULL out the "area" pointer
409 * upon resuming or resetting the CPU.
412 extern int target_alloc_working_area(struct target_s
*target
, uint32_t size
, working_area_t
**area
);
413 extern int target_free_working_area(struct target_s
*target
, working_area_t
*area
);
414 extern int target_free_working_area_restore(struct target_s
*target
, working_area_t
*area
, int restore
);
415 extern void target_free_all_working_areas(struct target_s
*target
);
416 extern void target_free_all_working_areas_restore(struct target_s
*target
, int restore
);
418 extern target_t
*all_targets
;
420 extern target_event_callback_t
*target_event_callbacks
;
421 extern target_timer_callback_t
*target_timer_callbacks
;
423 extern uint32_t target_buffer_get_u32(target_t
*target
, const uint8_t *buffer
);
424 extern uint16_t target_buffer_get_u16(target_t
*target
, const uint8_t *buffer
);
425 extern uint8_t target_buffer_get_u8 (target_t
*target
, const uint8_t *buffer
);
426 extern void target_buffer_set_u32(target_t
*target
, uint8_t *buffer
, uint32_t value
);
427 extern void target_buffer_set_u16(target_t
*target
, uint8_t *buffer
, uint16_t value
);
428 extern void target_buffer_set_u8 (target_t
*target
, uint8_t *buffer
, uint8_t value
);
430 int target_read_u32(struct target_s
*target
, uint32_t address
, uint32_t *value
);
431 int target_read_u16(struct target_s
*target
, uint32_t address
, uint16_t *value
);
432 int target_read_u8(struct target_s
*target
, uint32_t address
, uint8_t *value
);
433 int target_write_u32(struct target_s
*target
, uint32_t address
, uint32_t value
);
434 int target_write_u16(struct target_s
*target
, uint32_t address
, uint16_t value
);
435 int target_write_u8(struct target_s
*target
, uint32_t address
, uint8_t value
);
437 /* Issues USER() statements with target state information */
438 int target_arch_state(struct target_s
*target
);
440 void target_handle_event(target_t
*t
, enum target_event e
);
441 void target_all_handle_event(enum target_event e
);
443 #define ERROR_TARGET_INVALID (-300)
444 #define ERROR_TARGET_INIT_FAILED (-301)
445 #define ERROR_TARGET_TIMEOUT (-302)
446 #define ERROR_TARGET_NOT_HALTED (-304)
447 #define ERROR_TARGET_FAILURE (-305)
448 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
449 #define ERROR_TARGET_DATA_ABORT (-307)
450 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
451 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
452 #define ERROR_TARGET_NOT_RUNNING (-310)
453 #define ERROR_TARGET_NOT_EXAMINED (-311)
455 extern const Jim_Nvp nvp_error_target
[];
456 extern const char *target_strerror_safe(int err
);
458 #endif /* TARGET_H */