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 * Copyright (C) 2011 by Broadcom Corporation *
12 * Evan Hunter - ehunter@broadcom.com *
14 * Copyright (C) ST-Ericsson SA 2011 *
15 * michel.jaouen@stericsson.com : smp minimum support *
17 * This program is free software; you can redistribute it and/or modify *
18 * it under the terms of the GNU General Public License as published by *
19 * the Free Software Foundation; either version 2 of the License, or *
20 * (at your option) any later version. *
22 * This program is distributed in the hope that it will be useful, *
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
25 * GNU General Public License for more details. *
27 * You should have received a copy of the GNU General Public License *
28 * along with this program; if not, write to the *
29 * Free Software Foundation, Inc., *
30 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
31 ***************************************************************************/
36 #include <helper/list.h>
40 struct command_context;
46 struct gdb_fileio_info;
49 * TARGET_UNKNOWN = 0: we don't know anything about the target yet
50 * TARGET_RUNNING = 1: the target is executing user code
51 * TARGET_HALTED = 2: the target is not executing code, and ready to talk to the
52 * debugger. on an xscale it means that the debug handler is executing
53 * TARGET_RESET = 3: the target is being held in reset (only a temporary state,
54 * not sure how this is used with all the recent changes)
55 * TARGET_DEBUG_RUNNING = 4: the target is running, but it is executing code on
56 * behalf of the debugger (e.g. algorithm for flashing)
58 * also see: target_state_name();
66 TARGET_DEBUG_RUNNING = 4,
74 enum target_reset_mode {
76 RESET_RUN = 1, /* reset and let target run */
77 RESET_HALT = 2, /* reset and halt target out of reset */
78 RESET_INIT = 3, /* reset and halt target out of reset, then run init script */
81 enum target_debug_reason {
83 DBG_REASON_BREAKPOINT = 1,
84 DBG_REASON_WATCHPOINT = 2,
85 DBG_REASON_WPTANDBKPT = 3,
86 DBG_REASON_SINGLESTEP = 4,
87 DBG_REASON_NOTHALTED = 5,
89 DBG_REASON_UNDEFINED = 7,
92 enum target_endianness {
93 TARGET_ENDIAN_UNKNOWN = 0,
94 TARGET_BIG_ENDIAN = 1, TARGET_LITTLE_ENDIAN = 2
102 struct working_area **user;
103 struct working_area *next;
107 struct target *target;
108 /* field for smp display */
109 /* element 0 coreid currently displayed ( 1 till n) */
110 /* element 1 coreid to be displayed at next resume 1 till n 0 means resume
111 * all cores core displayed */
115 /* target back off timer */
116 struct backoff_timer {
121 /* split target registers into multiple class */
122 enum target_register_class {
127 /* target_type.h contains the full definition of struct target_type */
129 struct target_type *type; /* target type definition (name, access functions) */
130 const char *cmd_name; /* tcl Name of target */
131 int target_number; /* DO NOT USE! field to be removed in 2010 */
132 struct jtag_tap *tap; /* where on the jtag chain is this */
133 int32_t coreid; /* which device on the TAP? */
136 * Indicates whether this target has been examined.
138 * Do @b not access this field directly, use target_was_examined()
139 * or target_set_examined().
144 * true if the target is currently running a downloaded
145 * "algorithm" instead of arbitrary user code. OpenOCD code
146 * invoking algorithms is trusted to maintain correctness of
147 * any cached state (e.g. for flash status), which arbitrary
148 * code will have no reason to know about.
152 struct target_event_action *event_action;
154 int reset_halt; /* attempt resetting the CPU into the halted mode? */
155 uint32_t working_area; /* working area (initialised RAM). Evaluated
156 * upon first allocation from virtual/physical address. */
157 bool working_area_virt_spec; /* virtual address specified? */
158 uint32_t working_area_virt; /* virtual address */
159 bool working_area_phys_spec; /* virtual address specified? */
160 uint32_t working_area_phys; /* physical address */
161 uint32_t working_area_size; /* size in bytes */
162 uint32_t backup_working_area; /* whether the content of the working area has to be preserved */
163 struct working_area *working_areas;/* list of allocated working areas */
164 enum target_debug_reason debug_reason;/* reason why the target entered debug state */
165 enum target_endianness endianness; /* target endianness */
166 /* also see: target_state_name() */
167 enum target_state state; /* the current backend-state (running, halted, ...) */
168 struct reg_cache *reg_cache; /* the first register cache of the target (core regs) */
169 struct breakpoint *breakpoints; /* list of breakpoints */
170 struct watchpoint *watchpoints; /* list of watchpoints */
171 struct trace *trace_info; /* generic trace information */
172 struct debug_msg_receiver *dbgmsg; /* list of debug message receivers */
173 uint32_t dbg_msg_enabled; /* debug message status */
174 void *arch_info; /* architecture specific information */
175 struct target *next; /* next target in list */
177 int display; /* display async info in telnet session. Do not display
178 * lots of halted/resumed info when stepping in debugger. */
179 bool halt_issued; /* did we transition to halted state? */
180 long long halt_issued_time; /* Note time when halt was issued */
182 bool dbgbase_set; /* By default the debug base is not set */
183 uint32_t dbgbase; /* Really a Cortex-A specific option, but there is no
184 * system in place to support target specific options
186 struct rtos *rtos; /* Instance of Real Time Operating System support */
187 bool rtos_auto_detect; /* A flag that indicates that the RTOS has been specified as "auto"
188 * and must be detected when symbols are offered */
189 struct backoff_timer backoff;
190 int smp; /* add some target attributes for smp support */
191 struct target_list *head;
192 /* the gdb service is there in case of smp, we have only one gdb server
194 * the target attached to the gdb is changing dynamically by changing
195 * gdb_service->target pointer */
196 struct gdb_service *gdb_service;
198 /* file-I/O information for host to do syscall */
199 struct gdb_fileio_info *fileio_info;
203 struct target *target;
204 struct target_list *next;
207 struct gdb_fileio_info {
215 /** Returns the instance-specific name of the specified target. */
216 static inline const char *target_name(struct target *target)
218 return target->cmd_name;
221 const char *debug_reason_name(struct target *t);
225 /* allow GDB to do stuff before others handle the halted event,
226 * this is in lieu of defining ordering of invocation of events,
227 * which would be more complicated
229 * Telling GDB to halt does not mean that the target stopped running,
230 * simply that we're dropping out of GDB's waiting for step or continue.
232 * This can be useful when e.g. detecting power dropout.
234 TARGET_EVENT_GDB_HALT,
235 TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
236 TARGET_EVENT_RESUMED, /* target resumed to normal execution */
237 TARGET_EVENT_RESUME_START,
238 TARGET_EVENT_RESUME_END,
240 TARGET_EVENT_GDB_START, /* debugger started execution (step/run) */
241 TARGET_EVENT_GDB_END, /* debugger stopped execution (step/run) */
243 TARGET_EVENT_RESET_START,
244 TARGET_EVENT_RESET_ASSERT_PRE,
245 TARGET_EVENT_RESET_ASSERT, /* C code uses this instead of SRST */
246 TARGET_EVENT_RESET_ASSERT_POST,
247 TARGET_EVENT_RESET_DEASSERT_PRE,
248 TARGET_EVENT_RESET_DEASSERT_POST,
249 TARGET_EVENT_RESET_HALT_PRE,
250 TARGET_EVENT_RESET_HALT_POST,
251 TARGET_EVENT_RESET_WAIT_PRE,
252 TARGET_EVENT_RESET_WAIT_POST,
253 TARGET_EVENT_RESET_INIT,
254 TARGET_EVENT_RESET_END,
256 TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
257 TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
259 TARGET_EVENT_EXAMINE_START,
260 TARGET_EVENT_EXAMINE_END,
262 TARGET_EVENT_GDB_ATTACH,
263 TARGET_EVENT_GDB_DETACH,
265 TARGET_EVENT_GDB_FLASH_ERASE_START,
266 TARGET_EVENT_GDB_FLASH_ERASE_END,
267 TARGET_EVENT_GDB_FLASH_WRITE_START,
268 TARGET_EVENT_GDB_FLASH_WRITE_END,
270 TARGET_EVENT_TRACE_CONFIG,
273 struct target_event_action {
274 enum target_event event;
275 struct Jim_Interp *interp;
276 struct Jim_Obj *body;
278 struct target_event_action *next;
281 bool target_has_event_action(struct target *target, enum target_event event);
283 struct target_event_callback {
284 int (*callback)(struct target *target, enum target_event event, void *priv);
286 struct target_event_callback *next;
289 struct target_reset_callback {
290 struct list_head list;
292 int (*callback)(struct target *target, enum target_reset_mode reset_mode, void *priv);
295 struct target_timer_callback {
296 int (*callback)(void *priv);
302 struct target_timer_callback *next;
305 int target_register_commands(struct command_context *cmd_ctx);
306 int target_examine(void);
308 int target_register_event_callback(
309 int (*callback)(struct target *target,
310 enum target_event event, void *priv),
312 int target_unregister_event_callback(
313 int (*callback)(struct target *target,
314 enum target_event event, void *priv),
317 int target_register_reset_callback(
318 int (*callback)(struct target *target,
319 enum target_reset_mode reset_mode, void *priv),
321 int target_unregister_reset_callback(
322 int (*callback)(struct target *target,
323 enum target_reset_mode reset_mode, void *priv),
326 /* Poll the status of the target, detect any error conditions and report them.
328 * Also note that this fn will clear such error conditions, so a subsequent
329 * invocation will then succeed.
331 * These error conditions can be "sticky" error conditions. E.g. writing
332 * to memory could be implemented as an open loop and if memory writes
333 * fails, then a note is made of it, the error is sticky, but the memory
334 * write loop still runs to completion. This improves performance in the
335 * normal case as there is no need to verify that every single write succeed,
336 * yet it is possible to detect error conditions.
338 int target_poll(struct target *target);
339 int target_resume(struct target *target, int current, uint32_t address,
340 int handle_breakpoints, int debug_execution);
341 int target_halt(struct target *target);
342 int target_call_event_callbacks(struct target *target, enum target_event event);
343 int target_call_reset_callbacks(struct target *target, enum target_reset_mode reset_mode);
346 * The period is very approximate, the callback can happen much more often
347 * or much more rarely than specified
349 int target_register_timer_callback(int (*callback)(void *priv),
350 int time_ms, int periodic, void *priv);
351 int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
352 int target_call_timer_callbacks(void);
354 * Invoke this to ensure that e.g. polling timer callbacks happen before
355 * a synchronous command completes.
357 int target_call_timer_callbacks_now(void);
359 struct target *get_target_by_num(int num);
360 struct target *get_current_target(struct command_context *cmd_ctx);
361 struct target *get_target(const char *id);
364 * Get the target type name.
366 * This routine is a wrapper for the target->type->name field.
367 * Note that this is not an instance-specific name for his target.
369 const char *target_type_name(struct target *target);
372 * Examine the specified @a target, letting it perform any
373 * Initialisation that requires JTAG access.
375 * This routine is a wrapper for target->type->examine.
377 int target_examine_one(struct target *target);
379 /** @returns @c true if target_set_examined() has been called. */
380 static inline bool target_was_examined(struct target *target)
382 return target->examined;
385 /** Sets the @c examined flag for the given target. */
386 /** Use in target->type->examine() after one-time setup is done. */
387 static inline void target_set_examined(struct target *target)
389 target->examined = true;
393 * Add the @a breakpoint for @a target.
395 * This routine is a wrapper for target->type->add_breakpoint.
397 int target_add_breakpoint(struct target *target,
398 struct breakpoint *breakpoint);
400 * Add the @a ContextID breakpoint for @a target.
402 * This routine is a wrapper for target->type->add_context_breakpoint.
404 int target_add_context_breakpoint(struct target *target,
405 struct breakpoint *breakpoint);
407 * Add the @a ContextID & IVA breakpoint for @a target.
409 * This routine is a wrapper for target->type->add_hybrid_breakpoint.
411 int target_add_hybrid_breakpoint(struct target *target,
412 struct breakpoint *breakpoint);
414 * Remove the @a breakpoint for @a target.
416 * This routine is a wrapper for target->type->remove_breakpoint.
419 int target_remove_breakpoint(struct target *target,
420 struct breakpoint *breakpoint);
422 * Add the @a watchpoint for @a target.
424 * This routine is a wrapper for target->type->add_watchpoint.
426 int target_add_watchpoint(struct target *target,
427 struct watchpoint *watchpoint);
429 * Remove the @a watchpoint for @a target.
431 * This routine is a wrapper for target->type->remove_watchpoint.
433 int target_remove_watchpoint(struct target *target,
434 struct watchpoint *watchpoint);
437 * Find out the just hit @a watchpoint for @a target.
439 * This routine is a wrapper for target->type->hit_watchpoint.
441 int target_hit_watchpoint(struct target *target,
442 struct watchpoint **watchpoint);
445 * Obtain the registers for GDB.
447 * This routine is a wrapper for target->type->get_gdb_reg_list.
449 int target_get_gdb_reg_list(struct target *target,
450 struct reg **reg_list[], int *reg_list_size,
451 enum target_register_class reg_class);
456 * This routine is a wrapper for target->type->step.
458 int target_step(struct target *target,
459 int current, uint32_t address, int handle_breakpoints);
461 * Run an algorithm on the @a target given.
463 * This routine is a wrapper for target->type->run_algorithm.
465 int target_run_algorithm(struct target *target,
466 int num_mem_params, struct mem_param *mem_params,
467 int num_reg_params, struct reg_param *reg_param,
468 uint32_t entry_point, uint32_t exit_point,
469 int timeout_ms, void *arch_info);
472 * Starts an algorithm in the background on the @a target given.
474 * This routine is a wrapper for target->type->start_algorithm.
476 int target_start_algorithm(struct target *target,
477 int num_mem_params, struct mem_param *mem_params,
478 int num_reg_params, struct reg_param *reg_params,
479 uint32_t entry_point, uint32_t exit_point,
483 * Wait for an algorithm on the @a target given.
485 * This routine is a wrapper for target->type->wait_algorithm.
487 int target_wait_algorithm(struct target *target,
488 int num_mem_params, struct mem_param *mem_params,
489 int num_reg_params, struct reg_param *reg_params,
490 uint32_t exit_point, int timeout_ms,
494 * This routine is a wrapper for asynchronous algorithms.
497 int target_run_flash_async_algorithm(struct target *target,
498 const uint8_t *buffer, uint32_t count, int block_size,
499 int num_mem_params, struct mem_param *mem_params,
500 int num_reg_params, struct reg_param *reg_params,
501 uint32_t buffer_start, uint32_t buffer_size,
502 uint32_t entry_point, uint32_t exit_point,
506 * Read @a count items of @a size bytes from the memory of @a target at
507 * the @a address given.
509 * This routine is a wrapper for target->type->read_memory.
511 int target_read_memory(struct target *target,
512 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
513 int target_read_phys_memory(struct target *target,
514 uint32_t address, uint32_t size, uint32_t count, uint8_t *buffer);
516 * Write @a count items of @a size bytes to the memory of @a target at
517 * the @a address given. @a address must be aligned to @a size
520 * The endianness is the same in the host and target memory for this
524 * Really @a buffer should have been defined as "const void *" and
525 * @a buffer should have been aligned to @a size in the host memory.
527 * This is not enforced via e.g. assert's today and e.g. the
528 * target_write_buffer fn breaks this assumption.
530 * This routine is wrapper for target->type->write_memory.
532 int target_write_memory(struct target *target,
533 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
534 int target_write_phys_memory(struct target *target,
535 uint32_t address, uint32_t size, uint32_t count, const uint8_t *buffer);
538 * Write to target memory using the virtual address.
540 * Note that this fn is used to implement software breakpoints. Targets
541 * can implement support for software breakpoints to memory marked as read
542 * only by making this fn write to ram even if it is read only(MMU or
545 * It is sufficient to implement for writing a single word(16 or 32 in
546 * ARM32/16 bit case) to write the breakpoint to ram.
548 * The target should also take care of "other things" to make sure that
549 * software breakpoints can be written using this function. E.g.
550 * when there is a separate instruction and data cache, this fn must
551 * make sure that the instruction cache is synced up to the potential
552 * code change that can happen as a result of the memory write(typically
553 * by invalidating the cache).
555 * The high level wrapper fn in target.c will break down this memory write
556 * request to multiple write requests to the target driver to e.g. guarantee
557 * that writing 4 bytes to an aligned address happens with a single 32 bit
558 * write operation, thus making this fn suitable to e.g. write to special
559 * peripheral registers which do not support byte operations.
561 int target_write_buffer(struct target *target,
562 uint32_t address, uint32_t size, const uint8_t *buffer);
563 int target_read_buffer(struct target *target,
564 uint32_t address, uint32_t size, uint8_t *buffer);
565 int target_checksum_memory(struct target *target,
566 uint32_t address, uint32_t size, uint32_t *crc);
567 int target_blank_check_memory(struct target *target,
568 uint32_t address, uint32_t size, uint32_t *blank);
569 int target_wait_state(struct target *target, enum target_state state, int ms);
572 * Obtain file-I/O information from target for GDB to do syscall.
574 * This routine is a wrapper for target->type->get_gdb_fileio_info.
576 int target_get_gdb_fileio_info(struct target *target, struct gdb_fileio_info *fileio_info);
579 * Pass GDB file-I/O response to target after finishing host syscall.
581 * This routine is a wrapper for target->type->gdb_fileio_end.
583 int target_gdb_fileio_end(struct target *target, int retcode, int fileio_errno, bool ctrl_c);
587 /** Return the *name* of this targets current state */
588 const char *target_state_name(struct target *target);
590 /** Return the *name* of a target event enumeration value */
591 const char *target_event_name(enum target_event event);
593 /** Return the *name* of a target reset reason enumeration value */
594 const char *target_reset_mode_name(enum target_reset_mode reset_mode);
598 * if "area" passed in to target_alloc_working_area() points to a memory
599 * location that goes out of scope (e.g. a pointer on the stack), then
600 * the caller of target_alloc_working_area() is responsible for invoking
601 * target_free_working_area() before "area" goes out of scope.
603 * target_free_all_working_areas() will NULL out the "area" pointer
604 * upon resuming or resetting the CPU.
607 int target_alloc_working_area(struct target *target,
608 uint32_t size, struct working_area **area);
609 /* Same as target_alloc_working_area, except that no error is logged
610 * when ERROR_TARGET_RESOURCE_NOT_AVAILABLE is returned.
612 * This allows the calling code to *try* to allocate target memory
613 * and have a fallback to another behaviour(slower?).
615 int target_alloc_working_area_try(struct target *target,
616 uint32_t size, struct working_area **area);
617 int target_free_working_area(struct target *target, struct working_area *area);
618 void target_free_all_working_areas(struct target *target);
619 uint32_t target_get_working_area_avail(struct target *target);
622 * Free all the resources allocated by targets and the target layer
624 void target_quit(void);
626 extern struct target *all_targets;
628 uint64_t target_buffer_get_u64(struct target *target, const uint8_t *buffer);
629 uint32_t target_buffer_get_u32(struct target *target, const uint8_t *buffer);
630 uint32_t target_buffer_get_u24(struct target *target, const uint8_t *buffer);
631 uint16_t target_buffer_get_u16(struct target *target, const uint8_t *buffer);
632 void target_buffer_set_u64(struct target *target, uint8_t *buffer, uint64_t value);
633 void target_buffer_set_u32(struct target *target, uint8_t *buffer, uint32_t value);
634 void target_buffer_set_u24(struct target *target, uint8_t *buffer, uint32_t value);
635 void target_buffer_set_u16(struct target *target, uint8_t *buffer, uint16_t value);
637 void target_buffer_get_u64_array(struct target *target, const uint8_t *buffer, uint32_t count, uint64_t *dstbuf);
638 void target_buffer_get_u32_array(struct target *target, const uint8_t *buffer, uint32_t count, uint32_t *dstbuf);
639 void target_buffer_get_u16_array(struct target *target, const uint8_t *buffer, uint32_t count, uint16_t *dstbuf);
640 void target_buffer_set_u64_array(struct target *target, uint8_t *buffer, uint32_t count, const uint64_t *srcbuf);
641 void target_buffer_set_u32_array(struct target *target, uint8_t *buffer, uint32_t count, const uint32_t *srcbuf);
642 void target_buffer_set_u16_array(struct target *target, uint8_t *buffer, uint32_t count, const uint16_t *srcbuf);
644 int target_read_u64(struct target *target, uint64_t address, uint64_t *value);
645 int target_read_u32(struct target *target, uint32_t address, uint32_t *value);
646 int target_read_u16(struct target *target, uint32_t address, uint16_t *value);
647 int target_read_u8(struct target *target, uint32_t address, uint8_t *value);
648 int target_write_u64(struct target *target, uint64_t address, uint64_t value);
649 int target_write_u32(struct target *target, uint32_t address, uint32_t value);
650 int target_write_u16(struct target *target, uint32_t address, uint16_t value);
651 int target_write_u8(struct target *target, uint32_t address, uint8_t value);
653 /* Issues USER() statements with target state information */
654 int target_arch_state(struct target *target);
656 void target_handle_event(struct target *t, enum target_event e);
658 #define ERROR_TARGET_INVALID (-300)
659 #define ERROR_TARGET_INIT_FAILED (-301)
660 #define ERROR_TARGET_TIMEOUT (-302)
661 #define ERROR_TARGET_NOT_HALTED (-304)
662 #define ERROR_TARGET_FAILURE (-305)
663 #define ERROR_TARGET_UNALIGNED_ACCESS (-306)
664 #define ERROR_TARGET_DATA_ABORT (-307)
665 #define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
666 #define ERROR_TARGET_TRANSLATION_FAULT (-309)
667 #define ERROR_TARGET_NOT_RUNNING (-310)
668 #define ERROR_TARGET_NOT_EXAMINED (-311)
670 extern bool get_target_reset_nag(void);
672 #endif /* TARGET_H */