1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Ø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 <helper/types.h>
33 struct command_context;
41 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
42 * TARGET_RUNNING = 1: the target is executing user code
43 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
44 * debugger. on an xscale it means that the debug handler is executing
45 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
46 * not sure how this is used with all the recent changes)
47 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
48 * behalf of the debugger (e.g. algorithm for flashing)
50 * also see: target_state_name();
60 TARGET_DEBUG_RUNNING = 4,
68 enum target_reset_mode
71 RESET_RUN = 1, /* reset and let target run */
72 RESET_HALT = 2, /* reset and halt target out of reset */
73 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
76 enum target_debug_reason
79 DBG_REASON_BREAKPOINT = 1,
80 DBG_REASON_WATCHPOINT = 2,
81 DBG_REASON_WPTANDBKPT = 3,
82 DBG_REASON_SINGLESTEP = 4,
83 DBG_REASON_NOTHALTED = 5,
84 DBG_REASON_UNDEFINED = 6
89 TARGET_ENDIAN_UNKNOWN = 0,
90 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
99 struct working_area **user;
100 struct working_area *next;
103 // target_type.h contains the full definitionof struct targe_type
106 struct target_type *type; /* target type definition (name, access functions) */
107 const char *cmd_name; /* tcl Name of target */
108 int target_number; /* DO NOT USE! field to be removed in 2010 */
109 struct jtag_tap *tap; /* where on the jtag chain is this */
110 const char *variant; /* what variant of this chip is it? */
113 * Indicates whether this target has been examined.
115 * Do @b not access this field directly, use target_was_examined()
116 * or target_set_examined().
120 /** true iff the target is currently running a downloaded
121 * "algorithm" instetad of arbitrary user code. OpenOCD code
122 * invoking algorithms is trusted to maintain correctness of
123 * any cached state (e.g. for flash status), which arbitrary
124 * code will have no reason to know about.
128 struct target_event_action *event_action;
130 int reset_halt; /* attempt resetting the CPU into the halted mode? */
131 uint32_t working_area; /* working area (initialized RAM). Evaluated
132 * upon first allocation from virtual/physical address. */
133 bool working_area_virt_spec; /* virtual address specified? */
134 uint32_t working_area_virt; /* virtual address */
135 bool working_area_phys_spec; /* virtual address specified? */
136 uint32_t working_area_phys; /* physical address */
137 uint32_t working_area_size; /* size in bytes */
138 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
139 struct working_area *working_areas;/* list of allocated working areas */
140 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
141 enum target_endianess endianness; /* target endianess */
142 // also see: target_state_name()
143 enum target_state state; /* the current backend-state (running, halted, ...) */
144 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
145 struct breakpoint *breakpoints; /* list of breakpoints */
146 struct watchpoint *watchpoints; /* list of watchpoints */
147 struct trace *trace_info; /* generic trace information */
148 struct debug_msg_receiver *dbgmsg;/* list of debug message receivers */
149 uint32_t dbg_msg_enabled; /* debug message status */
150 void *arch_info; /* architecture specific information */
151 struct target *next; /* next target in list */
153 int display; /* display async info in telnet session. Do not display
154 * lots of halted/resumed info when stepping in debugger. */
155 bool halt_issued; /* did we transition to halted state? */
156 long long halt_issued_time; /* Note time when halt was issued */
159 /** Returns the instance-specific name of the specified target. */
160 static inline const char *target_name(struct target *target)
162 return target->cmd_name;
165 const char *debug_reason_name(struct target *t);
169 /* LD historical names
170 * - Prior to the great TCL change
171 * - June/July/Aug 2008
173 TARGET_EVENT_OLD_gdb_program_config,
174 TARGET_EVENT_OLD_pre_resume,
176 /* allow GDB to do stuff before others handle the halted event,
177 * this is in lieu of defining ordering of invocation of events,
178 * which would be more complicated
180 * Telling GDB to halt does not mean that the target stopped running,
181 * simply that we're dropping out of GDB's waiting for step or continue.
183 * This can be useful when e.g. detecting power dropout.
185 TARGET_EVENT_GDB_HALT,
186 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
187 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
188 TARGET_EVENT_RESUME_START,
189 TARGET_EVENT_RESUME_END,
191 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
192 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
194 TARGET_EVENT_RESET_START,
195 TARGET_EVENT_RESET_ASSERT_PRE,
196 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
197 TARGET_EVENT_RESET_ASSERT_POST,
198 TARGET_EVENT_RESET_DEASSERT_PRE,
199 TARGET_EVENT_RESET_DEASSERT_POST,
200 TARGET_EVENT_RESET_HALT_PRE,
201 TARGET_EVENT_RESET_HALT_POST,
202 TARGET_EVENT_RESET_WAIT_PRE,
203 TARGET_EVENT_RESET_WAIT_POST,
204 TARGET_EVENT_RESET_INIT,
205 TARGET_EVENT_RESET_END,
207 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
208 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
210 TARGET_EVENT_EXAMINE_START,
211 TARGET_EVENT_EXAMINE_END,
213 TARGET_EVENT_GDB_ATTACH,
214 TARGET_EVENT_GDB_DETACH,
216 TARGET_EVENT_GDB_FLASH_ERASE_START,
217 TARGET_EVENT_GDB_FLASH_ERASE_END,
218 TARGET_EVENT_GDB_FLASH_WRITE_START,
219 TARGET_EVENT_GDB_FLASH_WRITE_END,
222 struct target_event_action {
223 enum target_event event;
224 struct Jim_Interp *interp;
225 struct Jim_Obj *body;
227 struct target_event_action *next;
230 bool target_has_event_action(struct target *target, enum target_event event);
232 struct target_event_callback
234 int (*callback)(struct target *target, enum target_event event, void *priv);
236 struct target_event_callback *next;
239 struct target_timer_callback
241 int (*callback)(void *priv);
246 struct target_timer_callback *next;
249 int target_register_commands(struct command_context *cmd_ctx);
250 int target_register_user_commands(struct command_context *cmd_ctx);
251 int target_init(struct command_context *cmd_ctx);
252 int target_examine(void);
253 int target_process_reset(struct command_context *cmd_ctx,
254 enum target_reset_mode reset_mode);
256 int target_register_event_callback(
257 int (*callback)(struct target *target,
258 enum target_event event, void *priv),
260 int target_unregister_event_callback(
261 int (*callback)(struct target *target,
262 enum target_event event, void *priv),
264 int target_poll(struct target *target);
265 int target_resume(struct target *target, int current, uint32_t address,
266 int handle_breakpoints, int debug_execution);
267 int target_halt(struct target *target);
268 int target_call_event_callbacks(struct target *target, enum target_event event);
271 * The period is very approximate, the callback can happen much more often
272 * or much more rarely than specified
274 int target_register_timer_callback(int (*callback)(void *priv),
275 int time_ms, int periodic, void *priv);
276 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
278 int target_call_timer_callbacks(void);
280 * Invoke this to ensure that e.g. polling timer callbacks happen before
281 * a syncrhonous command completes.
283 int target_call_timer_callbacks_now(void);
285 struct target* get_current_target(struct command_context *cmd_ctx);
286 struct target *get_target(const char *id);
289 * Get the target type name.
291 * This routine is a wrapper for the target->type->name field.
292 * Note that this is not an instance-specific name for his target.
294 const char *target_type_name(struct target *target);
297 * Examine the specified @a target, letting it perform any
298 * initialization that requires JTAG access.
300 * This routine is a wrapper for target->type->examine.
302 int target_examine_one(struct target *target);
304 /// @returns @c true if target_set_examined() has been called.
305 static inline bool target_was_examined(struct target *target)
307 return target->examined;
310 /// Sets the @c examined flag for the given target.
311 /// Use in target->type->examine() after one-time setup is done.
312 static inline void target_set_examined(struct target *target)
314 target->examined = true;
318 * Add the @a breakpoint for @a target.
320 * This routine is a wrapper for target->type->add_breakpoint.
322 int target_add_breakpoint(struct target *target,
323 struct breakpoint *breakpoint);
325 * Remove the @a breakpoint for @a target.
327 * This routine is a wrapper for target->type->remove_breakpoint.
329 int target_remove_breakpoint(struct target *target,
330 struct breakpoint *breakpoint);
332 * Add the @a watchpoint for @a target.
334 * This routine is a wrapper for target->type->add_watchpoint.
336 int target_add_watchpoint(struct target *target,
337 struct watchpoint *watchpoint);
339 * Remove the @a watchpoint for @a target.
341 * This routine is a wrapper for target->type->remove_watchpoint.
343 int target_remove_watchpoint(struct target *target,
344 struct watchpoint *watchpoint);
347 * Obtain the registers for GDB.
349 * This routine is a wrapper for target->type->get_gdb_reg_list.
351 int target_get_gdb_reg_list(struct target *target,
352 struct reg **reg_list[], int *reg_list_size);
357 * This routine is a wrapper for target->type->step.
359 int target_step(struct target *target,
360 int current, uint32_t address, int handle_breakpoints);
362 * Run an algorithm on the @a target given.
364 * This routine is a wrapper for target->type->run_algorithm.
366 int target_run_algorithm(struct target *target,
367 int num_mem_params, struct mem_param *mem_params,
368 int num_reg_params, struct reg_param *reg_param,
369 uint32_t entry_point, uint32_t exit_point,
370 int timeout_ms, void *arch_info);
373 * Read @a count items of @a size bytes from the memory of @a target at
374 * the @a address given.
376 * This routine is a wrapper for target->type->read_memory.
378 int target_read_memory(struct target *target,
379 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
381 * Write @a count items of @a size bytes to the memory of @a target at
382 * the @a address given. @a address must be aligned to @a size
385 * The endianness is the same in the host and target memory for this
389 * Really @a buffer should have been defined as "const void *" and
390 * @a buffer should have been aligned to @a size in the host memory.
392 * This is not enforced via e.g. assert's today and e.g. the
393 * target_write_buffer fn breaks this assumption.
395 * This routine is wrapper for target->type->write_memory.
397 int target_write_memory(struct target *target,
398 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
401 * Write @a count items of 4 bytes to the memory of @a target at
402 * the @a address given. Because it operates only on whole words,
403 * this should be faster than target_write_memory().
405 * This routine is wrapper for target->type->bulk_write_memory.
407 int target_bulk_write_memory(struct target *target,
408 uint32_t address, uint32_t count, uint8_t *buffer);
411 * Write to target memory using the virtual address.
413 * Note that this fn is used to implement software breakpoints. Targets
414 * can implement support for software breakpoints to memory marked as read
415 * only by making this fn write to ram even if it is read only(MMU or
418 * It is sufficient to implement for writing a single word(16 or 32 in
419 * ARM32/16 bit case) to write the breakpoint to ram.
421 * The target should also take care of "other things" to make sure that
422 * software breakpoints can be written using this function. E.g.
423 * when there is a separate instruction and data cache, this fn must
424 * make sure that the instruction cache is synced up to the potential
425 * code change that can happen as a result of the memory write(typically
426 * by invalidating the cache).
428 * The high level wrapper fn in target.c will break down this memory write
429 * request to multiple write requests to the target driver to e.g. guarantee
430 * that writing 4 bytes to an aligned address happens with a single 32 bit
431 * write operation, thus making this fn suitable to e.g. write to special
432 * peripheral registers which do not support byte operations.
434 int target_write_buffer(struct target *target,
435 uint32_t address, uint32_t size, uint8_t *buffer);
436 int target_read_buffer(struct target *target,
437 uint32_t address, uint32_t size, uint8_t *buffer);
438 int target_checksum_memory(struct target *target,
439 uint32_t address, uint32_t size, uint32_t* crc);
440 int target_blank_check_memory(struct target *target,
441 uint32_t address, uint32_t size, uint32_t* blank);
442 int target_wait_state(struct target *target, enum target_state state, int ms);
444 /** Return the *name* of this targets current state */
445 const char *target_state_name( struct target *target );
449 * if "area" passed in to target_alloc_working_area() points to a memory
450 * location that goes out of scope (e.g. a pointer on the stack), then
451 * the caller of target_alloc_working_area() is responsible for invoking
452 * target_free_working_area() before "area" goes out of scope.
454 * target_free_all_working_areas() will NULL out the "area" pointer
455 * upon resuming or resetting the CPU.
458 int target_alloc_working_area(struct target *target,
459 uint32_t size, struct working_area **area);
460 int target_free_working_area(struct target *target, struct working_area *area);
461 int target_free_working_area_restore(struct target *target,
462 struct working_area *area, int restore);
463 void target_free_all_working_areas(struct target *target);
464 void target_free_all_working_areas_restore(struct target *target, int restore);
466 extern struct target *all_targets;
468 extern struct target_event_callback *target_event_callbacks;
469 extern struct target_timer_callback *target_timer_callbacks;
471 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
472 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
473 uint8_t target_buffer_get_u8 (struct target *target, const uint8_t *buffer);
474 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
475 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
476 void target_buffer_set_u8 (struct target *target, uint8_t *buffer, uint8_t value);
478 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
479 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
480 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
481 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
482 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
483 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
485 /* Issues USER() statements with target state information */
486 int target_arch_state(struct target *target);
488 void target_handle_event(struct target *t, enum target_event e);
489 void target_all_handle_event(enum target_event e);
491 #define ERROR_TARGET_INVALID (-300)
492 #define ERROR_TARGET_INIT_FAILED (-301)
493 #define ERROR_TARGET_TIMEOUT (-302)
494 #define ERROR_TARGET_NOT_HALTED (-304)
495 #define ERROR_TARGET_FAILURE (-305)
496 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
497 #define ERROR_TARGET_DATA_ABORT (-307)
498 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
499 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
500 #define ERROR_TARGET_NOT_RUNNING (-310)
501 #define ERROR_TARGET_NOT_EXAMINED (-311)
503 const char *target_strerror_safe(int err);
505 extern bool get_target_reset_nag(void);
507 #endif /* TARGET_H */