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 ***************************************************************************/
31 #include "breakpoints.h"
32 #include "algorithm.h"
37 struct command_context_s;
41 * Cast a member of a structure out to the containing structure.
42 * @param ptr The pointer to the member.
43 * @param type The type of the container struct this is embedded in.
44 * @param member The name of the member within the struct.
46 * This is a mechanism which is used throughout the Linux kernel.
48 #define container_of(ptr, type, member) ({ \
49 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
50 (type *)( (char *)__mptr - offsetof(type,member) );})
53 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
54 * TARGET_RUNNING = 1: the target is executing user code
55 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
56 * debugger. on an xscale it means that the debug handler is executing
57 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
58 * not sure how this is used with all the recent changes)
59 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
60 * behalf of the debugger (e.g. algorithm for flashing)
62 * also see: target_state_name();
72 TARGET_DEBUG_RUNNING = 4,
75 extern const Jim_Nvp nvp_target_state[];
82 extern const Jim_Nvp nvp_assert[];
84 enum target_reset_mode
87 RESET_RUN = 1, /* reset and let target run */
88 RESET_HALT = 2, /* reset and halt target out of reset */
89 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
92 extern const Jim_Nvp nvp_reset_mode[];
94 enum target_debug_reason
97 DBG_REASON_BREAKPOINT = 1,
98 DBG_REASON_WATCHPOINT = 2,
99 DBG_REASON_WPTANDBKPT = 3,
100 DBG_REASON_SINGLESTEP = 4,
101 DBG_REASON_NOTHALTED = 5,
102 DBG_REASON_UNDEFINED = 6
105 extern const Jim_Nvp nvp_target_debug_reason[];
107 enum target_endianess
109 TARGET_ENDIAN_UNKNOWN = 0,
110 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
113 extern const Jim_Nvp nvp_target_endian[];
117 typedef struct working_area_s
123 struct working_area_s **user;
124 struct working_area_s *next;
127 // target_type.h contains the full definitionof struct target_type_s
128 struct target_type_s;
129 typedef struct target_type_s target_type_t;
131 /* forward decloration */
132 typedef struct target_event_action_s target_event_action_t;
134 typedef struct target_s
136 target_type_t *type; /* target type definition (name, access functions) */
137 const char *cmd_name; /* tcl Name of target */
138 int target_number; /* DO NOT USE! field to be removed in 2010 */
139 jtag_tap_t *tap; /* where on the jtag chain is this */
140 const char *variant; /* what varient of this chip is it? */
141 target_event_action_t *event_action;
143 int reset_halt; /* attempt resetting the CPU into the halted mode? */
144 uint32_t working_area; /* working area (initialized RAM). Evaluated
145 * upon first allocation from virtual/physical address. */
146 bool working_area_virt_spec; /* virtual address specified? */
147 uint32_t working_area_virt; /* virtual address */
148 bool working_area_phys_spec; /* virtual address specified? */
149 uint32_t working_area_phys; /* physical address */
150 uint32_t working_area_size; /* size in bytes */
151 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
152 struct working_area_s *working_areas;/* list of allocated working areas */
153 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
154 enum target_endianess endianness; /* target endianess */
155 // also see: target_state_name()
156 enum target_state state; /* the current backend-state (running, halted, ...) */
157 struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
158 struct breakpoint_s *breakpoints; /* list of breakpoints */
159 struct watchpoint_s *watchpoints; /* list of watchpoints */
160 struct trace_s *trace_info; /* generic trace information */
161 struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
162 uint32_t dbg_msg_enabled; /* debug message status */
163 void *arch_info; /* architecture specific information */
164 struct target_s *next; /* next target in list */
166 int display; /* display async info in telnet session. Do not display
167 * lots of halted/resumed info when stepping in debugger. */
168 bool halt_issued; /* did we transition to halted state? */
169 long long halt_issued_time; /* Note time when halt was issued */
174 /* LD historical names
175 * - Prior to the great TCL change
176 * - June/July/Aug 2008
178 TARGET_EVENT_OLD_gdb_program_config,
179 TARGET_EVENT_OLD_pre_reset,
180 TARGET_EVENT_OLD_post_reset,
181 TARGET_EVENT_OLD_pre_resume,
183 /* allow GDB to do stuff before others handle the halted event,
184 * this is in lieu of defining ordering of invocation of events,
185 * which would be more complicated
187 * Telling GDB to halt does not mean that the target stopped running,
188 * simply that we're dropping out of GDB's waiting for step or continue.
190 * This can be useful when e.g. detecting power dropout.
192 TARGET_EVENT_GDB_HALT,
193 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
194 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
195 TARGET_EVENT_RESUME_START,
196 TARGET_EVENT_RESUME_END,
198 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
199 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
201 TARGET_EVENT_RESET_START,
202 TARGET_EVENT_RESET_ASSERT_PRE,
203 TARGET_EVENT_RESET_ASSERT_POST,
204 TARGET_EVENT_RESET_DEASSERT_PRE,
205 TARGET_EVENT_RESET_DEASSERT_POST,
206 TARGET_EVENT_RESET_HALT_PRE,
207 TARGET_EVENT_RESET_HALT_POST,
208 TARGET_EVENT_RESET_WAIT_PRE,
209 TARGET_EVENT_RESET_WAIT_POST,
210 TARGET_EVENT_RESET_INIT,
211 TARGET_EVENT_RESET_END,
213 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
214 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
216 TARGET_EVENT_EXAMINE_START,
217 TARGET_EVENT_EXAMINE_END,
219 TARGET_EVENT_GDB_ATTACH,
220 TARGET_EVENT_GDB_DETACH,
222 TARGET_EVENT_GDB_FLASH_ERASE_START,
223 TARGET_EVENT_GDB_FLASH_ERASE_END,
224 TARGET_EVENT_GDB_FLASH_WRITE_START,
225 TARGET_EVENT_GDB_FLASH_WRITE_END,
228 struct target_event_action_s {
229 enum target_event event;
232 target_event_action_t *next;
235 typedef struct target_event_callback_s
237 int (*callback)(struct target_s *target, enum target_event event, void *priv);
239 struct target_event_callback_s *next;
240 } target_event_callback_t;
242 typedef struct target_timer_callback_s
244 int (*callback)(void *priv);
249 struct target_timer_callback_s *next;
250 } target_timer_callback_t;
252 extern int target_register_commands(struct command_context_s *cmd_ctx);
253 extern int target_register_user_commands(struct command_context_s *cmd_ctx);
254 extern int target_init(struct command_context_s *cmd_ctx);
255 extern int target_examine(void);
256 extern int handle_target(void *priv);
257 extern int target_process_reset(struct command_context_s *cmd_ctx, enum target_reset_mode reset_mode);
259 extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
260 extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
261 extern int target_poll(target_t *target);
262 extern int target_resume(target_t *target, int current, uint32_t address, int handle_breakpoints, int debug_execution);
263 extern int target_halt(target_t *target);
264 extern int target_call_event_callbacks(target_t *target, enum target_event event);
266 /* The period is very approximate, the callback can happen much more often
267 * or much more rarely than specified
269 extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
270 extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
271 extern int target_call_timer_callbacks(void);
272 /* invoke this to ensure that e.g. polling timer callbacks happen before
273 * a syncrhonous command completes.
275 extern int target_call_timer_callbacks_now(void);
277 extern target_t* get_current_target(struct command_context_s *cmd_ctx);
278 extern target_t *get_target(const char *id);
281 * Get the target name.
283 * This routine is a wrapper for the target->type->name field.
285 extern const char *target_get_name(struct target_s *target);
288 * Examine the specified @a target.
290 * This routine is a wrapper for target->type->examine.
292 extern int target_examine_one(struct target_s *target);
293 /// @returns @c true if the target has been examined.
294 extern bool target_was_examined(struct target_s *target);
295 /// Sets the @c examined flag for the given target.
296 extern void target_set_examined(struct target_s *target);
297 /// Reset the @c examined flag for the given target.
298 extern void target_reset_examined(struct target_s *target);
302 * Add the @a breakpoint for @a target.
304 * This routine is a wrapper for target->type->add_breakpoint.
306 extern int target_add_breakpoint(struct target_s *target,
307 struct breakpoint_s *breakpoint);
309 * Remove the @a breakpoint for @a target.
311 * This routine is a wrapper for target->type->remove_breakpoint.
313 extern int target_remove_breakpoint(struct target_s *target,
314 struct breakpoint_s *breakpoint);
316 * Add the @a watchpoint for @a target.
318 * This routine is a wrapper for target->type->add_watchpoint.
320 extern int target_add_watchpoint(struct target_s *target,
321 struct watchpoint_s *watchpoint);
323 * Remove the @a watchpoint for @a target.
325 * This routine is a wrapper for target->type->remove_watchpoint.
327 extern int target_remove_watchpoint(struct target_s *target,
328 struct watchpoint_s *watchpoint);
331 * Obtain the registers for GDB.
333 * This routine is a wrapper for target->type->get_gdb_reg_list.
335 extern int target_get_gdb_reg_list(struct target_s *target,
336 struct reg_s **reg_list[], int *reg_list_size);
341 * This routine is a wrapper for target->type->step.
343 int target_step(struct target_s *target,
344 int current, uint32_t address, int handle_breakpoints);
346 * Run an algorithm on the @a target given.
348 * This routine is a wrapper for target->type->run_algorithm.
350 extern int target_run_algorithm(struct target_s *target,
351 int num_mem_params, mem_param_t *mem_params,
352 int num_reg_params, reg_param_t *reg_param,
353 uint32_t entry_point, uint32_t exit_point,
354 int timeout_ms, void *arch_info);
357 * Read @a count items of @a size bytes from the memory of @a target at
358 * the @a address given.
360 * This routine is a wrapper for target->type->read_memory.
362 extern int target_read_memory(struct target_s *target,
363 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
365 * Write @a count items of @a size bytes to the memory of @a target at
366 * the @a address given.
368 * This routine is wrapper for target->type->write_memory.
370 extern int target_write_memory(struct target_s *target,
371 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
374 * Write @a count items of 4 bytes to the memory of @a target at
375 * the @a address given. Because it operates only on whole words,
376 * this should be faster than target_write_memory().
378 * This routine is wrapper for target->type->bulk_write_memory.
380 extern int target_bulk_write_memory(struct target_s *target,
381 uint32_t address, uint32_t count, uint8_t *buffer);
384 * Write to target memory using the virtual address.
386 * Note that this fn is used to implement software breakpoints. Targets
387 * can implement support for software breakpoints to memory marked as read
388 * only by making this fn write to ram even if it is read only(MMU or
391 * It is sufficient to implement for writing a single word(16 or 32 in
392 * ARM32/16 bit case) to write the breakpoint to ram.
394 * The target should also take care of "other things" to make sure that
395 * software breakpoints can be written using this function. E.g.
396 * when there is a separate instruction and data cache, this fn must
397 * make sure that the instruction cache is synced up to the potential
398 * code change that can happen as a result of the memory write(typically
399 * by invalidating the cache).
401 * The high level wrapper fn in target.c will break down this memory write
402 * request to multiple write requests to the target driver to e.g. guarantee
403 * that writing 4 bytes to an aligned address happens with a single 32 bit
404 * write operation, thus making this fn suitable to e.g. write to special
405 * peripheral registers which do not support byte operations.
407 extern int target_write_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
408 extern int target_read_buffer(struct target_s *target, uint32_t address, uint32_t size, uint8_t *buffer);
409 extern int target_checksum_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* crc);
410 extern int target_blank_check_memory(struct target_s *target, uint32_t address, uint32_t size, uint32_t* blank);
411 extern int target_wait_state(target_t *target, enum target_state state, int ms);
413 /** Return the *name* of this targets current state */
414 const char *target_state_name( target_t *target );
418 * if "area" passed in to target_alloc_working_area() points to a memory
419 * location that goes out of scope (e.g. a pointer on the stack), then
420 * the caller of target_alloc_working_area() is responsible for invoking
421 * target_free_working_area() before "area" goes out of scope.
423 * target_free_all_working_areas() will NULL out the "area" pointer
424 * upon resuming or resetting the CPU.
427 extern int target_alloc_working_area(struct target_s *target, uint32_t size, working_area_t **area);
428 extern int target_free_working_area(struct target_s *target, working_area_t *area);
429 extern int target_free_working_area_restore(struct target_s *target, working_area_t *area, int restore);
430 extern void target_free_all_working_areas(struct target_s *target);
431 extern void target_free_all_working_areas_restore(struct target_s *target, int restore);
433 extern target_t *all_targets;
435 extern target_event_callback_t *target_event_callbacks;
436 extern target_timer_callback_t *target_timer_callbacks;
438 extern uint32_t target_buffer_get_u32(target_t *target, const uint8_t *buffer);
439 extern uint16_t target_buffer_get_u16(target_t *target, const uint8_t *buffer);
440 extern uint8_t target_buffer_get_u8 (target_t *target, const uint8_t *buffer);
441 extern void target_buffer_set_u32(target_t *target, uint8_t *buffer, uint32_t value);
442 extern void target_buffer_set_u16(target_t *target, uint8_t *buffer, uint16_t value);
443 extern void target_buffer_set_u8 (target_t *target, uint8_t *buffer, uint8_t value);
445 int target_read_u32(struct target_s *target, uint32_t address, uint32_t *value);
446 int target_read_u16(struct target_s *target, uint32_t address, uint16_t *value);
447 int target_read_u8(struct target_s *target, uint32_t address, uint8_t *value);
448 int target_write_u32(struct target_s *target, uint32_t address, uint32_t value);
449 int target_write_u16(struct target_s *target, uint32_t address, uint16_t value);
450 int target_write_u8(struct target_s *target, uint32_t address, uint8_t value);
452 /* Issues USER() statements with target state information */
453 int target_arch_state(struct target_s *target);
455 void target_handle_event(target_t *t, enum target_event e);
456 void target_all_handle_event(enum target_event e);
458 #define ERROR_TARGET_INVALID (-300)
459 #define ERROR_TARGET_INIT_FAILED (-301)
460 #define ERROR_TARGET_TIMEOUT (-302)
461 #define ERROR_TARGET_NOT_HALTED (-304)
462 #define ERROR_TARGET_FAILURE (-305)
463 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
464 #define ERROR_TARGET_DATA_ABORT (-307)
465 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
466 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
467 #define ERROR_TARGET_NOT_RUNNING (-310)
468 #define ERROR_TARGET_NOT_EXAMINED (-311)
470 extern const Jim_Nvp nvp_error_target[];
471 extern const char *target_strerror_safe(int err);
473 #endif /* TARGET_H */